Class: WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Tiktok

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

Overview

See Also:

Defined Under Namespace

Modules: AgeGroup, AttributionEventCount, AudienceType, BidType, BillingEvent, BrandSafetyType, BudgetMode, ClickAttributionWindow, DeepFunnelOptimizationStatus, EngagedViewAttributionWindow, Gender, Ios14Targeting, OperatingSystem, OperationStatus, OptimizationGoal, Pacing, PlacementType, ProductSource, ScheduleType, ShoppingAdsRetargetingType, SpendingPower, ViewAttributionWindow Classes: Action, InstantFormConfig

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(field_type:, label: nil) ⇒ Object

A question for a TikTok instant form.

Parameters:

  • field_type (String)

    Question type (EMAIL, PHONE_NUMBER, NAME, CUSTOM).

  • label (String, nil) (defaults to: nil)

    Custom label for the question.



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

Instance Attribute Details

#actionsArray<WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Tiktok::Action>?



2099
2100
2101
2102
2103
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2099

optional :actions,
-> {
  WhopSDK::Internal::Type::ArrayOf[WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::Action]
},
nil?: true

#age_groupsArray<Symbol, WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Tiktok::AgeGroup>?



2108
2109
2110
2111
2112
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2108

optional :age_groups,
-> {
  WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::AgeGroup]
},
nil?: true

#app_idString?

App ID for app promotion campaigns.

Returns:

  • (String, nil)


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

optional :app_id, String, nil?: true

#attribution_event_countSymbol, ...



2123
2124
2125
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2123

optional :attribution_event_count,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::AttributionEventCount },
nil?: true

#audience_idsArray<String>?

Returns:

  • (Array<String>, nil)


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

optional :audience_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#audience_ruleHash{Symbol=>Object}?

Represents untyped JSON

Returns:

  • (Hash{Symbol=>Object}, nil)


2136
2137
2138
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2136

optional :audience_rule,
WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown],
nil?: true

#audience_typeSymbol, ...



2143
2144
2145
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2143

optional :audience_type,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::AudienceType },
nil?: true

#bid_priceFloat?

Bid price (cost per result for Cost Cap).

Returns:

  • (Float, nil)


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

optional :bid_price, Float, nil?: true

#bid_typeSymbol, ...

Bidding strategy (BID_TYPE_NO_BID, BID_TYPE_CUSTOM).



2157
2158
2159
2160
2161
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2157

optional :bid_type,
enum: -> {
  WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::BidType
},
nil?: true

#billing_eventSymbol, ...

How you are billed on TikTok (CPC, CPM, OCPM, CPV).



2167
2168
2169
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2167

optional :billing_event,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::BillingEvent },
nil?: true

#brand_safety_typeSymbol, ...



2174
2175
2176
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2174

optional :brand_safety_type,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::BrandSafetyType },
nil?: true

#budget_modeSymbol, ...

Budget mode (BUDGET_MODE_DAY, BUDGET_MODE_TOTAL, BUDGET_MODE_DYNAMIC_DAILY_BUDGET).



2183
2184
2185
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2183

optional :budget_mode,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::BudgetMode },
nil?: true

#carrier_idsArray<String>?

Returns:

  • (Array<String>, nil)


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

optional :carrier_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#category_exclusion_idsArray<String>?

Returns:

  • (Array<String>, nil)


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

optional :category_exclusion_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#click_attribution_windowSymbol, ...



2200
2201
2202
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2200

optional :click_attribution_window,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::ClickAttributionWindow },
nil?: true

#comment_disabledBoolean?

Represents ‘true` or `false` values.

Returns:

  • (Boolean, nil)


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

optional :comment_disabled, WhopSDK::Internal::Type::Boolean, nil?: true

#contextual_tag_idsArray<String>?

Returns:

  • (Array<String>, nil)


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

optional :contextual_tag_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#conversion_bid_priceFloat?

Target cost per conversion for oCPM.

Returns:

  • (Float, nil)


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

optional :conversion_bid_price, Float, nil?: true

#creative_material_modeString?

Creative delivery strategy.

Returns:

  • (String, nil)


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

optional :creative_material_mode, String, nil?: true

#daypartingString?

Ad delivery schedule (48x7 character string).

Returns:

  • (String, nil)


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

optional :dayparting, String, nil?: true

#deep_funnel_event_sourceString?

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

Returns:

  • (String, nil)


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

optional :deep_funnel_event_source, String, nil?: true

#deep_funnel_event_source_idString?

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

Returns:

  • (String, nil)


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

optional :deep_funnel_event_source_id, String, nil?: true

#deep_funnel_optimization_statusSymbol, ...



2250
2251
2252
2253
2254
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2250

optional :deep_funnel_optimization_status,
enum: -> {
  WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::DeepFunnelOptimizationStatus
},
nil?: true

#device_model_idsArray<String>?

Returns:

  • (Array<String>, nil)


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

optional :device_model_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#device_price_rangesArray<String>?

Returns:

  • (Array<String>, nil)


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

optional :device_price_ranges, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#engaged_view_attribution_windowSymbol, ...



2269
2270
2271
2272
2273
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2269

optional :engaged_view_attribution_window,
enum: -> {
  WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::EngagedViewAttributionWindow
},
nil?: true

#excluded_audience_idsArray<String>?

Returns:

  • (Array<String>, nil)


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

optional :excluded_audience_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#excluded_location_idsArray<String>?

TikTok location/region IDs to exclude.

Returns:

  • (Array<String>, nil)


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

optional :excluded_location_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#frequencyInteger?

Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Returns:

  • (Integer, nil)


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

optional :frequency, Integer, nil?: true

#frequency_scheduleInteger?

Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Returns:

  • (Integer, nil)


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

optional :frequency_schedule, Integer, nil?: true

#genderSymbol, ...



2303
2304
2305
2306
2307
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2303

optional :gender,
enum: -> {
  WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::Gender
},
nil?: true

#identity_authorized_bc_idString?

Business Center ID for BC_AUTH_TT identity.

Returns:

  • (String, nil)


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

optional :identity_authorized_bc_id, String, nil?: true

#identity_idString?

TikTok identity ID for the ad group.

Returns:

  • (String, nil)


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

optional :identity_id, String, nil?: true

#identity_typeString?

Identity type (AUTH_CODE, TT_USER, BC_AUTH_TT).

Returns:

  • (String, nil)


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

optional :identity_type, String, nil?: true

#instant_form_configWhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Tiktok::InstantFormConfig?

Instant form configuration for lead generation campaigns.



2331
2332
2333
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2331

optional :instant_form_config,
-> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::InstantFormConfig },
nil?: true

#instant_form_idString?

TikTok instant form ID (set automatically when instant_form_config is provided).

Returns:

  • (String, nil)


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

optional :instant_form_id, String, nil?: true

#interest_category_idsArray<String>?

Returns:

  • (Array<String>, nil)


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

optional :interest_category_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#interest_keyword_idsArray<String>?

Returns:

  • (Array<String>, nil)


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

optional :interest_keyword_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#inventory_filter_enabledBoolean?

Represents ‘true` or `false` values.

Returns:

  • (Boolean, nil)


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

optional :inventory_filter_enabled, WhopSDK::Internal::Type::Boolean, nil?: true

#ios14_targetingSymbol, ...



2360
2361
2362
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2360

optional :ios14_targeting,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::Ios14Targeting },
nil?: true

#isp_idsArray<String>?

Returns:

  • (Array<String>, nil)


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

optional :isp_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#languagesArray<String>?

Returns:

  • (Array<String>, nil)


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

optional :languages, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#location_idsArray<String>?

TikTok location/region IDs for geo targeting.

Returns:

  • (Array<String>, nil)


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

optional :location_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#min_android_versionString?

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

Returns:

  • (String, nil)


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

optional :min_android_version, String, nil?: true

#min_ios_versionString?

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

Returns:

  • (String, nil)


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

optional :min_ios_version, String, nil?: true

#network_typesArray<String>?

Returns:

  • (Array<String>, nil)


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

optional :network_types, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#operating_systemsArray<Symbol, WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Tiktok::OperatingSystem>?



2402
2403
2404
2405
2406
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2402

optional :operating_systems,
-> {
  WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::OperatingSystem]
},
nil?: true

#operation_statusSymbol, ...

Initial status (ENABLE, DISABLE).



2412
2413
2414
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2412

optional :operation_status,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::OperationStatus },
nil?: true

#optimization_eventString?

Conversion event (e.g., COMPLETE_PAYMENT).

Returns:

  • (String, nil)


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

optional :optimization_event, String, nil?: true

#optimization_goalSymbol, ...

What this ad group optimizes for on TikTok.



2426
2427
2428
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2426

optional :optimization_goal,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::OptimizationGoal },
nil?: true

#pacingSymbol, ...

Budget pacing (PACING_MODE_SMOOTH, PACING_MODE_FAST).



2434
2435
2436
2437
2438
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2434

optional :pacing,
enum: -> {
  WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::Pacing
},
nil?: true

#pangle_audience_package_exclude_idsArray<String>?

Returns:

  • (Array<String>, nil)


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

optional :pangle_audience_package_exclude_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#pangle_audience_package_include_idsArray<String>?

Returns:

  • (Array<String>, nil)


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

optional :pangle_audience_package_include_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#pangle_block_app_idsArray<String>?

Returns:

  • (Array<String>, nil)


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

optional :pangle_block_app_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#pixel_idString?

TikTok Pixel ID for conversion tracking.

Returns:

  • (String, nil)


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

optional :pixel_id, String, nil?: true

#placement_typeSymbol, ...

Placement strategy (PLACEMENT_TYPE_AUTOMATIC, PLACEMENT_TYPE_NORMAL).



2465
2466
2467
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2465

optional :placement_type,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::PlacementType },
nil?: true

#placementsArray<String>?

Placements (PLACEMENT_TIKTOK, PLACEMENT_PANGLE, etc.).

Returns:

  • (Array<String>, nil)


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

optional :placements, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#product_set_idString?

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

Returns:

  • (String, nil)


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

optional :product_set_id, String, nil?: true

#product_sourceSymbol, ...



2485
2486
2487
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2485

optional :product_source,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::ProductSource },
nil?: true

#promotion_typeString?

Promotion type (optimization location).

Returns:

  • (String, nil)


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

optional :promotion_type, String, nil?: true

#schedule_end_timeString?

Schedule end time (UTC, YYYY-MM-DD HH:MM:SS).

Returns:

  • (String, nil)


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

optional :schedule_end_time, String, nil?: true

#schedule_start_timeString?

Schedule start time (UTC, YYYY-MM-DD HH:MM:SS).

Returns:

  • (String, nil)


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

optional :schedule_start_time, String, nil?: true

#schedule_typeSymbol, ...

Schedule type (SCHEDULE_START_END, SCHEDULE_FROM_NOW).



2511
2512
2513
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2511

optional :schedule_type,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::ScheduleType },
nil?: true

#secondary_optimization_eventString?

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

Returns:

  • (String, nil)


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

optional :secondary_optimization_event, String, nil?: true

#shopping_ads_retargeting_actions_daysInteger?

Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Returns:

  • (Integer, nil)


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

optional :shopping_ads_retargeting_actions_days, Integer, nil?: true

#shopping_ads_retargeting_typeSymbol, ...



2532
2533
2534
2535
2536
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2532

optional :shopping_ads_retargeting_type,
enum: -> {
  WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::ShoppingAdsRetargetingType
},
nil?: true

#spending_powerSymbol, ...



2541
2542
2543
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2541

optional :spending_power,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::SpendingPower },
nil?: true

#tiktok_subplacementsArray<String>?

TikTok subplacements (IN_FEED, SEARCH_FEED, etc.).

Returns:

  • (Array<String>, nil)


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

optional :tiktok_subplacements, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#vertical_sensitivity_idString?

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

Returns:

  • (String, nil)


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

optional :vertical_sensitivity_id, String, nil?: true

#video_download_disabledBoolean?

Represents ‘true` or `false` values.

Returns:

  • (Boolean, nil)


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

optional :video_download_disabled, WhopSDK::Internal::Type::Boolean, nil?: true

#video_user_actionsArray<String>?

Returns:

  • (Array<String>, nil)


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

optional :video_user_actions, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#view_attribution_windowSymbol, ...



2572
2573
2574
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2572

optional :view_attribution_window,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::ViewAttributionWindow },
nil?: true

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


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