IGユーザーカタログ商品検索

IGユーザーの Instagramショップ商品カタログの中で、特定の検索文字列に一致する商品と商品バリエーションを表示します。使い方について詳しくは、商品のタグ付けをご覧ください。

作成

この操作はサポートされていません。

読み取り

GET /{ig-user-id}/catalog_product_search

IGユーザーのInstagramショップ商品カタログの中で、特定の検索文字列に一致する商品のコレクションを入手します。

制限

Instagramクリエイターアカウントはサポートされていません。
ストーリーズ、Instagram TV、リール、ライブ、メンションはサポートされていません。
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}`	必須。アプリユーザーのapp-scoped user ID。

クエリ文字列パラメーター

キー	プレースホルダー	値
`access_token`	`{access-token}`	必須。アプリユーザーのユーザーアクセストークン。
`catalog_id`	`{catalog-id}`	必須。検索するカタログのID。
`q`	`{q}`	各商品の名前またはSKU番号から検索する文字列(SKU番号はカタログ管理インターフェイスの[コンテンツID]列で追加できます)。文字列が指定されていない場合、タグ付け可能な商品すべてが返されます。

応答

タグ付け対象商品とそのメタデータの配列を含む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`	商品ID。
`merchant_id`	販売者ID。
`product_name`	商品名。
`image_url`	商品画像のURL。
`retailer_id`	小売店ID。
`review_status`	審査ステータス。可能な値は、`approved`、`outdated`、`pending`、`rejected`です。承認済み商品はアプリユーザーのInstagramショップに表示可能ですが、承認済みステータスは商品の在庫があることを示すものではありません(商品が在庫切れという可能性もあります)。公開された投稿に表示されるタグは、`review_status`が`approved`の商品に関連するものだけです。
`is_checkout_flow`	`true`なら、Instagramアプリの中で直接商品を購入できます。`false`なら、アプリユーザーのアプリ/ウェブサイトの中で商品を購入する必要があります。
`product_variants`	商品バリエーションの商品ID (`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"
            }
          ]
    }
  ]
}

更新

この操作はサポートされていません。

削除

この操作はサポートされていません。