Получение данных о производительности рекламной кампании
Используйте этот метод в API аналитики Microsoft Store, чтобы получить сводную сводку данных о производительности рекламной кампании для приложений в течение заданного диапазона дат и других необязательных фильтров. Этот метод возвращает данные в формате JSON.
Этот метод возвращает те же данные, которые предоставляются отчетом рекламной кампании в Центре партнеров. Дополнительные сведения о рекламных кампаниях см. в статье "Создание рекламной кампании для приложения".
Для создания, обновления или получения сведений о рекламных кампаниях можно использовать методы управления рекламными кампаниями в API рекламных кампаний в Microsoft Store.
Необходимые компоненты
Чтобы использовать этот метод, сначала необходимо выполнить следующие действия:
- Если это еще не сделано, выполните все предварительные требования для API аналитики Microsoft Store.
- Получите маркер доступа Azure AD для использования в заголовке запроса для этого метода. После получения маркера доступа у вас будет 60 минут, чтобы использовать его до истечения срока действия. После истечения срока действия маркера можно получить новый.
Запросить
Синтаксис запроса
| Способ | URI запроса |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion |
Заголовок запроса
| Верхний колонтитул | Тип | Описание |
|---|---|---|
| Авторизация | строка | Обязательный. Маркер доступа Azure AD в маркере> носителя<формы. |
Параметры запроса
Чтобы получить данные о производительности рекламной кампании для конкретного приложения, используйте параметр applicationId . Чтобы получить данные о производительности рекламы для всех приложений, связанных с учетной записью разработчика, опустите параметр applicationId .
| Параметр | Тип | Описание | Обязательное поле |
|---|---|---|---|
| applicationId | строка | Идентификатор приложения, для которого требуется получить данные о производительности рекламной кампании. | No |
| startDate | Дата | Дата начала в диапазоне дат данных о производительности рекламной кампании для получения в формате ГГГГ/ММ/ДД. Значение по умолчанию — текущая дата минус 30 дней. | No |
| endDate | Дата | Дата окончания в диапазоне дат для получения данных о производительности рекламной кампании в формате ГГГГ/ММ/ДД. Значение по умолчанию — текущая дата минус один день. | No |
| популярное | INT | Количество строк данных, возвращаемых в запросе. Максимальное значение и значение по умолчанию, если не указано значение 10000. Если в запросе есть больше строк, текст ответа содержит следующую ссылку, которую можно использовать для запроса следующей страницы данных. | No |
| skip | INT | Количество строк, пропускаемых в запросе. Используйте этот параметр для страницы с помощью больших наборов данных. Например, top=10000 и skip=0 извлекает первые 10000 строк данных, top=10000 и skip=10000 извлекает следующие 10000 строк данных и т. д. | No |
| Фильтр | строка | Одна или несколько инструкций, которые фильтруют строки в ответе. Единственным поддерживаемым фильтром является campaignId. Каждая инструкция может использовать операторы eq или ne, а операторы можно объединить с помощью и или. Ниже приведен пример параметра фильтра: filter=campaignId eq '100023' |
No |
| aggregationLevel | строка | Указывает диапазон времени, для которого требуется получить статистические данные. Может быть одной из следующих строк: день, неделя или месяц. Если не указано, значение по умолчанию равно дню. | No |
| orderby | строка | Инструкция, которая упорядочивает значения результатов для данных о производительности рекламной кампании. Синтаксис — orderby=field [order], field [order],.... Параметр поля может быть одной из следующих строк:
Параметр order является необязательным и может быть asc или desc , чтобы указать возрастание или убывание для каждого поля. Значение по умолчанию — asc. Ниже приведен пример строки заказа : orderby=date,campaignId |
No |
| groupby | строка | Инструкция, которая применяет агрегирование данных только к указанным полям. Можно указать следующие поля:
Параметр groupby можно использовать с параметром aggregationLevel . Например: &groupby=applicationId&aggregationLevel=week |
No |
Пример запроса
В следующем примере показано несколько запросов на получение данных о производительности рекламной кампании.
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?aggregationLevel=week&groupby=applicationId,campaignId,date HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?applicationId=9NBLGGH0XK8Z&startDate=2015/1/20&endDate=2016/8/31&skip=0&filter=campaignId eq '31007388' HTTP/1.1
Authorization: Bearer <your access token>
Response
Текст ответа
| Значение | Тип | Описание |
|---|---|---|
| Значение | array | Массив объектов, содержащих статистические данные о производительности рекламной кампании. Дополнительные сведения о данных в каждом объекте см . в разделе "Объект производительности кампании" ниже. |
| @nextLink | строка | Если есть дополнительные страницы данных, эта строка содержит универсальный код ресурса (URI), который можно использовать для запроса следующей страницы данных. Например, это значение возвращается, если верхний параметр запроса имеет значение 5, но для запроса имеется более 5 элементов данных. |
| TotalCount | INT | Общее количество строк в результатах данных для запроса. |
Объект производительности кампании
Элементы в массиве значений содержат следующие значения.
| Значение | Тип | Описание |
|---|---|---|
| Дата | строка | Первая дата в диапазоне дат для данных о производительности рекламной кампании. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат. |
| applicationId | строка | Идентификатор магазина приложения, для которого извлекаются данные о производительности рекламной кампании. |
| campaignId | строка | Идентификатор рекламной кампании. |
| lineId | строка | Идентификатор строки доставки рекламной кампании, создающей эти данные о производительности. |
| currencyCode | строка | Код валюты бюджета кампании. |
| тратить | строка | Сумма бюджета, которая была потрачена на рекламную кампанию. |
| Впечатления | длинный | Количество объявлений для кампании. |
| Установки | длинный | Количество установок приложений, связанных с кампанией. |
| clicks | длинный | Количество щелчков рекламы для кампании. |
| iapInstalls | длинный | Количество установок надстройки (также называемой покупкой в приложении или IAP), связанной с кампанией. |
| activeUsers | длинный | Количество пользователей, которые щелкнули рекламу, которая входит в кампанию и вернулась в приложение. |
Пример ответа
В следующем примере показан пример текста ответа JSON для этого запроса.
{
"Value": [
{
"date": "2015-04-12",
"applicationId": "9WZDNCRFJ31Q",
"campaignId": "4568",
"lineId": "0001",
"currencyCode": "USD",
"spend": 700.6,
"impressions": 200,
"installs": 30,
"clicks": 8,
"iapInstalls": 0,
"activeUsers": 0
},
{
"date": "2015-05-12",
"applicationId": "9WZDNCRFJ31Q",
"campaignId": "1234",
"lineId": "0002",
"currencyCode": "USD",
"spend": 325.3,
"impressions": 20,
"installs": 2,
"clicks": 5,
"iapInstalls": 0,
"activeUsers": 0
}
],
"@nextLink": "promotion?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2015/1/20&endDate=2016/8/31&top=2&skip=2",
"TotalCount": 1917
}