Поделиться через

Управление рекламными материалами

  • Статья

Используйте эти методы в API рекламных акций Microsoft Store для отправки собственных пользовательских творческих элементов для использования в рекламных рекламных кампаниях или получения существующего творческого элемента. Творческий объект может быть связан с одной или несколькими линиями доставки, даже в рекламных кампаниях, если он всегда представляет одно и то же приложение.

Дополнительные сведения о связях между творческими и рекламными кампаниями, линиями доставки и профилями целевого назначения см. в статье "Запуск рекламных кампаний с помощью служб Microsoft Store".

Примечание.

При использовании этого API для отправки собственного творческого объекта максимальный размер для вашего творческого объекта составляет 40 КБ. При отправке творческого файла, превышающего это, этот API не вернет ошибку, но кампания не будет успешно создана.

Необходимые компоненты

Чтобы использовать эти методы, сначала необходимо выполнить следующие действия:

  • Если вы этого еще не сделали, выполните все предварительные требования для API рекламных акций Microsoft Store.
  • Получите маркер доступа Azure AD для использования в заголовке запроса для этих методов. После получения маркера доступа у вас будет 60 минут, чтобы использовать его до истечения срока действия. После истечения срока действия маркера можно получить новый.

Запросить

Эти методы имеют следующие URI.

Тип метода URI запроса Description
POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative Создает новый творческий объект.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/{creativeId} Возвращает творческий объект, указанный creativeId.

Примечание.

В настоящее время этот API не поддерживает метод PUT.

Верхний колонтитул Тип Описание
Авторизация строка Обязательный. Маркер доступа Azure AD в маркере> носителя<формы.
Идентификатор отслеживания GUID Необязательно. Идентификатор, отслеживающий поток вызовов.

Текст запроса

Для метода POST требуется текст запроса JSON с необходимыми полями объекта Creative .

Примеры запросов

В следующем примере показано, как вызвать метод POST для создания творческого элемента. В этом примере значение содержимого сокращено для краткости.

POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative HTTP/1.1
Authorization: Bearer <your access token>

{
  "name": "Contoso App Campaign - Creative 1",
  "content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAgGB...other base64 data shortened for brevity...",
  "height": 80,
  "width": 480,
  "imageAttributes":
  {
    "imageExtension": "PNG"
  }
}

В следующем примере показано, как вызвать метод GET для получения творческого элемента.

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/106851  HTTP/1.1
Authorization: Bearer <your access token>

Response

Эти методы возвращают текст ответа JSON с объектом Creative , который содержит сведения о созданном или извлеченном творческом объекте. В следующем примере показан текст отклика для этих методов. В этом примере значение содержимого сокращено для краткости.

{
    "Data": {
        "id": 106126,
        "name": "Contoso App Campaign - Creative 2",
        "content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAgGB...other base64 data shortened for brevity...",
        "height": 50,
        "width": 300,
        "format": "Banner",
        "imageAttributes":
        {
          "imageExtension": "PNG"
        },
        "storeProductId": "9nblggh42cfd"
    }
}

Объект Creative

Тела запросов и ответов для этих методов содержат следующие поля. В этой таблице показано, какие поля доступны только для чтения (это означает, что они не могут быть изменены в методе PUT) и какие поля необходимы в тексте запроса для метода POST.

Поле Тип Описание Только чтение По умолчанию. Требуется для POST
id integer Идентификатор творческого. Да Нет
name строка Имя творческого. No Да
content строка Содержимое творческого изображения в формате Base64 в кодировке Base64.

Обратите внимание , что максимальный допустимый размер для вашего творческого объекта составляет 40 КБ. При отправке творческого файла, превышающего это, этот API не вернет ошибку, но кампания не будет успешно создана.		 No Да
высота integer Высота творческого. No Да
width integer Ширина творческого. No Да
landingUrl строка Если вы используете службу отслеживания кампаний, например AppsFlyer, Kochava, Tune или Vungle для измерения аналитики установки приложения, назначьте URL-адрес отслеживания в этом поле при вызове метода POST (если указано, это значение должно быть допустимым URI). Если вы не используете службу отслеживания кампаний, опустите это значение при вызове метода POST (в этом случае этот URL-адрес будет создан автоматически). No Да
format строка Формат рекламы. В настоящее время единственным поддерживаемым значением является Баннер. No Баннер No
imageAttributes ImageAttributes Предоставляет атрибуты для творческого объекта. No Да
storeProductId строка Идентификатор Магазина для приложения, с которым связана эта рекламная кампания. Пример идентификатора магазина для продукта — 9nblggh42cfd. No No

Объект ImageAttributes

Поле Тип Описание Только для чтения Default value Требуется для POST
imageExtension строка Одно из следующих значений: PNG или JPG. No Да