Class: WhopSDK::Models::AdGroupUpdateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/whop_sdk/models/ad_group_update_params.rb,
sig/whop_sdk/models/ad_group_update_params.rbs

Overview

See Also:

• WhopSDK::Resources::AdGroups#update

Defined Under Namespace

Modules: BidType, BudgetType, ConversionEvent, ConversionLocation, MessageApp, Status

Instance Attribute Summary

• #audiences ⇒ Object^?

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

• #bid_type ⇒ Symbol, ...

  Bid strategy.

• #budget_amount ⇒ Float^?

  Ad-set budget in dollars (ABO only; omit under CBO).

• #budget_type ⇒ Symbol, ...

  Whether the budget is daily or lifetime.

• #conversion_event ⇒ Symbol, ...

  The pixel event optimized for.

• #conversion_location ⇒ Symbol, ...

  Where results happen: website (conversions), profile (IG/FB engagement), messaging (DM), on_ad (engagement on the ad, surface follows the optimization goal), or the lead destinations (instant_forms, instant_forms_and_messenger, website_and_instant_forms).

• #demographics ⇒ Object^?

  Demographic targeting: { automatic, minimum_age, maximum_age, gender }.

• #desired_cost_per_result ⇒ Float^?

  Target/cap cost for average_target / maximum_target.

• #devices ⇒ Object^?

  Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }.

• #ends_at ⇒ String^?

  Schedule end, ISO 8601.

• #frequency_cap ⇒ Object^?

  { maximum_impressions, per_days } — only valid for reach optimization.

• #id ⇒ String
• #languages ⇒ Array<String>^?

  Languages to target as ISO 639 codes (e.g. en, es).

• #message_apps ⇒ Array<Symbol, WhopSDK::Models::AdGroupUpdateParams::MessageApp>^?

  Required when conversion_location is messaging: which apps to message on.

• #minimum_daily_spend ⇒ Float^?

  Daily spend floor within the budget.

• #optimization_goal ⇒ String^?

  What the ad group optimizes for (e.g. conversions, link_clicks, reach).

• #placements ⇒ Object^?

  'automatic' (Advantage+) or a list of { platform, positions }.

• #regions ⇒ Object^?

  Geo targeting: { include / exclude: { countries (ISO 3166-1), regions (states/provinces as ISO 3166-2, e.g. US-CA), cities (keyed), zips } }.

• #starts_at ⇒ String^?

  Schedule start, ISO 8601.

• #status ⇒ Symbol, ...

  Initial status (default: active).

• #title ⇒ String^?

  The display name of the ad group.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, audiences: nil, bid_type: nil, budget_amount: nil, budget_type: nil, conversion_event: nil, conversion_location: nil, demographics: nil, desired_cost_per_result: nil, devices: nil, ends_at: nil, frequency_cap: nil, languages: nil, message_apps: nil, minimum_daily_spend: nil, optimization_goal: nil, placements: nil, regions: nil, starts_at: nil, status: nil, title: nil, request_options: {}) ⇒ Object constructor

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

• #to_hash ⇒ {

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(id:, audiences: nil, bid_type: nil, budget_amount: nil, budget_type: nil, conversion_event: nil, conversion_location: nil, demographics: nil, desired_cost_per_result: nil, devices: nil, ends_at: nil, frequency_cap: nil, languages: nil, message_apps: nil, minimum_daily_spend: nil, optimization_goal: nil, placements: nil, regions: nil, starts_at: nil, status: nil, title: nil, request_options: {}) ⇒ Object

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

Parameters:

• id (String)
• audiences (Object) (defaults to: nil) —

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

• bid_type (Symbol, WhopSDK::Models::AdGroupUpdateParams::BidType) (defaults to: nil) —

  Bid strategy.

• budget_amount (Float) (defaults to: nil) —

  Ad-set budget in dollars (ABO only; omit under CBO).

• budget_type (Symbol, WhopSDK::Models::AdGroupUpdateParams::BudgetType) (defaults to: nil) —

  Whether the budget is daily or lifetime.

• conversion_event (Symbol, String, WhopSDK::Models::AdGroupUpdateParams::ConversionEvent, nil) (defaults to: nil) —

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

• conversion_location (Symbol, WhopSDK::Models::AdGroupUpdateParams::ConversionLocation) (defaults to: nil) —

  Where results happen: website (conversions), profile (IG/FB engagement), messagi

• demographics (Object) (defaults to: nil) —

  Demographic targeting: { automatic, minimum_age, maximum_age, gender }.

• desired_cost_per_result (Float) (defaults to: nil) —

  Target/cap cost for average_target / maximum_target.

• devices (Object) (defaults to: nil) —

  Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }.

• ends_at (String) (defaults to: nil) —

  Schedule end, ISO 8601.

• frequency_cap (Object) (defaults to: nil) —

  { maximum_impressions, per_days } — only valid for reach optimization.

• languages (Array<String>) (defaults to: nil) —

  Languages to target as ISO 639 codes (e.g. en, es). Empty/omitted = all language

• message_apps (Array<Symbol, WhopSDK::Models::AdGroupUpdateParams::MessageApp>) (defaults to: nil) —

  Required when conversion_location is messaging: which apps to message on. Combin

• minimum_daily_spend (Float) (defaults to: nil) —

  Daily spend floor within the budget.

• optimization_goal (String) (defaults to: nil) —

  What the ad group optimizes for (e.g. conversions, link_clicks, reach).

• placements (Object) (defaults to: nil) —

  'automatic' (Advantage+) or a list of { platform, positions }. Omit positions to

• regions (Object) (defaults to: nil) —

  Geo targeting: { include / exclude: { countries (ISO 3166-1), regions (states/pr

• starts_at (String) (defaults to: nil) —

  Schedule start, ISO 8601.

• status (Symbol, WhopSDK::Models::AdGroupUpdateParams::Status) (defaults to: nil) —

  Initial status (default: active).

• title (String) (defaults to: nil) —

  The display name of the ad group.

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

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

Instance Attribute Details

#audiences ⇒ Object^?

Saved-audience targeting: { include, exclude } arrays of audience IDs. Incompatible with demographics.automatic (Advantage+).

Parameters:

• (top)

Returns:

• (Object, nil)

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

optional :audiences, WhopSDK::Internal::Type::Unknown

#bid_type ⇒ Symbol, ...

Bid strategy.

Returns:

• (Symbol, WhopSDK::Models::AdGroupUpdateParams::BidType, nil)

# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 26

optional :bid_type, enum: -> { WhopSDK::AdGroupUpdateParams::BidType }

#budget_amount ⇒ Float^?

Ad-set budget in dollars (ABO only; omit under CBO).

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 32

optional :budget_amount, Float

#budget_type ⇒ Symbol, ...

Whether the budget is daily or lifetime.

Returns:

• (Symbol, WhopSDK::Models::AdGroupUpdateParams::BudgetType, nil)

# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 38

optional :budget_type, enum: -> { WhopSDK::AdGroupUpdateParams::BudgetType }

#conversion_event ⇒ Symbol, ...

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

Parameters:

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

Returns:

• (Symbol, String, WhopSDK::Models::AdGroupUpdateParams::ConversionEvent, nil)

# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 44

optional :conversion_event, union: -> { WhopSDK::AdGroupUpdateParams::ConversionEvent }, nil?: true

#conversion_location ⇒ Symbol, ...

Where results happen: website (conversions), profile (IG/FB engagement), messaging (DM), on_ad (engagement on the ad, surface follows the optimization goal), or the lead destinations (instant_forms, instant_forms_and_messenger, website_and_instant_forms). The lead form itself is set on the ad.

Returns:

• (Symbol, WhopSDK::Models::AdGroupUpdateParams::ConversionLocation, nil)

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

optional :conversion_location, enum: -> { WhopSDK::AdGroupUpdateParams::ConversionLocation }

#demographics ⇒ Object^?

Demographic targeting: { automatic, minimum_age, maximum_age, gender }.

Parameters:

• (top)

Returns:

• (Object, nil)

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

optional :demographics, WhopSDK::Internal::Type::Unknown

#desired_cost_per_result ⇒ Float^?

Target/cap cost for average_target / maximum_target.

Parameters:

• (Float)

Returns:

• (Float, nil)

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

optional :desired_cost_per_result, Float

#devices ⇒ Object^?

Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }.

Parameters:

• (top)

Returns:

• (Object, nil)

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

optional :devices, WhopSDK::Internal::Type::Unknown

#ends_at ⇒ String^?

Schedule end, ISO 8601.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :ends_at, String

#frequency_cap ⇒ Object^?

{ maximum_impressions, per_days } — only valid for reach optimization.

Parameters:

• (top)

Returns:

• (Object, nil)

# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 83

optional :frequency_cap, WhopSDK::Internal::Type::Unknown

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 13

required :id, String

#languages ⇒ Array<String>^?

Languages to target as ISO 639 codes (e.g. en, es). Empty/omitted = all languages.

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 90

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

#message_apps ⇒ Array<Symbol, WhopSDK::Models::AdGroupUpdateParams::MessageApp>^?

Required when conversion_location is messaging: which apps to message on. Combinations map to the matching Meta destination.

Returns:

• (Array<Symbol, WhopSDK::Models::AdGroupUpdateParams::MessageApp>, nil)

# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 97

optional :message_apps,
-> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::AdGroupUpdateParams::MessageApp] }

#minimum_daily_spend ⇒ Float^?

Daily spend floor within the budget.

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 104

optional :minimum_daily_spend, Float

#optimization_goal ⇒ String^?

What the ad group optimizes for (e.g. conversions, link_clicks, reach).

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 110

optional :optimization_goal, String

#placements ⇒ Object^?

'automatic' (Advantage+) or a list of { platform, positions }. Omit positions to target all of a platform's.

Valid positions per platform:

• facebook: feed, right_hand_column, marketplace, search, profile_feed, notification, story, instream_video, facebook_reels, facebook_reels_overlay, biz_disco_feed
• instagram: stream, story, explore, explore_home, reels, profile_feed, profile_reels, ig_search
• messenger: story
• audience_network: classic, rewarded_video
• threads: threads_stream
• whatsapp: status

Parameters:

• (top)

Returns:

• (Object, nil)

# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 129

optional :placements, WhopSDK::Internal::Type::Unknown

#regions ⇒ Object^?

Geo targeting: { include / exclude: { countries (ISO 3166-1), regions (states/provinces as ISO 3166-2, e.g. US-CA), cities (keyed), zips } }.

Parameters:

• (top)

Returns:

• (Object, nil)

# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 136

optional :regions, WhopSDK::Internal::Type::Unknown

#starts_at ⇒ String^?

Schedule start, ISO 8601.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 142

optional :starts_at, String

#status ⇒ Symbol, ...

Initial status (default: active).

Returns:

• (Symbol, WhopSDK::Models::AdGroupUpdateParams::Status, nil)

# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 148

optional :status, enum: -> { WhopSDK::AdGroupUpdateParams::Status }

#title ⇒ String^?

The display name of the ad group.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 154

optional :title, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 212

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/whop_sdk/models/ad_group_update_params.rbs', line 148

def to_hash: -> {