IG Media Product Tags

Представляет метки товаров для объекта IG Media. Подробную информацию об использовании см. в руководстве по меткам товаров.

Создание

POST /{ig-media-id}/product_tags

Создает или обновляет метки товаров для существующего объекта IG Media.

Ограничения

  • Аккаунты авторов в Instagram не поддерживаются.
  • Истории, Instagram TV, Live и упоминания не поддерживаются.
  • Добавлять метки можно до тех пор, пока не будет достигнуто ограничение в 5 меток. Если к объекту уже добавлена метка товара, указанного в запросе, предыдущие значения x и y метки будут заменены новыми (новая метка не будет добавлена).

Требования

ТипТребование

Маркеры доступа

Пользователь

Роли в Business Manager

Пользователь приложения должен иметь роль администратора в том Business Manager, который владеет магазином в Instagram, связанным с IG User.

Магазин в Instagram

Пользователь IG User, который владеет объектом IG Media, должен иметь утвержденный магазин в Instagram с каталогом, в котором имеются товары.

Разрешения

catalog_management
instagram_basic
instagram_shopping_tag_products
pages_show_list


Если пользователь приложения получил роль на Странице, связанной с целевым пользователем IG User, через Business Manager, также потребуется одно из следующих разрешений:


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}

Обязательный параметр. ID объекта IG Media.

Параметры строки запроса

КлючЗаполнительЗначение

access_token

{access-token}

Обязательный параметр. Маркер доступа пользователя приложения.

updated_tags

{updated-tags}

Обязательный параметр. Применяется только к изображениям и видео. Массив объектов, указывающий, какие метки товаров нужно добавить к изображению или видео (не более пяти меток; метки и идентификаторы товаров должны быть уникальными). Каждый объект должен включать в себя следующее:


  • product_id — обязательный параметр. Идентификатор товара.
  • x — только для изображений. Необязательный параметр. Число с плавающей запятой. Задает расстояние в процентах от левого края опубликованного изображения. Возможные значения: от 0.0 до 1.0.
  • y — только для изображений. Необязательный параметр. Число с плавающей запятой. Задает расстояние в процентах от верхнего края опубликованного изображения. Возможные значения: от 0.0 до 1.0.

Пример:


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

Ответ

Объект, указывающий на успех или отклонение.

{
  "success": {success}
}

Содержание ответа

СвойствоЗначение

success

Возвращает true, если метки товаров объекта IG Media можно обновить. В противном случае возвращает 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..."

Пример строки полезной нагрузки POST, раскодированный для HTML:

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 Media. См. руководство по меткам товаров для получения подробной информации об этапах назначения меток товаров.

Ограничения

  • Аккаунты авторов в Instagram не поддерживаются.
  • Истории, Instagram TV, видео Reels, Live и упоминания не поддерживаются.

Требования

ТипТребование

Маркеры доступа

Пользователь

Роли в Business Manager

Пользователь приложения должен иметь роль администратора в том Business Manager, который владеет магазином в Instagram, связанным с IG User.

Магазин в Instagram

Пользователь IG User, который владеет объектом IG Media, должен иметь утвержденный магазин в Instagram с каталогом, в котором имеются товары.

Разрешения

catalog_management
instagram_basic
instagram_shopping_tag_products
pages_show_list


Если пользователь приложения получил роль на Странице, связанной с целевым пользователем IG User, через Business Manager, также потребуется одно из следующих разрешений:


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}

Обязательный параметр. ID объекта IG Media.

Параметры строки запроса

КлючЗаполнительЗначение

access_token

{access-token}

Обязательный параметр. Маркер доступа пользователя приложения.

Ответ

Объект в формате JSON, содержащий массив меток товаров для объекта IG Media. Ответ может включать в себя эти поля меток товара:

{
  "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 вместо 100 USD).

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 Media.

Ограничения

  • Аккаунты авторов в Instagram не поддерживаются.
  • Истории, Instagram TV, видео Reels, Live и упоминания не поддерживаются.

Требования

ТипТребование

Маркеры доступа

Пользователь

Роли в Business Manager

Пользователь приложения должен иметь роль администратора в том Business Manager, который владеет магазином в Instagram, связанным с IG User.

Магазин в Instagram

Пользователь IG User, который владеет объектом IG Media, должен иметь утвержденный магазин в Instagram с каталогом, в котором имеются товары.

Разрешения

catalog_management
instagram_basic
instagram_shopping_tag_products
pages_show_list


Если пользователь приложения получил роль на Странице, связанной с целевым пользователем IG User, через Business Manager, также потребуется одно из следующих разрешений:


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}

Обязательный параметр. ID объекта IG Media.

Параметры строки запроса

КлючЗаполнительЗначение

access_token

{access-token}

Обязательный параметр. Маркер доступа пользователя приложения.

deleted_tags

{deleted-tags}

Обязательный параметр. Массив, содержащий следующую информацию о каждой метке, которую нужно удалить:


  • merchant_id (обязательный параметр) — ID продавца;
  • product_id (обязательный параметр) — ID товара.

Ответ

Объект, указывающий на успех или отклонение.

{
  "success": {success}
}

Содержание ответа

СвойствоЗначение

success

Возвращает true, если указанные метки товаров объекта IG Media можно удалить; в противном случае возвращает 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..."

Пример строки полезной нагрузки POST, раскодированный для HTML:

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

Ответ

{
  "success": true
}