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

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

Примечание Вы также можете создавать и управлять рекламными кампаниями с помощью Центра партнеров, а к кампаниям, создаваемым программным способом, можно получить доступ в Центре партнеров. Дополнительные сведения об управлении рекламными кампаниями в Центре партнеров см. в статье Создание рекламной кампании для вашего приложения.

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

• Управление линиями доставки для рекламных кампаний
• Управление профилями целевого назначения для рекламных кампаний
• Управление креативами для рекламных кампаний

Предпосылки

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

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

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

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

Просьба

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

Заголовок

Параметры

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

Основное содержание запроса

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

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

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

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

{
    "name": "Contoso App Campaign",
    "storeProductId": "9nblggh42cfd",
    "configuredStatus": "Active",
    "objective": "DriveInstalls",
    "type": "Community"
}

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

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign?storeProductId=9nblggh42cfd&fetch=100&skip=0&campaignSetSortColumn=createdDateTime HTTP/1.1
Authorization: Bearer <your access token>

Ответ

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

{
    "Data": {
        "id": 31043481,
        "name": "Contoso App Campaign",
        "createdDate": "2017-01-17T10:12:15Z",
        "storeProductId": "9nblggh42cfd",
        "configuredStatus": "Active",
        "effectiveStatus": "Active",
        "effectiveStatusReasons": [
            "{\"ValidationStatusReasons\":null}"
        ],
        "labels": [],
        "objective": "DriveInstalls",
        "type": "Paid",
        "lines": [
            {
                "id": 31043476,
                "name": "Contoso App Campaign - Paid Line"
            }
        ]
    }
}

Объект Кампании

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

Связанные темы

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