Class: WhopSDK::Models::AdCampaignUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/whop_sdk/models/ad_campaign_update_params.rb,
sig/whop_sdk/models/ad_campaign_update_params.rbs

Overview

See Also:

  • WhopSDK::Resources::AdCampaigns#update

Defined Under Namespace

Modules: BidType, BudgetOptimization, Status

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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:, bid_type: nil, budget_amount: nil, budget_optimization: nil, ends_at: nil, starts_at: nil, status: nil, title: nil, request_options: {}) ⇒ Object

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

Parameters:

  • id (String)
  • bid_type (Symbol, WhopSDK::Models::AdCampaignUpdateParams::BidType) (defaults to: nil) —

    CBO bid strategy: minimum_cost (lowest cost), average_target (cost cap), or maxi

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

    The campaign budget, in the account's currency. Interpreted as daily or lifetime

  • budget_optimization (Symbol, WhopSDK::Models::AdCampaignUpdateParams::BudgetOptimization) (defaults to: nil) —

    Which level owns the budget — the campaign (CBO) or each ad group (ABO). Only ch

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

    Campaign schedule end (ISO 8601). CBO only.

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

    Campaign schedule start (ISO 8601). CBO only.

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

    Set to active to launch a draft campaign (moderates and pushes it live). Live-ca

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

    The name of the campaign.

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



# File 'lib/whop_sdk/models/ad_campaign_update_params.rb', line 64

Instance Attribute Details

#bid_type ⇒ Symbol, ...

CBO bid strategy: minimum_cost (lowest cost), average_target (cost cap), or maximum_target (bid cap). Switching to minimum_cost clears the cap amounts stored on the campaign's ad groups. CBO only.

Returns:



21
 
# File 'lib/whop_sdk/models/ad_campaign_update_params.rb', line 21

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

#budget_amount ⇒ Float?

The campaign budget, in the account's currency. Interpreted as daily or lifetime per the campaign's existing budget type.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


28
 
# File 'lib/whop_sdk/models/ad_campaign_update_params.rb', line 28

optional :budget_amount, Float

#budget_optimization ⇒ Symbol, ...

Which level owns the budget — the campaign (CBO) or each ad group (ABO). Only changeable before the campaign is live on Meta; switching to ad_campaign requires budget_amount in the same request, and switching to ad_group clears the campaign budget.

Returns:



37
 
# File 'lib/whop_sdk/models/ad_campaign_update_params.rb', line 37

optional :budget_optimization, enum: -> { WhopSDK::AdCampaignUpdateParams::BudgetOptimization }

#ends_at ⇒ String?

Campaign schedule end (ISO 8601). CBO only.

Parameters:

  • (String)

Returns:

  • (String, nil) 


43
 
# File 'lib/whop_sdk/models/ad_campaign_update_params.rb', line 43

optional :ends_at, String

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#starts_at ⇒ String?

Campaign schedule start (ISO 8601). CBO only.

Parameters:

  • (String)

Returns:

  • (String, nil) 


49
 
# File 'lib/whop_sdk/models/ad_campaign_update_params.rb', line 49

optional :starts_at, String

#status ⇒ Symbol, ...

Set to active to launch a draft campaign (moderates and pushes it live). Live-campaign pause and resume use the pause and unpause actions.

Returns:



56
 
# File 'lib/whop_sdk/models/ad_campaign_update_params.rb', line 56

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

#title ⇒ String?

The name of the campaign.

Parameters:

  • (String)

Returns:

  • (String, nil) 


62
 
# File 'lib/whop_sdk/models/ad_campaign_update_params.rb', line 62

optional :title, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/whop_sdk/models/ad_campaign_update_params.rb', line 96

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


68
 
# File 'sig/whop_sdk/models/ad_campaign_update_params.rbs', line 68

def to_hash: -> {