월별 앱 사용량 가져오기

Microsoft Store 분석 API에서 이 메서드를 사용하여 지정된 날짜 범위(지난 90일만) 및 기타 선택적 필터 중에 애플리케이션에 대한 JSON 형식의 집계 사용량 데이터(Xbox 멀티 플레이 제외)를 가져옵니다. 이 정보는 파트너 센터의 사용량 보고서에서도 볼 수 있습니다.

애너하임 기반 PWA 앱에 대한 원격 분석은 디바이스 수준에서 수집됩니다. 따라서 사용자와 관련된 메트릭은 이러한 제품에 사용할 수 없습니다. 필드의 유효성에 대한 자세한 내용은 아래 사용량 값 섹션을 참조하세요.

필수 조건

이 메서드를 사용하려면 먼저 다음을 수행해야 합니다.

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

요청

요청 구문

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

요청 헤더

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

요청 매개 변수

매개 변수 형식 설명 필수
applicationId 문자열 리뷰 데이터를 검색할 앱의 Store ID.
startDate 날짜 검색할 리뷰 데이터의 날짜 범위의 시작 날짜. 기본값은 현재 날짜입니다. 아니요
endDate 날짜 검색할 리뷰 데이터의 날짜 범위의 종료 날짜. 기본값은 현재 날짜입니다. 아니요
top int 요청에서 반환할 데이터 행의 수. 지정되지 않은 경우 최댓값 및 기본값은 10000입니다. 쿼리에 행이 더 있는 경우, 다음 데이터 페이지를 요청하는 데 사용할 수 있는 다음 링크가 응답 본문에 포함됩니다. 아니요
skip int 쿼리에서 건너뛸 행 수. 이 매개 변수를 사용하여 큰 데이터 집합을 페이징합니다. 예를 들어 top=10000 및 skip=0은 데이터의 첫 10000행을 검색하고 top=10000 및 skip=10000은 데이터의 그 다음 10000행을 검색하는 식으로 이어집니다. 아니요
필터 문자열 응답의 행을 필터링하는 하나 이상의 문. 각 명령문에는 응답 본문의 필드 이름 및 eq 또는 ne 연산자와 연결된 값이 포함되며, 명령문은 and 또는 or을 사용하여 결합할 수 있습니다. 문자열 값은 필터 매개 변수에서 단일 따옴표로 묶여야 합니다. 다음의 필드를 응답 본문에서 지정할 수 있습니다.
  • market
  • deviceType
  • packageVersion
아니요
orderby 문자열 결과 데이터 값을 정렬하는 문. 구문은 orderby=field [order],field [order],...입니다. 필드 매개 변수는 다음 문자열 중 하나일 수 있습니다.
  • date
  • applicationId
  • applicationName
  • market
  • packageVersion
  • deviceType
  • subscriptionName
  • monthlySessionCount
  • engagementDurationMinutes
  • monthlyActiveUsers
  • monthlyActiveDevices
  • monthlyNewUsers
  • averageDailyActiveUsers
  • averageDailyActiveDevices
  • monthlyNewDevices

order 매개 변수는 옵션이며 각 필드를 asc 또는 desc로 오름차순 또는 내림차순으로 지정할 수 있습니다. 기본값은 asc입니다.

다음은 orderby 문자열의 예시입니다. orderby=date,market

아니요
groupby 문자열 지정된 필드에만 데이터 집계를 적용하는 문. 응답 본문에서 지정할 수 있는 필드는 다음과 같습니다.
  • applicationName
  • subscriptionName
  • deviceType
  • packageVersion
  • market
  • date

반환된 데이터 행에는 groupby 매개 변수에 지정된 필드와 다음이 포함됩니다.

  • applicationId
  • subscriptionName
  • monthlySessionCount
  • engagementDurationMinutes
  • monthlyActiveUsers
  • monthlyActiveDevices
  • monthlyNewUsers
  • averageDailyActiveUsers
  • averageDailyActiveDevices
  • monthlyNewDevices

groupby 매개 변수는 aggregationLevel 매개 변수와 함께 사용할 수 있습니다. 예시: &groupby=ageGroup,market&aggregationLevel=week

아니요

요청 예제

다음 예제는 월별 앱 사용량 데이터를 가져오기 위한 요청을 보여 줍니다. applicationId 값을 앱의 Store ID로 바꿉니다.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagemonthly?applicationId=XXXXXXXXXXXX&startDate=2018-06-01&endDate=2018-07-01 HTTP/1.1  
Authorization: Bearer <your access token>

응답

응답 본문

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

 

사용량 값

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

형식 설명 UWP 가용성 애너하임 기반 PWA 가용성 Xbox 가용성
날짜 문자열 사용량 데이터에 대한 날짜 범위의 시작 날짜. 요청에서 하루를 지정한 경우 이 값은 해당 날짜입니다. 요청에서 주, 월 또는 다른 날짜 범위를 지정한 경우 이 값은 해당 날짜 범위의 첫 번째 날짜입니다.
applicationId 문자열 사용량 데이터를 검색할 앱의 Store ID.
applicationName 문자열 앱의 표시 이름.
market 문자열 고객이 앱을 사용한 시장의 ISO 3166 국가 번호.
packageVersion 문자열 사용량이 발생한 패키지의 버전. 아니요
deviceType 문자열 사용량이 발생한 디바이스 유형을 지정하는 다음 문자열 중 하나입니다.
  • PC
  • 전화
  • 콘솔-Xbox One
  • 콘솔-Xbox 시리즈 X
  • 태블릿
  • IoT
  • 서버
  • Holographic
  • 알 수 없음
subscriptionName 문자열 Xbox Game Pass를 통해 사용했는지 여부를 나타냅니다. 아니요 아니요
monthlySessionCount long 해당 월의 사용자 세션 수.
engagementDurationMinutes double 사용자가 앱을 적극적으로 사용하는 시간(분)은 앱이 시작될 때(프로세스 시작), 시작하고 앱이 종료될 때(프로세스 종료), 끝나거나 비활성 기간 후에 끝나는 고유한 기간으로 측정됩니다.
monthlyActiveUsers long 해당 월에 앱을 사용하는 고객 수. 아니요
monthlyActiveDevices long 앱이 시작될 때(프로세스 시작), 시작하고 앱이 종료될 때(프로세스 종료), 끝나거나 비활성 기간 후에 끝나는 고유한 기간 동안 앱을 실행하는 디바이스의 수.
monthlyNewUsers long 해당 월에 앱을 처음 사용한 고객 수. 아니요
averageDailyActiveUsers double 앱을 매일 사용하는 평균 고객 수. 아니요
averageDailyActiveDevices double 모든 사용자가 매일 앱과 상호 작용하는 데 사용한 디바이스의 평균 개수.
monthlyNewDevices long 해당 월에 처음으로 앱을 사용한 장치 수.

참고 항목

특정 제품에 대해 필드가 유효하지 않은 경우, 해당 필드에 대한 값은 응답에서 0 또는 null로 전송됩니다. 새 사용자 및 새 디바이스의 계산은 3년의 롤링 기간으로 수행됩니다. 즉, 사용자/디바이스가 3년 이상 애플리케이션을 사용하지 않는 경우 3년 후에 새 사용자/디바이스로 처리됩니다.

요청 및 응답 예제

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

샘플 요청

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

샘플 응답

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "deviceType": "All",
            "packageVersion": "All",
            "market": "All",
            "engagementDurationMinutes": 2828568.3,
            "monthlyActiveUsers": 165249,
            "monthlyActiveDevices": 165753,
            "monthlyNewUsers": 95787,
            "monthlySessionCount": 314263,
            "averageDailyActiveUsers": 192.506111111111,
            "averageDailyActiveDevices": 191.199722222222,
            "monthlyNewDevices": 0
        }
    ],
    "TotalCount": 1
}

샘플 요청

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagemonthly?applicationId=9NBLGGGZ5QDR&startDate=2022-06-01&endDate=2022-07-01&groupby=applicationName,subscriptionName,deviceType,packageVersion,market,date&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

샘플 응답

{
    "Value": [
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "JP",
            "engagementDurationMinutes": 0.3,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "MX",
            "engagementDurationMinutes": 2.7,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "Unknown",
            "engagementDurationMinutes": 0.1,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "US",
            "engagementDurationMinutes": 0.2,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AE",
            "engagementDurationMinutes": 3.2,
            "monthlyActiveUsers": 2,
            "monthlyActiveDevices": 2,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 3,
            "averageDailyActiveUsers": 0.07,
            "averageDailyActiveDevices": 0.07,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AO",
            "engagementDurationMinutes": 1.2,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AR",
            "engagementDurationMinutes": 574.7,
            "monthlyActiveUsers": 39,
            "monthlyActiveDevices": 39,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 53,
            "averageDailyActiveUsers": 1.43,
            "averageDailyActiveDevices": 1.43,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AT",
            "engagementDurationMinutes": 5.3,
            "monthlyActiveUsers": 4,
            "monthlyActiveDevices": 4,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 9,
            "averageDailyActiveUsers": 0.17,
            "averageDailyActiveDevices": 0.17,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AU",
            "engagementDurationMinutes": 434.7,
            "monthlyActiveUsers": 22,
            "monthlyActiveDevices": 22,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 36,
            "averageDailyActiveUsers": 0.9,
            "averageDailyActiveDevices": 0.9,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AZ",
            "engagementDurationMinutes": 13.5,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        }
    ],
    "TotalCount": 10
}