Class: WhopSDK::Models::AdReportRetrieveResponse::Summary

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/ad_report_retrieve_response.rb,
sig/whop_sdk/models/ad_report_retrieve_response.rbs

Overview

See Also:

  • WhopSDK::Models::AdReportRetrieveResponse#summary

Instance Attribute Summary collapse

Instance Method Summary collapse

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(click_through_rate:, clicks:, cost_per_click:, cost_per_mille:, cost_per_result:, frequency:, impressions:, reach:, result_count:, result_label_key:, result_label_override:, return_on_ad_spend:, spend:, spend_currency:) ⇒ Object

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

Aggregate totals and rates over the date range.

Parameters:

  • click_through_rate (Float) —

    Click-through rate (clicks / impressions).

  • clicks (Integer) —

    Total clicks over the date range.

  • cost_per_click (Float) —

    Cost per click in the requested reporting currency.

  • cost_per_mille (Float, nil) —

    Cost per thousand impressions in the requested reporting currency.

  • cost_per_result (Float, nil) —

    Spend divided by resultCount. Null when there are no results.

  • frequency (Float, nil) —

    Average number of times each reached user saw an ad.

  • impressions (Integer) —

    Total impressions over the date range.

  • reach (Integer) —

    Unique users reached, deduplicated by the external ad platform.

  • result_count (Integer, nil) —

    Count of the campaign's primary optimization result (purchases, clicks, etc.) —

  • result_label_key (Symbol, WhopSDK::Models::ResultLabelKeys, nil) —

    Types of optimization results tracked from external ad platforms

  • result_label_override (String, nil) —

    Advertiser-defined label for the result when resultLabelKey is custom.

  • return_on_ad_spend (Float, nil) —

    Alias for purchaseReturnOnAdSpend — return on ad spend for purchases, as repor

  • spend (Float) —

    Total spend over the date range in the requested reporting currency.

  • spend_currency (Symbol, WhopSDK::Models::Currency, nil) —

    The available currencies on the platform




# File 'lib/whop_sdk/models/ad_report_retrieve_response.rb', line 549

Instance Attribute Details

#click_through_rate ⇒ Float

Click-through rate (clicks / impressions).

Parameters:

  • value (Float)

Returns:

  • (Float) 


467
 
# File 'lib/whop_sdk/models/ad_report_retrieve_response.rb', line 467

required :click_through_rate, Float

#clicks ⇒ Integer

Total clicks over the date range.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


473
 
# File 'lib/whop_sdk/models/ad_report_retrieve_response.rb', line 473

required :clicks, Integer

#cost_per_click ⇒ Float

Cost per click in the requested reporting currency.

Parameters:

  • value (Float)

Returns:

  • (Float) 


479
 
# File 'lib/whop_sdk/models/ad_report_retrieve_response.rb', line 479

required :cost_per_click, Float

#cost_per_mille ⇒ Float?

Cost per thousand impressions in the requested reporting currency.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


485
 
# File 'lib/whop_sdk/models/ad_report_retrieve_response.rb', line 485

required :cost_per_mille, Float, nil?: true

#cost_per_result ⇒ Float?

Spend divided by resultCount. Null when there are no results.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


491
 
# File 'lib/whop_sdk/models/ad_report_retrieve_response.rb', line 491

required :cost_per_result, Float, nil?: true

#frequency ⇒ Float?

Average number of times each reached user saw an ad.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


497
 
# File 'lib/whop_sdk/models/ad_report_retrieve_response.rb', line 497

required :frequency, Float, nil?: true

#impressions ⇒ Integer

Total impressions over the date range.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


503
 
# File 'lib/whop_sdk/models/ad_report_retrieve_response.rb', line 503

required :impressions, Integer

#reach ⇒ Integer

Unique users reached, deduplicated by the external ad platform.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


509
 
# File 'lib/whop_sdk/models/ad_report_retrieve_response.rb', line 509

required :reach, Integer

#result_count ⇒ Integer?

Count of the campaign's primary optimization result (purchases, clicks, etc.) — see resultLabelKey.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


516
 
# File 'lib/whop_sdk/models/ad_report_retrieve_response.rb', line 516

required :result_count, Integer, nil?: true

#result_label_key ⇒ Symbol, ...

Types of optimization results tracked from external ad platforms

Parameters:

  • value (WhopSDK::Models::result_label_keys, nil)

Returns:



522
 
# File 'lib/whop_sdk/models/ad_report_retrieve_response.rb', line 522

required :result_label_key, enum: -> { WhopSDK::ResultLabelKeys }, nil?: true

#result_label_override ⇒ String?

Advertiser-defined label for the result when resultLabelKey is custom.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


528
 
# File 'lib/whop_sdk/models/ad_report_retrieve_response.rb', line 528

required :result_label_override, String, nil?: true

#return_on_ad_spend ⇒ Float?

Alias for purchaseReturnOnAdSpend — return on ad spend for purchases, as reported by the external ad platform.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


535
 
# File 'lib/whop_sdk/models/ad_report_retrieve_response.rb', line 535

required :return_on_ad_spend, Float, nil?: true

#spend ⇒ Float

Total spend over the date range in the requested reporting currency.

Parameters:

  • value (Float)

Returns:

  • (Float) 


541
 
# File 'lib/whop_sdk/models/ad_report_retrieve_response.rb', line 541

required :spend, Float

#spend_currency ⇒ Symbol, ...

The available currencies on the platform

Parameters:

  • value (WhopSDK::Models::currency, nil)

Returns:



547
 
# File 'lib/whop_sdk/models/ad_report_retrieve_response.rb', line 547

required :spend_currency, enum: -> { WhopSDK::Currency }, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


368
 
# File 'sig/whop_sdk/models/ad_report_retrieve_response.rbs', line 368

def to_hash: -> {