Marketing API Version

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.

You must have permissions for objects you promote, including page_id, application_id, pixel_id. If your access token does not allow access, you cannot promote them.

Validation

  • When you specify application_id and object_store_url:
    • 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.
    • Ad creative must link to the specified object_store_url.
    • You cannot specify object_store_url without application_id. This option is only available in Ads Manager.
  • If you use page_id, the creative must promote that page_id.
  • If you use pixel_id your must provide custom_event_type.

Restrictions

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:
    • provide application_id or product_catalog_id if not already given
    • change pixel_id, pixel_rule or custom_event_type to a new value
  • 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.

Reading

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".

If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription

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

custom_event_type

enum {COMPLETE_REGISTRATION, CONTENT_VIEW, SEARCH, RATE, TUTORIAL_COMPLETION, ADD_TO_CART, ADD_TO_WISHLIST, INITIATED_CHECKOUT, ADD_PAYMENT_INFO, PURCHASE, LEAD, LEVEL_ACHIEVED, ACHIEVEMENT_UNLOCKED, SPENT_CREDITS, OTHER}

The event from an App Event of a mobile app, or tag of an conversion pixel.

event_id

numeric string

The ID of a Facebook Event

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.

offer_id

numeric string

The ID of an Offer from a Facebook Page.

page_id

numeric string

The ID of a Facebook Page

pixel_id

numeric string

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

product_catalog_id

numeric string

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

product_set_id

numeric string

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

Edges

No edges

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.