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

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

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(id:, granularity:, level:, name:, summary:) ⇒ Object

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

Per-entity ad performance row. Returned when the ‘breakdown` arg on `adReport` is set.

Parameters:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/whop_sdk/models/ad_report_retrieve_response.rb', line 99

class Granularity < WhopSDK::Internal::Type::BaseModel
  # @!attribute bucket_start
  #   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.
  #
  #   @return [Time]
  required :bucket_start, Time

  # @!attribute clicks
  #   Clicks in this bucket.
  #
  #   @return [Integer]
  required :clicks, Integer

  # @!attribute granularity
  #   The bucket size of this row (`daily` or `hourly`).
  #
  #   @return [Symbol, WhopSDK::Models::Granularities]
  required :granularity, enum: -> { WhopSDK::Granularities }

  # @!attribute impressions
  #   Impressions in this bucket.
  #
  #   @return [Integer]
  required :impressions, Integer

  # @!attribute reach
  #   Unique users reached in this bucket. Always `0` for hourly rows (Meta does not
  #   return reach at hourly grain).
  #
  #   @return [Integer]
  required :reach, Integer

  # @!attribute result_count
  #   Count of the primary optimization result in this bucket.
  #
  #   @return [Integer, nil]
  required :result_count, Integer, nil?: true

  # @!attribute result_label_key
  #   Types of optimization results tracked from external ad platforms
  #
  #   @return [Symbol, WhopSDK::Models::ResultLabelKeys, nil]
  required :result_label_key, enum: -> { WhopSDK::ResultLabelKeys }, nil?: true

  # @!attribute result_label_override
  #   Advertiser-defined label for the result when `resultLabelKey` is `custom`.
  #
  #   @return [String, nil]
  required :result_label_override, String, nil?: true

  # @!attribute spend
  #   Charged spend in this bucket in the requested reporting currency — the amount
  #   billed including platform fees, not the platform-side net spend.
  #
  #   @return [Float]
  required :spend, Float

  # @!attribute spend_currency
  #   Currency of the `spend` value.
  #
  #   @return [Symbol, WhopSDK::Models::Currency]
  required :spend_currency, enum: -> { WhopSDK::Currency }

  # @!attribute stat_date
  #   The date these stats cover (midnight UTC). For hourly rows, see `statHour` and
  #   `bucketStart`.
  #
  #   @return [Time]
  required :stat_date, Time

  # @!attribute stat_hour
  #   Hour of the day in the ad account's reporting timezone (0-23). `null` for daily
  #   rows.
  #
  #   @return [Integer, nil]
  required :stat_hour, Integer, nil?: true

  # @!method initialize(bucket_start:, clicks:, granularity:, impressions:, reach:, result_count:, result_label_key:, result_label_override:, spend:, spend_currency:, stat_date:, stat_hour:)
  #   Some parameter documentations has been truncated, see
  #   {WhopSDK::Models::AdReportRetrieveResponse::Breakdown::Granularity} for more
  #   details.
  #
  #   Per-bucket ad performance for an ad campaign, ad group, or ad. Bucket grain is
  #   set by the `ad_report` query's `granularity` argument.
  #
  #   @param bucket_start [Time] The bucket's start time as a real UTC instant. `(statDate, statHour)` resolved i
  #
  #   @param clicks [Integer] Clicks in this bucket.
  #
  #   @param granularity [Symbol, WhopSDK::Models::Granularities] The bucket size of this row (`daily` or `hourly`).
  #
  #   @param impressions [Integer] Impressions in this bucket.
  #
  #   @param reach [Integer] Unique users reached in this bucket. Always `0` for hourly rows (Meta does not r
  #
  #   @param result_count [Integer, nil] Count of the primary optimization result in this bucket.
  #
  #   @param result_label_key [Symbol, WhopSDK::Models::ResultLabelKeys, nil] Types of optimization results tracked from external ad platforms
  #
  #   @param result_label_override [String, nil] Advertiser-defined label for the result when `resultLabelKey` is `custom`.
  #
  #   @param spend [Float] Charged spend in this bucket in the requested reporting currency — the amount bi
  #
  #   @param spend_currency [Symbol, WhopSDK::Models::Currency] Currency of the `spend` value.
  #
  #   @param stat_date [Time] The date these stats cover (midnight UTC). For hourly rows, see `statHour` and `
  #
  #   @param stat_hour [Integer, nil] Hour of the day in the ad account's reporting timezone (0-23). `null` for daily
end

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) 


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

required :bucket_start, Time

#clicks ⇒ Integer

Clicks in this bucket.

Returns:

  • (Integer) 


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

required :clicks, Integer

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

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

Returns:



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

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

#impressions ⇒ Integer

Impressions in this bucket.

Returns:

  • (Integer) 


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

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) 


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

required :reach, Integer

#result_count ⇒ Integer?

Count of the primary optimization result in this bucket.

Returns:

  • (Integer, nil) 


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

required :result_count, Integer, nil?: true

#result_label_key ⇒ Symbol, ...

Types of optimization results tracked from external ad platforms

Returns:



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

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) 


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

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) 


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

required :spend, Float

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

Currency of the ‘spend` value.

Returns:



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

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) 


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

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) 


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

required :stat_hour, Integer, nil?: true