IG 用戶目錄產品搜尋

表示與 IG 用戶的 Instagram 商店商品目錄內指定搜尋字串相符的產品和產品款式。如需完整使用詳細資料，請參閱商品標註指南。

建立

不支援執行此作業。

讀取

GET /{ig-user-id}/catalog_product_search

取得與目標 IG 用戶的 Instagram 商店目錄內指定搜尋字串相符的商品精選集。

限制

不支援 Instagram 創作者帳號。
不支援限時動態、Instagram TV、Reels、Live 和 Mentions。
將會傳回 review_status 為 rejected 的產品，但 IG 影音素材不能標註禁止刊登的產品。
發佈標註未經核准產品的貼文時，API 並不會傳回錯誤，但是在產品獲得核准之前，標籤不會顯示在已發佈的貼文。因此，建議只有在貼文包含產品的 review_status 為 approved 的標籤時，才允許應用程式用戶發佈。預設情況下，在您取得應用程式用戶的合格產品時，系統將為每個產品傳回此欄位。

必備條件

類型	條件
存取權杖	用戶
企業角色	應用程式用戶在擁有 IG 用戶的 Instagram 商店的企業管理平台上，必須具有管理員角色。
Instagram 商店	IG 用戶必須具有已核准的 Instagram 商店，以及包含產品的商品目錄。
權限	`catalog_management` `instagram_basic` `instagram_shopping_tag_products` `pages_show_list` 如果應用程式用戶是透過連結至目標 IG 用戶之粉絲專頁的企業管理平台獲得角色，您還需要下列其中一項： `ads_management` `business_management`

要求語法

GET https://graph.facebook.com/{api-version}/{ig-user-id}/catalog_product_search
  ?catalog_id={catalog-id}
  &q={q}
  &access_token={access-token}

路徑參數

預留位置	值
`{api-version}`	API 版本。
`{ig-user-id}`	必填。應用程式用戶的應用程式範圍用戶編號。

查詢字串參數

索引鍵	預留位置	值
`access_token`	`{access-token}`	必填。應用程式用戶的用戶存取權杖。
`catalog_id`	`{catalog-id}`	必填。要搜尋的目錄編號。
`q`	`{q}`	要在每個產品的名稱或 SKU 號碼（您可以在目錄管理介面中的內容編號欄位新增 SKU 號碼）中搜尋的字串。如果未指定字串，系統將傳回所有符合標註資格的產品。

回應

JSON 格式的物件，其中包含符合標籤條件的產品陣列及其中繼資料。支援游標型分頁。

{
  "data": [
    {
      "product_id": {product-id},
      "merchant_id": {merchant-id},
      "product_name": "{product-name}",
      "image_url": "{image-url}",
      "retailer_id": "{retailer-id}",
      "review_status": "{review-status}",
      "is_checkout_flow": {is-checkout-flow}
    }
  ]
}

回應內容

屬性	值
`product_id`	產品編號。
`merchant_id`	商家編號。
`product_name`	產品名稱。
`image_url`	產品圖像網址。
`retailer_id`	零售商編號。
`review_status`	審查狀態。數值可為 `approved`、`outdated`、`pending`、`rejected`。已核准的產品可以顯示在應用程式用戶的 Instagram 商店中，但已核准的狀態並不表示供貨現況（例如，產品可能缺貨）。只有與 `review_status` 為 `approved` 的產品相關聯的標籤，才能顯示在已發佈的貼文。
`is_checkout_flow`	若為 `true`，則可以直接在 Instagram 應用程式中購買產品。若為 `false`，則必須在應用程式用戶的應用程式／網站購買產品。
`product_variants`	產品款式的產品編號（`product_id`）和款式名稱（`variant_name`）。

cURL 範例

要求

curl -i -X GET \
 "https://graph.facebook.com/v19.0/90010177253934/catalog_product_search?catalog_id=960179311066902&q=gummy&access_token=EAAOc"

回應

{
  "data": [
    {
      "product_id": 3231775643511089,
      "merchant_id": 90010177253934,
      "product_name": "Gummy Wombats",
      "image_url": "https://scont...",
      "retailer_id": "oh59p9vzei",
      "review_status": "approved",
      "is_checkout_flow": true,
      "product_variants": [
            {
              "product_id": 5209223099160494
            },
            {
              "product_id": 7478222675582505,
              "variant_name": "Green Gummy Wombats"
            }
          ]
    }
  ]
}

更新

不支援執行此作業。

刪除

不支援執行此作業。