다음을 통해 공유

광고 캠페인 관리

Microsoft Store 프로모션 API 이러한 방법을 사용하여 앱에 대한 홍보용 광고 캠페인을 만들고 편집하고 가져옵니다. 이 방법을 사용하여 만든 각 캠페인은 하나의 앱에만 연결할 수 있습니다.

참고 파트너 센터를 사용하여 광고 캠페인을 만들고 관리할 수도 있으며, 프로그래밍 방식으로 만든 캠페인에 파트너 센터에서 액세스할 수 있습니다. 파트너 센터에서 광고 캠페인을 관리하는 방법에 대한 자세한 내용은 앱대한 광고 캠페인 만들기를 참조하세요.

이러한 방법을 사용하여 캠페인을 만들거나 업데이트할 때, 일반적으로 캠페인과 연관된 배달 라인, 대상 프로필, 그리고 크리에이티브를 관리하기 위해 다음 방법 중 하나 이상을 호출합니다. 캠페인, 배달 라인, 타겟팅 프로필 및 크리에이티브 간의 관계에 대한 자세한 내용은 Microsoft Store 서비스사용하여 광고 캠페인 실행을 참조하세요.

필수 조건

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

  • 아직 완료하지 않았다면, Microsoft Store 프로모션 API를 위한 모든 필수 구성 요소를 완료하세요.

    참고 필수 구성 요소의 일부로 파트너 센터 하나 이상의 유료 광고 캠페인을 만들 있고 파트너 센터에서 광고 캠페인에 대해 하나 이상의 결제 방법을 추가해야 합니다. 이 API를 사용하여 만든 광고 캠페인의 배달 라인은 파트너 센터의 광고 캠페인 페이지에서 선택한 기본 결제 방법을 자동으로 청구합니다.

  • 이러한 메서드에 대한 요청 헤더에 사용할 Azure AD 액세스 토큰 가져옵니다. 액세스 토큰을 받은 후 60분 이내에 사용해야 합니다. 그렇지 않으면 만료됩니다. 토큰이 만료되면 새 토큰을 가져올 수 있습니다.

요청

이러한 메서드에는 다음 URI가 있습니다.

메서드 형식 URI 요청 설명
게시하기 https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign 새 광고 캠페인을 만듭니다.
놓다 https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign/{campaignId} campaignId지정된 광고 캠페인을 편집합니다.
가져오기 https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign/{campaignId} campaignId로 지정된 광고 캠페인을 가져옵니다.
가져오기 https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign 광고 캠페인에 대한 쿼리입니다. 지원되는 쿼리 매개 변수는 매개 변수 섹션을 참조하세요.
헤더 유형 설명
승인 문자열 필수 사항입니다. Azure AD 액세스 토큰은 Bearer<token> 형식입니다.
추적 번호 GUID 선택 사항입니다. 호출 흐름을 추적하는 ID입니다.

 

매개 변수

광고 캠페인을 쿼리하는 GET 메서드는 다음과 같은 선택적 쿼리 매개 변수를 지원합니다.

이름 유형 설명
건너뛰기 정수 (int) 쿼리에서 건너뛸 행의 수를 지정합니다. 이 매개 변수를 사용하여 데이터 집합을 탐색합니다. 예를 들어 fetch=10 및 skip=0은 데이터의 처음 10개 행을 검색하고 top=10 및 skip=10은 다음 10개의 데이터 행을 검색합니다.
가져오다 정수 (int) 요청에 반환할 데이터 행 수입니다.
캠페인 설정 정렬 열 문자열 지정된 필드에 따라 응답 본문의 캠페인 개체를 정렬합니다. 구문은 CampaignSetSortColumn=field입니다. 여기서 필드 매개 변수는 다음 문자열 중 하나일 수 있습니다.

  • 아이디
  • 생성 날짜 및 시간

기본값은 createdDateTime입니다.
내림차순인지 불리언 (Boolean) 응답 본문의 Campaign 개체를 내림차순 또는 오름차순으로 정렬합니다.
스토어제품ID 문자열 이 값을 사용하여 지정된 스토어 ID앱과 연결된 광고 캠페인만 반환합니다. 제품에 대한 상점 ID의 예는 9nblggh42cfd입니다.
라벨 문자열 이 값을 사용하여 캠페인 개체에 지정된 레이블 포함하는 광고 캠페인만 반환합니다.

요청 메시지 본문

POST 및 PUT 메서드에는 Campaign 개체의 필수 필드와 설정하거나 변경하려는 추가 필드가 있는 JSON 요청 본문이 필요합니다.

요청 예제

다음 예제에서는 POST 메서드를 호출하여 광고 캠페인을 만드는 방법을 보여 줍니다.

POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign HTTP/1.1
Authorization: Bearer <your access token>

{
    "name": "Contoso App Campaign",
    "storeProductId": "9nblggh42cfd",
    "configuredStatus": "Active",
    "objective": "DriveInstalls",
    "type": "Community"
}

다음 예제에서는 GET 메서드를 호출하여 특정 광고 캠페인을 검색하는 방법을 보여 줍니다.

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign/31043481  HTTP/1.1
Authorization: Bearer <your access token>

다음 예제에서는 GET 메서드를 호출하여 만든 날짜를 기준으로 정렬된 광고 캠페인 집합을 쿼리하는 방법을 보여 줍니다.

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign?storeProductId=9nblggh42cfd&fetch=100&skip=0&campaignSetSortColumn=createdDateTime HTTP/1.1
Authorization: Bearer <your access token>

응답

이러한 메서드는 호출한 메서드에 따라 하나 이상의 Campaign 개체가 있는 JSON 응답 본문을 반환합니다. 다음 예제에서는 특정 캠페인에 대한 GET 메서드에 대한 응답 본문을 보여 줍니다.

{
    "Data": {
        "id": 31043481,
        "name": "Contoso App Campaign",
        "createdDate": "2017-01-17T10:12:15Z",
        "storeProductId": "9nblggh42cfd",
        "configuredStatus": "Active",
        "effectiveStatus": "Active",
        "effectiveStatusReasons": [
            "{\"ValidationStatusReasons\":null}"
        ],
        "labels": [],
        "objective": "DriveInstalls",
        "type": "Paid",
        "lines": [
            {
                "id": 31043476,
                "name": "Contoso App Campaign - Paid Line"
            }
        ]
    }
}

캠페인 개체

이러한 메서드에 대한 요청 및 응답 본문에는 다음 필드가 포함됩니다. 다음 표에서는 읽기 전용인 필드(PUT 메서드에서 변경할 수 없음) 및 POST 메서드에 대한 요청 본문에 필요한 필드를 보여 줍니다.

분야 유형 설명 읽기 전용 기본값 POST 요청에 필요합니다
아이디 정수 광고 캠페인의 ID입니다. 예 아니오
이름 문자열 광고 캠페인의 이름입니다. 아니오 예
구성된 상태 문자열 개발자가 지정한 광고 캠페인의 상태를 지정하는 다음 값 중 하나입니다.
  • 진행 중
  • 비활성
 아니오 활동 중 예
유효 상태 문자열 시스템 유효성 검사에 따라 광고 캠페인의 유효 상태를 지정하는 다음 값 중 하나입니다.
  • 진행 중
  • 비활성
  • 처리 중
 예 아니오
유효한 상태 이유 배열 광고 캠페인의 유효 상태에 대한 이유를 지정하는 다음 값 중 하나 이상:
  • AdCreativesInactive
  • 결제 실패
  • AdLinesInactive
  • 검증실패
  • 실패
 예 아니오
스토어제품ID 문자열 앱에 연결된 이 광고 캠페인의 스토어 ID는입니다. 제품에 대한 상점 ID의 예는 9nblggh42cfd입니다. 예 예
라벨 배열 캠페인에 대한 사용자 지정 레이블을 나타내는 하나 이상의 문자열입니다. 이러한 레이블은 캠페인 검색 및 태그 지정에 사용됩니다. 아니오 영 아니오
유형 문자열 캠페인 유형을 지정하는 다음 값 중 하나입니다.
  • 유료
  • 집
  • 커뮤니티
 예 예
목표 문자열 캠페인의 목표를 지정하는 다음 값 중 하나입니다.
  • 드라이브 설치
  • DriveReengagement
  • 인앱구매
 아니오 드라이브 설치 예
라인 배열 광고 캠페인과 관련된 배달 라인을 식별하는 하나 이상의 객체입니다. 이 필드의 각 개체는 배달 줄의 ID와 이름을 지정하는 id 필드 및 이름 필드로 구성됩니다. 아니오 아니오
생성일 문자열 광고 캠페인을 만든 날짜와 시간(ISO 8601 형식)입니다. 예 아니오