배달 라인 관리

Microsoft Store 프로모션 API에서 이러한 메서드를 사용하여 하나 이상의 배달 라인을 만들어 인벤토리를 구매하고 홍보용 광고 캠페인에 대한 광고를 배달합니다. 각 배달 라인에 대해 타기팅을 설정하고, 입찰 가격을 설정할 수 있으며, 예산을 설정하고 사용할 크리에이티브와 연결하여 지출할 금액을 결정할 수 있습니다.

배달 라인과 광고 캠페인, 대상 프로필, 크리에이티브 간의 관계에 대한 자세한 내용은 Microsoft Store 서비스를 사용하여 광고 캠페인 실행을 참조하세요.

참고 이 API를 사용하여 광고 캠페인에 대한 배달 라인을 성공적으로 만들려면 먼저 파트너 센터에서 광고 캠페인 페이지를 사용하여 하나의 유료 광고 캠페인을 만들고 이 페이지에서 하나 이상의 결제 방법을 추가해야 합니다. 이렇게 하면 이 API를 사용하여 광고 캠페인에 대한 청구 가능한 배달 라인을 성공적으로 만들 수 있습니다. API를 사용하여 만든 광고 캠페인에 대한 요금은 파트너 센터의 광고 캠페인 페이지에서 선택한 기본 결제 방법에 자동으로 청구됩니다.

필수 조건

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

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

    참고 항목

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

  • 이러한 메서드의 요청 헤더에 사용할 Azure AD 액세스 토큰을 가져옵니다. 액세스 토큰을 가져온 후 만료되기까지 60분이 걸립니다. 토큰이 만료된 후 새 토큰을 가져올 수 있습니다.

Request

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

메서드 형식 요청 URI 설명
게시 https://manage.devcenter.microsoft.com/v1.0/my/promotion/line 새 배달 라인을 만듭니다.
PUT https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/{lineId} lineId에서 지정한 배달 라인을 편집합니다.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/{lineId} lineId에서 지정한 배달 라인을 가져옵니다.
헤더 유형 설명
Authorization 문자열 필수. Bearer<토큰> 형식의 Azure AD 액세스 토큰입니다.
추적 ID GUID 선택 사항. 호출 흐름을 추적하는 ID입니다.

요청 본문

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

요청 예제

다음 예제에서는 POST 메서드를 호출하여 배달 라인을 만드는 방법을 보여 줍니다.

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

{
    "name": "Contoso App Campaign - Paid Line",
    "configuredStatus": "Active",
    "startDateTime": "2017-01-19T12:09:34Z",
    "endDateTime": "2017-01-31T23:59:59Z",
    "bidAmount": 0.4,
    "dailyBudget": 20,
    "targetProfileId": {
        "id": 310021746
    },
    "creatives": [
        {
            "id": 106851
        }
    ],
    "campaignId": 31043481,
    "minMinutesPerImp ": 1
}

다음 예제에서는 GET 메서드를 호출하여 배달 라인을 검색하는 방법을 보여 줍니다.

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

응답

이러한 메서드는 만들거나 업데이트하거나 검색한 배달 라인에 대한 정보가 포함된 배달 라인 개체가 있는 JSON 응답 본문을 반환합니다. 다음 예제에서는 이러한 메서드에 대한 응답 본문을 보여 줍니다.

{
    "Data": {
        "id": 31043476,
        "name": "Contoso App Campaign - Paid Line",
        "configuredStatus": "Active",
        "effectiveStatus": "Active",
        "effectiveStatusReasons": [
            "{\"ValidationStatusReasons\":null}"
        ],
        "startDateTime": "2017-01-19T12:09:34Z",
        "endDateTime": "2017-01-31T23:59:59Z",
        "createdDateTime": "2017-01-17T10:28:34Z",
        "bidType": "CPM",
        "bidAmount": 0.4,
        "dailyBudget": 20,
        "targetProfileId": {
            "id": 310021746
        },
        "creatives": [
            {
                "id": 106126
            }
        ],
        "campaignId": 31043481,
        "minMinutesPerImp ": 1,
        "pacingType ": "SpendEvenly",
        "currencyId ": 732
    }
}

배달 라인 개체

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

필드 형식 설명 읽기 전용 기본값 POST/PUT에 필요한지 여부
id 정수 배달 라인의 ID입니다. 없음
이름 string 배달 라인의 이름입니다. 아니요 게시
configuredStatus string 개발자가 지정한 전달 라인의 상태를 지정하는 다음 값 중 하나입니다.
  • 진행 중
  • 비활성
아니요 게시
effectiveStatus string 시스템 유효성 검사에 따라 배달 라인의 유효성 상태를 지정하는 다음 값 중 하나입니다.
  • 진행 중
  • 비활성
  • 처리 중
  • 실패함
아니요
effectiveStatusReasons 배열 배달 라인의 유효성 상태에 대한 이유를 지정하는 다음 값 중 하나 이상입니다.
  • AdCreativesInactive
  • ValidationFailed
아니요
startDatetime string ISO 8601 형식의 배달 라인 시작 날짜 및 시간입니다. 이 값은 이미 과거인 경우 변경할 수 없습니다. 아니요 POST, PUT
endDatetime string ISO 8601 형식의 배달 라인 종료 날짜 및 시간입니다. 이 값은 이미 과거인 경우 변경할 수 없습니다. 아니요 POST, PUT
createdDatetime string 배달 라인을 만든 ISO 8601 형식의 날짜 및 시간입니다. 아니요
bidType string 배달 라인의 입찰 유형을 지정하는 값입니다. 현재 지원되는 유일한 값은 CPM 값입니다. 아니요 CPM 아니요
bidAmount decimal 광고 요청 입찰에 사용할 입찰 금액입니다. 아니요 대상 시장을 기반으로 하는 평균 CPM 값입니다(이 값은 주기적으로 수정됨). 아니요
dailyBudget decimal 배달 라인에 대한 일일 예산입니다. dailyBudget 또는 lifetimeBudget을 설정해야 합니다. 아니요 POST, PUT(lifetimeBudget을 설정하지 않은 경우)
lifetimeBudget decimal 배달 라인에 대한 수명 예산입니다. lifetimeBudget* 또는 dailyBudget을 설정해야 합니다. 아니요 POST, PUT(dailyBudget을 설정하지 않은 경우)
targetingProfileId 개체 이 배달 라인의 대상으로 지정하려는 사용자, 지역 및 인벤토리 유형을 설명하는 대상 프로필을 식별하는 개체입니다. 이 개체는 대상 프로필의 ID를 지정하는 단일 id 필드로 구성됩니다. 아니요 아니요
creatives 배열 배달 라인과 연결된 크리에이티브를 나타내는 하나 이상의 개체입니다. 이 필드의 각 개체는 크리에이티브의 ID를 지정하는 단일 id 필드로 구성됩니다. 아니요 아니요
campaignId 정수 부모 광고 캠페인의 ID입니다. 아니요 아니요
minMinutesPerImp 정수 이 배달 라인에서 동일한 사용자에게 표시되는 두 광고 노출 간의 최소 시간 간격(분)을 지정합니다. 아니요 4000 아니요
pacingType string 속도 유형을 지정하는 다음 값 중 하나입니다.
  • SpendEvenly
  • SpendAsFastAsPossible
아니요 SpendEvenly 아니요
currencyId 정수 캠페인 통화의 ID입니다. 개발자 계정의 통화입니다(POST 또는 PUT 호출에서 이 필드를 지정할 필요가 없음). 아니요