Получение данных о производительности рекламы

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

Этот метод возвращает те же данные, которые предоставляются отчетом о производительности рекламы в Центре партнеров.

Предпосылки

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

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

Дополнительные сведения см. в разделе "Доступ к данным аналитики с помощью служб Microsoft Store".

Просьба

Синтаксис запроса

Метод Запрос URI
ПОЛУЧАЙ https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance

Заголовок запроса

Заголовок Тип Описание
Авторизация струна Обязательное. Маркер доступа Azure AD в форме Bearer<токен>.

Параметры запроса

Чтобы получить данные о производительности рекламы для конкретного приложения, используйте параметр applicationId . Чтобы получить данные о производительности рекламы для всех приложений, связанных с учетной записью разработчика, опустите параметр applicationId .

Параметр Тип Описание Обязательно
applicationId струна Идентификатор приложения, для которого требуется получить данные о производительности рекламы. нет
Дата начала дата Дата начала в диапазоне дат для извлечения данных о производительности рекламы в формате ГГГГ/ММ/ДД. Значение по умолчанию — текущая дата минус 30 дней. нет
Дата окончания дата Дата окончания в формате ГГГГ/ММ/ДД в диапазоне дат, для которых нужно получить данные о производительности рекламы. Значение по умолчанию — текущая дата минус один день. нет
Верх инт Количество строк данных, возвращаемых в запросе. Максимальное значение и значение по умолчанию, если не указано значение 10000. Если в запросе есть больше строк, текст ответа содержит следующую ссылку, которую можно использовать для запроса следующей страницы данных. нет
пропустить инт Количество строк, пропускаемых в запросе. Используйте этот параметр для навигации по большим наборам данных. Например, top=10000 и skip=0 извлекает первые 10000 строк данных, top=10000 и skip=10000 извлекает следующие 10000 строк данных и т. д. нет
фильтр струна Одна или несколько инструкций, которые фильтруют строки в ответе. Для получения дополнительной информации см. раздел поля фильтрации ниже. нет
уровень агрегации струна Указывает диапазон времени, для которого требуется получить статистические данные. Может быть одной из следующих строк: день, неделя или месяц. Если не указано, значение по умолчанию равно дню. нет
сортировать по струна Инструкция, которая упорядочивает значения результирующих данных. Синтаксис — orderby=field [order], field [order],.... Параметр поля может быть одной из следующих строк:
  • дата
  • рынок
  • тип устройства
  • adUnitId

Параметр order является необязательным и может быть asc или desc , чтобы указать возрастание или убывание для каждого поля. Значение по умолчанию — asc.

Пример строки orderby: orderby=date,market

нет
ГруппаПо струна Инструкция, которая применяет агрегирование данных только к указанным полям. Можно указать следующие поля:

  • applicationId
  • applicationName
  • дата
  • accountCurrencyCode
  • рынок
  • тип устройства
  • adUnitName
  • adUnitId
  • pubCenterAppName
  • adProvider

Параметр groupby можно использовать с параметром aggregationLevel . Например: &groupby=applicationId&aggregationLevel=week

нет

Фильтрация полей

Параметр фильтра текста запроса содержит одну или несколько инструкций, которые фильтруют строки в ответе. Каждая инструкция содержит поле и значение, связанное с операторами eq или ne, и операторы могут объединяться с помощью илиили. Ниже приведен пример параметра фильтра :

  • filter=market eq 'US' и deviceType eq 'phone'

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

Поле Описание
рынок Строка, содержащая код страны по ISO 3166 для рынка, на котором были показаны объявления.
тип устройства Одна из следующих строк: PC/Tablet или Phone.
adUnitId Строка, указывающая идентификатор рекламного блока для применения к фильтру.
pubCenterAppName Строка, указывающая имя pubCenter для текущего приложения, которое следует применить к фильтру.
adProvider Строка, указывающая имя поставщика рекламы для применения к фильтру.
дата Строка, задающая дату в формате ГГГГ/ММ/ДД для применения к фильтру.

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

В следующем примере показано несколько запросов на получение данных о производительности рекламы. Замените значение applicationId идентификатором Магазина для приложения.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance?applicationId=9NBLGGH4R315&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance?applicationId=9NBLGGH4R315&startDate=8/1/2015&endDate=8/31/2015&skip=0&$filter=market eq 'US' and deviceType eq 'phone’ eq 'US'; and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

Ответ

Основная часть ответа

Ценность Тип Описание
Ценность массив Массив объектов, содержащих статистические данные о производительности рекламы. Дополнительные сведения о данных в каждом объекте см. в разделе "Значения производительности рекламы " ниже.
@nextLink струна Если есть дополнительные страницы данных, эта строка содержит универсальный код ресурса (URI), который можно использовать для запроса следующей страницы данных. Например, это значение возвращается, если верхний параметр запроса имеет значение 5, но для запроса имеется более 5 элементов данных.
Общее количество инт Общее количество строк в результатах данных для запроса.

Значения производительности рекламы

Элементы в массиве значений содержат следующие значения.

Ценность Тип Описание
дата струна Первая дата в диапазоне дат для данных о производительности рекламы. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат.
applicationId струна Идентификатор магазина приложения, для которого извлекаются данные о производительности рекламы.
название приложения струна Отображаемое имя приложения.
adUnitId струна Идентификатор рекламного блока.
adUnitName струна Имя рекламного блока, указанное разработчиком в Центре партнеров.
adProvider струна Имя поставщика рекламы
тип устройства струна Тип устройства, на котором показывались объявления. Список поддерживаемых строк см. в разделе поля фильтра выше.
рынок струна Код страны ISO 3166 для рынка, на котором обслуживались объявления.
КодВалютыСчета струна Код валюты для учетной записи.
pubCenterAppName струна Имя приложения pubCenter, связанного с приложением в Центре партнеров.
запросы к поставщикам рекламы инт Количество запросов рекламы для указанного поставщика рекламы.
Впечатления инт Количество показов объявлений.
Щелчки инт Количество щелчков рекламы.
Доход в валюте счёта число/номер Доход в валюте для страны или региона счета.
Запросы инт Количество рекламных запросов.

Пример ответа

В следующем примере показан пример текста ответа JSON для этого запроса.

{
  "Value": [
    {
      "date": "2015-03-09",
      "applicationId": "9NBLGGH4R315",
      "applicationName": "Contoso Demo",
      "market": "US",
      "deviceType": "phone",
      "adUnitId":"10765920",
      "adUnitName":"TestAdUnit",
      "revenueInAccountCurrency": 10.0,
      "impressions": 1000,
      "requests": 10000,
      "clicks": 1,
      "accountCurrencyCode":"USD"
    },
    {
      "date": "2015-03-09",
      "applicationId": "9NBLGGH4R315",
      "applicationName": "Contoso Demo",
      "market": "US",
      "deviceType": "phone",
      "adUnitId":"10795110",
      "adUnitName":"TestAdUnit2",
      "revenueInAccountCurrency": 20.0,
      "impressions": 2000,
      "requests": 20000,
      "clicks": 3,
      "accountCurrencyCode":"USD"
    },
  ],
  "@nextLink": "adsperformance?applicationId=9NBLGGH4R315&aggregationLevel=week&startDate=2015/03/01&endDate=2016/02/01&top=2&skip=2",
  "TotalCount": 191753
}