文档已更新。
中文(简体) 译文尚未完成。
英语更新时间:2021年10月27日

商品系列精品栏 API

您可使用此 API 创建用于店铺的精品栏,并将元数据添加到商品系列中,如封面图片和描述。此类商品系列之后可随时在电商管理工具中用作精品栏,以自定义您的 Facebook 或 Instagram 店铺(其他情况下需手动创建精品栏)。您也可以通过提供店铺编号,直接发布此类便于使用的商品系列。店铺编号可通过使用商务 API 获得。

详细了解如何在电商管理工具、Business 帮助中心中创建精品栏

POST(创建或更新 API)

商品系列的创建及更新保持不变。不过,您需注意一些新的可选字段:

字段说明

metadata

可选

精品栏元数据块的父对象参数。

publish_to_shops

可选

提供 shop_id(s) 以直接创建或更新商品系列,并发布至店铺的参数。

元数据字段


字段说明

cover_image_url

可选

精品栏封面图片的网址。

description

可选

面向客户的商品系列的描述。

external_url

可选

精品栏的网址。此网址不向消费者展示,但会在您创建广告以推广商品系列时用作默认网址。

发布至店铺字段

publish_to_shops 字段接受空数组,或带有显示在下方示例中的参数的数组。如已提供空数组,则将从所有店铺中取消发布给定的商品系列(如发布较早)。


字段说明

shop_id

此处的 shop_id 已经过预估,且可使用商务 API 获得。

示例 — 负载

{ 
    "name": "Best sellers",
    "filter": {
      "retailer_id": {
        "is_any": [
          "pid1",
          "pid2"
        ]
      } 
    },
    "metadata": {
      "cover_image_url": "https://foo.com/image.jpg" (https://foo.com/image.jpg%E2%80%9D),
      "external_url": "https://foo.com/best-sellers",
      "description":"Our best selling products"
    }
  "publish_to_shops": [{"shop_id": "shop_id1"}, {"shop_id": "shop_id2"}]
}

创建商品系列

使用符合特定商品编号的精品栏元数据创建商品系列:

curl \
  -F "name=Best Sellers" \
  -F "filter={'retailer_id': {'is_any': ['pid1', 'pid2']}}" 
  -F "metadata={'cover_image_url':'https://foo.com/image.jpg', 'external_url':'https://foo.com/best-sellers', 'description':'Our best selling products'}" \
  -F "access_token=<ACCESS_TOKEN>" \
  https://graph.facebook.com/API_VERSION/PRODUCT_CATALOG_ID/product_sets

更新商品系列

使用精品栏元数据更新现有的商品系列,并发布至商铺:

curl \
  -F "name=Updated Best Sellers" \
  -F "metadata={'cover_image_url':'https://foo.com/image_updated.jpg', 'external_url':'https://foo.com/best-sellers-updated', 'description':'Our updated best selling products'}" \
  -F "publish_to_shops=[{'shop_id':'shop_id1'}, {'shop_id':'shop_id2'}]"
  -F "access_token=<ACCESS_TOKEN>" \
  https://graph.facebook.com/API_VERSION/PRODUCT_SET_ID

GET(读取 API)

GET 节点中,live_metadata 字段会返回已发布且在特定商品系列中启用的元数据,同时 latest_metadata 字段会返回上次发送至 API 的元数据。如遇某些情况,则这些字段可能会有所不同,例如,更新后图片更改,以及因完整性因素图片未通过审核。

所有字段都是非默认字段,且应明确在图谱 API 中作为字段参数调用。

字段说明

latest_metadata

已发送的最新元数据信息。可能与 live_metadata 不同(例如,review_status 显示为 REJECTED)。

live_metadata

当前已针对此商品系列发布的元数据。

元数据字段


字段说明

cover_image_url

商品系列中面向客户的封面图片的网址。

description

商品系列中面向客户的描述。

external_url

精品栏的网址。此网址不向消费者展示,但会在您创建广告以推广商品系列时用作默认网址。

integrity_review_status

完整性审核状态。可以是 APPROVEDREJECTED、和 PENDING

示例 — 阅读商品系列,以查看已发布的元数据:

curl -G \
  -d "access_token=<ACCESS_TOKEN>" \
  https://graph.facebook.com/<API_VERSION>/<PRODUCT_SET_ID>/?fields=id,name,latest_metadata{cover_image_url, description, review_status},live_metadata{cover_image_url, description, review_status}

回复

{ 
    "id": 1234567890,
    "name": "Best sellers",
    "latest_metadata": {
        "cover_image_url": "https://foo.com/some_new_image.jpg" (https://foo.com/image.jpg%E2%80%9D),
        "description":"Our best selling products",
        "integrity_review_status": "REJECTED"
    },
    "live_metadata": {
        "cover_image_url": "https://foo.com/some_good_image.jpg", 
        "description":"Our best selling products",
        "integrity_review_status": "APPROVED"
    }
}

常见问题

问:封面图片可接受的最小宽高比是多少?

:图片的宽高比必须至少为 600x600(尽管编辑裁剪功能在此比例中无法使用)。如上传比例为 800x800 或更大比例的图片,则会默认选择宽高比。为提供最佳效果,建议宽高比为 1080x1080。

问:封面图片的最大文件大小是多少?

A:文件大小不得超过 8 MB。

问:封面图片支持什么样的文件格式?

:支持 JPG 和 PNG 的格式。

问:描述是否有长度限制?

:描述没有长度限制。最大长度为 200 个字符。

问:如何从店铺中取消发布精品栏(商品系列)?

:您可使用更新 API,并将 shop_id 字段从先前已在其中发布的 publish_to_shop 列表移除。如已提供空数组 ([]),则将从所有店铺中取消发布商品系列。