Selltics Docs

Русский

English

Русский

English

Оформление

Amazon Ads API ​

Обновлено

Что такое Amazon Ads API, как приложение получает доступ, что такое профиль и как доставляются метрики.

Как это описывает Amazon

Предметная область в том виде, в каком её публикует Amazon. Эта страница не описывает какое-либо конкретное приложение; каждое утверждение пересказывает публичную документацию из раздела Источники.

Коротко ​

  • API управляет кампаниями рекламодателя и возвращает данные об эффективности.
  • Доступ выдаётся через Login with Amazon (LWA); access token живёт один час.
  • Выбранный id профиля передаётся в каждом вызове кампаний или отчётов, поэтому такой запрос действует на один аккаунт в одном маркетплейсе.
  • Метрики приходят отчётами (pull) или через Amazon Marketing Stream (push).

Что это ​

  • Amazon Ads API даёт приложению программный доступ к рекламным аккаунтам рекламодателя в Amazon Ads.
  • Он создаёт и изменяет кампании, группы объявлений, объявления, ключевые слова и таргеты и возвращает данные об эффективности.
  • Он охватывает спонсорские рекламные продукты — Sponsored Products, Sponsored Brands и Sponsored Display — и, через отдельные эндпоинты, Amazon DSP.
  • Доступ выдаётся каждому приложению отдельно, после того как Amazon одобрит заявку на доступ к API.

Авторизация ​

  • Login with Amazon (LWA). Рекламодатель выдаёт приложению доступ через поток OAuth 2.0 authorization code. Приложение обменивает код на access token и refresh token.
  • Access token живёт недолго (один час). Когда он истекает, refresh token обменивается на новый access token.
  • Каждый вызов идентифицируется access token (Authorization: Bearer …) и LWA client id приложения (Amazon-Advertising-API-ClientId).

Профили и scope ​

  • Профиль — это один рекламный аккаунт в одном маркетплейсе: у продавца, который торгует в США и в Германии, два профиля.
  • Получение списка профилей, доступных токену, — первый вызов приложения.
  • Выбранный id профиля затем передаётся в каждом вызове кампаний или отчётов в заголовке Amazon-Advertising-API-Scope, поэтому запрос всегда действует ровно на один аккаунт в одном маркетплейсе.

Регионы ​

API обслуживается тремя региональными хостами, и профиль доступен только через хост своего региона:

  • Северная Америка — advertising-api.amazon.com. Маркетплейсы, например: США, Канада, Мексика, Бразилия.
  • Европа — advertising-api-eu.amazon.com. Маркетплейсы, например: Великобритания, Германия, Франция, Италия, Испания, Индия, ОАЭ.
  • Дальний Восток — advertising-api-fe.amazon.com. Маркетплейсы, например: Япония, Австралия, Сингапур.

Получение метрик ​

  • Отчёты (pull). Отчёт запрашивается с диапазоном дат, типом отчёта, колонками и фильтрами; Amazon формирует его асинхронно. Приложение опрашивает статус отчёта и, когда он готов, скачивает сжатый файл по URL из ответа.
  • Amazon Marketing Stream (push). Приложение подписывается для каждого рекламодателя на наборы данных, например почасовой трафик и конверсии спонсорской рекламы или изменения кампаний. Amazon доставляет сообщения в принадлежащий приложению ресурс AWS — очередь Amazon SQS или поток Amazon Data Firehose — почти в реальном времени, без опроса со стороны приложения.

Лимиты

Вызовы ограничиваются по частоте; ограниченный вызов отвечает HTTP 429 и повторяется позже с backoff.

В этом разделе ​

Источники ​