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

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

  • Статья

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

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

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

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

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

  • Если вы этого еще не сделали, выполните все предварительные требования для API рекламных акций Microsoft Store.

    Примечание.

    В рамках предварительных требований убедитесь, что вы создаете по крайней мере одну платную рекламную кампанию в Центре партнеров и добавляете по крайней мере один инструмент оплаты для рекламной кампании в Центре партнеров. Линии доставки, создаваемые с помощью этого API, автоматически выставляют счета за инструмент оплаты по умолчанию, выбранный на странице рекламных кампаний в Центре партнеров.

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

Запросить

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

Тип метода URI запроса Description
POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/line Создает новую линию доставки.
PUT https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/{lineId} Изменяет строку доставки, указанную lineId.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/{lineId} Возвращает строку доставки, указанную в lineId.
Верхний колонтитул Тип Описание
Авторизация строка Обязательный. Маркер доступа Azure AD в маркере> носителя<формы.
Идентификатор отслеживания GUID Необязательно. Идентификатор, отслеживающий поток вызовов.

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

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

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

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

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

{
    "name": "Contoso App Campaign - Paid Line",
    "configuredStatus": "Active",
    "startDateTime": "2017-01-19T12:09:34Z",
    "endDateTime": "2017-01-31T23:59:59Z",
    "bidAmount": 0.4,
    "dailyBudget": 20,
    "targetProfileId": {
        "id": 310021746
    },
    "creatives": [
        {
            "id": 106851
        }
    ],
    "campaignId": 31043481,
    "minMinutesPerImp ": 1
}

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

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

Response

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

{
    "Data": {
        "id": 31043476,
        "name": "Contoso App Campaign - Paid Line",
        "configuredStatus": "Active",
        "effectiveStatus": "Active",
        "effectiveStatusReasons": [
            "{\"ValidationStatusReasons\":null}"
        ],
        "startDateTime": "2017-01-19T12:09:34Z",
        "endDateTime": "2017-01-31T23:59:59Z",
        "createdDateTime": "2017-01-17T10:28:34Z",
        "bidType": "CPM",
        "bidAmount": 0.4,
        "dailyBudget": 20,
        "targetProfileId": {
            "id": 310021746
        },
        "creatives": [
            {
                "id": 106126
            }
        ],
        "campaignId": 31043481,
        "minMinutesPerImp ": 1,
        "pacingType ": "SpendEvenly",
        "currencyId ": 732
    }
}

Объект линии доставки

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

Поле Тип Описание Только чтение По умолчанию. Требуется для POST/PUT
id integer Идентификатор строки доставки. Да Нет
name строка Имя строки доставки. No POST
configuredStatus строка Одно из следующих значений, указывающее состояние строки доставки, указанной разработчиком:
  • Активные
  • Неактивный
 No POST
effectiveStatus строка Одно из следующих значений, указывающее эффективное состояние линии доставки на основе проверки системы:
  • Активные
  • Неактивный
  • Обработка
  • Неудачно
 Да Нет
effectiveStatusReasons array Одно или несколько следующих значений, указывающих причину эффективного состояния линии доставки:
  • AdCreativesInactive
  • ValidationFailed
 Да Нет
startDatetime строка Дата начала и время для строки доставки в формате ISO 8601. Это значение нельзя изменить, если оно уже в прошлом. No POST, PUT
endDatetime строка Дата и время окончания строки доставки в формате ISO 8601. Это значение нельзя изменить, если оно уже в прошлом. No POST, PUT
createdDatetime строка Дата и время создания линии доставки в формате ISO 8601. Да Нет
bidType строка Значение, указывающее тип торгов линии доставки. В настоящее время единственным поддерживаемым значением является CPM. No CPM No
bidAmount десятичное Сумма ставки, которую будет использоваться для торгов любой рекламный запрос. No Среднее значение CPM на основе целевых рынков (это значение периодически редактируется). No
ежедневные бюджетные ресурсы десятичное Ежедневный бюджет для линии доставки. Необходимо задать ежедневное или время существования. No POST, PUT (если время существования не задано )
время существования десятичное Бюджет времени существования для линии доставки. Необходимо задать значение "время существования"* или "ежедневный бюджет ". No POST, PUT (если ежедневные бюджеты не заданы)
targetingProfileId объект Объект, определяющий целевой профиль , описывающий пользователей, географии и типы инвентаризации, предназначенные для этой линии доставки. Этот объект состоит из одного поля идентификатора, указывающего идентификатор целевого профиля. No No
творческие возможности array Один или несколько объектов, представляющих творческие объекты, связанные с линией доставки. Каждый объект в этом поле состоит из одного поля идентификатора , указывающего идентификатор творческого элемента. No No
campaignId integer Идентификатор родительской рекламной кампании. No No
minMinutesPerImp integer Указывает минимальный интервал времени (в минутах) между двумя впечатлениями, отображаемыми одному и тому же пользователю из этой строки доставки. No 4000 No
pacingType строка Одно из следующих значений, указывающее тип интервала:
  • SpendEvenly
  • SpendAsFastAsPossible
 No SpendEvenly No
currencyId integer Идентификатор валюты кампании. Да Валюта учетной записи разработчика (не нужно указывать это поле в вызовах POST или PUT) No