광고 캠페인 성과 데이터 가져오기

아티클
03/13/2024

Microsoft Store 분석 API에서 이 메서드를 사용하여 지정된 날짜 범위 및 다른 선택 필터에 대해 응용 프로그램에 대한 프로모션 광고 캠페인 성과 집계 요약 데이터를 가져옵니다. 이 메서드는 JSON 형식으로 데이터를 반환합니다.

이 메서드는 파트너 센터의 광고 캠페인 보고서에서 제공하는 것과 동일한 데이터를 반환합니다. 광고 캠페인에 대한 자세한 정보는 앱에 대한 광고 캠페인 만들기를 참조하세요 .

광고 캠페인을 만들고, 업데이트하고, 세부 정보를 검색하기 위해 Microsoft Store 프로모션 API의 광고 캠페인 관리 메서드를 사용할 수 있습니다.

필수 조건

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

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

Request

요청 구문

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

요청 헤더

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

요청 매개 변수

특정 앱에 대한 광고 캠페인 성과 데이터를 검색하려면 applicationId 매개 변수를 사용합니다. 개발자 계정과 연결된 모든 앱의 광고 성과 데이터를 검색하려면 applicationId 매개 변수를 생략합니다.

매개 변수	형식	설명	필수
applicationId	문자열	광고 캠페인 성과 데이터를 검색할 앱의 Store ID.	아니요
startDate	date	YYYY/MM/DD 형식의 검색할 광고 캠페인 성과 데이터의 날짜 범위의 시작 날짜. 기본값은 현재 날짜에서 30일을 뺀 값입니다.	아니요
endDate	date	YYYY/MM/DD 형식의 검색할 광고 캠페인 성과 데이터의 날짜 범위의 종료 날짜. 기본값은 현재 날짜에서 하루를 뺀 값입니다.	아니요
top	int	요청에서 반환할 데이터 행의 수. 지정되지 않은 경우 최댓값 및 기본값은 10000입니다. 쿼리에 행이 더 있는 경우, 다음 데이터 페이지를 요청하는 데 사용할 수 있는 다음 링크가 응답 본문에 포함됩니다.	아니요
skip	int	쿼리에서 건너뛸 행 수. 이 매개 변수를 사용하여 큰 데이터 집합을 페이징합니다. 예를 들어 top=10000 및 skip=0은 데이터의 첫 10000행을 검색하고 top=10000 및 skip=10000은 데이터의 그 다음 10000행을 검색하는 식으로 이어집니다.	아니요
필터	문자열	응답의 행을 필터링하는 하나 이상의 문. 유일하게 지원되는 필터는 campaignId입니다. 각 문은 eq 또는 ne 연산자를 사용할 수 있으며, 문은 and 또는 or을 사용하여 결합될 수 있습니다. 다음은 필터 매개 변수의 예입니다. `filter=campaignId eq '100023'`.	아니요
aggregationLevel	문자열	집계 데이터를 검색할 시간 범위를 지정합니다. 일 문자열, 주 문자열 또는 월 문자열 중 하나일 수 있습니다. 지정하지 않으면 기본값이 일이 됩니다.	아니요
orderby	문자열	광고 캠페인 성과 데이터에 대한 결과 데이터 값을 정렬하는 명령문. 구문은 orderby=field [order],field [order],...입니다. 필드 매개 변수는 다음 문자열 중 하나일 수 있습니다. date campaignId order 매개 변수는 옵션이며 각 필드를 asc 또는 desc로 오름차순 또는 내림차순으로 지정할 수 있습니다. 기본값은 asc입니다. 다음은 orderby 문자열의 예입니다. orderby=date,campaignId	아니요
groupby	문자열	지정된 필드에만 데이터 집계를 적용하는 문. 다음과 같은 필드를 지정할 수 있습니다. campaignId applicationId date currencyCode groupby 매개 변수는 aggregationLevel 매개 변수와 함께 사용할 수 있습니다. 예시: &groupby=applicationId&aggregationLevel=week	아니요

요청 예시

다음의 예시는 광고 캠페인 성과 데이터를 가져오기 위한 몇 가지 요청을 보여줍니다.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?aggregationLevel=week&groupby=applicationId,campaignId,date  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?applicationId=9NBLGGH0XK8Z&startDate=2015/1/20&endDate=2016/8/31&skip=0&filter=campaignId eq '31007388' HTTP/1.1
Authorization: Bearer <your access token>

응답

응답 본문

값	형식	설명
값	배열	집계된 광고 캠페인 성과 데이터를 포함하는 개체의 배열. 각 개체의 데이터에 대한 자세한 정보는 아래의 캠페인 성과 개체 섹션을 참조하십시오.
@nextLink	문자열	추가적인 데이터 페이지가 있는 경우, 다음 데이터 페이지를 요청하는 데 사용할 수 있는 URI가 이 문자열에 포함됩니다. 예를 들어 요청의 top 매개 변수가 5로 설정되어 있지만 쿼리에 대한 데이터 항목이 5개 이상인 경우 이 값이 반환됩니다.
TotalCount	int	쿼리에 대한 데이터 결과의 총 행 수.

캠페인 성과 개체

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

값	형식	설명
date	문자열	광고 캠페인 성과 데이터의 날짜 범위의 첫 번째 날짜. 요청에서 하루를 지정한 경우 이 값은 해당 날짜입니다. 요청에서 주, 월 또는 기타 날짜 범위를 지정한 경우, 이 값은 해당 날짜 범위 중 첫 날짜입니다.
applicationId	문자열	광고 캠페인 성과 데이터를 검색할 앱의 Store ID.
campaignId	문자열	광고 캠페인 ID.
lineId	문자열	이 성과 데이터를 생성하는 광고 캠페인 전달 라인 ID.
currencyCode	문자열	캠페인 예산의 통화 코드.
지출	문자열	광고 캠페인에 지출된 예산 금액.
impressions	long	캠페인의 광고 노출 수.
installs	long	캠페인과 관련된 앱 설치 수.
clicks	long	캠페인의 광고 클릭 수.
iapInstalls	long	캠페인에 관련되어 설치된 추가 기능(앱 내 구매 또는 IAP라고도 함)의 수.
activeUsers	long	캠페인의 일부인 광고를 클릭하고 앱으로 돌아온 사용자의 수.

응답 예시

다음의 예시는 이 요청의 JSON 응답 본문 예시를 보여 줍니다.

{
  "Value": [
    {
      "date": "2015-04-12",
      "applicationId": "9WZDNCRFJ31Q",
      "campaignId": "4568",
      "lineId": "0001",
      "currencyCode": "USD",
      "spend": 700.6,
      "impressions": 200,
      "installs": 30,
      "clicks": 8,
      "iapInstalls": 0,
      "activeUsers": 0
    },
    {
      "date": "2015-05-12",
      "applicationId": "9WZDNCRFJ31Q",
      "campaignId": "1234",
      "lineId": "0002",
      "currencyCode": "USD",
      "spend": 325.3,
      "impressions": 20,
      "installs": 2,
      "clicks": 5,
      "iapInstalls": 0,
      "activeUsers": 0
    }
  ],
  "@nextLink": "promotion?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2015/1/20&endDate=2016/8/31&top=2&skip=2",
  "TotalCount": 1917
}

다음을 통해 공유

광고 캠페인 성과 데이터 가져오기

필수 조건

Request

요청 구문

요청 헤더

요청 매개 변수

요청 예시

응답

응답 본문

캠페인 성과 개체

응답 예시

피드백

추가 리소스

다음을 통해 공유

광고 캠페인 성과 데이터 가져오기

필수 조건

Request

요청 구문

요청 헤더

요청 매개 변수

요청 예시

응답

응답 본문

캠페인 성과 개체

응답 예시

관련 항목

피드백

추가 리소스