추가 기능 구입 가져오기Get add-on acquisitions

Microsoft Store analytics API에서이 메서드를 사용 하 여 지정 된 날짜 범위 및 기타 선택적 필터를 사용 하 여 앱의 추가 기능에 대 한 추가 기능에 대 한 집계 획득 데이터를 JSON 형식으로 가져올 수 있습니다.Use this method in the Microsoft Store analytics API to get aggregate acquisition data for add-ons for your app in JSON format during a given date range and other optional filters. 이 정보는 파트너 센터의 추가 기능 구분 보고서 에서도 사용할 수 있습니다.This information is also available in the Add-on acquisitions report in Partner Center.

필수 구성 요소Prerequisites

이 방법을 사용 하려면 먼저 다음을 수행 해야 합니다.To use this method, you need to first do the following:

  • 아직 수행 하지 않은 경우 Microsoft Store 분석 API에 대 한 모든 필수 구성 요소 를 완료 합니다.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 요청 URIRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions

요청 헤더Request header

헤더Header 형식Type DescriptionDescription
권한 부여Authorization 문자열string 필수 사항입니다.Required. Bearer <token> 형식의 Azure AD 액세스 토큰입니다.The Azure AD access token in the form Bearer <token>.

요청 매개 변수Request parameters

ApplicationId 또는 inappproductid 매개 변수는 필수입니다.The applicationId or inAppProductId parameter is required. 앱에 등록된 모든 추가 기능의 구입 데이터를 검색하려면 applicationId 매개 변수를 지정합니다.To retrieve acquisition data for all add-ons registered to the app, specify the applicationId parameter. 단일 추가 기능에 대 한 획득 데이터를 검색 하려면 Inappproductid 매개 변수를 지정 합니다.To retrieve acquisition data for a single add-on, specify the inAppProductId parameter. 둘 다 지정 하는 경우 applicationId 매개 변수는 무시 됩니다.If you specify both, the applicationId parameter is ignored.

매개 변수Parameter TypeType 설명Description 필요한 공간Required
applicationIdapplicationId 문자열string 추가 기능 획득 데이터를 검색 하려는 앱의 저장소 ID 입니다.The Store ID of the app for which you want to retrieve add-on acquisition data. Yes
inAppProductIdinAppProductId 문자열string 획득 데이터를 검색 하려는 추가 기능에 대 한 저장소 ID 입니다.The Store ID of the add-on for which you want to retrieve acquisition data. Yes
startDatestartDate datedate 검색할 추가 기능 획득 데이터의 날짜 범위에 있는 시작 날짜입니다.The start date in the date range of add-on acquisition data to retrieve. 기본값은 현재 날짜입니다.The default is the current date. 아니요No
endDateendDate datedate 검색할 추가 기능 획득 데이터의 날짜 범위에 있는 종료 날짜입니다.The end date in the date range of add-on acquisition data to retrieve. 기본값은 현재 날짜입니다.The default is the current date. No
toptop intint 요청에 반환할 데이터 행 수입니다.The number of rows of data to return in the request. 지정 되지 않은 경우 최대값 및 기본값은 1만입니다.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은 처음 1만 개의 데이터 행을 검색 하 고 top = 10000 및 skip = 10000은 데이터의 다음 1만 행을 검색 하는 식입니다.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
filterfilter 문자열string 응답의 행을 필터링 하는 하나 이상의 문입니다.One or more statements that filter the rows in the response. 자세한 내용은 아래의 필터 필드 섹션을 참조 하십시오.For more information, see the filter fields section below. 아니요No
aggregationLevelaggregationLevel 문자열string 집계 데이터를 검색 하는 시간 범위를 지정 합니다.Specifies the time range for which to retrieve aggregate data. , 또는 문자열 중 하나일 수 있습니다.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 add-on 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
  • 유형별storeClient
  • gendergender
  • 시장market
  • osVersionosVersion
  • deviceTypedeviceType
  • 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 = date, marketHere 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
  • inAppProductNameinAppProductName
  • 구매 유형acquisitionType
  • ageGroupageGroup
  • 유형별storeClient
  • gendergender
  • 시장market
  • osVersionosVersion
  • deviceTypedeviceType
  • orderNameorderName

반환 된 데이터 행에는 groupby 매개 변수 및 다음에 지정 된 필드가 포함 됩니다.The returned data rows will contain the fields specified in the groupby parameter as well as the following:

  • datedate
  • applicationIdapplicationId
  • inAppProductIdinAppProductId
  • 구매 수량acquisitionQuantity

Groupby 매개 변수는 aggregationLevel 매개 변수와 함께 사용할 수 있습니다.The groupby parameter can be used with the aggregationLevel parameter. 예: & Groupby = agegroup, market & aggregationLevel = weekFor example: &groupby=ageGroup,market&aggregationLevel=week

아니요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. 몇 가지 예제 필터 매개 변수는 다음과 같습니다.Here are some example filter parameters:

  • filter = market eq ' US ' 및 성별 eq ' 'filter=market eq 'US' and gender eq 'm'
  • filter = (market ne ' US ') and (성별 ne ' Unknown ') and (성별 ne ' 없음 ') and (' n o n e n t '가 55 보다 큼 ' 또는 ageGroup ne ' 13 ' 미만)filter=(market ne 'US') and (gender ne 'Unknown') and (gender ne 'm') and (market ne 'NO') and (ageGroup ne 'greater than 55' or ageGroup ne ‘less than 13’)

지원 되는 필드 목록은 다음 표를 참조 하세요.For a list of the supported fields, see the following table. 문자열 값은 필터 매개 변수에서 작은따옴표로 묶어야 합니다.String values must be surrounded by single quotes in the filter parameter.

필드Fields 설명Description
구매 유형acquisitionType Key, Input, Predict, PredictOnly, NoneOne of the following strings:
  • 늘릴free
  • 기간인trial
  • 지급paid
  • 프로 모션 코드promotional code
  • iapiap
ageGroupageGroup Key, Input, Predict, PredictOnly, NoneOne of the following strings:
  • 13 미만less than 13
  • 13-1713-17
  • 18-2418-24
  • 25-3425-34
  • 35-4435-44
  • 44-5544-55
  • 55 보다 큼greater than 55
  • 알 수 없음Unknown
유형별storeClient Key, Input, Predict, PredictOnly, NoneOne of the following strings:
  • Windows Phone 스토어(클라이언트)Windows Phone Store (client)
  • Microsoft Store (클라이언트)Microsoft Store (client)
  • Microsoft Store (웹)Microsoft Store (web)
  • 조직에서 대량 구매Volume purchase by organizations
  • 기타Other
gendergender Key, Input, Predict, PredictOnly, NoneOne of the following strings:
  • mm
  • ff
  • 알 수 없음Unknown
marketmarket 획득이 발생 한 시장의 ISO 3166 국가 코드를 포함 하는 문자열입니다.A string that contains the ISO 3166 country code of the market where the acquisition occurred.
osVersionosVersion Key, Input, Predict, PredictOnly, NoneOne of the following strings:
  • 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
  • 알 수 없음Unknown
deviceTypedeviceType Key, Input, Predict, PredictOnly, NoneOne of the following strings:
  • 컴퓨터PC
  • 내선Phone
  • 콘솔-Xbox OneConsole-Xbox One
  • 콘솔-Xbox 시리즈 XConsole-Xbox Series X
  • IoTIoT
  • HolographicHolographic
  • 알 수 없음Unknown
orderNameorderName 추가 기능을 획득 하는 데 사용 된 프로 모션 코드의 주문 이름을 지정 하는 문자열입니다 .이는 사용자가 교환 a 판촉 코드를 통해 추가 기능을 획득 한 경우에만 적용 됩니다.A string that specifies the name of the order for the promotional code that was used to acquire the add-on (this only applies if the user acquired the add-on by redeeming a promotional code).

요청 예제Request example

다음 예제에서는 추가 기능 획득 데이터를 가져오는 몇 가지 요청을 보여 줍니다.The following examples demonstrates several requests for getting add-on acquisition data. InappproductidapplicationId 값을 추가 기능 또는 앱의 적절 한 상점 ID로 바꿉니다.Replace the inAppProductId and applicationId values with the appropriate Store ID for your add-on or app.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?inAppProductId=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/inappacquisitions?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/inappacquisitions?inAppProductId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=7/3/2015&top=100&skip=0&filter=market ne 'US' and gender ne 'Unknown' and gender ne 'm' and market ne 'NO' and ageGroup ne '>55' HTTP/1.1
Authorization: Bearer <your access token>

응답Response

응답 본문Response body

Value 형식Type DescriptionDescription
Value arrayarray 집계 추가 기능 획득 데이터를 포함 하는 개체의 배열입니다.An array of objects that contain aggregate add-on acquisition data. 각 개체의 데이터에 대 한 자세한 내용은 아래의 추가 기능 획득 값 섹션을 참조 하십시오.For more information about the data in each object, see the add-on 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 매개 변수가 1만로 설정 되어 있지만 쿼리에 대 한 추가 기능 획득 데이터의 행이 1만 개를 초과 하는 경우이 값이 반환 됩니다.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 add-on acquisition data for the query.
TotalCountTotalCount intint 쿼리의 데이터 결과에 있는 총 행 수입니다.The total number of rows in the data result for the query.

추가 기능 획득 값Add-on acquisition values

배열의 요소에는 다음 값이 포함 됩니다.Elements in the Value array contain the following values.

Value 형식Type 설명Description
datedate 문자열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.
inAppProductIdinAppProductId 문자열string 획득 데이터를 검색 하는 추가 기능에 대 한 저장소 ID입니다.The Store ID of the add-on for which you are retrieving acquisition data.
inAppProductNameinAppProductName 문자열string 추가 기능에 대 한 표시 이름입니다.The display name of the add-on. 이 값은 groupby 매개 변수에서 inappproductname 필드를 지정 하지 않는 한 aggregationLevel 매개 변수가 day로 설정 된 경우에만 응답 데이터에 표시 됩니다.This value only appears in the response data if the aggregationLevel parameter is set to day, unless you specify the inAppProductName field in the groupby parameter.
applicationIdapplicationId 문자열string 추가 기능 획득 데이터를 검색 하려는 앱의 저장소 ID입니다.The Store ID of the app for which you want to retrieve add-on acquisition data.
applicationNameapplicationName 문자열string 응용 프로그램의 표시 이름입니다.The display name of the app.
deviceTypedeviceType 문자열string 가져오기를 완료 한 장치의 유형입니다.The type of device that completed the acquisition. 지원 되는 문자열 목록은 위의 필터 필드 섹션을 참조 하십시오.For a list of the supported strings, see the filter fields section above.
orderNameorderName 문자열string 주문의 이름입니다.The name of the order.
유형별storeClient 문자열string 획득이 발생 한 저장소의 버전입니다.The version of the Store where the acquisition occurred. 지원 되는 문자열 목록은 위의 필터 필드 섹션을 참조 하십시오.For a list of the supported strings, see the filter fields section above.
osVersionosVersion 문자열string 획득이 발생 한 OS 버전입니다.The OS version on which the acquisition occurred. 지원 되는 문자열 목록은 위의 필터 필드 섹션을 참조 하십시오.For a list of the supported strings, see the filter fields section above.
marketmarket 문자열string 획득이 발생 한 시장의 ISO 3166 국가 코드입니다.The ISO 3166 country code of the market where the acquisition occurred.
gendergender 문자열string 취득 한 사용자의 성별입니다.The gender of the user who made the acquisition. 지원 되는 문자열 목록은 위의 필터 필드 섹션을 참조 하십시오.For a list of the supported strings, see the filter fields section above.
ageGroupageGroup 문자열string 가져오기를 수행한 사용자의 나이 그룹입니다.The age group of the user who made the acquisition. 지원 되는 문자열 목록은 위의 필터 필드 섹션을 참조 하십시오.For a list of the supported strings, see the filter fields section above.
구매 유형acquisitionType 문자열string 취득 유형 (무료, 유료 등)입니다.The type of acquisition (free, paid, and so on). 지원 되는 문자열 목록은 위의 필터 필드 섹션을 참조 하십시오.For a list of the supported strings, see the filter fields section above.
구매 수량acquisitionQuantity integerinteger 발생 한 인수 수입니다.The number of acquisitions that occurred.

응답 예제Response example

다음 예제에서는이 요청에 대 한 예제 JSON 응답 본문을 보여 줍니다.The following example demonstrates an example JSON response body for this request.

{
  "Value": [
    {
      "date": "2015-01-02",
      "inAppProductId": "9NBLGGH3LHKL",
      "inAppProductName": "Contoso add-on 7",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso Demo",
      "deviceType": "Phone",
      "orderName": "",
      "storeClient": "Windows Phone Store (client)",
      "osVersion": "Windows Phone 8.1",
      "market": "GB",
      "gender": "m",
      "ageGroup": "50orover",
      "acquisitionType": "iap",
      "acquisitionQuantity": 1
    }
  ],
  "@nextLink": "inappacquisitions?applicationId=9NBLGGGZ5QDR&inAppProductId=&aggregationLevel=day&startDate=2015/01/01&endDate=2016/02/01&top=1&skip=1",
  "TotalCount": 33677
}