這份文件已更新。
中文(台灣) 的翻譯尚未完成。
英文更新時間:2021年11月8日

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

所有欄位均非預設欄位,在圖形 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 清單移除。若提供空陣列 ([]),就會在所有商店取消發佈該商品組合。