Order

注文エンティティ。注: 1. 特に指定されていない限り、すべてのレベルの文字列はすべて 1,000 文字未満にする必要があります。2. 特に指定されていない限り、すべてのレベルの繰り返しフィールドの数は 50 未満にする必要があります。3. 指定する場合、すべてのレベルのタイムスタンプは有効なタイムスタンプである必要があります。

JSON 表現
{
  "googleOrderId": string,
  "merchantOrderId": 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.
}
フィールド
googleOrderId

string

Google が割り当てた注文 ID。

merchantOrderId

string

必須: 販売者が割り当てた内部注文 ID。この ID は一意でなければならず、後続の注文更新操作に必要です。この ID は、指定された googleOrderId などの固有の値に設定できます。ユーザーに表示される ID は userVisibleOrderId ですが、ユーザー フレンドリーな別の値にすることもできます。最大文字数は 128 文字です。

userVisibleOrderId

string

現在の注文を参照する、ユーザーに表示される ID。この ID は、ウェブサイト、アプリ、メールなど、他のコンテキストで表示されるこの注文の ID と一致している必要があります。

userVisibleStateLabel
(deprecated)

string

非推奨: 代わりに OrderExtensions ステータスを使用してください。この注文の状態についてユーザーに表示されるラベル。

buyerInfo

object (UserInfo)

購入者に関する情報を確認できます。

image

object (Image)

注文が関連付けられている画像。

createTime

string (Timestamp format)

必須: この注文が作成された日時。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒(例: "2014-10-02T15:01:23.045123456Z")。

lastUpdateTime

string (Timestamp format)

この注文が最後に更新された日時。OrderUpdate の場合は必須です。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。(例: "2014-10-02T15:01:23.045123456Z")。

transactionMerchant

object (Merchant)

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

contents

object (Contents)

必須: 広告申込情報のグループである注文コンテンツ。

priceAttributes[]

object (PriceAttribute)

価格、割引、税金など。

followUpActions[]

object (Action)

注文レベルでのフォローアップ アクション。

paymentData

object (PaymentData)

注文の支払い関連のデータ。

termsOfServiceUrl

string

注文/提案された注文に適用される利用規約へのリンク。

note

string

注文に添付されたメモ。

promotions[]

object (Promotion)

この注文に関連付けられているすべてのプロモーション。

disclosures[]

object (Disclosure)

この注文に関連付けられている開示。

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" }

共用体フィールド verticals。一部の項目で上書きされない限り、これらのプロパティはすべての項目に適用されます。このカテゴリは項目レベルのカテゴリタイプと一致している必要があります。verticals は次のいずれかになります。
purchase

object (PurchaseOrderExtension)

注文番号

ticket

object (TicketOrderExtension)

チケットの注文

目次

項目のラッパー。

JSON 表現
{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}
フィールド
lineItems[]

object (LineItem)

注文の項目のリスト。少なくとも 1 つの lineItem が必要です。最大 50 個まで指定できます。項目はすべて同じカテゴリに属している必要があります。

PaymentData

注文に関連する支払いデータ。

JSON 表現
{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
フィールド
paymentResult

object (PaymentResult)

取引を完了するためにインテグレータによって使用される支払い結果。このフィールドは、購入手続きが Actions on Google によって管理されている場合、Actions on Google によって入力されます。

paymentInfo

object (PaymentInfo)

注文に関する支払い情報。ユーザーが対応する際に有用な情報です。

PaymentResult

取引を完了するためにインテグレータによって使用された支払い結果。

JSON 表現
{

  // Union field result can be only one of the following:
  "googlePaymentData": string,
  "merchantPaymentMethodId": string
  // End of list of possible types for union field result.
}
フィールド
共用体フィールド result。Google の支払いデータと販売者の支払い方法のどちらかが提供されます。result は次のいずれかになります。
googlePaymentData

string

Google によって提供される支払い方法に関するデータ。お客様の決済代行業者が Google でサポートされている決済代行業者のリスト(https://developers.google.com/pay/api/)にある場合、このリンクからお客様の決済代行業者にアクセスし、詳細情報を確認してください。それ以外の場合は、次のドキュメントでペイロードの詳細をご覧ください。https://developers.google.com/pay/api/payment-data-cryptography

merchantPaymentMethodId

string

ユーザーが選択した、販売者またはアクションが指定したお支払い方法。

PaymentInfo

行われている注文に関する支払い情報。このプロトコルは、ユーザーに表示される操作に役立つ情報をキャプチャします。

JSON 表現
{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
フィールド
paymentMethodDisplayInfo

object (PaymentMethodDisplayInfo)

取引に使用されたお支払い方法の表示情報。

paymentMethodProvenance

enum (PaymentMethodProvenance)

取引に使用された支払い方法の提供元。ユーザーは Google と販売者の両方に同じお支払い方法を登録している場合があります。

PaymentMethodDisplayInfo

取引を完了するためにインテグレータによって使用された支払い結果。

JSON 表現
{
  "paymentType": enum (PaymentType),
  "paymentMethodDisplayName": string
}
フィールド
paymentType

enum (PaymentType)

支払いの種類。

paymentMethodDisplayName

string

ユーザーに表示される支払い方法の名前。例: VISA **** 1234 当座預金口座 **** 5678

プロモーション

カートに追加されたプロモーションまたはクーポン。

JSON 表現
{
  "coupon": string
}
フィールド
coupon

string

必須: この特典に適用されるクーポンコード。

PurchaseOrderExtension

購入カテゴリの注文拡張。項目で上書きされない限り、これらのプロパティは注文内のすべての項目に適用されます。

JSON 表現
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  },
  "purchaseLocationType": enum (PurchaseLocationType),
  "errors": [
    {
      object (PurchaseError)
    }
  ]
}
フィールド
status

enum (PurchaseStatus)

必須: 注文の全体的なステータス。

userVisibleStatusLabel

string

ユーザーに表示されるステータスのラベルまたは文字列。最大文字数は 50 文字です。

type

enum (PurchaseType)

必須: 購入のタイプ。

returnsInfo

object (PurchaseReturnsInfo)

注文の返品情報。

fulfillmentInfo

object (PurchaseFulfillmentInfo)

注文のフルフィルメント情報。

extension

object

販売者と Google の間で交換される追加フィールド。

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

purchaseLocationType

enum (PurchaseLocationType)

購入場所(店舗またはオンライン)

errors[]

object (PurchaseError)

省略可: この注文が拒否された原因となったエラー。

PurchaseError

注文書が拒否される原因となるエラー。

JSON 表現
{
  "type": enum (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": integer
}
フィールド
type

enum (ErrorType)

必須: 販売者によって注文が拒否された詳しい理由を表します。

description

string

エラーに関するその他の説明。

entityId

string

エラーに対応するエンティティ ID。たとえば、これは LineItemId や ItemOptionId に対応します。

updatedPrice

object (PriceAttribute)

PRICE_CHANGED / INCORRECT_PRICE のエラータイプの場合に関連します。

availableQuantity

integer

現在入手可能な数量。AVAILABILITY_CHANGED の場合に適用されます。

TicketOrderExtension

映画、スポーツなどのチケット注文の注文内容。

JSON 表現
{
  "ticketEvent": {
    object (TicketEvent)
  }
}
フィールド
ticketEvent

object (TicketEvent)

すべての項目チケットに適用されるイベント。

TicketEvent

単一のイベントを表します。

JSON 表現
{
  "type": enum (Type),
  "name": string,
  "description": string,
  "url": string,
  "location": {
    object (Location)
  },
  "eventCharacters": [
    {
      object (EventCharacter)
    }
  ],
  "startDate": {
    object (Time)
  },
  "endDate": {
    object (Time)
  },
  "doorTime": {
    object (Time)
  }
}
フィールド
type

enum (Type)

必須: チケット イベントのタイプ(映画、コンサートなど)。

name

string

必須: イベントの名前。たとえば、イベントが映画の場合は、映画の名前になります。

description

string

イベントの説明を入力します。

url

string

イベント情報への URL。

location

object (Location)

イベントが開催される場所、または組織の所在地。

eventCharacters[]

object (EventCharacter)

このイベントの関係者。映画イベントの監督や俳優、コンサートのパフォーマーなどが該当します。

startDate

object (Time)

開始時間

endDate

object (Time)

終了時間

doorTime

object (Time)

入場時間。イベントの開始時間とは異なる場合があります。たとえば、イベントは午前 9 時に開始されますが、入場時間は午前 8 時 30 分です。

EventCharacter

イベントに関する人物。たとえば主催者、演奏者など。

JSON 表現
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
フィールド
type

enum (Type)

イベントキャラクターのタイプ(俳優、ディレクターなど)。

name

string

指定します。

image

object (Image)

キャラクターの画像。