광고 캠페인 관리

아티클
03/10/2024

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

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

이러한 메서드를 사용하여 캠페인을 만들거나 업데이트하면 일반적으로 다음 메서드 중 하나 이상을 호출하여 캠페인과 연결된 배달 라인, 대상 프로필 및 크리에이티브를 관리할 수도 있습니다. 광고 캠페인, 배달 라인, 대상 프로필, 크리에이티브 간의 관계에 대한 자세한 내용은 Microsoft Store 서비스를 사용하여 광고 캠페인 실행을 참조하세요.

필수 조건

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

아직 수행하지 않은 경우 Microsoft Store 프로모션 API에 대한 필수 구성 요소를 모두 완료합니다.

참고 필수 구성 요소의 일부로 파트너 센터에서 하나 이상의 유료 광고 캠페인을 만들고 파트너 센터에서 광고 캠페인에 대한 하나 이상의 결제 방법을 추가해야 합니다. 이 API를 사용하여 만든 광고 캠페인의 배송 라인은 파트너 센터의 광고 캠페인 페이지에서 선택한 기본 결제 방법에 자동으로 청구됩니다.
이러한 메서드의 요청 헤더에 사용할 Azure AD 액세스 토큰을 가져옵니다. 액세스 토큰을 가져온 후 만료되기까지 60분이 걸립니다. 토큰이 만료된 후 새 토큰을 가져올 수 있습니다.

Request

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

메서드 형식	요청 URI	설명
게시	`https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign`	새 광고 캠페인을 만듭니다.
PUT	`https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign/{campaignId}`	campaignId에서 지정한 광고 캠페인을 편집합니다.
GET	`https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign/{campaignId}`	campaignId에서 지정한 광고 캠페인을 가져옵니다.
GET	`https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign`	광고 캠페인을 쿼리합니다. 지원되는 쿼리 매개 변수는 매개 변수 섹션을 참조하세요.

헤더	유형	설명
Authorization	문자열	필수. Bearer<토큰> 형식의 Azure AD 액세스 토큰입니다.
추적 ID	GUID	선택 사항. 호출 흐름을 추적하는 ID입니다.

매개 변수

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

이름	형식	설명
skip	int	쿼리에서 건너뛸 행 수. 이 매개 변수를 사용하여 데이터 집합을 페이징합니다. 예를 들어 fetch=10 및 skip=0은 데이터의 처음 10개 행을 검색하고, top=10 및 skip=10은 데이터의 다음 10개 행을 검색하는 방식 등으로 수행됩니다.
fetch	int	요청에서 반환할 데이터 행의 수.
campaignSetSortColumn	string	지정된 필드를 기준으로 응답 본문의 캠페인 개체의 순서를 지정합니다. 구문은 CampaignSetSortColumn=field이며, 여기서 field 매개 변수는 다음 문자열 중 하나일 수 있습니다. id createdDateTime 기본값은 createdDateTime입니다.
isDescending	Boolean	응답 본문의 캠페인 개체를 내림차순 또는 오름차순으로 정렬합니다.
storeProductId	string	이 값을 사용하여 지정된 Store ID의 앱에 연결된 광고 캠페인만 반환합니다. 제품에 대한 Store ID 예제는 9nblggh42cfd입니다.
label	string	이 값을 사용하여 캠페인 개체에서 지정된 label이 포함된 광고 캠페인만 반환합니다.

요청 본문

POST 및 PUT 메서드에는 캠페인 개체의 필수 필드 및 설정하거나 변경하려는 추가 필드가 있는 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>

응답

이러한 메서드는 호출한 메서드에 따라 하나 이상의 캠페인 개체가 있는 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	정수	광고 캠페인 ID.	예		없음
이름	string	광고 캠페인의 이름입니다.	예		예
configuredStatus	string	개발자가 지정한 광고 캠페인의 상태를 지정하는 다음 값 중 하나입니다. 진행 중 비활성	아니요	활성	예
effectiveStatus	string	시스템 유효성 검사에 따라 광고 캠페인의 유효성 상태를 지정하는 다음 값 중 하나입니다. 진행 중 비활성 처리 중	예		아니요
effectiveStatusReasons	배열	광고 캠페인의 유효성 상태에 대한 이유를 지정하는 다음 값 중 하나 이상입니다. AdCreativesInactive BillingFailed AdLinesInactive ValidationFailed 실패함	예		아니요
storeProductId	string	이 광고 캠페인이 연결된 앱에 대한 Store ID입니다. 제품에 대한 Store ID 예제는 9nblggh42cfd입니다.	예		예
레이블	배열	캠페인에 대한 사용자 지정 레이블을 나타내는 하나 이상의 문자열입니다. 이러한 레이블을 캠페인 검색 및 태그 지정에 사용할 수 있습니다.	아니요	null	아니요
type	string	캠페인 유형을 지정하는 다음 값 중 하나입니다. 유료 집 커뮤니티	예		예
목표	string	캠페인 목표를 지정하는 다음 값 중 하나입니다. DriveInstall DriveReengagement DriveInAppPurchase	아니요	DriveInstall	예
lines	배열	광고 캠페인과 연결된 배달 라인을 식별하는 하나 이상의 개체입니다. 이 필드의 각 개체는 배달 라인의 ID와 이름을 지정하는 id 및 name 필드로 구성됩니다.	아니요		아니요
createdDate	string	광고 캠페인을 만든 ISO 8601 형식의 날짜 및 시간입니다.	예		아니요

광고 캠페인 관리

필수 조건

Request

헤더

매개 변수

요청 본문

요청 예제

응답

캠페인 개체

피드백

피드백

추가 리소스

광고 캠페인 관리

필수 조건

Request

헤더

매개 변수

요청 본문

요청 예제

응답

캠페인 개체

관련 항목

피드백

피드백

추가 리소스