크리에이티브 관리
Microsoft Store 프로모션 API에서 이 메서드를 사용하여 홍보용 광고 캠페인에서 사용할 사용자 고유의 사용자 지정 크리에이티브를 업로드하거나 기존 크리에이티브를 가져옵니다. 크리에이티브는 하나 이상의 배달 라인과 연결될 수 있으며, 항상 동일한 앱을 나타내는 경우 여러 광고 캠페인에서 공유될 수도 있습니다.
크리에이티브와 광고 캠페인, 배달 라인 및 대상 프로필 간의 관계에 대한 자세한 내용은 Microsoft Store 서비스를 사용하여 광고 캠페인 실행을 참조하세요.
참고 항목
이 API를 사용하여 사용자 고유의 크리에이티브를 업로드하는 경우 크리에이티브에 허용되는 최대 크기는 40KB입니다. 이보다 큰 크리에이티브 파일을 제출하면 이 API에서 오류를 반환하지는 않지만 캠페인이 성공적으로 만들어지지 않습니다.
필수 조건
이 메서드를 사용하려면 먼저 다음을 수행해야 합니다.
- 아직 수행하지 않은 경우 Microsoft Store 프로모션 API에 대한 필수 구성 요소를 모두 완료합니다.
- 이러한 메서드의 요청 헤더에 사용할 Azure AD 액세스 토큰을 가져옵니다. 액세스 토큰을 가져온 후 만료되기까지 60분이 걸립니다. 토큰이 만료된 후 새 토큰을 가져올 수 있습니다.
Request
이러한 메서드에 있는 URI는 다음과 같습니다.
메서드 형식 | 요청 URI | 설명 |
---|---|---|
게시 | https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative |
새 크리에이티브를 만듭니다. |
GET | https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/{creativeId} |
creativeId에서 지정한 크리에이티브를 가져옵니다. |
참고 항목
이 API는 현재 PUT 메서드를 지원하지 않습니다.
헤더
헤더 | 형식 | 설명 |
---|---|---|
권한 부여 | string | 필수. Bearer<토큰> 형식의 Azure AD 액세스 토큰입니다. |
추적 ID | GUID | 선택 사항. 호출 흐름을 추적하는 ID입니다. |
요청 본문
POST 메서드에는 크리에이티브 개체의 필수 필드가 있는 JSON 요청 본문이 필요합니다.
요청 예제
다음 예제에서는 POST 메서드를 호출하여 크리에이티브를 만드는 방법을 보여 줍니다. 간단히 하기 위해 이 예제에서 content 값을 줄였습니다.
POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative HTTP/1.1
Authorization: Bearer <your access token>
{
"name": "Contoso App Campaign - Creative 1",
"content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAgGB...other base64 data shortened for brevity...",
"height": 80,
"width": 480,
"imageAttributes":
{
"imageExtension": "PNG"
}
}
다음 예제에서는 GET 메서드를 호출하여 크리에이티브를 검색하는 방법을 보여 줍니다.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/106851 HTTP/1.1
Authorization: Bearer <your access token>
Response
이러한 메서드는 만들거나 검색한 크리에이티브에 대한 정보가 포함된 크리에이티브 개체가 있는 JSON 응답 본문을 반환합니다. 다음 예제에서는 이러한 메서드에 대한 응답 본문을 보여 줍니다. 간단히 하기 위해 이 예제에서 content 값을 줄였습니다.
{
"Data": {
"id": 106126,
"name": "Contoso App Campaign - Creative 2",
"content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAgGB...other base64 data shortened for brevity...",
"height": 50,
"width": 300,
"format": "Banner",
"imageAttributes":
{
"imageExtension": "PNG"
},
"storeProductId": "9nblggh42cfd"
}
}
크리에이티브 개체
이러한 메서드에 대한 요청 및 응답 본문에는 다음 필드가 포함됩니다. 다음 표에서는 읽기 전용(PUT 메서드에서 변경할 수 없음을 의미) 필드와 POST 메서드에 대한 요청 본문에 필요한 필드를 보여 줍니다.
필드 | 형식 | 설명 | 읽기 전용 | 기본 | POST에 필요한지 여부 |
---|---|---|---|---|---|
id | 정수 | 크리에이티브의 ID입니다. | 예 | 없음 | |
이름 | string | 크리에이티브의 이름입니다. | 예 | 예 | |
content | string | Base64 인코딩 형식의 크리에이티브 이미지 콘텐츠입니다. 참고 크리에이티브에 허용되는 최대 크기는 40KB입니다. 이보다 큰 크리에이티브 파일을 제출하면 이 API에서 오류를 반환하지는 않지만 캠페인이 성공적으로 만들어지지 않습니다. |
예 | 예 | |
높이 | 정수 | 크리에이티브의 높이입니다. | 예 | 예 | |
width | 정수 | 크리에이티브의 너비입니다. | 예 | 예 | |
landingUrl | string | AppsFlyer, Kochava, Tune 또는 Vungle과 같은 캠페인 추적 서비스를 사용하여 앱에 대한 설치 분석을 측정하는 경우 POST 메서드를 호출할 때 추적 URL을 이 필드에 할당합니다(지정하는 경우 이 값은 유효한 URI여야 함). 캠페인 추적 서비스를 사용하지 않는 경우 POST 메서드를 호출할 때 이 값을 생략합니다(이 경우 이 URL이 자동으로 만들어짐). | 예 | 예 | |
format | string | 광고 형식입니다. 현재 지원되는 유일한 값은 Banner 값입니다. | 아니요 | 배너 | 아니요 |
imageAttributes | ImageAttributes | 크리에이티브에 대한 속성을 제공합니다. | 예 | 예 | |
storeProductId | string | 이 광고 캠페인이 연결된 앱에 대한 Store ID입니다. 제품에 대한 Store ID 예제는 9nblggh42cfd입니다. | 아니요 | 아니요 |
ImageAttributes 개체
필드 | 형식 | 설명 | 읽기 전용 | Default value | POST에 필요한지 여부 |
---|---|---|---|---|---|
imageExtension | string | PNG 또는 JPG 값 중 하나입니다. | 예 | 예 |