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

Статья
01/10/2024

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

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

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

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

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

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

Запросить

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

Способ	URI запроса
GET	`https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance`

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

Верхний колонтитул	Тип	Описание
Авторизация	строка	Обязательный. Маркер доступа 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
Фильтр	строка	Одна или несколько инструкций, которые фильтруют строки в ответе. Дополнительные сведения см. в разделе полей фильтра ниже.	No
aggregationLevel	строка	Указывает диапазон времени, для которого требуется получить статистические данные. Может быть одной из следующих строк: день, неделя или месяц. Если не указано, значение по умолчанию равно дню.	No
orderby	строка	Инструкция, которая упорядочивает значения результирующих данных. Синтаксис — orderby=field [order], field [order],.... Параметр поля может быть одной из следующих строк: date рынок deviceType adUnitId Параметр order является необязательным и может быть asc или desc , чтобы указать возрастание или убывание для каждого поля. Значение по умолчанию — asc. Ниже приведен пример строки заказа : orderby=date,market	No
groupby	строка	Инструкция, которая применяет агрегирование данных только к указанным полям. Можно указать следующие поля: applicationId applicationName date accountCurrencyCode рынок deviceType adUnitName adUnitId pubCenterAppName adProvider Параметр groupby можно использовать с параметром aggregationLevel . Например: &groupby=applicationId&aggregationLevel=week	No

Поля фильтра

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

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

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

Поле	Description
на рынок	Строка, содержащая код страны ISO 3166 рынка, в котором были обслуживались объявления.
deviceType	Одна из следующих строк: 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>

Response

Текст ответа

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

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

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

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

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

В следующем примере показан пример текста ответа 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
}

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

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

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

Запросить

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

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

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

Поля фильтра

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

Response

Текст ответа

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

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

Обратная связь

Дополнительные ресурсы

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

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

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

Запросить

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

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

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

Поля фильтра

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

Response

Текст ответа

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

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

См. также

Обратная связь

Дополнительные ресурсы