這份文件已更新。
中文(香港) 的翻譯尚未完成。
英文更新時間:2022年1月19日

商品組合焦點系列 API

您可以使用這個 API 建立商店中使用的焦點系列,以及新增商品組合的中繼資料,例如封面圖片和說明。之後您就可以在商務管理工具中使用這些商品組合焦點系列自訂您的 Facebook 或 Instagram 商店(否則需手動建立焦點系列)。您也可以提供商店編號,直接發佈這類準備就緒的商品組合。使用商務 API 即可取得商店編號。

進一步了解如何在商務管理工具中建立焦點系列,企業商家幫助中心

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 的中繼資料。這些欄位未必會相同,舉例來說,如果在更新時更換圖片但因誠信因素而遭拒絕,就有可能發生這種情形。

所有欄位均非預設欄位,在 Graph API 中應以欄位參數的形式明確呼叫。

欄位描述

latest_metadata

最近一次傳送的中繼資料資訊。未必與 live_metadata 相同(例如,若 review_status 的狀態是 REJECTED 便不相同)。

live_metadata

此商品組合目前正在使用的中繼資料。

中繼資料欄位


欄位描述

cover_image_url

供客戶查看的商品組合封面圖片網址。

description

供客戶查看的商品組合說明。

external_url

焦點系列的網址。此網址不會向消費者顯示,但在建立宣傳商品組合的廣告時,這是預設網址。

integrity_review_status

誠信審查狀態。可以是 APPROVEDREJECTEDPENDING 其中任何一種狀態。

範例:讀取一個商品組合,查看正在使用的中繼資料:

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 這個長闊比例。

問:封面圖片的檔案大小上限是多少?

:檔案大小上限為 8 MB。

問:支援哪些檔案格式的封面圖片?

:支援 JPG 和 PNG。

問:說明文字長度是否設有限制?

:說明文字長度不設下限,但長度上限為 200 個字元。

問:如何在商店取消發佈焦點系列(商品組合)?

:您可以使用更新 API,從之前發佈 shop_id 欄位的 publish_to_shop 清單中移除這個欄位。如果提供空白陣列 ([]),系統會在所有商店取消發佈該項商品組合。