Skip to content

CreateStandaloneAdRequestPromotedObject.md

Latest commit

 

History

History
32 lines (26 loc) · 2.43 KB

CreateStandaloneAdRequestPromotedObject.md

File metadata and controls

32 lines (26 loc) · 2.43 KB
Raw

Zernio::CreateStandaloneAdRequestPromotedObject

Properties

Name Type Description Notes
pixel_id String Pixel ID. Meta: Facebook Pixel ID, required for `goal: conversions`. TikTok: TikTok Pixel ID, required for `goal: conversions`. [optional]
custom_event_type String The event the campaign/ad group optimises against. Meta: standard event like `PURCHASE`, `LEAD`, `COMPLETE_REGISTRATION`, `ADD_TO_CART`. Uppercased internally so callers can pass any case. Required for `goal: conversions`. TikTok: an `optimization_event` code (UPPER_SNAKE, not Meta's vocabulary and not PascalCase). Must be one of the event types your TikTok Pixel is configured to track; passed through verbatim and validated by TikTok. Newer pixels (Events API / funnel-template setups) use TikTok's updated taxonomy, e.g. `SHOPPING` for purchase/payment events; legacy pixels use codes like `ON_WEB_ORDER` (Complete Payment), `INITIATE_ORDER` (Place an Order), `ON_WEB_CART` (Add to Cart), `ON_WEB_REGISTER` (Complete Registration), `FORM` (Submit Form), `ON_WEB_DETAIL` (View Content). On rejection the error lists the event types your pixel actually tracks. Optional for `goal: conversions`. [optional]
page_id String Facebook Page ID. Used by `goal: lead_generation`. Auto-filled from the connected Page when omitted. [optional]
application_id String App ID. Required for `goal: app_promotion`. [optional]
object_store_url String App Store / Play Store listing URL. Required for `goal: app_promotion`. [optional]
custom_conversion_id String Custom Conversion ID, when optimising against one instead of a standard event. [optional]
product_catalog_id String Catalog ID for catalog/Advantage+ Shopping campaigns. [optional]
product_set_id String Product Set ID inside the catalog. [optional]

Example

require 'zernio-sdk'

instance = Zernio::CreateStandaloneAdRequestPromotedObject.new(
  pixel_id: null,
  custom_event_type: null,
  page_id: null,
  application_id: null,
  object_store_url: null,
  custom_conversion_id: null,
  product_catalog_id: null,
  product_set_id: null
)