Class: WhopSDK::Models::AdGroup

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

Overview

See Also:

  • WhopSDK::Resources::AdGroups#create

Defined Under Namespace

Modules: BidType, BudgetType, ConversionEvent, ConversionLocation, DeliveryStatus, ResultEvent, Status Classes: AdCampaign, Issue

Instance Attribute Summary collapse

Class Method 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:) ⇒ Object

The ad campaign this ad group belongs to, an object with an id.

Parameters:

  • id (String) —

    The referenced entity's id.




# File 'lib/whop_sdk/models/ad_group.rb', line 401

Instance Attribute Details

#ad_campaign ⇒ WhopSDK::Models::AdGroup::AdCampaign

The ad campaign this ad group belongs to, an object with an id.

Parameters:

  • value (WhopSDK::AdGroup::AdCampaign)

Returns:



17
 
# File 'lib/whop_sdk/models/ad_group.rb', line 17

required :ad_campaign, -> { WhopSDK::AdGroup::AdCampaign }

#added_to_carts ⇒ Float

Whop pixel-attributed add-to-cart events, last-click.

Parameters:

  • value (Float)

Returns:

  • (Float) 


23
 
# File 'lib/whop_sdk/models/ad_group.rb', line 23

required :added_to_carts, Float

#audiences ⇒ Object

Saved-audience targeting: { include, exclude } arrays of audience IDs.

Parameters:

  • value (top)

Returns:

  • (Object) 


29
 
# File 'lib/whop_sdk/models/ad_group.rb', line 29

required :audiences, WhopSDK::Internal::Type::Unknown

#bid_type ⇒ Symbol, ...

Bid strategy.

Parameters:

  • value (WhopSDK::Models::AdGroup::bid_type, nil)

Returns:



35
 
# File 'lib/whop_sdk/models/ad_group.rb', line 35

required :bid_type, enum: -> { WhopSDK::AdGroup::BidType }, nil?: true

#budget_amount ⇒ Float?

Ad-set budget; null when the campaign owns budget (CBO).

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


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

required :budget_amount, Float, nil?: true

#budget_type ⇒ Symbol, ...

Whether the budget is daily or lifetime.

Parameters:

  • value (WhopSDK::Models::AdGroup::budget_type, nil)

Returns:



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

required :budget_type, enum: -> { WhopSDK::AdGroup::BudgetType }, nil?: true

#click_through_rate ⇒ Float

Clicks divided by impressions, between 0 and 1.

Parameters:

  • value (Float)

Returns:

  • (Float) 


53
 
# File 'lib/whop_sdk/models/ad_group.rb', line 53

required :click_through_rate, Float

#clicks ⇒ Float

The number of clicks.

Parameters:

  • value (Float)

Returns:

  • (Float) 


59
 
# File 'lib/whop_sdk/models/ad_group.rb', line 59

required :clicks, Float

#completed_registrations ⇒ Float

Whop pixel-attributed complete-registration events, last-click.

Parameters:

  • value (Float)

Returns:

  • (Float) 


65
 
# File 'lib/whop_sdk/models/ad_group.rb', line 65

required :completed_registrations, Float

#contacts ⇒ Float

Whop pixel-attributed contact events, last-click.

Parameters:

  • value (Float)

Returns:

  • (Float) 


71
 
# File 'lib/whop_sdk/models/ad_group.rb', line 71

required :contacts, Float

#conversion_event ⇒ Symbol, ...

The pixel event optimized for. A standard event, or any custom pixel event name.

Parameters:

  • value (WhopSDK::Models::AdGroup::conversion_event, nil)

Returns:



77
 
# File 'lib/whop_sdk/models/ad_group.rb', line 77

required :conversion_event, union: -> { WhopSDK::AdGroup::ConversionEvent }, nil?: true

#conversion_location ⇒ Symbol, ...

Where results happen: website, profile (IG/FB), messaging (DM), on_ad (engagement), or the lead destinations (instant_forms, instant_forms_and_messenger, website_and_instant_forms).

Parameters:

  • value (WhopSDK::Models::AdGroup::conversion_location, nil)

Returns:



85
 
# File 'lib/whop_sdk/models/ad_group.rb', line 85

required :conversion_location, enum: -> { WhopSDK::AdGroup::ConversionLocation }, nil?: true

#cost_per_added_to_cart ⇒ Float?

Spend divided by attributed add-to-cart events; null when they are not the goal and none are attributed.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


92
 
# File 'lib/whop_sdk/models/ad_group.rb', line 92

required :cost_per_added_to_cart, Float, nil?: true

#cost_per_click ⇒ Float

Spend divided by clicks; 0 when there are no clicks.

Parameters:

  • value (Float)

Returns:

  • (Float) 


98
 
# File 'lib/whop_sdk/models/ad_group.rb', line 98

required :cost_per_click, Float

#cost_per_completed_registration ⇒ Float?

Spend divided by attributed complete-registration events; null when they are not the goal and none are attributed.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


105
 
# File 'lib/whop_sdk/models/ad_group.rb', line 105

required :cost_per_completed_registration, Float, nil?: true

#cost_per_contact ⇒ Float?

Spend divided by attributed contact events; null when contacts are not the goal and none are attributed.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


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

required :cost_per_contact, Float, nil?: true

#cost_per_lead ⇒ Float?

Spend divided by attributed leads; null when leads are not a goal and none are attributed.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


119
 
# File 'lib/whop_sdk/models/ad_group.rb', line 119

required :cost_per_lead, Float, nil?: true

#cost_per_mille ⇒ Float

Spend per 1,000 impressions; 0 when there are no impressions.

Parameters:

  • value (Float)

Returns:

  • (Float) 


125
 
# File 'lib/whop_sdk/models/ad_group.rb', line 125

required :cost_per_mille, Float

#cost_per_purchase ⇒ Float?

Spend divided by attributed purchases; null when purchases are not a goal and none are attributed.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


132
 
# File 'lib/whop_sdk/models/ad_group.rb', line 132

required :cost_per_purchase, Float, nil?: true

#cost_per_result ⇒ Float?

Spend divided by Whop pixel-attributed results; null when nothing Whop-attributable is being optimized for.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


139
 
# File 'lib/whop_sdk/models/ad_group.rb', line 139

required :cost_per_result, Float, nil?: true

#cost_per_schedule ⇒ Float?

Spend divided by attributed schedule events; null when schedules are not the goal and none are attributed.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


146
 
# File 'lib/whop_sdk/models/ad_group.rb', line 146

required :cost_per_schedule, Float, nil?: true

#cost_per_submitted_application ⇒ Float?

Spend divided by attributed submit-application events; null when they are not the goal and none are attributed.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


153
 
# File 'lib/whop_sdk/models/ad_group.rb', line 153

required :cost_per_submitted_application, Float, nil?: true

#cost_per_viewed_content ⇒ Float?

Spend divided by attributed view-content events; null when they are not the goal and none are attributed.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


160
 
# File 'lib/whop_sdk/models/ad_group.rb', line 160

required :cost_per_viewed_content, Float, nil?: true

#created_at ⇒ String

When the ad group was created, ISO 8601.

Parameters:

  • value (String)

Returns:

  • (String) 


166
 
# File 'lib/whop_sdk/models/ad_group.rb', line 166

required :created_at, String

#custom_conversions ⇒ Float

Whop pixel-attributed custom (merchant-defined) conversion events, last-click, across all custom event names.

Parameters:

  • value (Float)

Returns:

  • (Float) 


173
 
# File 'lib/whop_sdk/models/ad_group.rb', line 173

required :custom_conversions, Float

#custom_event_counts ⇒ Object

Whop pixel-attributed custom conversions broken out by merchant-defined event name, last-click, as a { event_name => count } map over the stats window. Empty when no named custom events are attributed. Custom events fired without a name are counted in custom_conversions but omitted here, so these values sum to at most custom_conversions.

Parameters:

  • value (top)

Returns:

  • (Object) 


183
 
# File 'lib/whop_sdk/models/ad_group.rb', line 183

required :custom_event_counts, WhopSDK::Internal::Type::Unknown

#delivery_status ⇒ Symbol, WhopSDK::Models::AdGroup::DeliveryStatus

The current delivery state, mirroring the Delivery column in the ads dashboard. When several states apply at once, the highest-precedence one is returned.

Parameters:

  • value (WhopSDK::Models::AdGroup::delivery_status)

Returns:



190
 
# File 'lib/whop_sdk/models/ad_group.rb', line 190

required :delivery_status, enum: -> { WhopSDK::AdGroup::DeliveryStatus }

#demographics ⇒ Object

Demographic targeting: automatic (Advantage+), age range, gender.

Parameters:

  • value (top)

Returns:

  • (Object) 


196
 
# File 'lib/whop_sdk/models/ad_group.rb', line 196

required :demographics, WhopSDK::Internal::Type::Unknown

#desired_cost_per_result ⇒ Float?

Target/cap cost for average_target / maximum_target.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


202
 
# File 'lib/whop_sdk/models/ad_group.rb', line 202

required :desired_cost_per_result, Float, nil?: true

#devices ⇒ Object

Device targeting: platforms and operating systems.

Parameters:

  • value (top)

Returns:

  • (Object) 


208
 
# File 'lib/whop_sdk/models/ad_group.rb', line 208

required :devices, WhopSDK::Internal::Type::Unknown

#dynamic_creative ⇒ Boolean

Whether ads within this ad group have their creatives and copy dynamically AB tested.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


215
 
# File 'lib/whop_sdk/models/ad_group.rb', line 215

required :dynamic_creative, WhopSDK::Internal::Type::Boolean

#ends_at ⇒ String?

Schedule end, ISO 8601.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


221
 
# File 'lib/whop_sdk/models/ad_group.rb', line 221

required :ends_at, String, nil?: true

#frequency ⇒ Float?

Platform-reported impressions divided by reach.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


227
 
# File 'lib/whop_sdk/models/ad_group.rb', line 227

required :frequency, Float, nil?: true

#frequency_cap ⇒ Object?

Impression cap; only valid for reach optimization.

Parameters:

  • value (top, nil)

Returns:

  • (Object, nil) 


233
 
# File 'lib/whop_sdk/models/ad_group.rb', line 233

required :frequency_cap, WhopSDK::Internal::Type::Unknown, nil?: true

#id ⇒ String

Unique identifier for the ad group.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/whop_sdk/models/ad_group.rb', line 11

required :id, String

#impressions ⇒ Float

The number of impressions.

Parameters:

  • value (Float)

Returns:

  • (Float) 


239
 
# File 'lib/whop_sdk/models/ad_group.rb', line 239

required :impressions, Float

#issues ⇒ Array<WhopSDK::Models::AdGroup::Issue>

Parameters:

  • value (::Array[WhopSDK::AdGroup::Issue])

Returns:



244
 
# File 'lib/whop_sdk/models/ad_group.rb', line 244

required :issues, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::AdGroup::Issue] }

#languages ⇒ Array<String>

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


249
 
# File 'lib/whop_sdk/models/ad_group.rb', line 249

required :languages, WhopSDK::Internal::Type::ArrayOf[String]

#leads ⇒ Float

Whop pixel-attributed leads, last-click.

Parameters:

  • value (Float)

Returns:

  • (Float) 


255
 
# File 'lib/whop_sdk/models/ad_group.rb', line 255

required :leads, Float

#message_apps ⇒ Array<String>

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


260
 
# File 'lib/whop_sdk/models/ad_group.rb', line 260

required :message_apps, WhopSDK::Internal::Type::ArrayOf[String]

#minimum_daily_spend ⇒ Float?

Daily spend floor within the budget.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


266
 
# File 'lib/whop_sdk/models/ad_group.rb', line 266

required :minimum_daily_spend, Float, nil?: true

#optimization_goal ⇒ String?

What the ad group optimizes for.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


272
 
# File 'lib/whop_sdk/models/ad_group.rb', line 272

required :optimization_goal, String, nil?: true

#placements ⇒ Array<Object>

Parameters:

  • value (::Array[top])

Returns:

  • (Array<Object>) 


277
 
# File 'lib/whop_sdk/models/ad_group.rb', line 277

required :placements, WhopSDK::Internal::Type::ArrayOf[WhopSDK::Internal::Type::Unknown]

#purchase_value ⇒ Float

USD value of pixel-attributed purchases.

Parameters:

  • value (Float)

Returns:

  • (Float) 


283
 
# File 'lib/whop_sdk/models/ad_group.rb', line 283

required :purchase_value, Float

#purchases ⇒ Float

Whop pixel-attributed purchases, last-click.

Parameters:

  • value (Float)

Returns:

  • (Float) 


289
 
# File 'lib/whop_sdk/models/ad_group.rb', line 289

required :purchases, Float

#reach ⇒ Float

The number of unique people who saw this.

Parameters:

  • value (Float)

Returns:

  • (Float) 


295
 
# File 'lib/whop_sdk/models/ad_group.rb', line 295

required :reach, Float

#regions ⇒ Object

Geo targeting: include/exclude countries, regions (ISO 3166-2 states, e.g. US-CA), cities, zips.

Parameters:

  • value (top)

Returns:

  • (Object) 


302
 
# File 'lib/whop_sdk/models/ad_group.rb', line 302

required :regions, WhopSDK::Internal::Type::Unknown

#result_event ⇒ Symbol, ...

The Whop pixel conversion event whose attributed count represents results — the optimization goal, or the highest-volume attributed event for campaigns that budget per ad group. Null when the goal isn't a Whop-attributed event.

Parameters:

  • value (WhopSDK::Models::AdGroup::result_event, nil)

Returns:



310
 
# File 'lib/whop_sdk/models/ad_group.rb', line 310

required :result_event, enum: -> { WhopSDK::AdGroup::ResultEvent }, nil?: true

#result_event_name ⇒ String?

The merchant-defined event name when result_event is custom; null for the standard events.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


317
 
# File 'lib/whop_sdk/models/ad_group.rb', line 317

required :result_event_name, String, nil?: true

#results ⇒ Float?

The Whop pixel-attributed count behind result_event. When a campaign's ad groups optimize different goals there is no single result_event (it is null), and this is instead the sum of each ad group's own attributed results. Null when nothing Whop-attributable is being optimized for.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


326
 
# File 'lib/whop_sdk/models/ad_group.rb', line 326

required :results, Float, nil?: true

#return_on_ad_spend ⇒ Float

Purchase value divided by spend, both in USD (a currency-neutral ratio); 0 when there is no spend.

Parameters:

  • value (Float)

Returns:

  • (Float) 


333
 
# File 'lib/whop_sdk/models/ad_group.rb', line 333

required :return_on_ad_spend, Float

#schedules ⇒ Float

Whop pixel-attributed schedule events, last-click.

Parameters:

  • value (Float)

Returns:

  • (Float) 


339
 
# File 'lib/whop_sdk/models/ad_group.rb', line 339

required :schedules, Float

#spend ⇒ Float

The amount charged, in spend_currency.

Parameters:

  • value (Float)

Returns:

  • (Float) 


345
 
# File 'lib/whop_sdk/models/ad_group.rb', line 345

required :spend, Float

#spend_currency ⇒ String?

The ISO 4217 currency code of all monetary metrics.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


351
 
# File 'lib/whop_sdk/models/ad_group.rb', line 351

required :spend_currency, String, nil?: true

#starts_at ⇒ String?

Schedule start, ISO 8601.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :starts_at, String, nil?: true

#status ⇒ Symbol, WhopSDK::Models::AdGroup::Status

Delivery status of the ad group.

Parameters:

  • value (WhopSDK::Models::AdGroup::status)

Returns:



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

required :status, enum: -> { WhopSDK::AdGroup::Status }

#submitted_applications ⇒ Float

Whop pixel-attributed submit-application events, last-click.

Parameters:

  • value (Float)

Returns:

  • (Float) 


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

required :submitted_applications, Float

#title ⇒ String?

The display title of the ad group.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :title, String, nil?: true

#unique_click_through_rate ⇒ Float?

Unique clicks divided by impressions, between 0 and 1.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


381
 
# File 'lib/whop_sdk/models/ad_group.rb', line 381

required :unique_click_through_rate, Float, nil?: true

#unique_clicks ⇒ Float

The number of unique clicks.

Parameters:

  • value (Float)

Returns:

  • (Float) 


387
 
# File 'lib/whop_sdk/models/ad_group.rb', line 387

required :unique_clicks, Float

#updated_at ⇒ String

When the ad group was last updated, ISO 8601.

Parameters:

  • value (String)

Returns:

  • (String) 


393
 
# File 'lib/whop_sdk/models/ad_group.rb', line 393

required :updated_at, String

#viewed_contents ⇒ Float

Whop pixel-attributed view-content events, last-click.

Parameters:

  • value (Float)

Returns:

  • (Float) 


399
 
# File 'lib/whop_sdk/models/ad_group.rb', line 399

required :viewed_contents, Float

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/whop_sdk/models/ad_group.rb', line 553

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


259
 
# File 'sig/whop_sdk/models/ad_group.rbs', line 259

def to_hash: -> {