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

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

Instance Attribute 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(android_devices: nil, attribution_setting: nil, attribution_spec: nil, audience_network_positions: nil, audience_type: nil, bid_amount: nil, bid_strategy: nil, billing_event: nil, brand_safety_content_filter_levels: nil, budget_remaining: nil, cost_per_result_goal: nil, created_time: nil, daily_budget: nil, daily_min_spend_target: nil, daily_spend_cap: nil, destination_type: nil, dsa_beneficiary: nil, dsa_payor: nil, end_time: nil, excluded_geo_locations: nil, facebook_positions: nil, frequency_control_count: nil, frequency_control_days: nil, frequency_control_type: nil, geo_cities: nil, geo_locations: nil, geo_regions: nil, geo_zips: nil, instagram_actor_id: nil, instagram_positions: nil, ios_devices: nil, is_dynamic_creative: nil, lead_conversion_location: nil, lead_form_config: nil, lead_gen_form_id: nil, lifetime_budget: nil, lifetime_min_spend_target: nil, lifetime_spend_cap: nil, location_types: nil, messenger_positions: nil, optimization_goal: nil, page_id: nil, pixel_id: nil, promoted_object: nil, publisher_platforms: nil, source_adset_id: nil, start_time: nil, status: nil, targeting_automation: nil, threads_positions: nil, updated_time: nil, user_device: nil, user_os: nil, whatsapp_phone_number: nil, whatsapp_positions: nil) ⇒ Object

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

Meta (Facebook/Instagram) ad set configuration.

Parameters:

  • android_devices (Array<String>, nil) (defaults to: nil)
  • attribution_setting (String, nil) (defaults to: nil) —

    Represents textual data as UTF-8 character sequences. This type is most often us

  • attribution_spec (Array<WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::AttributionSpec>, nil) (defaults to: nil) —

    Conversion attribution windows.

  • audience_network_positions (Array<String>, nil) (defaults to: nil)
  • audience_type (String, nil) (defaults to: nil) —

    Audience type for retargeting.

  • bid_amount (Integer, nil) (defaults to: nil) —

    Bid amount in cents.

  • bid_strategy (Symbol, WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::BidStrategy, nil) (defaults to: nil) —

    Meta bid strategy.

  • billing_event (Symbol, WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::BillingEvent, nil) (defaults to: nil) —

    How you are billed on Meta.

  • brand_safety_content_filter_levels (Array<String>, nil) (defaults to: nil)
  • budget_remaining (String, nil) (defaults to: nil) —

    Represents textual data as UTF-8 character sequences. This type is most often us

  • cost_per_result_goal (Float, nil) (defaults to: nil) —

    Represents signed double-precision fractional values as specified by [IEEE 754](

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

    Represents textual data as UTF-8 character sequences. This type is most often us

  • daily_budget (Integer, nil) (defaults to: nil) —

    Daily budget in cents.

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

    Represents textual data as UTF-8 character sequences. This type is most often us

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

    Represents textual data as UTF-8 character sequences. This type is most often us

  • destination_type (Symbol, WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::DestinationType, nil) (defaults to: nil) —

    Where ads in this ad set direct people.

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

    Represents textual data as UTF-8 character sequences. This type is most often us

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

    Represents textual data as UTF-8 character sequences. This type is most often us

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

    End time (ISO8601). Required for lifetime budgets.

  • excluded_geo_locations (WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::ExcludedGeoLocations, nil) (defaults to: nil) —

    Geo locations to exclude.

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

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

  • frequency_control_count (Integer, nil) (defaults to: nil) —

    Represents non-fractional signed whole numeric values. Int can represent values

  • frequency_control_days (Integer, nil) (defaults to: nil) —

    Represents non-fractional signed whole numeric values. Int can represent values

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

    Represents textual data as UTF-8 character sequences. This type is most often us

  • geo_cities (Array<WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::GeoCity>, nil) (defaults to: nil)
  • geo_locations (WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::GeoLocations, nil) (defaults to: nil) —

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

  • geo_regions (Array<WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::GeoRegion>, nil) (defaults to: nil)
  • geo_zips (Array<String>, nil) (defaults to: nil)
  • instagram_actor_id (String, nil) (defaults to: nil) —

    Instagram account ID for this ad set.

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

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

  • ios_devices (Array<String>, nil) (defaults to: nil)
  • is_dynamic_creative (Boolean, nil) (defaults to: nil) —

    Represents ‘true` or `false` values.

  • lead_conversion_location (Symbol, WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::LeadConversionLocation, nil) (defaults to: nil)
  • lead_form_config (WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::LeadFormConfig, nil) (defaults to: nil) —

    Configuration for a Meta lead gen instant form.

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

    Represents textual data as UTF-8 character sequences. This type is most often us

  • lifetime_budget (Integer, nil) (defaults to: nil) —

    Lifetime budget in cents.

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

    Represents textual data as UTF-8 character sequences. This type is most often us

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

    Represents textual data as UTF-8 character sequences. This type is most often us

  • location_types (Array<String>, nil) (defaults to: nil)
  • messenger_positions (Array<String>, nil) (defaults to: nil)
  • optimization_goal (Symbol, WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::OptimizationGoal, nil) (defaults to: nil) —

    What this ad set optimizes for on Meta.

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

    Facebook Page ID for this ad set.

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

    Represents textual data as UTF-8 character sequences. This type is most often us

  • promoted_object (WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::PromotedObject, nil) (defaults to: nil) —

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

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

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

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

    Represents textual data as UTF-8 character sequences. This type is most often us

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

    Represents textual data as UTF-8 character sequences. This type is most often us

  • status (Symbol, WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::Status, nil) (defaults to: nil)
  • targeting_automation (WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::TargetingAutomation, nil) (defaults to: nil) —

    Advantage+ audience expansion settings.

  • threads_positions (Array<String>, nil) (defaults to: nil)
  • updated_time (String, nil) (defaults to: nil) —

    Represents textual data as UTF-8 character sequences. This type is most often us

  • user_device (Array<String>, nil) (defaults to: nil)
  • user_os (Array<String>, nil) (defaults to: nil)
  • whatsapp_phone_number (String, nil) (defaults to: nil) —

    Represents textual data as UTF-8 character sequences. This type is most often us

  • whatsapp_positions (Array<String>, nil) (defaults to: nil) 


873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 873

class AttributionSpec < WhopSDK::Internal::Type::BaseModel
  # @!attribute event_type
  #   Attribution event type (e.g., CLICK_THROUGH, VIEW_THROUGH).
  #
  #   @return [String]
  required :event_type, String

  # @!attribute window_days
  #   Attribution window in days (1, 7, 28).
  #
  #   @return [Integer]
  required :window_days, Integer

  # @!method initialize(event_type:, window_days:)
  #   Meta conversion attribution window.
  #
  #   @param event_type [String] Attribution event type (e.g., CLICK_THROUGH, VIEW_THROUGH).
  #
  #   @param window_days [Integer] Attribution window in days (1, 7, 28).
end

Instance Attribute Details

#event_type ⇒ String

Attribution event type (e.g., CLICK_THROUGH, VIEW_THROUGH).

Returns:

  • (String) 


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

required :event_type, String

#window_days ⇒ Integer

Attribution window in days (1, 7, 28).

Returns:

  • (Integer) 


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

required :window_days, Integer