Class: WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta

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

Overview

See Also:

Defined Under Namespace

Modules: BidStrategy, BillingEvent, DestinationType, LeadConversionLocation, OptimizationGoal, Status Classes: AttributionSpec, ExcludedGeoLocations, GeoCity, GeoLocations, GeoRegion, LeadFormConfig, PromotedObject, TargetingAutomation

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(custom_conversion_id: nil, custom_event_str: nil, custom_event_type: nil, page_id: nil, pixel_id: nil, whatsapp_phone_number: nil) ⇒ Object

The object this ad set promotes (pixel, page, etc.).

Parameters:

  • custom_conversion_id (String, nil) (defaults to: nil) —

    Custom conversion rule ID (numeric, from Meta Events Manager).

  • custom_event_str (String, nil) (defaults to: nil) —

    Pixel event name, used when custom_event_type is OTHER.

  • custom_event_type (String, nil) (defaults to: nil) —

    Custom event type (e.g., PURCHASE, COMPLETE_REGISTRATION, OTHER).

  • page_id (String, nil) (defaults to: nil) —

    Facebook Page ID.

  • pixel_id (String, nil) (defaults to: nil) —

    Meta Pixel ID for conversion tracking.

  • whatsapp_phone_number (String, nil) (defaults to: nil) —

    WhatsApp phone number for messaging campaigns.




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

Instance Attribute Details

#android_devices ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

#attribution_setting ⇒ String?

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) 


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

optional :attribution_setting, String, nil?: true

#attribution_spec ⇒ Array<WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::AttributionSpec>?

Conversion attribution windows.

Returns:



403
404
405
406
407
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 403

optional :attribution_spec,
-> {
  WhopSDK::Internal::Type::ArrayOf[WhopSDK::AdGroupUpdateParams::PlatformConfig::Meta::AttributionSpec]
},
nil?: true

#audience_network_positions ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

#audience_type ⇒ String?

Audience type for retargeting.

Returns:

  • (String, nil) 


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

optional :audience_type, String, nil?: true

#bid_amount ⇒ Integer?

Bid amount in cents.

Returns:

  • (Integer, nil) 


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

optional :bid_amount, Integer, nil?: true

#bid_strategy ⇒ Symbol, ...

Meta bid strategy.

Returns:



430
431
432
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 430

optional :bid_strategy,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Meta::BidStrategy },
nil?: true

#billing_event ⇒ Symbol, ...

How you are billed on Meta.

Returns:



438
439
440
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 438

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

#brand_safety_content_filter_levels ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

#budget_remaining ⇒ String?

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) 


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

optional :budget_remaining, String, nil?: true

#cost_per_result_goal ⇒ Float?

Represents signed double-precision fractional values as specified by [IEEE 754](en.wikipedia.org/wiki/IEEE_floating_point).

Returns:

  • (Float, nil) 


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

optional :cost_per_result_goal, Float, nil?: true

#created_time ⇒ String?

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) 


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

optional :created_time, String, nil?: true

#daily_budget ⇒ Integer?

Daily budget in cents.

Returns:

  • (Integer, nil) 


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

optional :daily_budget, Integer, nil?: true

#daily_min_spend_target ⇒ String?

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) 


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

optional :daily_min_spend_target, String, nil?: true

#daily_spend_cap ⇒ String?

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) 


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

optional :daily_spend_cap, String, nil?: true

#destination_type ⇒ Symbol, ...

Where ads in this ad set direct people.

Returns:



492
493
494
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 492

optional :destination_type,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Meta::DestinationType },
nil?: true

#dsa_beneficiary ⇒ String?

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) 


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

optional :dsa_beneficiary, String, nil?: true

#dsa_payor ⇒ String?

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) 


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

optional :dsa_payor, String, nil?: true

#end_time ⇒ String?

End time (ISO8601). Required for lifetime budgets.

Returns:

  • (String, nil) 


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

optional :end_time, String, nil?: true

#excluded_geo_locations ⇒ WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::ExcludedGeoLocations?

Geo locations to exclude.

Returns:



520
521
522
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 520

optional :excluded_geo_locations,
-> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Meta::ExcludedGeoLocations },
nil?: true

#facebook_positions ⇒ Array<String>?

Facebook ad placements (feed, reels, stories, etc.).

Returns:

  • (Array<String>, nil) 


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

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

#frequency_control_count ⇒ Integer?

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

Returns:

  • (Integer, nil) 


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

optional :frequency_control_count, Integer, nil?: true

#frequency_control_days ⇒ Integer?

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

Returns:

  • (Integer, nil) 


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

optional :frequency_control_days, Integer, nil?: true

#frequency_control_type ⇒ String?

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) 


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

optional :frequency_control_type, String, nil?: true

#geo_cities ⇒ Array<WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::GeoCity>?

Returns:



554
555
556
557
558
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 554

optional :geo_cities,
-> {
  WhopSDK::Internal::Type::ArrayOf[WhopSDK::AdGroupUpdateParams::PlatformConfig::Meta::GeoCity]
},
nil?: true

#geo_locations ⇒ WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::GeoLocations?

Geo targeting (countries, regions, cities, zips).

Returns:



564
565
566
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 564

optional :geo_locations,
-> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Meta::GeoLocations },
nil?: true

#geo_regions ⇒ Array<WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::GeoRegion>?

Returns:



571
572
573
574
575
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 571

optional :geo_regions,
-> {
  WhopSDK::Internal::Type::ArrayOf[WhopSDK::AdGroupUpdateParams::PlatformConfig::Meta::GeoRegion]
},
nil?: true

#geo_zips ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

#instagram_actor_id ⇒ String?

Instagram account ID for this ad set.

Returns:

  • (String, nil) 


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

optional :instagram_actor_id, String, nil?: true

#instagram_positions ⇒ Array<String>?

Instagram ad placements (stream, story, reels, etc.).

Returns:

  • (Array<String>, nil) 


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

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

#ios_devices ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

#is_dynamic_creative ⇒ Boolean?

Represents ‘true` or `false` values.

Returns:

  • (Boolean, nil) 


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

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

#lead_conversion_location ⇒ Symbol, ...

Returns:



608
609
610
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 608

optional :lead_conversion_location,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Meta::LeadConversionLocation },
nil?: true

#lead_form_config ⇒ WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::LeadFormConfig?

Configuration for a Meta lead gen instant form.

Returns:



616
617
618
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 616

optional :lead_form_config,
-> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Meta::LeadFormConfig },
nil?: true

#lead_gen_form_id ⇒ String?

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) 


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

optional :lead_gen_form_id, String, nil?: true

#lifetime_budget ⇒ Integer?

Lifetime budget in cents.

Returns:

  • (Integer, nil) 


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

optional :lifetime_budget, Integer, nil?: true

#lifetime_min_spend_target ⇒ String?

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) 


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

optional :lifetime_min_spend_target, String, nil?: true

#lifetime_spend_cap ⇒ String?

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) 


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

optional :lifetime_spend_cap, String, nil?: true

#location_types ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

#messenger_positions ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

#optimization_goal ⇒ Symbol, ...

What this ad set optimizes for on Meta.

Returns:



661
662
663
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 661

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

#page_id ⇒ String?

Facebook Page ID for this ad set.

Returns:

  • (String, nil) 


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

optional :page_id, String, nil?: true

#pixel_id ⇒ String?

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) 


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

optional :pixel_id, String, nil?: true

The object this ad set promotes (pixel, page, etc.).

Returns:



682
683
684
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 682

optional :promoted_object,
-> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Meta::PromotedObject },
nil?: true

#publisher_platforms ⇒ Array<String>?

Platforms to publish on (facebook, instagram, messenger, audience_network).

Returns:

  • (Array<String>, nil) 


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

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

#source_adset_id ⇒ String?

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) 


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

optional :source_adset_id, String, nil?: true

#start_time ⇒ String?

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) 


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

optional :start_time, String, nil?: true

#status ⇒ Symbol, ...

Returns:



709
710
711
712
713
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 709

optional :status,
enum: -> {
  WhopSDK::AdGroupUpdateParams::PlatformConfig::Meta::Status
},
nil?: true

#targeting_automation ⇒ WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::TargetingAutomation?

Advantage+ audience expansion settings.

Returns:



719
720
721
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 719

optional :targeting_automation,
-> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Meta::TargetingAutomation },
nil?: true

#threads_positions ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

#updated_time ⇒ String?

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) 


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

optional :updated_time, String, nil?: true

#user_device ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

#user_os ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

#whatsapp_phone_number ⇒ String?

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) 


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

optional :whatsapp_phone_number, String, nil?: true

#whatsapp_positions ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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