Class: Whop_sdk::AdReports::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/whop_sdk/ad_reports/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



9
10
11
 
# File 'lib/whop_sdk/ad_reports/client.rb', line 9

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(request_options: {}, **params) ⇒ Whop_sdk::Types::AdReport

Performance report for a company, ad campaigns, ad groups, or ads. Always returns aggregate summary totals summed across the scope. Set granularity to additionally get a time series, or set breakdown (campaign/ad_group/ad) to additionally get per-entity rows inside the requested scope. Exactly one of companyId, adCampaignIds, adGroupIds, or adIds must be provided.

Required permissions:

  • ad_campaign:stats:read

Examples:

client.ad_reports.retrieve(
  company_id: "biz_xxxxxxxxxxxxxx",
  from: "2023-12-01T05:00:00Z",
  to: "2023-12-01T05:00:00Z"
)

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

Returns:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/whop_sdk/ad_reports/client.rb', line 46

def retrieve(request_options: {}, **params)
  params = Whop_sdk::Internal::Types::Utils.normalize_keys(params)
  query_params = {}
  query_params["ad_campaign_ids"] = params[:ad_campaign_ids] if params.key?(:ad_campaign_ids)
  query_params["ad_group_ids"] = params[:ad_group_ids] if params.key?(:ad_group_ids)
  query_params["ad_ids"] = params[:ad_ids] if params.key?(:ad_ids)
  query_params["breakdown"] = params[:breakdown] if params.key?(:breakdown)
  query_params["company_id"] = params[:company_id] if params.key?(:company_id)
  query_params["currency"] = params[:currency] if params.key?(:currency)
  query_params["from"] = params[:from] if params.key?(:from)
  query_params["granularity"] = params[:granularity] if params.key?(:granularity)
  query_params["to"] = params[:to] if params.key?(:to)

  request = Whop_sdk::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "ad_reports",
    query: query_params,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Whop_sdk::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Whop_sdk::Types::AdReport.load(response.body)
  else
    error_class = Whop_sdk::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end