Class: WhopSDK::Models::AdReportRetrieveResponse::Granularity

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

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from WhopSDK::Internal::Type::BaseModel

Instance Attribute Details

#bucket_start ⇒ Time

The bucket’s start time as a real UTC instant. ‘(statDate, statHour)` resolved in the ad account’s reporting timezone — render this in the viewer’s local timezone.

Returns:

  • (Time) 


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

required :bucket_start, Time

#clicks ⇒ Integer

Clicks in this bucket.

Returns:

  • (Integer) 


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

required :clicks, Integer

#granularity ⇒ Symbol, WhopSDK::Models::Granularities

The bucket size of this row (‘daily` or `hourly`).

Returns:



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

required :granularity, enum: -> { WhopSDK::Granularities }

#impressions ⇒ Integer

Impressions in this bucket.

Returns:

  • (Integer) 


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

required :impressions, Integer

#reach ⇒ Integer

Unique users reached in this bucket. Always ‘0` for hourly rows (Meta does not return reach at hourly grain).

Returns:

  • (Integer) 


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

required :reach, Integer

#result_count ⇒ Integer?

Count of the primary optimization result in this bucket.

Returns:

  • (Integer, nil) 


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

required :result_count, Integer, nil?: true

#result_label_key ⇒ Symbol, ...

Types of optimization results tracked from external ad platforms

Returns:



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

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

#result_label_override ⇒ String?

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

Returns:

  • (String, nil) 


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

required :result_label_override, String, nil?: true

#spend ⇒ Float

Charged spend in this bucket in the requested reporting currency — the amount billed including platform fees, not the platform-side net spend.

Returns:

  • (Float) 


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

required :spend, Float

#spend_currency ⇒ Symbol, WhopSDK::Models::Currency

Currency of the ‘spend` value.

Returns:



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

required :spend_currency, enum: -> { WhopSDK::Currency }

#stat_date ⇒ Time

The date these stats cover (midnight UTC). For hourly rows, see ‘statHour` and `bucketStart`.

Returns:

  • (Time) 


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

required :stat_date, Time

#stat_hour ⇒ Integer?

Hour of the day in the ad account’s reporting timezone (0-23). ‘null` for daily rows.

Returns:

  • (Integer, nil) 


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

required :stat_hour, Integer, nil?: true