Получение сведений о покупках приложенияGet app acquisitions

Используйте этот метод в API аналитики Microsoft Store для получения сводных данных в формате JSON для приложения в заданном диапазоне дат или с учетом других дополнительных фильтров.Use this method in the Microsoft Store analytics API to get aggregate acquisition data in JSON format 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/appacquisitions

Заголовок запроса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 Код продукта в Store для приложения, по которому требуется получить данные о покупках IAP.The Store ID of the app for which you want to retrieve acquisition data. ДаYes
startDatestartDate Датаdate Начальная дата диапазона дат, для которого требуется получить данные о покупках.The start date in the date range of acquisition data to retrieve. По умолчанию используется текущая дата.The default is the current date. НетNo
endDateendDate Датаdate Конечная дата диапазона дат, для которого требуется получить данные о покупках.The end date in the date range of acquisition 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 rows in the response. Каждое выражение содержит имя поля из тела ответа и значение, которое связано с помощью операторов eq или ne; выражения можно комбинировать, используя операторы and или or.Each statement contains a field name from the response body and value that are associated with the eq or ne operators, and statements can be combined using and or or. В параметре filter строковые значения должны быть заключены в одиночные кавычки.String values must be surrounded by single quotes in the filter parameter. Например, filter=market eq 'US' and gender eq 'm'.For example, filter=market eq 'US' and gender eq 'm'.

Вы можете указать следующие поля из тела ответа:You can specify the following fields from the response body:

  • Тип приобретенияacquisitionType
  • ageGroupageGroup
  • storeClientstoreClient
  • gendergender
  • звонкmarket
  • osVersionosVersion
  • Типа устройстваdeviceType
  • orderNameorderName
Нет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 acquisition. Используется следующий синтаксис: 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
  • Тип приобретенияacquisitionType
  • ageGroupageGroup
  • storeClientstoreClient
  • gendergender
  • звонкmarket
  • osVersionosVersion
  • Типа устройстваdeviceType
  • orderNameorderName

Параметр 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
  • Тип приобретенияacquisitionType
  • ageGroupageGroup
  • storeClientstoreClient
  • gendergender
  • звонкmarket
  • osVersionosVersion
  • Типа устройстваdeviceType
  • orderNameorderName

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

  • datedate
  • applicationIdapplicationId
  • acquisitionQuantityacquisitionQuantity

Параметр 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 acquisition data. Замените значение applicationId кодом продукта в Магазине для вашего приложения.Replace the applicationId value with the Store ID for your app.

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&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 aggregate acquisition data for the app. Дополнительные сведения о данных в каждом объекте см. далее в разделе Значения информации о покупках.For more information about the data in each object, see the acquisition 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 10000 but there are more than 10000 rows of acquisition data for the query.
TotalCountTotalCount INTint Общее количество строк в результирующих данных для запроса.The total number of rows in the data result for the query.

Значения информации о покупкахAcquisition values

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

ЗначениеValue ТипType ОписаниеDescription
Датаdate строкаstring Первая дата в диапазоне дат, для которого требуется получить данные о покупках.The first date in the date range for the acquisition 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 acquisition data.
applicationNameapplicationName строкаstring Отображаемое имя приложения.The display name of the app.
deviceTypedeviceType строкаstring Одна из следующих строк, указывающая тип устройства, на котором совершено приобретение:One of the following strings that specifies the type of device on which the acquisition occurred:
  • ACPIPC
  • ФаксPhone
  • Консоль — Xbox OneConsole-Xbox One
  • Консоль — серия Xbox XConsole-Xbox Series X
  • Интернет вещейIoT
  • Holographic (голография),Holographic
  • UnknownUnknown
orderNameorderName строкаstring Имя заказаThe name of the order.
storeClientstoreClient строкаstring Одна из следующих строк, указывающая версию Store, где совершено приобретение:One of the following strings that indicates the version of the Store where the acquisition occurred:
  • Магазин Windows Phone (клиент)Windows Phone Store (client)
  • Microsoft Store (client) (или Windows Store (client), если запрашиваются данные до 23 марта 2018 г.)Microsoft Store (client) (or Windows Store (client) if querying for data before March 23, 2018)
  • Microsoft Store (web) (или Windows Store (web), если запрашиваются данные до 23 марта 2018 г.)Microsoft Store (web) (or Windows Store (web) if querying for data before March 23, 2018)
  • Volume purchase by organizations;Volume purchase by organizations
  • ДругоеOther
osVersionosVersion строкаstring Одна из следующих строк, указывающая версию ОС, в которой произведено приобретение:One of the following strings that specifies the OS version on which the acquisition occurred:
  • Windows Phone 7.5Windows Phone 7.5
  • Windows Phone 8Windows Phone 8
  • Windows Phone 8.1Windows Phone 8.1
  • Windows Phone 10Windows Phone 10
  • Windows 8Windows 8
  • Windows 8.1Windows 8.1
  • Windows 10Windows 10
  • UnknownUnknown
marketmarket строкаstring Код страны по стандарту ISO 3166 для рынка, на котором произошла покупкаThe ISO 3166 country code of the market where the acquisition occurred.
gendergender строкаstring Одна из следующих строк, указывающая пол пользователя, совершившего приобретение:One of the following strings that specifies the gender of the user who made the acquisition:
  • mm
  • ff
  • UnknownUnknown
ageGroupageGroup строкаstring Одна из следующих строк, указывающая возрастную группу пользователя, совершившего приобретение:One of the following strings that specifies the age group of the user who made the acquisition:
  • less than 13less than 13
  • 13-1713-17
  • 18-2418-24
  • 25-3425-34
  • 35-44,35-44
  • 44-55,44-55
  • greater than 55,greater than 55
  • UnknownUnknown
Тип приобретенияacquisitionType строкаstring Одна из следующих строк, указывающих тип приобретения:One of the following strings that indicates the type of acquisition:
  • БесплатноFree
  • Пробная версияTrial
  • ПлатныйPaid
  • Promotional codePromotional code
  • IAPIap
  • IAP подпискиSubscription Iap
  • Частная аудиторияPrivate Audience
  • Предварительный заказPre Order
  • Xbox Game Pass (или Game Pass при запросе данных до 23 марта 2018 г.)Xbox Game Pass (or Game Pass if querying for data before March 23, 2018)
  • ДискDisk
  • Prepaid CodePrepaid Code
acquisitionQuantityacquisitionQuantity numbernumber Число покупок, выполненных на указанном уровне агрегированияThe number of acquisitions that occurred during the specified aggregation level.

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

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

{
  "Value": [
    {
      "date": "2016-02-01",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso Demo",
      "deviceType": "Phone",
      "orderName": "",
      "storeClient": "Windows Phone Store (client)",
      "osVersion": "Windows Phone 8.1",
      "market": "IT",
      "gender": "m",
      "ageGroup": "0-17",
      "acquisitionType": "Free",
      "acquisitionQuantity": 1
    }
  ],
  "@nextLink": "appacquisitions?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2015/01/01&endDate=2016/02/01&top=1&skip=1&orderby=date desc",
  "TotalCount": 466766
}