图谱 API 版

Canvas Product Set

读取

A product set inside the canvas

自 2021 年 9 月 14 日起，对于由缺少端点所需权限的应用发出的版本 12.0 及其以上的调用，以下字段会引发错误。从 2021 年 12 月 13 日起，此更改将应用于所有版本。

storefront_settings

Example

use FacebookAds\Api;
use FacebookAds\Http\RequestInterface;

$params = array(
  'fields' => array(
    'id',
    'name',
    'product_set_id',
  ),
);

$data = Api::instance()->call(
  '/' . <CANVAS_PRODUCT_SET_ID>,
  RequestInterface::METHOD_GET,
  $params)->getContent();

curl -G \
  --data-urlencode 'fields=[ 
    "id", 
    "name", 
    "product_set_id" 
  ]' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v2.11/<CANVAS_PRODUCT_SET_ID>

参数

这个端点不包含任何参数。

字段

字段	描述
`id` numeric string	The id of the element
`bottom_padding` numeric string	The padding below the element
`element_group_key` string	The element group key to bundle multiple elements in editing
`element_type` enum	The type of the element 默认
`image_overlay_spec` AdCreativeLinkDataImageOverlaySpec	How to render overlays over a product item
`item_description` string	A token to represent which field from the product to show in the product description
`item_headline` string	A token to represent which field from the product to show in the product headline
`max_products` unsigned int32	Maximum number of products to show
`name` string	The name of the element 默认
`product_set_id` numeric string	The product set id which contains a subset of products within a product catalog
`retailer_item_ids` list<string>	An array of items that should be shown first in the product set element. If this is not set then products will be dynamically chosen
`show_in_feed` bool	A flag that products should be shown in feed unit
`top_padding` numeric string	The padding above the element

错误代码

错误	描述
368	The action attempted has been deemed abusive or is otherwise disallowed
104	Incorrect signature

创建

你无法在此端点执行该操作。

更新

你无法在此端点执行该操作。

删除

你无法在此端点执行该操作。

Create a Collection Ads Product Set

To create a product set used in Collection ads from a set of products in Dynamic Ads:


curl
  -F 'canvas_product_set={ 
    "bottom_padding": 8, 
    "max_items": 50, 
    "name": "Collection Product Set Name", 
    "product_set_id": "PRODUCT_SET_ID",
    "show_in_feed": true,
    "item_headline": "See more at {{product.brand | titleize}}",
    "item_description": "{{product.price}}",
    "retailer_item_ids": [
       "RETAILER_ID_1", 
       "RETAILER_ID_2", 
       "RETAILER_ID_3", 
       "RETAILER_ID_4",
    ], 
    "top_padding": 24 
  }' \
  -F 'access_token=ACCESS_TOKEN' \
  https://graph.facebook.com/VERSION/PAGE_ID/canvas_elements