API Marketing
Versione API Graph

Ad Set, Promoted Object

The object an ad set promotes, such as a Page or app. The campaign's objective and the ad set's promoted_object provide intent for your ads. When you create ad sets for campaigns with the certain objectives, promoted_object is required. See Ad Set, Creating.

Requirements

  • You must have permissions for objects you promote, including page_id, application_id, and pixel_id
  • If you use page_id, the creative must promote that page_id
  • If you use pixel_id, you must provide custom_event_type
  • If you use object_store_url, you must include application_id. This option is only available in Ads Manager.
    • object_store_url MUST be associated with that app. You can configure this under your app settings.
    • Mobile device targeting for the ad set must match supported platforms for your specified app.
    • The ad creative must link to the specified object_store_url.

Limitations

If you use promoted_object:

  • promoted_object is immutable in most cases. It is set on creation and cannot be changed. To promote a different object, create a new ad set. The exceptions are:
    • Adding application_id or product_catalog_id if not already given
    • Changing pixel_id, pixel_rule or custom_event_type to a new value when the following objectives and optimization goals are set:
      • CONVERSIONS, PRODUCT_CATALOG_SALES
      • OFFSITE_CONVERSIONS
  • You cannot set promoted_object for existing ad sets. You must create a new ad set except for the exceptions above.
  • If promoted_object is specified, Facebook automaticallly infers conversion_specs for your specified objectives. You cannot manually configure conversion_specs; we ignore any value you pass.
  • You can update all ad fields for existing ads in a legacy ad set without a promoted_object set.

Lettura

Promoted Object describes the object an ad set is promoting, such as the Page in a Page Like campaign. It is a generalized way of specifying a broad range of objects which are related to advertising objectives.

Taken together, the campaign's objective and the ad set's promoted_object should be enough to answer the question: "What is this ad set/campaign all about?". For example, "This campaign is meant to get more page likes for my Page X", or "This ad set is driving mobile app installs for my app Y".

Parametri

Questo endpoint non dispone di parametri.

Campi

CampoDescrizione
application_id
numeric string

The ID of a Facebook Application. Usually related to mobile or canvas games being promoted on Facebook for installs or engagement

Standard
boosted_product_set_id
numeric string

boosted_product_set_id

Standard
conversion_goal_id
numeric string

The ID of conversion goal used for conversion specs and tracking specs generation

Standard
custom_conversion_id
numeric string

The ID of a Custom Conversion.

Standard
custom_event_str
string

The event from an App Event of a mobile app, which is not in the standard event list.

custom_event_type = OTHER is required

Standard
custom_event_type
enum {AD_IMPRESSION, RATE, TUTORIAL_COMPLETION, CONTACT, CUSTOMIZE_PRODUCT, DONATE, FIND_LOCATION, SCHEDULE, START_TRIAL, SUBMIT_APPLICATION, SUBSCRIBE, ADD_TO_CART, ADD_TO_WISHLIST, INITIATED_CHECKOUT, ADD_PAYMENT_INFO, PURCHASE, LEAD, COMPLETE_REGISTRATION, CONTENT_VIEW, SEARCH, SERVICE_BOOKING_REQUEST, MESSAGING_CONVERSATION_STARTED_7D, LEVEL_ACHIEVED, ACHIEVEMENT_UNLOCKED, SPENT_CREDITS, LISTING_INTERACTION, D2_RETENTION, D7_RETENTION, OTHER}

The event from an App Event of a mobile app, (Purchase, Lead or CompleteRegistration) event from Offline Conversion data, or tag of an conversion pixel.

Standard
event_id
numeric string

The ID of a Facebook Event

Standard
lead_ads_form_event_source_type
enum

lead_ads_form_event_source_type

mcme_conversion_id
numeric string

mcme_conversion_id

Standard
object_store_url
string

The uri of the mobile / digital store where an application can be bought / downloaded. This is platform specific. When combined with the "application_id" this uniquely specifies an object which can be the subject of a Facebook advertising campaign.

Standard
offer_id
numeric string

The ID of an Offer from a Facebook Page.

Standard
offline_conversion_data_set_id
numeric string

The ID of the offline dataset.

Standard
offsite_conversion_event_id
numeric string

offsite_conversion_event_id

Standard
page_id
numeric string

The ID of a Facebook Page

Standard
pixel_aggregation_rule
string

A JSON rule that will decide whether an action from a pixel matches this promoted object spec based on aggregated results from previous pixel fires.

Standard
pixel_id
numeric string

The ID of a Facebook conversion pixel. Used with offsite conversion campaigns.

Standard
pixel_rule
string

A JSON rule that will decide whether an action from a pixel matches this promoted object spec

Standard
place_page_set_id
numeric string

The ID of a Place Page Set for Dynamic Local Ads.

Standard
product_catalog_id
numeric string

The ID of a Product Catalog. Used with Dynamic Product Ads.

Standard
product_set_id
numeric string

The ID of a Product Set within an Ad Set level Product Catalog. Used with Dynamic Product Ads.

Standard
retention_days
string

Value for retention period for aggregation based rule for the promoted object.

Standard
value_semantic_type
enum

The semantic of the event value to be using for optimization

Standard
variation
enum

variation

Standard
whatsapp_phone_number
numeric string

The WhatsApp phone number for this promoted ad.

Standard

Creazione

When you create ad sets in campaigns with the certain objectives, you must provide promoted_object. See Ad Set, Creating.

Non puoi eseguire questa operazione in questo endpoint.

Aggiornamento

Non puoi eseguire questa operazione in questo endpoint.

Eliminazione

Non puoi eseguire questa operazione in questo endpoint.