Получение преобразований приложения по каналуGet app conversions by channel

Используйте этот метод в API аналитики для Microsoft Store для получения сводных сведений о конверсиях по каждому каналу для приложения в заданном диапазоне дат или с учетом других дополнительных фильтров.Use this method in the Microsoft Store analytics API to get aggregate conversions by channel for an application during a given date range and other optional filters.

  • Конверсия означает, что пользователь (выполнивший вход с помощью учетной записи Майкрософт) получил новую лицензию на ваше приложение (независимо от того, берете ли вы за это деньги или предоставляете лицензию бесплатно).A conversion means that a customer (signed in with a Microsoft account) has newly obtained a license to your app (whether you charged money or you've offered it for free).
  • Канал — это способ, с использованием которого пользователь оказался на странице описания вашего приложения (например, через Магазин или настраиваемую кампанию по продвижению приложения).The channel is the method in which a customer arrived at your app's listing page (for example, via the Store or a custom app promotion campaign).

Эти сведения также доступны в отчете о приобретении в центре партнеров.This information is also available in the Acquisitions report in Partner Center.

Предварительные требованияPrerequisites

Для использования этого метода сначала необходимо сделать следующее:To use this method, you need to first do the following:

  • Если вы еще не сделали этого, выполните все необходимые условия для API аналитики для Microsoft Store.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Получите маркер доступа Azure AD, который будет использоваться в заголовке запроса этого метода.Obtain an Azure AD access token to use in the request header for this method. После получения маркера доступа у вас будет 60 минут, чтобы использовать его до истечения срока действия.After you obtain an access token, you have 60 minutes to use it before it expires. После истечения срока действия маркера можно получить новый маркер.After the token expires, you can obtain a new one.

ЗапросRequest

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

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions

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

ЗаголовокHeader ТипType ОписаниеDescription
АвторизацияAuthorization строкаstring Обязательный элемент.Required. Маркер доступа Azure AD в формате Bearer <token>.The Azure AD access token in the form Bearer <token>.

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

ПараметрParameter ТипType ОписаниеDescription Обязательное значениеRequired
applicationIdapplicationId строкаstring Код продукта в Магазине для приложения, по которому требуется получить данные о конверсиях.The Store ID of the app for which you want to retrieve conversion data. Пример кода продукта в Магазине: 9WZDNCRFJ3Q8An example Store ID is 9WZDNCRFJ3Q8. ДаYes
startDatestartDate Датаdate Начальная дата диапазона дат, для которого требуется получить данные о конверсиях.The start date in the date range of conversion data to retrieve. Значение по умолчанию: 1/1/2016.The default is 1/1/2016. НетNo
endDateendDate Датаdate Конечная дата диапазона дат, для которого требуется получить данные о конверсиях.The end date in the date range of conversion data to retrieve. По умолчанию используется текущая дата.The default is the current date. нетNo
toptop INTint Количество строк данных, возвращаемых в запросе.The number of rows of data to return in the request. Максимальное значение и значение по умолчанию (если параметр не указан) — 10 000.The maximum value and the default value if not specified is 10000. Если в запросе содержится больше строк, то тело ответа будет содержать ссылку «Далее», которую можно использовать для запроса следующей страницы данныхIf there are more rows in the query, the response body includes a next link that you can use to request the next page of data. НетNo
skipskip INTint Количество строк, пропускаемых в запросе.The number of rows to skip in the query. Используйте этот параметр для постраничного перемещения по большим наборам данных.Use this parameter to page through large data sets. Например, при top=10000 и skip=0 извлекаются первые 10 000 строк данных; при top=10000 и skip=10000 извлекаются следующие 10 000 строк данных и т. д.For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 rows of data, and so on. НетNo
фильтрfilter строкаstring Одно или несколько выражений для фильтрации текста ответа.One or more statements that filter the response body. Каждое выражение может использовать операторы eq или ne; кроме того, операторы можно объединять с помощью и или или.Each statement can use the eq or ne operators, and statements can be combined using and or or. Можно указать следующие строки в инструкциях фильтра.You can specify the following strings in the filter statements. Описания см. в разделе значения конверсии в этой статье.For descriptions, see the conversion values section in this article.
  • applicationNameapplicationName
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • channelTypechannelType
  • storeClientstoreClient
  • Типа устройстваdeviceType
  • звонкmarket

Вот пример параметра filter: filter=deviceType eq 'PC'.Here is an example filter parameter: filter=deviceType eq 'PC'.

НетNo
aggregationLevelaggregationLevel строкаstring Определяет диапазон времени, для которого требуется получить сводные данные.Specifies the time range for which to retrieve aggregate data. Можно использовать следующие строки: day, week или month.Can be one of the following strings: day, week, or month. Если параметр не задан, значение по умолчанию — day.If unspecified, the default is day. НетNo
orderbyorderby строкаstring Оператор, который определяет порядок полученных значений данных для каждой конверсии.A statement that orders the result data values for each conversion. Используется следующий синтаксис: orderby=field [order],field [order],..., где параметр field может принимать одно из следующих строковых значений:The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following strings:
  • datedate
  • applicationNameapplicationName
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • channelTypechannelType
  • storeClientstoreClient
  • Типа устройстваdeviceType
  • звонкmarket

Параметр order является необязательным и может принимать значения asc или desc, которые указывают, соответственно, порядок сортировки по возрастанию или по убыванию для каждого поля.The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. Значение по умолчанию — ASC.The default is asc.

Ниже приведен пример строки OrderBy : OrderBy = Дата, рыночнаяHere is an example orderby string: orderby=date,market

НетNo
groupbygroupby строкаstring Выражение, которое применяет агрегирование данных только к указанным полям.A statement that applies data aggregation only to the specified fields. Можно указать следующие поля:You can specify the following fields:
  • datedate
  • applicationNameapplicationName
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • channelTypechannelType
  • storeClientstoreClient
  • Типа устройстваdeviceType
  • звонкmarket

Возвращенные строки данных будут содержать поля, указанные в параметре groupby, а также:The returned data rows will contain the fields specified in the groupby parameter as well as the following:

  • datedate
  • applicationIdapplicationId
  • conversionCountconversionCount
  • clickCountclickCount

Параметр groupby можно использовать вместе с параметром aggregationLevel.The groupby parameter can be used with the aggregationLevel parameter. Например: GroupBy = возрастная группа, аггрегатионлевел рынка & = Week .For example: groupby=ageGroup,market&aggregationLevel=week

НетNo

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

В следующем примере демонстрируются несколько запросов на получение информации о конверсиях приложения.The following example demonstrates several requests for getting app conversion data. Замените значение applicationId кодом продукта в Магазине для вашего приложения.Replace the applicationId value with the Store ID for your app.

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

Текст ответаResponse body

ЗначениеValue ТипType ОписаниеDescription
ЗначениеValue arrayarray Массив объектов, содержащий сводную информацию о конверсиях для данного приложения.An array of objects that contain aggregate conversion data for the app. Дополнительные сведения о данных в каждом объекте см. далее в разделе Значения конверсии.For more information about the data in each object, see the conversion values section below.
@nextLink строкаstring При наличии дополнительных страниц данных эта строка содержит универсальный код ресурса (URI), который можно использовать для запроса следующей страницы данных.If there are additional pages of data, this string contains a URI that you can use to request the next page of data. Например, это значение возвращается в том случае, если параметр top запроса имеет значение 10 000, но для данного запроса имеется больше 10 000 строк с информацией о конверсиях.For example, this value is returned if the top parameter of the request is set to 10 but there are more than 10 rows of conversion data for the query.
TotalCountTotalCount INTint Общее количество строк в результирующих данных для запроса.The total number of rows in the data result for the query.

Значения конверсииConversion values

Объекты в массиве Value содержат следующие значения.Objects in the Value array contain the following values.

ЗначениеValue ТипType ОписаниеDescription
Датаdate строкаstring Первая дата в диапазоне дат, для которого требуется получить данные о конверсиях.The first date in the date range for the conversion data. Если в запросе указан один день, это значение равно дате, соответствующей тому дню.If the request specified a single day, this value is that date. Если запрос указывает неделю, месяц или другой диапазон дат, это значение равно первой дате в этом диапазоне дат.If the request specified a week, month, or other date range, this value is the first date in that date range.
applicationIdapplicationId строкаstring Код продукта в Магазине для приложения, по которому запрашиваются данные о конверсиях.The Store ID of the app for which you are retrieving conversion data.
applicationNameapplicationName строкаstring Отображаемое название приложения, по которому запрашиваются данные о конверсиях.The display name of the app for which you are retrieving conversion data.
appTypeappType строкаstring Тип продукта, для которого запрашиваются данные о конверсиях.The type of the product for which you are retrieving conversion data. Для этого метода единственным поддерживаемым значением является App.For this method, the only supported value is App.
customCampaignIdcustomCampaignId строкаstring Строка идентификатора для пользовательской кампании по продвижению приложения, связанной с этим приложением.The ID string for a custom app promotion campaign that is associated with the app.
referrerUriDomainreferrerUriDomain строкаstring Указывает домен, на котором было активировано описание приложения с идентификатором настраиваемой кампании по продвижению приложения.Specifies the domain where the app listing with the custom app promotion campaign ID was activated.
channelTypechannelType строкаstring Одно из следующих строковых значений, определяющих канал конверсии:One of the following strings that specifies the channel for the conversion:
  • кустомкампаигнидCustomCampaignId
  • Трафик МагазинаStore Traffic
  • ДругоеOther
storeClientstoreClient строкаstring Версия Магазина, в котором произведена конверсия.The version of the Store where the conversion occurred. На данный момент единственным поддерживаемым значением является SFC.Currently, the only supported value is SFC.
deviceTypedeviceType строкаstring Одна из следующих строк:One of the following strings:
  • ACPIPC
  • ФаксPhone
  • Консоль — Xbox OneConsole-Xbox One
  • Консоль — серия Xbox XConsole-Xbox Series X
  • Интернет вещейIoT
  • Holographic (голография),Holographic
  • UnknownUnknown
marketmarket строкаstring Код страны по стандарту ISO 3166 для рынка, на котором произошла конверсия.The ISO 3166 country code of the market where the conversion occurred.
clickCountclickCount numbernumber Число пользователей, щелкнувших по ссылке на описание вашего приложения.The number of customer clicks on your app listing link.
conversionCountconversionCount numbernumber Количество конверсий пользователей.The number of customer conversions.

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

В следующем примере демонстрируется пример тела ответа JSON на данный запрос.The following example demonstrates an example JSON response body for this request.

{
  "Value": [
    {
      "date": "2016-01-01",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso App",
      "appType": "App",
      "customCampaignId": "",
      "referrerUriDomain": "Universal Client Store",
      "channelType": "Store Traffic",
      "storeClient": "SFC",
      "deviceType": "PC",
      "market": "US",
      "clickCount": 7,
      "conversionCount": 0
    }
  ],
  "@nextLink": null,
  "TotalCount": 1
}