business_management and catalog_management permissions.business_management and catalog_management permissions.POST request to the owned_product_catalogs edge. The following fields are required for catalog segment creation:parent_catalog_id: The parent catalog from which your segment was created. This catalog needs to be Collaborative Ads compliant. You can find your catalog’s status in Commerce Manager.catalog_segment_filter: A JSON-encoded rule used to create the catalog segment.business_management and catalog_management permissions.POST request to /{catalog_segment_id}/agencies. In your call, you can add the following fields:| Field | Description |
|---|---|
businesstype: numeric string or integer | Required. ID for the business the catalog will be shared with. |
permitted_taskstype: array < enum {MANAGE, ADVERTISE} > | Required. Tasks the business will be allowed to execute. Available options are: ['ADVERTISE', 'MANAGE']. |
utm_settingstype: JSON object {enum{campaign_source,campaign_medium,campaign_name}: string} | Optional. You can specify campaign_source, campaign_medium, and campaign_name.
For example: {campaign_source: “fb_campaign_source”}. |
enabled_collab_termstype: array < enum {ENFORCE_CREATE_NEW_AD_ACCOUNT, ENFORCE_SHARE_AD_PERFORMANCE_ACCESS} > | Optional. Collaboration terms to be enforced on new brand partners. Available options are: ['ENFORCE_CREATE_NEW_AD_ACCOUNT', 'ENFORCE_SHARE_AD_PERFORMANCE_ACCESS']. |
business_management permission. The API call must include a user access token and that user needs to have permission on the suggested partner, business, or collaboration request.GET {business-id}?fields=collaborative_ads_suggested_partners — Find partners for a specific business.GET collaborative_ads_directory?fields=collaborative_ads_merchants — Get the complete list of collaborative ads retailers.GET {cpas-advertiser-partnership-recommendation-id}?fields=advertiser_business_id,brand_business_id,brands,countries,merchant_business_id,status,status_reason — Get one single retailer recommendation.POST request to /{cpas-collaboration-request-id}:{business-id}/collaborative_ads_collaboration_requests?
brands=”[“[BRAND NAME]”, “[BRAND NAME 2]”]”&
contact_email=[CONTACT_EMAIL]&
contact_first_name=[CONTACT_FIRST_NAME]&
contact_last_name=[CONTACT_LAST_NAME]&
phone_number=[PHONE NUMBER]&
receiver_business=[RECEIVING BUSINESS ID]
requester_agency_or_brand=[REQUESTING ENTITY - AGENCY, BRAND or MERCHANT]
GET {business-id}/collaborative_ads_collaboration_requestsGET {cpas-collaboration-request-id}?fields=phone_number,receiver_business,request_type,source,status/{product-catalog-id}/assigned_users endpoint. Note: This requires the business_management permission.business_management and ads_management permissions.catalog_segment_ID instead of a catalog ID:curl \
-F 'name=Product Catalog Sales Campaign' \
-F 'objective=PRODUCT_CATALOG_SALES' \
-F 'promoted_object={"product_catalog_id":"<CATALOG_SEGMENT_ID>"}' \
-F 'status=PAUSED' \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<API_VERSION>/act_<AD_ACCOUNT_ID>/campaigns
{
"id": "<CAMPAIGN_ID>"
}
multi_share_end_card is set to false by default and you cannot changedescription in template_datatemplate_url_spec which you can use for deeplink URLs must point to merchant’s websitecatalog_segment_value and related metrics for:catalog_segment_value includes a breakdown of the conversion events, including purchases, add-to-carts and view products for the catalog segment at each ad object level. It aggregates events across website, mobile and omni-channel sources. Learn more about Estimated and In-Development Insights Metrics.ads_management and business_management permissions. See App Review.action_converted_product_id breakdown is not supported on the ad account level.| Metric | Description |
|---|---|
catalog_segment_value | Value from conversion events, including a breakdown of purchases, add-to-carts and view products for the catalog segment at each ad object level. |
catalog_segment_value_omni_purchase_roas | Total return on ad spend (ROAS) from purchases of items shared between Brand and Retailer. This number is based on information received from one or more Retailer’ connected Facebook Business Tools. The amount is attributed to your ads. |
catalog_segment_value_website_purchase_roas | Total return on ad spend (ROAS) from website purchases of items shared between Brand and Retailer. This number is based on information received from one or more Retailers’ connected Facebook Business Tools. The amount is attributed to your ads. |
catalog_segment_value_mobile_purchase_roas | The total return on ad spend (ROAS) from mobile app purchases of items shared between Brand and Retailer. This number is based on information received from one or more Retailers’ connected Facebook Business Tools. The amount is attributed to your ads. |
catalog_segment_actions | Similar to catalog_segment_value, when using this metric a breakdown of actions is given for the catalog segment at each ad object level. |
converted_product_value | Value of conversions driven by your ads for a given product ID. This number is recorded by your Retailer partner’s Pixel or App SDK.
The API only returns Product IDs —see /{product-item-id} for information. If you want to get brand names as well, please use Ads Manager. |
converted_product_quantity | Quantity of conversions driven by your ads for a given product ID. This number is recorded by your Retailer partner’s Pixel or App SDK.
The API only returns Product IDs —see /{product-item-id} for information. If you want to get brand names as well, please use Ads Manager. |
time_range to your query. For example: &time_range[since]=2020-03-01&time_range[until]=2020-04-01.converted_product_value and converted_product_quantity metrics by adding &action_breakdowns=action_converted_product_id to your query.action_converted_product_id breakdown is not supported on the ad account level.action_converted_product_idaction_type, action_converted_product_id