Method: orders.patch

서드 파티에서 AOG로 주문을 업데이트합니다. 주문 ID가 비어 있거나 기존 주문과 같지 않은 경우 INVALID_ARGUMENT를 반환합니다.

HTTP 요청

PATCH https://actions.googleapis.com/v3/orders/{orderUpdate.order.merchantOrderId}

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
orderUpdate.order.merchantOrderId

string

필수: 판매자가 할당한 내부 주문 ID입니다. 이 ID는 고유해야 하며 후속 주문 업데이트 작업에 필요합니다. 이 ID는 제공된 googleOrderId 또는 다른 고유한 값으로 설정할 수 있습니다. 사용자에게 표시되는 ID는 userVisibleOrderId이며 더 사용자 친화적인 다른 값일 수 있습니다. 최대 허용 길이는 64자(영문 기준)입니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "header": {
    object (OrderRequestHeader)
  },
  "orderUpdate": {
    "type": enum (Type),
    "order": {
      "googleOrderId": string,
      "userVisibleOrderId": string,
      "userVisibleStateLabel": string,
      "buyerInfo": {
        object (UserInfo)
      },
      "image": {
        object (Image)
      },
      "createTime": string,
      "lastUpdateTime": string,
      "transactionMerchant": {
        object (Merchant)
      },
      "contents": {
        object (Contents)
      },
      "priceAttributes": [
        {
          object (PriceAttribute)
        }
      ],
      "followUpActions": [
        {
          object (Action)
        }
      ],
      "paymentData": {
        object (PaymentData)
      },
      "termsOfServiceUrl": string,
      "note": string,
      "promotions": [
        {
          object (Promotion)
        }
      ],
      "disclosures": [
        {
          object (Disclosure)
        }
      ],
      "vertical": {
        "@type": string,
        field1: ...,
        ...
      },

      // Union field verticals can be only one of the following:
      "purchase": {
        object (PurchaseOrderExtension)
      },
      "ticket": {
        object (TicketOrderExtension)
      }
      // End of list of possible types for union field verticals.
    },
    "updateMask": string,
    "userNotification": {
      object (UserNotification)
    },
    "reason": string
  }
}
필드
header

object (OrderRequestHeader)

업데이트 주문 요청의 헤더입니다.

orderUpdate.type
(deprecated)

enum (Type)

지원 중단됨: 대신 OrderUpdate.update_mask를 사용하세요. 유형이 SNAPSHOT인 경우 OrderUpdate.order가 전체 주문이어야 합니다. type = ORDER_STATUS인 경우 주문 수준 상태 변경입니다. order.last_update_time과 이 카테고리 상태만 선택됩니다. 참고: type.ORDER_STATUS는 PurcahaseOrderExtension 상태 업데이트만 지원하며 이 지원을 연장할 계획은 없습니다. 대신 updateMask가 더 일반적이고 확장 가능하며 모든 카테고리에 사용될 수 있으므로 이를 사용하는 것이 좋습니다.

orderUpdate.order.googleOrderId

string

Google에서 할당한 주문 ID입니다.

orderUpdate.order.userVisibleOrderId

string

현재 주문을 참조하는 사용자에게 표시되는 ID입니다. 이 ID는 웹사이트, 앱, 이메일을 비롯한 다른 환경에서 이 주문에 대해 표시된 ID와 일치해야 합니다.

orderUpdate.order.userVisibleStateLabel
(deprecated)

string

지원 중단됨: 대신 OrderExtensions 상태를 사용하세요. 이 주문의 상태에 대해 사용자에게 표시되는 라벨입니다.

orderUpdate.order.buyerInfo

object (UserInfo)

구매자에 관한 정보입니다.

orderUpdate.order.image

object (Image)

주문과 관련된 이미지입니다.

orderUpdate.order.createTime

string (Timestamp format)

필수: 주문이 생성된 날짜 및 시간입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프로 정밀도는 나노초 수준입니다. 예: "2014-10-02T15:01:23.045123456Z"
orderUpdate.order.lastUpdateTime

string (Timestamp format)

주문이 마지막으로 업데이트된 날짜 및 시간입니다. OrderUpdate에 필요합니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프로 정밀도는 나노초 수준입니다. 예: "2014-10-02T15:01:23.045123456Z"
orderUpdate.order.transactionMerchant

object (Merchant)

결제를 지원한 판매자입니다. 이는 광고 항목 수준 제공업체와 다를 수 있습니다. 예: ANA의 항목이 포함된 Expedia 주문

orderUpdate.order.contents

object (Contents)

필수: 광고 항목 그룹인 콘텐츠를 주문합니다.

orderUpdate.order.priceAttributes[]

object (PriceAttribute)

가격, 할인, 세금 등

orderUpdate.order.followUpActions[]

object (Action)

주문 수준의 후속 조치

orderUpdate.order.paymentData

object (PaymentData)

주문의 결제 관련 데이터입니다.

orderUpdate.order.termsOfServiceUrl

string

주문/제안된 주문에 적용되는 서비스 약관으로 연결되는 링크입니다.

orderUpdate.order.note

string

주문에 첨부된 메모

orderUpdate.order.promotions[]

object (Promotion)

이 주문과 관련된 모든 프로모션입니다.

orderUpdate.order.disclosures[]

object (Disclosure)

이 주문과 관련된 정보 공개입니다.

orderUpdate.order.vertical
(deprecated)

object

지원 중단됨: 카테고리를 대신 사용하세요. 이러한 속성은 일부 광고 항목에서 재정의하지 않는 한 모든 광고 항목에 적용됩니다. 이 카테고리는 광고 항목 수준 카테고리 유형과 일치해야 합니다. 가능한 값: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

임의 유형의 필드를 포함하는 객체입니다. 추가 필드 "@type"은 유형을 식별하는 URI를 포함합니다. 예: { "id": 1234, "@type": "types.example.com/standard/id" }
orderUpdate.updateMask

string (FieldMask format)

참고: 다음 특수 입력란에 대한 고려사항/권장사항은 다음과 같습니다. 1. order.last_update_time은 업데이트 요청의 일부로 항상 업데이트됩니다. 2. updateMask의 일부로 제공되는 경우 order.create_time, order.google_order_id, order.merchant_order_id가 무시됩니다.

쉼표로 구분된 필드의 정규화된 이름 목록입니다. 예: "user.displayName,photo"
orderUpdate.userNotification

object (UserNotification)

지정하면 지정된 제목과 텍스트가 있는 알림을 사용자에게 표시합니다. 알림을 지정하면 알림을 받도록 제안되며 반드시 알림이 전송되지는 않습니다.

orderUpdate.reason

string

변경/업데이트 이유

통합 필드 verticals. 이러한 속성은 일부 광고 항목에서 재정의하지 않는 한 모든 광고 항목에 적용됩니다. 이 카테고리는 광고 항목 수준 카테고리 유형과 일치해야 합니다. verticals은 다음 중 하나여야 합니다.
orderUpdate.order.purchase

object (PurchaseOrderExtension)

주문서

orderUpdate.order.ticket

object (TicketOrderExtension)

티켓 주문

응답 본문

성공한 경우 응답 본문에 Order의 인스턴스가 포함됩니다.

OrderUpdate

주문을 업데이트합니다.

JSON 표현 
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
필드
type
(deprecated)

enum (Type)

지원 중단됨: 대신 OrderUpdate.update_mask를 사용하세요. 유형이 SNAPSHOT인 경우 OrderUpdate.order가 전체 주문이어야 합니다. type = ORDER_STATUS인 경우 주문 수준 상태 변경입니다. order.last_update_time과 이 카테고리 상태만 선택됩니다. 참고: type.ORDER_STATUS는 PurcahaseOrderExtension 상태 업데이트만 지원하며 이 지원을 연장할 계획은 없습니다. 대신 updateMask가 더 일반적이고 확장 가능하며 모든 카테고리에 사용될 수 있으므로 이를 사용하는 것이 좋습니다.
order

object (Order)
updateMask

string (FieldMask format)

참고: 다음 특수 입력란에 대한 고려사항/권장사항은 다음과 같습니다. 1. order.last_update_time은 업데이트 요청의 일부로 항상 업데이트됩니다. 2. updateMask의 일부로 제공되는 경우 order.create_time, order.google_order_id, order.merchant_order_id가 무시됩니다.

쉼표로 구분된 필드의 정규화된 이름 목록입니다. 예: "user.displayName,photo"
userNotification

object (UserNotification)

지정하면 지정된 제목과 텍스트가 있는 알림을 사용자에게 표시합니다. 알림을 지정하면 알림을 받도록 제안되며 반드시 알림이 전송되지는 않습니다.

reason

string

변경/업데이트 이유

유형

지원 중단됨: 대신 OrderUpdate.update_mask를 사용하세요. 주문의 업데이트를 허용했습니다.

열거형
TYPE_UNSPECIFIED 유형이 지정되지 않았습니다. 명시적으로 설정하면 안 됩니다.
ORDER_STATUS 주문 상태만 업데이트합니다.
SNAPSHOT 주문 스냅샷을 업데이트합니다.

UserNotification

주문 업데이트의 일부로 표시할 사용자 알림(선택사항)입니다.

JSON 표현 
{
  "title": string,
  "text": string
}
필드
title

string

사용자 알림의 제목입니다. 최대 허용 길이는 30자(영문 기준)입니다.

text

string

알림의 콘텐츠입니다. 최대 허용 길이는 100자(영문 기준)입니다.