추가 기능 취득 가져오기

아티클
03/13/2024

Microsoft Store 분석 API에서 이 메서드를 사용하여 지정된 날짜 범위 및 다른 선택 필터 동안 앱 추가 기능의 집계 취득 데이터를 JSON 형식으로 가져옵니다. 이 정보는 파트너 센터의 추가 기능 취득 보고서에서도 볼 수 있습니다.

필수 조건

이 메서드를 사용하려면 먼저 다음 방법대로 해야 합니다.

아직 완료하지 않은 경우 Microsoft Store 분석 API에 대한 모든 필수 조건을 완료합니다.
이 메서드에 대한 요청 헤더에 사용할 Azure AD 액세스 토큰을 가져오세요. 액세스 토큰을 가져온 후 만료되기까지 60분이 걸립니다. 토큰이 만료된 후 새 토큰을 가져올 수 있습니다.

Request

요청 구문

메서드	요청 URI
GET	`https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions`

요청 헤더

헤더	형식	설명
권한 부여	string	필수. Bearer<토큰> 형식의 Azure AD 액세스 토큰.

요청 매개 변수

applicationId 또는 inAppProductId 매개 변수가 필요합니다. 앱에 등록된 모든 추가 기능에 대한 취득 데이터를 검색하려면 applicationId 매개 변수를 지정합니다. 단일 추가 기능에 대한 취득 데이터를 검색하려면 inAppProductId 매개 변수를 지정합니다 . 둘 다 지정하면 applicationId 매개 변수가 무시됩니다.

매개 변수	형식	설명	필수
applicationId	문자열	추가 취득 데이터를 검색하려는 앱의 Store ID입니다.	예
inAppProductId	문자열	취득 데이터를 검색할 추가 기능의 Store ID입니다.	예
startDate	date	검색할 추가 기능 획득 데이터의 날짜 범위 중 시작 날짜입니다. 기본값은 현재 날짜입니다.	아니요
endDate	date	검색할 추가 기능 획득 데이터의 날짜 범위 중 종료 날짜입니다. 기본값은 현재 날짜입니다.	아니요
top	int	요청에서 반환할 데이터 행의 수. 지정되지 않은 경우 최댓값 및 기본값은 10000입니다. 쿼리에 행이 더 있는 경우, 다음 데이터 페이지를 요청하는 데 사용할 수 있는 다음 링크가 응답 본문에 포함됩니다.	아니요
skip	int	쿼리에서 건너뛸 행 수. 이 매개 변수를 사용하여 큰 데이터 집합을 페이징합니다. 예를 들어 top=10000 및 skip=0은 데이터의 첫 10000행을 검색하고 top=10000 및 skip=10000은 데이터의 그 다음 10000행을 검색하는 식으로 이어집니다.	아니요
필터	문자열	응답의 행을 필터링하는 하나 이상의 문. 자세한 정보는 아래의 필터 필드 섹션을 참조하세요.	아니요
aggregationLevel	문자열	집계 데이터를 검색할 시간 범위를 지정합니다. 일 문자열, 주 문자열 또는 월 문자열 중 하나일 수 있습니다. 지정하지 않으면 기본값이 일이 됩니다.	아니요
orderby	문자열	각 추가 기능 취득에 대한 결과 데이터 값의 순서를 지정하는 문입니다. 구문은 orderby=field [order],field [order],...입니다. 필드 매개 변수는 다음 문자열 중 하나일 수 있습니다. date acquisitionType ageGroup storeClient gender 시장 osVersion deviceType orderName order 매개 변수는 옵션이며 각 필드를 asc 또는 desc로 오름차순 또는 내림차순으로 지정할 수 있습니다. 기본값은 asc입니다. 다음은 orderby 문자열의 예시입니다. orderby=date,market	아니요
groupby	문자열	지정된 필드에만 데이터 집계를 적용하는 문. 다음과 같은 필드를 지정할 수 있습니다. date applicationName inAppProductName acquisitionType ageGroup storeClient gender 시장 osVersion deviceType orderName 반환된 데이터 행에는 groupby 매개 변수에 지정된 필드와 다음이 포함됩니다. date applicationId inAppProductId acquisitionQuantity groupby 매개 변수는 aggregationLevel 매개 변수와 함께 사용할 수 있습니다. 예시: &groupby=ageGroup,market&aggregationLevel=week	아니요

필터 필드

요청의 필터 매개 변수는 응답의 행을 필터링하는 하나 이상의 문을 포함합니다. 각 문에는 eq 또는 ne 연산자와 연결된 필드 및 값이 포함되며 and 또는 or를 사용하여 문을 결합할 수 있습니다. 다음은 대표적인 필터 매개 변수의 예시입니다.

filter=market eq 'US' and gender eq 'm'
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’)

지원되는 필드 목록은 다음의 테이블을 참조하세요. 문자열 값은 필터 매개 변수에서 단일 따옴표로 묶여야 합니다.

필드	설명
acquisitionType	다음의 문자열 중 하나입니다. 무료 평가판 유료 프로모션 코드 iap
ageGroup	다음의 문자열 중 하나입니다. 13 미만 13-17 18-24 25-34 35-44 44-55 55 초과 알 수 없음
storeClient	다음의 문자열 중 하나입니다. Windows Phone Store(클라이언트) Microsoft Store(클라이언트) Microsoft Store(웹) 조직에서 대량 구매 기타
gender	다음의 문자열 중 하나입니다. 남성 여성 알 수 없음
시장	취득이 발생한 시장의 ISO 3166 국가 코드를 포함하는 문자열.
osVersion	다음의 문자열 중 하나입니다. Windows Phone 7.5 Windows Phone 8 Windows Phone 8.1 Windows Phone 10 Windows 8 Windows 8.1 Windows 10 Windows 11 알 수 없음
deviceType	다음의 문자열 중 하나입니다. PC 전화 콘솔-Xbox One 콘솔-Xbox 시리즈 X IoT Holographic 알 수 없음
orderName	추가 기능을 취득하는 데 사용된 프로모션 코드의 주문 이름을 지정하는 문자열입니다(사용자가 프로모션 코드를 사용하여 추가 기능을 획득한 경우에만 적용됨).

요청 예시

다음의 예시는 추가 기능 취득 데이터를 가져오는 데 필요한 요청을 보여 줍니다. inAppProductId 및 applicationId 값을 추가 기능 또는 앱에 적합한 Store ID로 변경합니다.

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>

응답

응답 본문

값	형식	설명
값	배열	추가 기능 획득 집계 데이터가 들어 있는 개체의 배열입니다. 각 개체의 데이터에 대한 자세한 정보는 아래의 추가 기능 취득 값 섹션을 참조하세요.
@nextLink	문자열	추가적인 데이터 페이지가 있는 경우, 다음 데이터 페이지를 요청하는 데 사용할 수 있는 URI가 이 문자열에 포함됩니다. 예를 들어 요청의 top 매개 변수가 10000으로 설정되어 있지만 쿼리에 대한 추가 기능 취득 데이터의 행이 10000 보다 많은 경우 이 값이 반환됩니다.
TotalCount	int	쿼리의 데이터 결과에 포함된 행의 총 개수입니다.

추가 기능 획득 값

값 배열의 요소에는 다음의 값이 포함됩니다.

값	형식	설명
date	문자열	획득 데이터의 날짜 범위 중 첫 날짜입니다. 요청에서 하루를 지정한 경우, 이 값은 해당 날짜입니다. 요청에서 주, 월 또는 다른 날짜 범위를 지정한 경우 이 값은 해당 날짜 범위의 첫 번째 날짜입니다.
inAppProductId	문자열	취득 데이터를 검색할 추가 기능의 Store ID입니다.
inAppProductName	문자열	추가 기능의 표시 이름입니다. 이 값은 groupby 매개 변수에 inAppProductName 필드를 지정하지 않는 한 aggregationLevel 매개 변수가 day로 설정된 경우에만 응답 데이터에 나타납니다.
applicationId	문자열	추가 취득 데이터를 검색하려는 앱의 Store ID입니다.
applicationName	문자열	앱의 표시 이름.
deviceType	문자열	취득을 완료한 디바이스의 유형입니다. 지원되는 문자열 목록은 위의 필터 필드 섹션을 참조하세요.
orderName	문자열	주문의 이름입니다.
storeClient	문자열	취득이 발생한 Store의 버전입니다. 지원되는 문자열 목록은 위의 필터 필드 섹션을 참조하세요.
osVersion	문자열	취득이 발생한 OS 버전입니다. 지원되는 문자열 목록은 위의 필터 필드 섹션을 참조하세요.
시장	문자열	획득이 발생한 시장의 ISO 3166 국가 번호입니다.
gender	문자열	취득한 사용자의 성별입니다. 지원되는 문자열 목록은 위의 필터 필드 섹션을 참조하세요.
ageGroup	문자열	취득한 사용자의 연령 그룹입니다. 지원되는 문자열 목록은 위의 필터 필드 섹션을 참조하세요.
acquisitionType	문자열	취득 유형(무료, 유료 등)입니다. 지원되는 문자열 목록은 위의 필터 필드 섹션을 참조하세요.
acquisitionQuantity	정수	발생한 취득 횟수입니다.

요청 및 응답 예제

다음의 코드 조각은 해당 요청에 대한 예제 요청 및 JSON 응답 본문을 보여 줍니다.

샘플 요청

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

샘플 응답

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Deluxe Collector's Edition",
            "addonProductId": "9NBLGGAAGZDQ",
            "date": "2022-07-29",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 18.12,
            "purchasePriceLocalAmount": 18.12,
            "purchaseTaxUSDAmount": 1.13,
            "purchaseTaxLocalAmount": 1.13
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Episode 4",
            "addonProductId": "9NAAAAAAAAAQ",
            "date": "2017-01-07",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 4.147206,
            "purchasePriceLocalAmount": 3.99,
            "purchaseTaxUSDAmount": 0.686004,
            "purchaseTaxLocalAmount": 0.66
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Deluxe Collector's Edition",
            "addonProductId": "9NALGGGZ5QDQ",
            "date": "2018-04-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 1.99,
            "purchasePriceLocalAmount": 1.99,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Strategy Guide Episode 4",
            "addonProductId": "9NBLGGGZ5QDQ",
            "date": "2021-11-25",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 1.31902922876179,
            "purchasePriceLocalAmount": 150.0,
            "purchaseTaxUSDAmount": 0.114315866492689,
            "purchaseTaxLocalAmount": 13.0
        },
    ],
    "TotalCount": 4,
    "DataFreshnessTimestamp": "2022-07-29T05:54:00"
}

다음을 통해 공유

추가 기능 취득 가져오기

필수 조건

Request

요청 구문

요청 헤더

요청 매개 변수

필터 필드

요청 예시

응답

응답 본문

추가 기능 획득 값

요청 및 응답 예제

샘플 요청

샘플 응답

피드백

추가 리소스

다음을 통해 공유

추가 기능 취득 가져오기

필수 조건

Request

요청 구문

요청 헤더

요청 매개 변수

필터 필드

요청 예시

응답

응답 본문

추가 기능 획득 값

요청 및 응답 예제

샘플 요청

샘플 응답

관련 항목

피드백

추가 리소스