Получение преобразований приложения по каналу

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

  • Преобразование означает, что клиент (вошедшего с помощью учетной записи Майкрософт) получил лицензию на ваше приложение (независимо от того, взимаете ли вы деньги или предложили его бесплатно).
  • Канал — это метод, в котором клиент прибыл на страницу описания вашего приложения (например, через Магазин или пользовательскую кампанию по продвижению приложений).

Эти сведения также доступны в отчете о приобретениях в Центре партнеров.

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

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

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

Запросить

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

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

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

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

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

Параметр Тип Описание Обязательное поле
applicationId строка Идентификатор магазина приложения, для которого требуется получить данные преобразования. Пример идентификатора магазина — 9WZDNCRFJ3Q8. Да
startDate Дата Дата начала в диапазоне дат для получения данных преобразования. Значение по умолчанию — 1.1.2016. No
endDate Дата Дата окончания в диапазоне дат для получения данных преобразования. Значение по умолчанию — текущая дата. No
популярное INT Количество строк данных, возвращаемых в запросе. Максимальное значение и значение по умолчанию, если не указано значение 10000. Если в запросе есть больше строк, текст ответа содержит следующую ссылку, которую можно использовать для запроса следующей страницы данных. No
skip INT Количество строк, пропускаемых в запросе. Используйте этот параметр для страницы с помощью больших наборов данных. Например, top=10000 и skip=0 извлекает первые 10000 строк данных, top=10000 и skip=10000 извлекает следующие 10000 строк данных и т. д. No
Фильтр строка Один или несколько операторов, которые фильтруют текст отклика. Каждая инструкция может использовать операторы eq или ne, а операторы можно объединить с помощью и или. В инструкциях фильтра можно указать следующие строки. Описание см . в разделе "Значения преобразования" в этой статье.
  • applicationName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • Рынке

Ниже приведен пример параметра фильтра: filter=deviceType eq "PC".

No
aggregationLevel строка Указывает диапазон времени, для которого требуется получить статистические данные. Может быть одной из следующих строк: день, неделя или месяц. Если не указано, значение по умолчанию равно дню. No
orderby строка Инструкция, которая упорядочивает значения результирующих данных для каждого преобразования. Синтаксис — orderby=field [order], field [order],.... Параметр поля может быть одной из следующих строк:
  • date
  • applicationName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • Рынке

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

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

No
Groupby строка Инструкция, которая применяет агрегирование данных только к указанным полям. Можно указать следующие поля:
  • date
  • applicationName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • Рынке

Возвращаемые строки данных будут содержать поля, указанные в параметре groupby , а также следующие:

  • date
  • applicationId
  • conversionCount
  • clickCount

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

No

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

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=4/31/2017&skip=0&filter=market eq 'US'  HTTP/1.1
Authorization: Bearer <your access token>

Response

Текст ответа

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

Значения преобразования

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

Значение Тип Описание
Дата строка Первая дата в диапазоне дат для данных преобразования. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат.
applicationId строка Идентификатор магазина приложения, для которого извлекаются данные преобразования.
applicationName строка Отображаемое имя приложения, для которого извлекаются данные преобразования.
appType строка Тип продукта, для которого извлекаются данные преобразования. Для этого метода единственным поддерживаемым значением является App.
customCampaignId строка Строка идентификатора для пользовательской кампании по продвижению приложений, связанной с приложением.
referrerUriDomain строка Указывает домен, в котором был активирован список приложений с идентификатором пользовательской кампании по продвижению приложений.
channelType строка Одна из следующих строк, задающая канал для преобразования:
  • CustomCampaignId
  • Хранение трафика
  • Другое
storeClient строка Версия Магазина, в которой произошло преобразование. В настоящее время единственным поддерживаемым значением является SFC.
deviceType строка Одна из следующих строк:
  • ПК
  • Для телефонов
  • Console-Xbox One
  • Серия Xbox X консоли
  • Интернет вещей
  • Голографической
  • Unknown
на рынок строка Код страны ISO 3166 рынка, в котором произошло преобразование.
clickCount number Число клиентов щелкает ссылку на список приложений.
conversionCount number Количество преобразований клиентов.

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

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=06/23/2022&endDate=07/21/2022&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

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

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "clickCount": 3089,
            "conversionCount": 14
        }
    ],
    "@nextLink": "",
    "TotalCount": 1
}

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=06/19/2022&endDate=07/21/2022&skip=0&groupby=date,applicationName,customCampaignId,referrerUriDomain,channelType,storeClient,deviceType,market&filter=market eq 'US'
HTTP/1.1
Authorization: Bearer <your access token>

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

{
    "Value": [
        {
            "date": "2022-06-19",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "",
            "referrerUriDomain": "Universal Client Store",
            "channelType": "Store Traffic",
            "storeClient": "SFC",
            "deviceType": "PC",
            "market": "US",
            "clickCount": 13,
            "conversionCount": 0
        },
        {
            "date": "2022-06-20",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "",
            "referrerUriDomain": "Universal Client Store",
            "channelType": "Store Traffic",
            "storeClient": "SFC",
            "deviceType": "PC",
            "market": "US",
            "clickCount": 6,
            "conversionCount": 0
        },
        {
            "date": "2022-06-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "",
            "referrerUriDomain": "Universal Client Store",
            "channelType": "Store Traffic",
            "storeClient": "SFC",
            "deviceType": "PC",
            "market": "US",
            "clickCount": 4,
            "conversionCount": 0
        },
        {
            "date": "2022-06-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "",
            "referrerUriDomain": "Universal Client Store",
            "channelType": "Store Traffic",
            "storeClient": "SFC",
            "deviceType": "PC",
            "market": "US",
            "clickCount": 4,
            "conversionCount": 0
        },
    ],
    "@nextLink": "",
    "TotalCount": 4
}