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

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

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

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

Предпосылки

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

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

Просьба

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

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

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

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

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

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

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

нет
уровень агрегации струна Указывает диапазон времени, для которого требуется получить статистические данные. Может быть одной из следующих строк: день, неделя или месяц. Если не указано, значение по умолчанию равно дню. нет
сортировать по струна Инструкция, которая упорядочивает значения результирующих данных для каждого преобразования. Синтаксис — orderby=field [order], field [order],.... Параметр field может быть одной из следующих строк:
  • дата
  • applicationName
  • inAppProductName
  • тип приложения
  • customCampaignId
  • домен URL-адреса реферера
  • Тип канала
  • storeClient
  • тип устройства
  • рынок

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

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

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

  • дата
  • applicationName
  • inAppProductName
  • тип приложения
  • customCampaignId
  • домен URL-адреса реферера
  • Тип канала
  • storeClient
  • тип устройства
  • рынок

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

  • дата
  • applicationId
  • inAppProductId
  • inAppProductName
  • количество преобразований
  • количествоКликов

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

нет

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

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

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

Ответ

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

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

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

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

Ценность Тип Описание
дата струна Первая дата в диапазоне дат для данных преобразования. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат.
ИдентификаторПродуктаВПриложении струна Идентификатор хранилища для надстройки, из которой извлекаются данные конверсии.
название продукта в приложении струна Отображаемое имя надстройки, для которого вы извлекаете данные о конверсиях.
applicationId струна Идентификатор магазина приложения, для которого вы извлекаете данные о конверсии.
название приложения струна Отображаемое имя приложения, для которого извлекаются данные преобразования.
тип приложения струна Тип продукта, для которого извлекаются данные преобразования. Для этого метода единственным поддерживаемым значением является надстройка .
customCampaignId (идентификатор пользовательской кампании) струна Строка идентификатора для кампании по продвижению пользовательского приложения, связанной с приложением.
домен URI источника струна Указывает домен, в котором был активирован список приложений с идентификатором кастомизированной кампании по продвижению приложений.
Тип канала струна Одна из следующих строк, задающая канал для преобразования:
  • CustomCampaignId
  • Хранение трафика
  • Другое
storeClient струна Версия Магазина, в которой произошло преобразование. В настоящее время единственным поддерживаемым значением является SFC.
тип устройства струна Одна из следующих строк:
  • ПК
  • Телефон
  • Console-Xbox One
  • Консоль Xbox Series X
  • Интернет вещей
  • Голографический
  • Неизвестный
рынок струна Код страны ISO 3166 рынка, в котором произошло преобразование.
количество кликов число/номер Количество кликов пользователей по ссылке на страницу вашего приложения.
число конверсий число/номер Количество конверсий клиентов.

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

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2019&endDate=12/20/2021&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

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

{
    "Value": [
        {
            "inAppProductId": "9NN2HW33ZB2G",
            "applicationId": "9NBLGGGZ5QDR",
            "clickCount": 220636,
            "conversionCount": 154
        },
        {
            "inAppProductId": "9PN07J0WC18B",
            "applicationId": "9NBLGGGZ5QDR",
            "clickCount": 277061,
            "conversionCount": 187
        }
    ],
    "@nextLink": "",
    "TotalCount": 2
}

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=12/20/2021&top=10&skip=0&groupby=date,applicationName,inAppProductName,appType,customCampaignId,referrerUriDomain,channelType,storeClient,deviceType,market
HTTP/1.1
Authorization: Bearer <your access token>

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

{
    "Value": [
        {
            "inAppProductId": "9WZDNCRCWW61",
            "inAppProductName": "SeasonPass0",
            "appType": "Add-On",
            "date": "2022-06-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "mcg_mahjong_othergames",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "BR",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5H",
            "inAppProductName": "OEMFreePurchase",
            "appType": "Add-On",
            "date": "2022-07-06",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "mcg_solitaire_othergames",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "AT",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5Z",
            "inAppProductName": "Episode1Combo",
            "appType": "Add-On",
            "date": "2022-07-09",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5H",
            "inAppProductName": "OEMFreePurchase",
            "appType": "Add-On",
            "date": "2022-07-09",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW4Z",
            "inAppProductName": "Episode1Grandfathered",
            "appType": "Add-On",
            "date": "2022-07-11",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "|autosuggest",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "ES",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5W",
            "inAppProductName": "Episode2Combo",
            "appType": "Add-On",
            "date": "2022-07-11",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW4P",
            "inAppProductName": "SeasonPass24",
            "appType": "Add-On",
            "date": "2022-07-12",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5H",
            "inAppProductName": "OEMFreePurchase",
            "appType": "Add-On",
            "date": "2022-07-13",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "9wzdncrfjbd8",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CA",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW61",
            "inAppProductName": "SeasonPass0",
            "appType": "Add-On",
            "date": "2022-07-17",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "scom-web-store",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "US",
            "clickCount": 1,
            "conversionCount": 1
        }
    ],
    "@nextLink": "",
    "TotalCount": 9
}