Class: WhopSDK::Models::AdReportRetrieveParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::AdReportRetrieveParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/whop_sdk/models/ad_report_retrieve_params.rb

Overview

See Also:

• Resources::AdReports#retrieve

Defined Under Namespace

Modules: Breakdown

Instance Attribute Summary

• #ad_campaign_id ⇒ String^?

  The unique identifier of an ad campaign.

• #ad_group_id ⇒ String^?

  The unique identifier of an ad group.

• #ad_id ⇒ String^?

  The unique identifier of an ad.

• #breakdown ⇒ Symbol, ...

  Entity level to group an ad report by.

• #company_id ⇒ String^?

  The unique identifier of a company.

• #currency ⇒ String^?

  ISO 4217 currency code to report ‘spend` in.

• #from ⇒ Time

  Inclusive start of the reporting window.

• #granularity ⇒ Symbol, ...

  Bucket size for external ad stat rows.

• #to ⇒ Time

  Inclusive end of the reporting window.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(from:, to:, ad_campaign_id: nil, ad_group_id: nil, ad_id: nil, breakdown: nil, company_id: nil, currency: nil, granularity: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see AdReportRetrieveParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(from:, to:, ad_campaign_id: nil, ad_group_id: nil, ad_id: nil, breakdown: nil, company_id: nil, currency: nil, granularity: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see WhopSDK::Models::AdReportRetrieveParams for more details.

Parameters:

• from (Time) —

  Inclusive start of the reporting window.

• to (Time) —

  Inclusive end of the reporting window.

• ad_campaign_id (String, nil) (defaults to: nil) —

  The unique identifier of an ad campaign. Mutually exclusive with ‘companyId`, `a

• ad_group_id (String, nil) (defaults to: nil) —

  The unique identifier of an ad group. Mutually exclusive with ‘companyId`, `adCa

• ad_id (String, nil) (defaults to: nil) —

  The unique identifier of an ad. Mutually exclusive with ‘companyId`, `adCampaign

• breakdown (Symbol, WhopSDK::Models::AdReportRetrieveParams::Breakdown, nil) (defaults to: nil) —

  Entity level to group an ad report by.

• company_id (String, nil) (defaults to: nil) —

  The unique identifier of a company. Mutually exclusive with ‘adCampaignId`, `adG

• currency (String, nil) (defaults to: nil) —

  ISO 4217 currency code to report ‘spend` in. Defaults to the company’s ads repor

• granularity (Symbol, WhopSDK::Models::Granularities, nil) (defaults to: nil) —

  Bucket size for external ad stat rows.

• request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/whop_sdk/models/ad_report_retrieve_params.rb', line 70

Instance Attribute Details

#ad_campaign_id ⇒ String^?

The unique identifier of an ad campaign. Mutually exclusive with ‘companyId`, `adGroupId`, and `adId`.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/ad_report_retrieve_params.rb', line 27

optional :ad_campaign_id, String, nil?: true

#ad_group_id ⇒ String^?

The unique identifier of an ad group. Mutually exclusive with ‘companyId`, `adCampaignId`, and `adId`.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/ad_report_retrieve_params.rb', line 34

optional :ad_group_id, String, nil?: true

#ad_id ⇒ String^?

The unique identifier of an ad. Mutually exclusive with ‘companyId`, `adCampaignId`, and `adGroupId`.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/ad_report_retrieve_params.rb', line 41

optional :ad_id, String, nil?: true

#breakdown ⇒ Symbol, ...

Entity level to group an ad report by.

Returns:

• (Symbol, WhopSDK::Models::AdReportRetrieveParams::Breakdown, nil)

# File 'lib/whop_sdk/models/ad_report_retrieve_params.rb', line 47

optional :breakdown, enum: -> { WhopSDK::AdReportRetrieveParams::Breakdown }, nil?: true

#company_id ⇒ String^?

The unique identifier of a company. Mutually exclusive with ‘adCampaignId`, `adGroupId`, and `adId`. Use with `breakdown` to fan out across every campaign, ad group, or ad in the company without paging.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/ad_report_retrieve_params.rb', line 55

optional :company_id, String, nil?: true

#currency ⇒ String^?

ISO 4217 currency code to report ‘spend` in. Defaults to the company’s ads reporting currency.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/ad_report_retrieve_params.rb', line 62

optional :currency, String, nil?: true

#from ⇒ Time

Inclusive start of the reporting window.

Returns:

• (Time)

# File 'lib/whop_sdk/models/ad_report_retrieve_params.rb', line 14

required :from, Time

#granularity ⇒ Symbol, ...

Bucket size for external ad stat rows.

Returns:

• (Symbol, WhopSDK::Models::Granularities, nil)

# File 'lib/whop_sdk/models/ad_report_retrieve_params.rb', line 68

optional :granularity, enum: -> { WhopSDK::Granularities }, nil?: true

#to ⇒ Time

Inclusive end of the reporting window.

Returns:

• (Time)

# File 'lib/whop_sdk/models/ad_report_retrieve_params.rb', line 20

required :to, Time