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

  • Статья

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

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

Примечание

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

Предварительные требования

Для использования этих методов сначала необходимо сделать следующее.

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

Запрос

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

Тип метода Универсальный код ресурса (URI) запроса Описание
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 в видемаркера>носителя<.
Tracking ID GUID Необязательный элемент. Идентификатор, который отслеживает поток вызовов.

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

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

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

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

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>

Ответ

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

{
    "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
идентификатор Целое число Идентификатор рекламного материала. Да Нет
name строка Имя рекламного материала. Нет Да
содержимое строка Содержимое рекламного изображения в формате Base64.

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

Объект ImageAttributes

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