REST Resource: orders

리소스: Order

주문은 광고를 표시할 시기와 위치를 지정하는 Lines의 모음입니다.

JSON 표현 
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "orderState": enum (OrderState),
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  }
}
필드
name

string

출력 전용입니다. 주문의 리소스 이름으로, orders/{id}` 형식입니다.
externalId

string

선택사항입니다. 이 항목을 외부 소스에 매핑하는 데 사용되는 ID입니다.
displayName

string

출력 전용입니다. 주문의 표시 이름입니다.

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

string

출력 전용입니다. 주문을 설명하는 추가 자유 형식 필드입니다.
orderState

enum (OrderState)

출력 전용입니다. 선의 상태를 기반으로 계산된 주문 상태를 나타냅니다.
createTime

string (Timestamp format)

출력 전용입니다. 주문의 생성 타임스탬프입니다.

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

string (Timestamp format)

출력 전용입니다. 주문의 최종 업데이트된 타임스탬프입니다.

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

object (AdvertiserInfo)

출력 전용입니다. 광고주 정보

OrderState

주문 상태입니다.

열거형
ORDER_STATE_UNSPECIFIED 이 버전에서 주문 상태가 지정되지 않았거나 알 수 없는 경우의 기본값입니다.
ORDER_STATE_PENDING_RESERVATION

주문에는 다음이 포함됩니다.

  • 하나 이상의 행이 예약 대기 중 상태입니다.
  • 0개 이상의 행이 예약되어 있습니다.
  • 다른 모든 주에는 0선이 있습니다.
ORDER_STATE_RESERVED

주문에는 다음이 포함됩니다.

  • 줄 0개가 있을 수 있습니다
  • 하나 이상의 줄이 예약된 상태입니다.
  • 0개 이상의 행이 판매자 상태에 의해 거부되었습니다.
  • 다른 모든 주에는 0선이 있습니다.
ORDER_STATE_PENDING_BOOKING

주문에는 다음이 포함됩니다.

  • 줄 0개가 있을 수 있습니다
  • 사용할 수 없습니다.
  • 하나 이상의 노선이 예약 대기 중입니다.
  • 0개 이상의 행이 판매자 상태에 의해 거부되었습니다.
  • 0개 이상의 행이 구매자에 의해 취소되었습니다.
  • 다른 모든 주에는 0선이 있습니다.
ORDER_STATE_BOOKED

주문에는 다음이 포함됩니다.

  • 줄 0개가 있을 수 있습니다
  • 사용할 수 없습니다.
  • 행이 없습니다.
  • 한 개 이상의 행이 예약 상태에 있습니다.
  • 0개 이상의 행이 판매자 상태에 의해 거부되었습니다.
  • 0개 이상의 행이 구매자에 의해 취소되었습니다.
  • 다른 모든 주에는 0선이 있습니다.
ORDER_STATE_REJECTED_BY_SELLER

주문에는 다음이 포함됩니다.

  • 줄 0개가 있을 수 있습니다
  • 사용할 수 없습니다.
  • 행이 없습니다.
  • 예약 상태에 있는 행이 없습니다.
  • 하나 이상의 행이 판매자 상태에 의해 거부되었습니다.
  • 구매자에 의해 취소되었습니다.
  • 다른 모든 주에는 0선이 있습니다.
ORDER_STATE_CANCELLED_BY_BUYER

주문에는 다음이 포함됩니다.

  • 줄 0개가 있을 수 있습니다
  • 사용할 수 없습니다.
  • 행이 없습니다.
  • 예약 상태에 있는 행이 없습니다.
  • 거부됨
  • 에서 한 개 이상의 행을 취소했습니다.
  • 다른 모든 주에는 0선이 있습니다.
ORDER_STATE_PENDING_RESERVATION_EXPIRED

주문에는 다음이 포함됩니다.

  • 대기 중인 예약에서 1개 이상의 행이 만료되었습니다.
  • 다른 모든 주에는 0선이 있습니다.
ORDER_STATE_RESERVED_EXPIRED

주문에는 다음이 포함됩니다.

  • 예약된 항목이 하나 이상 만료되었습니다.
  • 다른 모든 주에는 0선이 있습니다.

메서드

get

 개별 주문을 검색합니다.

list

 주문을 나열합니다.

patch

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