Получение данных воронки приобретений приложенияGet app acquisition funnel data

Используйте этот метод в API аналитики для Microsoft Store для получения данных о воронке приобретений приложения в заданном диапазоне дат или с учетом других дополнительных фильтров.Use this method in the Microsoft Store analytics API to get acquisition funnel data for an application during a given date range and other optional filters. Эти сведения также доступны в отчете о приобретении в центре партнеров.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/funnel

Заголовок запроса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 acquisition funnel data. Пример кода продукта в Магазине: 9WZDNCRFJ3Q8An example Store ID is 9WZDNCRFJ3Q8. ДаYes
startDatestartDate Датаdate Начальная дата диапазона дат, для которого требуется получить данные о воронке приобретений.The start date in the date range of acquisition funnel data to retrieve. По умолчанию используется текущая дата.The default is the current date. НетNo
endDateendDate Датаdate Конечная дата диапазона дат, для которого требуется получить данные о воронке приобретений.The end date in the date range of acquisition funnel data to retrieve. По умолчанию используется текущая дата.The default is the current date. НетNo
фильтрfilter строкаstring Одно или несколько выражений для фильтрации строк в ответе.One or more statements that filter the rows in the response. Дополнительные сведения см. далее в разделе фильтрация полейFor more information, see the filter fields section below. НетNo

 

Поля фильтраFilter fields

Параметр filter запроса содержит один или несколько операторов, фильтрующих строки в ответе.The filter parameter of the request contains one or more statements that filter the rows in the response. Каждый оператор содержит поле и значение, которые связаны с операторами выражения eq или ne; операторы можно комбинировать с помощью and или or.Each statement contains a field and value that are associated with the eq or ne operators, and statements can be combined using and or or.

Поддерживаются следующие поля фильтра.The following filter fields are supported. В параметре filter строковые значения должны быть заключены в одиночные кавычки.String values must be surrounded by single quotes in the filter parameter.

ПоляFields ОписаниеDescription
campaignIdcampaignId Строка идентификатора для пользовательской кампании по продвижению приложения, связанной с этим приобретением.The ID string for a custom app promotion campaign that is associated with the acquisition.
marketmarket Строка, содержащая код страны по стандарту ISO 3166 для рынка, на котором произошла покупкаA string that contains the ISO 3166 country code of the market where the acquisition occurred.
deviceTypedeviceType Одна из следующих строк, указывающая тип устройства, на котором совершено приобретение:One of the following strings that specifies the device type on which the acquisition occurred:
  • ACPIPC
  • ФаксPhone
  • Консоль — Xbox OneConsole-Xbox One
  • Консоль — серия Xbox XConsole-Xbox Series X
  • Интернет вещейIoT
  • Holographic (голография),Holographic
  • UnknownUnknown
ageGroupageGroup Одна из следующих строк, указывающая возрастную группу пользователя, совершившего приобретение:One of the following strings that specifies the age group of the user who completed the acquisition:
  • 0–170 – 17
  • 18–2418 – 24
  • 25–3425 – 34
  • 35–4935 – 49
  • 50 и более50 or over
  • UnknownUnknown
gendergender Одна из следующих строк, указывающая пол пользователя, совершившего приобретение:One of the following strings that specifies the gender of the user who completed the acquisition:
  • MM
  • ЖF
  • UnknownUnknown

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

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=8/1/2016&endDate=8/31/2016&filter=market eq 'US' and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

ОтветResponse

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

ЗначениеValue ТипType ОписаниеDescription
ЗначениеValue arrayarray Массив объектов, содержащий сводную информацию о воронке приобретений для данного приложения.An array of objects that contain acquisition funnel data for the app. Дополнительные сведения о данных в каждом объекте см. далее в разделе значения воронки.For more information about the data in each object, see the funnel values section below.
TotalCountTotalCount INTint Общее число объектов в массиве Value.The total number of objects in the Value array.

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

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

ЗначениеValue ТипType ОписаниеDescription
MetricTypeMetricType строкаstring Одна из следующих строк, задающих тип данных воронки, включенный в этот объект:One of the following strings that specifies the type of funnel data that is included in this object:
  • PageViewPageView
  • ПолучениеAcquisition
  • УстановкаInstall
  • ИспользованиеUsage
UserCountUserCount строкаstring Количество пользователей, которые выполнили шаг воронки, определяемый значением MetricType.The number of users who performed the funnel step specified by the MetricType value.

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

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

{
  "Value": [
    {
      "MetricType": "PageView",
      "UserCount": 100
    },
    {
      "MetricType": "Acquisition",
      "UserCount": 80
    },
    {
      "MetricType": "Install",
      "UserCount": 50
    },
    {
      "MetricType": "Usage",
      "UserCount": 10
    }
  ],
  "TotalCount": 4
}