채널별 추가 기능 변환 가져오기Get add-on conversions by channel

Microsoft Store analytics API에서이 메서드를 사용 하 여 지정 된 날짜 범위 및 기타 선택적 필터를 사용 하는 동안 추가 기능에 대 한 채널로 집계 변환을 가져올 수 있습니다.Use this method in the Microsoft Store analytics API to get aggregate conversions by channel for an add-on during a given date range and other optional filters.

  • 변환은 고객이 (Microsoft 계정로 로그인 한) 추가 기능에 대 한 라이선스를 새로 획득 했음을 의미 합니다. (요금을 부과 했는지 아니면 무료로 제공 했는지 여부에 관계 없이)A conversion means that a customer (signed in with a Microsoft account) has newly obtained a license to your add-on (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 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/inappchannelconversions

요청 헤더Request header

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

요청 매개 변수Request parameters

매개 변수Parameter TypeType 설명Description 필요한 공간Required
applicationIdapplicationId 문자열string 추가 기능 변환 데이터를 검색 하려는 앱의 저장소 ID 입니다.The Store ID of the app for which you want to retrieve add-on conversion data. 예 매장 ID는 9WZDNCRFJ3Q8입니다.An example Store ID is 9WZDNCRFJ3Q8. Yes
inAppProductIdinAppProductId 문자열string 변환 데이터를 검색 하려는 추가 기능에 대 한 저장소 ID 입니다.The Store ID of the add-on for which you want to retrieve conversion data. Yes
startDatestartDate datedate 검색할 변환 데이터의 날짜 범위에 있는 시작 날짜입니다.The start date in the date range of conversion data to retrieve. 기본값은 1/1/2016입니다.The default is 1/1/2016. 아니요No
endDateendDate datedate 검색할 변환 데이터의 날짜 범위에 있는 종료 날짜입니다.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. 지정 되지 않은 경우 최대값 및 기본값은 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 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
  • 유형별storeClient
  • deviceTypedeviceType
  • 시장market

필터 매개 변수 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. , 또는 문자열 중 하나일 수 있습니다.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
  • inAppProductNameinAppProductName
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • channelTypechannelType
  • 유형별storeClient
  • deviceTypedeviceType
  • 시장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 = 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
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • channelTypechannelType
  • 유형별storeClient
  • deviceTypedeviceType
  • 시장market

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

  • datedate
  • applicationIdapplicationId
  • inAppProductIdinAppProductId
  • inAppProductNameinAppProductName
  • conversionCountconversionCount
  • 클릭 횟수clickCount

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

아니요No

요청 예제Request example

다음 예제에서는 앱 변환 데이터를 가져오는 몇 가지 요청을 보여 줍니다.The following example demonstrates several requests for getting app conversion data. ApplicationId 값을 앱의 스토어 ID로 바꿉니다.Replace the applicationId value with the Store ID for your app.

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

응답 본문Response body

Value 형식Type DescriptionDescription
Value arrayarray 추가 기능에 대 한 집계 변환 데이터를 포함 하는 개체의 배열입니다.An array of objects that contain aggregate conversion data for the add-on. 각 개체의 데이터에 대 한 자세한 내용은 아래의 변환 값 섹션을 참조 하십시오.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으로 설정 되어 있지만 쿼리에 대 한 변환 데이터 행이 10 개를 초과 하는 경우이 값이 반환 됩니다.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

배열의 개체에는 다음 값이 포함 됩니다.Objects in the Value array contain the following values.

Value 형식Type 설명Description
datedate 문자열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.
inAppProductIdinAppProductId 문자열string 변환 데이터를 검색 하는 추가 기능에 대 한 저장소 ID 입니다.The Store ID of the add-on for which you are retrieving conversion data.
inAppProductNameinAppProductName 문자열string 변환 데이터를 검색 하는 추가 기능에 대 한 표시 이름입니다.The display name of the add-on for which you are retrieving conversion data.
applicationIdapplicationId 문자열string 변환 데이터를 검색 하는 앱의 저장소 ID 입니다.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. 이 메서드의 경우 유일 하 게 지원 되는 값은 추가 기능입니다.For this method, the only supported value is Add-On.
customCampaignIdcustomCampaignId 문자열string 앱과 연결 된 사용자 지정 앱 판촉 캠페인 의 ID 문자열입니다.The ID string for a custom app promotion campaign that is associated with the app.
referrerUriDomainreferrerUriDomain 문자열string 사용자 지정 앱 판촉 캠페인 ID를 사용 하 여 나열 된 앱이 활성화 된 도메인을 지정 합니다.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:
  • CustomCampaignIdCustomCampaignId
  • 트래픽 저장Store Traffic
  • 기타Other
유형별storeClient 문자열string 변환이 발생 한 저장소의 버전입니다.The version of the Store where the conversion occurred. 현재 유일 하 게 지원 되는 값은 SFC입니다.Currently, the only supported value is SFC.
deviceTypedeviceType 문자열string Key, Input, Predict, PredictOnly, NoneOne of the following strings:
  • 컴퓨터PC
  • 내선Phone
  • 콘솔-Xbox OneConsole-Xbox One
  • 콘솔-Xbox 시리즈 XConsole-Xbox Series X
  • IoTIoT
  • HolographicHolographic
  • 알 수 없음Unknown
marketmarket 문자열string 변환이 발생 한 시장의 ISO 3166 국가 코드입니다.The ISO 3166 country code of the market where the conversion occurred.
클릭 횟수clickCount 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",
      "inAppProductId": "9NBLGGH3LHKL",
      "inAppProductName": "Contoso Add-On",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso App",
      "appType": "Add-On",
      "customCampaignId": "",
      "referrerUriDomain": "Universal Client Store",
      "channelType": "Store Traffic",
      "storeClient": "SFC",
      "deviceType": "PC",
      "market": "CN",
      "clickCount": 1,
      "conversionCount": 0
    }
  ],
  "@nextLink": null,
  "TotalCount": 1
}