IGメディア商品タグ

IGメディアの商品タグを表します。使い方について詳しくは、商品タグ付けをご覧ください。

作成

POST /{ig-media-id}/product_tags

既存のIGメディアの商品タグを作成または更新します。

制限

Instagramクリエイターアカウントはサポートされていません。
ストーリーズ、Instagram TV、Live、Mentionsはサポートされていません。
メディアへのタグは上限の5個に達するまで追加されていきます。対象とされたメディアがリクエスト中の商品によってすでにタグ付けされている場合、古いタグのxとyの値が、新しい値に更新されます(新しいタグは追加されません)。

要件

タイプ	要件
アクセストークン	ユーザー
ビジネスの役割	アプリユーザーには、IGユーザーのInstagramショップを所有するビジネスマネージャの管理者権限がなければなりません。
Instagramショップ	IGメディアを所有するIGユーザーには、承認済みのInstagramショップと、商品が含まれている商品カタログがなければなりません。
アクセス許可	`catalog_management` `instagram_basic` `instagram_shopping_tag_products` `pages_show_list` ターゲットのIGユーザーに接続されたページの役割がビジネスマネージャを介してアプリユーザーに付与されている場合は、次のうちのいずれか1つも必要です。 `ads_management` `business_management`

リクエストの構文

POST https://graph.facebook.com/{api-version}/{ig-media-id}/product_tags
  ?updated_tags={updated-tags}
  &access_token={access-token}

パスパラメーター

プレースホルダー	値
`{api-version}`	APIバージョン。
`{ig-media-id}`	必須。IGメディアID。

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

キープレースホルダー値

access_token

{access-token}

必須。アプリユーザーのユーザーアクセストークン。

updated_tags

{updated-tags}

必須。画像と動画にのみ適用。画像または動画にどの商品タグを付けるかを指定するオブジェクトの配列(最大5。タグと商品IDは一意でなければなりません)。オブジェクトごとに以下の情報が必要です。

product_id — 必須。商品ID。
x — 画像のみ。(任意)公開メディア画像の左境界からの距離をパーセントで示す浮動小数点数。値は、0.0以上1.0以下の範囲でなければなりません。
y — 画像のみ。(任意)公開メディア画像の上境界からの距離をパーセントで示す浮動小数点数。0.0～1.0の範囲の値でなければなりません。

例

[{product_id:'3231775643511089',x:0.5,y:0.8}]

応答

成否を示すオブジェクト。

{
  "success": {success}
}

応答の内容

プロパティ	値
`success`	IGメディアの商品タグの更新が可能な場合は`true`、それ以外の場合は`false`が返されます。

cURLの例

リクエスト

curl -i -X POST \
 "https://graph.facebook.com/v19.0/90010778325754/product_tags?updated_tags=%5B%0A%20%20%7B%0A%20%20%20%20product_id%3A'3859448974125379'%2C%0A%20%20%20%20x%3A%200.5%2C%0A%20%20%20%20y%3A%200.8%0A%20%20%7D%0A%5D&access_token=EAAOc..."

参考までに、以下にHTMLデコードされたPOSTペイロード文字列を示します。

https://graph.facebook.com/v19.0/90010778325754/product_tags?updated_tags=[ { product_id:'3859448974125379', x: 0.5, y: 0.8 } ]&access_token=EAAOc...

応答

{
  "success": true
}

読み取り

GET /{ig-media-id}/product_tags

IGメディアの商品タグのコレクションを取得します。商品タグ付けの手順について詳しくは、商品タグ付けガイドをご覧ください。

制限

Instagramクリエイターアカウントはサポートされていません。
ストーリーズ、Instagram TV、リール、Live、Mentionsはサポートされていません。

要件

タイプ	要件
アクセストークン	ユーザー
ビジネスの役割	アプリユーザーには、IGユーザーのInstagramショップを所有するビジネスマネージャの管理者権限がなければなりません。
Instagramショップ	IGメディアを所有するIGユーザーには、承認済みのInstagramショップと、商品が含まれている商品カタログがなければなりません。
アクセス許可	`catalog_management` `instagram_basic` `instagram_shopping_tag_products` `pages_show_list` ターゲットのIGユーザーに接続されたページの役割がビジネスマネージャを介してアプリユーザーに付与されている場合は、次のうちのいずれか1つも必要です。 `ads_management` `business_management`

リクエストの構文

GET https://graph.facebook.com/{api-version}/{ig-media-id}/product_tags
  ?access_token={access-token}

パスパラメーター

プレースホルダー	値
`{api-version}`	APIバージョン。
`{ig-media-id}`	必須。IGメディアID。

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

キー	プレースホルダー	値
`access_token`	`{access-token}`	必須。アプリユーザーのユーザーアクセストークン。

応答

IGメディアの商品タグの配列を含むJSON形式のオブジェクト。応答には、以下の商品タグフィールドが含まれることがあります。

{
  "data": [
    {
      "product_id": {product-id},
      "merchant_id": {merchant-id},
      "name": "{name}",
      "price_string": "{price-string}",
      "image_url": "{image-url}",
      "review_status": "{review-status}",
      "is_checkout": {is-checkout},
      "stripped_price_string": "{stripped-price-string}",
      "string_sale_price_string": "{string-sale-price-string}",
      "x": {x},
      "y": {y}
    }
  ]
}

応答の内容

プロパティ	値
`product_id`	商品ID。
`merchant_id`	販売者ID。
`name`	商品名。
`price_string`	価格文字列。
`image_url`	商品画像のURL。
`review_status`	商品レビューのステータス。値は次のいずれかです。 `approved` — 商品は承認済みです。 `rejected` — 商品は却下されました `pending` — まだ審査中です。 `outdated` — 商品は承認されましたが、その後編集されたため再承認が必要です。 `""` — レビューステータスなし。
`is_checkout`	`true`なら、Instagramアプリを通じて直接商品を購入できます。`false`なら、商品は販売者のウェブサイト上でのみ購入可能です。
`stripped_price_string`	商品の短縮価格文字列(スペースに制約がある場合の価格。`100 USD`の代わりに`$100`と表示するなど)。
`string_sale_price_string`	商品の販売価格。
`x`	メディア画像の左境界からの距離をパーセントで示す浮動小数点数。`0.0`以上`1.0`以下の範囲の値。
`y`	メディア画像の上境界からの距離をパーセントで示す浮動小数点数。`0.0`以上`1.0`以下の範囲の値。

cURLの例

リクエスト

curl -i -X GET \
 "https://graph.facebook.com/v19.0/90010778325754/product_tags?access_token=EAAOc..."

応答

{
  "data": [
    {
      "product_id": 3231775643511089,
      "merchant_id": 90010177253934,
      "name": "Gummy Bears",
      "price_string": "$3.50",
      "image_url": "https://scont...",
      "review_status": "approved",
      "is_checkout": true,
      "stripped_price_string": "$3.50",
      "stripped_sale_price_string": "$3",
      "x": 0.5,
      "y": 0.80000001192093
    }
  ]
}

更新

作成をご覧ください。

削除

DELETE /{ig-media-id}/product_tags

既存のIGメディアの商品タグを削除します。

制限

Instagramクリエイターアカウントはサポートされていません。
ストーリーズ、Instagram TV、リール、Live、Mentionsはサポートされていません。

要件

タイプ	要件
アクセストークン	ユーザー
ビジネスの役割	アプリユーザーには、IGユーザーのInstagramショップを所有するビジネスマネージャの管理者権限がなければなりません。
Instagramショップ	IGメディアを所有するIGユーザーには、承認済みのInstagramショップと、商品が含まれている商品カタログがなければなりません。
アクセス許可	`catalog_management` `instagram_basic` `instagram_shopping_tag_products` `pages_show_list` ターゲットのIGユーザーに接続されたページの役割がビジネスマネージャを介してアプリユーザーに付与されている場合は、次のうちのいずれか1つも必要です。 `ads_management` `business_management`

リクエストの構文

DELETE https://graph.facebook.com/{api-version}/{ig-media-id}/product_tags
  ?deleted_tags={deleted-tags}
  &access_token={access-token}

パスパラメーター

プレースホルダー	値
`{api-version}`	APIバージョン。
`{ig-media-id}`	必須。IGメディアID。

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

キープレースホルダー値

access_token

{access-token}

必須。アプリユーザーのユーザーアクセストークン。

deleted_tags

{deleted-tags}

必須。削除する各商品タグに関する以下の情報を含む配列

merchant_id — 必須。販売者ID。
product_id — 必須。商品ID。

応答

成否を示すオブジェクト。

{
  "success": {success}
}

応答の内容

プロパティ	値
`success`	IGメディアの指定した商品タグの削除が可能な場合は`true`、それ以外の場合は`false`が返されます。

cURLの例

リクエスト

curl -i -X DELETE \
  "https://graph.facebook.com/v19.0/90010778325754/product_tags?deleted_tags=%5B%0A%20%20%7B%0A%20%20%20%20product_id%3A'3859448974125379'%2C%0A%20%20%20%20merchant_id%3A'90010177253934'%0A%20%20%7D%0A%5D&access_token=EAAOc..."

参考までに、以下にHTMLデコードされたPOSTペイロード文字列を示します。

https://graph.facebook.com/v12.0/90010778325754/product_tags?deleted_tags=[ { product_id:'3859448974125379', merchant_id:'90010177253934' } ]&access_token=EAAOc...

応答

{
  "success": true
}