Method: orders.patch

注文を 3p から AOG に更新します。注文 ID が空か、既存の注文と一致しない場合は、INVALID_ARGUMENT を返します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 は注文全体になります。タイプが 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)

購入手続きを処理した販売者。項目レベルのプロバイダとは異なる場合があります。例: Expedia の注文における ANA の項目。
orderUpdate.order.contents

object (Contents)

必須: すべての項目を 1 つにまとめた注文内容。

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

任意の型のフィールドを含むオブジェクト。型を識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }
orderUpdate.updateMask

string (FieldMask format)

注: 以下の特別なフィールドには次の考慮事項や推奨事項があります。1. order.last_update_time は常に更新リクエストの一部として更新されます。2. order.create_time、order.google_order_id、order.merchant_order_id は、updateMask の一部として指定した場合は無視されます。

完全修飾された項目名のカンマ区切りリスト。例: "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 は注文全体になります。タイプが ORDER_STATUS の場合は、注文レベルのステータスが変更されます。order.last_update_time とこのカテゴリのステータスのみが取得されます。注: type.ORDER_STATUS は PurcahaseOrderExtension のステータス更新のみをサポートし、このサポートを拡張する予定はありません。代わりに、updateMask を使用することをおすすめします。これはより汎用的かつ拡張可能で、すべてのカテゴリで使用できます。
order

object (Order)
updateMask

string (FieldMask format)

注: 以下の特別なフィールドには次の考慮事項や推奨事項があります。1. order.last_update_time は常に更新リクエストの一部として更新されます。2. order.create_time、order.google_order_id、order.merchant_order_id は、updateMask の一部として指定した場合は無視されます。

完全修飾された項目名のカンマ区切りリスト。例: "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 文字です。