REST Resource: guaranteedOrders

리소스: GuaranteedOrder

보장된 주문

보장 주문은 보장 인벤토리 소스의 상위 항목입니다. 보장 인벤토리 소스를 만들 때 보장 주문 ID를 인벤토리 소스에 할당해야 합니다.

JSON 표현 
{
  "name": string,
  "legacyGuaranteedOrderId": string,
  "exchange": enum (Exchange),
  "guaranteedOrderId": string,
  "displayName": string,
  "status": {
    object (GuaranteedOrderStatus)
  },
  "updateTime": string,
  "publisherName": string,
  "readAccessInherited": boolean,
  "readAdvertiserIds": [
    string
  ],
  "defaultAdvertiserId": string,
  "defaultCampaignId": string,

  // Union field read_write_accessor can be only one of the following:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of list of possible types for union field read_write_accessor.
}
필드
name

string

출력 전용입니다. 보장 주문의 리소스 이름입니다.
legacyGuaranteedOrderId

string

출력 전용입니다. 보장된 주문의 기존 ID입니다. 원래 거래소에서 할당함 기존 ID는 하나의 거래소 내에서 고유하지만 모든 보장된 주문에서 고유하지는 않습니다. 이 ID는 SDF 및 UI에서 사용됩니다.
exchange

enum (Exchange)

필수 항목입니다. 변경할 수 없습니다. 보장 주문이 발생한 거래소입니다.
guaranteedOrderId

string

출력 전용입니다. 보장된 주문의 고유 식별자입니다. 보장된 주문 ID의 형식은 {exchange}-{legacyGuaranteedOrderId}입니다.
displayName

string

필수 항목입니다. 보장 주문의 표시 이름입니다.

최대 240바이트의 UTF-8로 인코딩되어야 합니다.
status

object (GuaranteedOrderStatus)

보장 주문의 상태 설정입니다.
updateTime

string (Timestamp format)

출력 전용입니다. 보장된 주문이 마지막으로 업데이트된 타임스탬프입니다. 시스템에서 할당합니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
publisherName

string

필수 항목입니다. 보장 주문의 게시자 이름입니다.

UTF-8로 인코딩되어야 하며 최대 크기는 240바이트여야 합니다.
readAccessInherited

boolean

readWritePartnerId의 모든 광고주가 보장 주문에 대한 읽기 액세스 권한을 보유하고 있는지 여부입니다. readWritePartnerId가 설정된 경우에만 적용됩니다. true이면 readAdvertiserIds를 재정의합니다.
readAdvertiserIds[]

string (int64 format)

보장 주문에 대한 읽기 액세스 권한이 있는 광고주의 ID입니다.

이 필드는 readWriteAdvertiserId에 할당된 광고주를 포함하지 않아야 합니다(설정된 경우). 이 입력란의 모든 광고주는 readWritePartnerId 또는 readWriteAdvertiserId과(와) 동일한 파트너에 속해야 합니다.
defaultAdvertiserId

string (int64 format)

출력 전용입니다. 보장 주문의 기본 광고주의 ID입니다.

기본 광고주는 readWriteAdvertiserId이거나, 설정되지 않은 경우 readAdvertiserIds에 나열된 첫 번째 광고주입니다. 그렇지 않으면 기본 광고주가 없습니다.
defaultCampaignId

string (int64 format)

보장된 주문에 할당된 기본 캠페인의 ID입니다.

기본 캠페인은 기본 광고주에 속해야 합니다.

통합 필드 read_write_accessor. 필수 항목입니다.

보장 주문에 대한 읽기/쓰기 액세스 권한이 있는 파트너 또는 광고주입니다. read_write_accessor는 다음 중 하나여야 합니다.
readWritePartnerId

string (int64 format)

보장된 주문에 대한 읽기/쓰기 액세스 권한이 있는 파트너입니다.
readWriteAdvertiserId

string (int64 format)

보장된 주문에 대한 읽기/쓰기 액세스 권한이 있는 광고주입니다. 이는 보장 주문의 기본 광고주이기도 합니다.

GuaranteedOrderStatus

보장 주문의 상태 설정입니다.

JSON 표현 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
필드
entityStatus

enum (EntityStatus)

보장된 주문을 처리할 수 있는지 여부입니다.

허용되는 값은 ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED, ENTITY_STATUS_PAUSED입니다. 기본값은 ENTITY_STATUS_ACTIVE입니다.
entityPauseReason

string

사용자가 이 보장 주문을 일시중지한 이유입니다.

최대 길이 100바이트로 UTF-8로 인코딩되어야 합니다.

entityStatus가 ENTITY_STATUS_PAUSED로 설정된 경우에만 적용됩니다.
configStatus

enum (GuaranteedOrderConfigStatus)

출력 전용입니다. 보장 주문의 구성 상태입니다.

허용되는 값은 PENDING 및 COMPLETED입니다.

게재되기 전에 보장된 주문을 구성해야 합니다(필수 입력란 작성, 광고 소재 선택, 기본 캠페인 선택). 현재 구성 작업은 UI를 통해서만 실행할 수 있습니다.

GuaranteedOrderConfigStatus

보장된 주문의 가능한 구성 상태입니다.

열거형
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED 이 버전에서 승인 상태가 지정되지 않았거나 알 수 없습니다.
PENDING 보장된 주문의 시작 상태입니다. 이 상태의 보장된 주문은 게재되기 전에 구성해야 합니다.
COMPLETED 구매자가 보장된 주문을 구성한 후의 상태입니다.

메서드

create

 새 보장 주문을 만듭니다.

editGuaranteedOrderReadAccessors

 보장 주문의 읽기 광고주를 수정합니다.

get

 보장된 주문을 가져옵니다.

list

 현재 사용자가 액세스할 수 있는 보장된 주문을 나열합니다.

patch

 기존의 보장 주문을 업데이트합니다.