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

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

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

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

Предпосылки

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

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

Просьба

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

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

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

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

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

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

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

Инструкция, которая упорядочивает значения результатов для данных о производительности рекламной кампании. Синтаксис — orderby=field [order], field [order],.... Параметр field может быть одной из следующих строк:

  • дата
  • кампании

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

Ниже приведен пример строки orderby: orderby=date,campaignId

 нет
ГруппаПо струна

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

  • кампании
  • applicationId
  • дата
  • код валюты

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

 нет

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

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

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>

Ответ

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

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

Объект эффективности кампании

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

Ценность Тип Описание
дата струна Первая дата в диапазоне дат для данных о производительности рекламной кампании. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат.
applicationId струна Идентификатор магазина приложения, для которого извлекаются данные о производительности рекламной кампании.
идентификатор кампании струна Идентификатор рекламной кампании.
идентификатор линии струна Идентификатор линии доставки рекламной кампании , которая сгенерировала эти данные о производительности.
Код валюты струна Код валюты бюджета кампании.
тратить струна Сумма бюджета, которая была потрачена на рекламную кампанию.
Впечатления долго Количество показов объявлений для кампании.
Устанавливает долго Количество установок приложений, связанных с кампанией.
Щелчки долго Количество кликов по рекламе для кампании.
iapInstalls долго Количество установок дополнений (также называемых покупками в-приложении или IAP), связанных с этой кампанией.
активные пользователи долго Количество пользователей, которые щелкнули рекламу, которая входит в кампанию и вернулась в приложение.

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

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