Instagram 用户目录商品搜索

表示 Instagram 用户的 Instagram 店铺商品目录中与给定搜索字符串匹配的商品和商品款式。如需了解完整的使用详情，请参阅商品标记指南。

创建

不支持此操作。

读取

GET /{ig-user-id}/catalog_product_search

获取目标 Instagram 用户的 Instagram 店铺目录中与给定搜索字符串匹配的一组商品。

限制

不支持 Instagram 创作者帐户。
不支持快拍、Instagram TV、Reels、Live 和 Mentions。
系统会返回 review_status 值为 rejected 的商品，但不能使用未通过审核的商品标记 Instagram 媒体。
对于未通过审核的商品，在发布带有此商品标记的帖子时，API 不会返回错误，但在此商品通过审核之前发布的帖子上不会显示此标记。因此，建议只有在商品的 review_status 为approved 时，才允许应用用户发布带有该商品标记的帖子。在获取应用用户符合条件的商品时，系统会默认为每个商品返回此字段。

要求

类型	要求
访问口令	用户
商务管理平台身份	应用用户必须在此 Instagram 用户的 Instagram 店铺所属的商务管理平台上具有管理员身份。
Instagram 店铺	Instagram 用户必须拥有已获批准的 Instagram 店铺，以及包含商品的商品目录。
权限	`catalog_management` `instagram_basic` `instagram_shopping_tag_products` `pages_show_list` 若在与目标 Instagram 用户相绑定的公共主页上，通过商务管理平台向应用用户授予了身份，您还将需要以下其中一项权限： `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"
            }
          ]
    }
  ]
}

更新

不支持此操作。

删除

不支持此操作。