Получение сведений о конверсии надстройки по каналу

Статья
01/10/2024

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

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

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

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

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

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

Запросить

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

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

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

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

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

Параметр	Тип	Описание	Обязательное поле
applicationId	строка	Идентификатор приложения, для которого требуется получить данные преобразования надстроек. Пример идентификатора магазина — 9WZDNCRFJ3Q8.	Да
inAppProductId	строка	Идентификатор хранилища надстройки, для которой требуется получить данные преобразования.	Да
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 inAppProductName appType customCampaignId referrerUriDomain channelType storeClient deviceType рынок Параметр order является необязательным и может быть asc или desc , чтобы указать возрастание или убывание для каждого поля. Значение по умолчанию — asc. Ниже приведен пример строки заказа : orderby=date,market	No
groupby	строка	Инструкция, которая применяет агрегирование данных только к указанным полям. Можно указать следующие поля: date applicationName inAppProductName appType customCampaignId referrerUriDomain channelType storeClient deviceType рынок Возвращаемые строки данных будут содержать поля, указанные в параметре groupby , а также следующие: date applicationId inAppProductId inAppProductName conversionCount clickCount Параметр groupby можно использовать с параметром aggregationLevel . Например: groupby=ageGroup,market&aggregationLevel=week	No

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

В следующем примере показано несколько запросов на получение данных преобразования приложений. Замените значение 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>

Response

Текст ответа

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

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

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

Значение	Тип	Описание
Дата	строка	Первая дата в диапазоне дат для данных преобразования. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат.
inAppProductId	строка	Идентификатор хранилища надстройки, для которой извлекаются данные преобразования.
inAppProductName	строка	Отображаемое имя надстройки, для которой извлекаются данные преобразования.
applicationId	строка	Идентификатор магазина приложения, для которого извлекаются данные преобразования.
applicationName	строка	Отображаемое имя приложения, для которого извлекаются данные преобразования.
appType	строка	Тип продукта, для которого извлекаются данные преобразования. Для этого метода единственным поддерживаемым значением является надстройка.
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/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
}

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

Получение сведений о конверсии надстройки по каналу

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

Запросить

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

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

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

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

Response

Текст ответа

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

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

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

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

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

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

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

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

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

Получение сведений о конверсии надстройки по каналу

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

Запросить

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

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

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

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

Response

Текст ответа

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

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

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

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

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

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

См. также

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

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