フルフィルメント アクション スキーマ

このオブジェクトのタイプ。親の Cart オブジェクトが ProposedOrder の一部である場合は、このフィールドを省略します。

値: type.googleapis.com/google.actions.v2.orders.Cart

カートの ID（省略可）。

このカートに関連付けられている販売者。

必須。

ユーザーが注文しようとしている商品またはサービスのリスト。

1 つ以上の項目が必要です。

このカートに適用されているプロモーション。現在、サポートされているのは 1 つのプロモーションのみです。

注文または配送手順に関するメモ。

フルフィルメントの設定など、ユーザーに関する詳細を定義します。

注文の受取人の名前（表示する名前）。firstName と lastName が指定されていない場合は、このフィールドを使用します。

例: Lovefood Ordering

注文を受け取るユーザーのメールアドレス。

例: ilovefood@example.com

注文を受け取るお客様の名（ファースト ネーム）。

例: Lovefood

注文品を受け取るお客様の姓。

例: Ordering

注文の受取人の電話番号（国コードを含む）。

例: +16501234567

注文を受け取るユーザーが Google アカウントでログインしているかどうかを示します。

必須。

注文情報の更新。

配達予定日時（ISO 8601 タイムスタンプ形式: 「{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z」または期間形式: 「P(n)Y(n)M(n)DT(n)H(n)M(n)S」）。たとえば、PT90M は 90 分間の長さを表します。デフォルト値「PT0M」は、できるだけ早く配信することを示します。参照: https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations購入手続きのレスポンス時に配達予定日を更新する場合に使用します。

例: PT90M

必須。

購入手続き時に事前定義された免責条項メッセージを表示する。

パートナーは、この注文に対して販売者に N の金額の手数料を請求します。

パートナーは、注文ごとにレストランに N ～ M の金額の手数料を請求します。

パートナーは、この注文に対して販売者に N% の手数料を請求します。

パートナーは、販売者に注文ごとに N% ～ M% の手数料を請求します。

請求される手数料の下限額。

請求される料金の上限。

請求される手数料の下限。

請求される手数料の割合の上限。

この広告表示オプションのタイプ。このフィールドは常に「type.googleapis.com/google.actions.v2.orders.FoodCartExtension」に設定されます。

値: type.googleapis.com/google.actions.v2.orders.FoodCartExtension

注文品を受け取るユーザーの連絡先情報。詳細には、お客様の名前、電話番号、メールアドレスが含まれます。

必須。

ユーザーのフルフィルメント設定。

CheckoutRequestMessage では、このフィールドに配送先住所を指定します。注文が配送の場合、このフィールドは必須です。テイクアウトまたは持ち帰りの注文の場合、このフィールドはメッセージに含まれません。

必須。

この広告表示オプションのタイプ。

値: type.googleapis.com/google.actions.v2.orders.FoodErrorExtension

必須。

発生したエラーを記述する FoodOrderError オブジェクトの配列。カートまたは商品アイテムごとに 1 つのエラーを推奨します。

1 つ以上の項目が必要です。

foodOrderErrors.error = "UNAVAILABLE_SLOT", "PROMO_EXPIRED", "PROMO_NOT_APPLICABLE", "PROMO_NOT_RECOGNIZED", "PROMO_ORDER_INELIGIBLE", "PROMO_USER_INELIGIBLE", "AVAILABILITY_CHANGED", "INCORRECT_PRICE", "INVALID", "NOT_FOUND", or "PRICE_CHANGED" の場合は必須です。

訂正を加えた新しい ProposedOrder。元の ProposedOrder に復元可能なエラーがある場合は、このオブジェクトを返します。たとえば、カート内の 1 つ以上の商品アイテムの価格が変更された場合、そのエラーは修正可能です。有効な ProposedOrder で復元可能なエラーが発生した場合、ユーザーにカートの確認を求めるのではなく、確認ステージに進みます。

foodOrderErrors.error = "UNAVAILABLE_SLOT", "PROMO_EXPIRED", "PROMO_NOT_APPLICABLE", "PROMO_NOT_RECOGNIZED", "PROMO_ORDER_INELIGIBLE", "PROMO_USER_INELIGIBLE", "AVAILABILITY_CHANGED", "INCORRECT_PRICE", "INVALID", "NOT_FOUND", or "PRICE_CHANGED" の場合は必須です。

ユーザーに選択されているデフォルトの支払いオプション。

お客様が利用できる代替のお支払い方法。

必須。

この広告表示オプションのタイプ。このフィールドは常に「type.googleapis.com/google.actions.v2.orders.FoodItemExtension」に設定されます。

値: type.googleapis.com/google.actions.v2.orders.FoodItemExtension

オプションには、アドオン アイテムや、一連のアドオンを含むアドオン グループがあります。

Google によって割り当てられた一意の ID。FoodOrderError または AsyncOrderUpdateRequest を送信する場合は、このフィールドを使用して、カートに同じ offerId を持つ複数の商品が含まれている場合を区別します。

例: 39231093

商品アイテムのオファー ID。

例: 912835081

オプションの名前。

例: Honey Mustard

オプションに関する注意事項。

項目のオプションの場合、項目の数。

例: 3

オプションのサブオプション（存在する場合）。

例: [ { "id": "71283712", "offerId": "51209121", "name": "BBQ Sauce", "price": { "currencyCode": "USD", "units": "3", "nanos": 780000000 }, "quantity": 2 }, { "id": "102941024", "offerId": "12084102", "name": "Ketchup", "price": { "currencyCode": "USD", "units": "2", "nanos": 980000000 }, "quantity": 6 } ]

必須。

error = "AVAILABILITY_CHANGED", "INCORRECT_PRICE", "PRICE_CHANGED", "INVALID", or "NOT_FOUND" の場合は必須です。

このフィールドは、商品単位のエラーに必要です。メニュー アイテムの場合は Google が割り当てた LineItem.id、アドオンの場合は FoodItemOption.id です。

エラーの説明。この説明は内部ロギング用であり、ユーザーには表示されません。

error = "PRICE_CHANGED" の場合は必須です。

エラーの原因となった商品の新しい価格。これは、エラーが「PRICE_CHANGED」の場合にのみ必須です。

error = "INVALID", or "NOT_FOUND" の場合は必須です。

エラーの原因となった商品アイテムの新しい在庫数。これは、エラーが「INVALID」または「NOT_FOUND」の場合にのみ必要です。「INVALID」と「NOT_FOUND」の場合は、値を 0 にする必要があります。

この広告表示オプションのタイプ。このフィールドは常に「type.googleapis.com/google.actions.v2.orders.FoodOrderExtension」に設定されます。

値: type.googleapis.com/google.actions.v2.orders.FoodOrderExtension

注文で利用可能なフルフィルメント オプションを表します。

マーケティング チャネルへのオプトインをユーザーがリクエストしている。デフォルトでは、ユーザーの同意を得ずにマーケティング コンテンツを送信することはできません。optinForRemarketing が true の場合、ユーザーを登録できます。optinForRemarketing が false の場合、または存在しない場合、システムのサブスクリプション ステータスはそのままにする必要があります。ユーザーは Google でオプトアウトすることはできず、マーケティング チャネルで提供されているオプトアウト機能のみを使用できます。このフラグは SubmitOrderRequestMessage にのみ存在します。

このフルフィルメント オプションの一意の識別子（存在する場合）。

必須。

このフルフィルメント オプションの有効期限が切れる日時。

このオプションの費用。

存在する場合は、配送注文を示します。

必須。

画像の URL。画像は 72 x 72 ピクセル以上にする必要があります。最適に表示されるように、216 x 216 ピクセル以上の解像度の画像を使用してください。画像は 6 MB 未満、64 メガピクセル未満でなければなりません。

type = "REGULAR" の場合は必須です。

カートの LineItem（ProposedOrder.cart.lineItems[0].id）の場合、これは注文の作成時に Google によって作成された一意の ID です。ProposedOrder の LineItem（ProposedOrder.otherItems[0].id）は、送料や税金などのアイテムを追加するために使用されます。この場合、id の値はプロバイダによって定義されます。たとえば、カートに同じ商品が 2 つあり、調理手順が異なる場合（トッピングが異なる 2 つの中サイズのピザなど）は、この場合、両方のアイテムのベース offerId は同じです。アイテムが不承認であることを示す注文更新リクエストを送信する場合は、この ID を不明瞭化子として使用します。つまり、特定のトッピングが不足しているためにピザの 1 つが不承認となった場合、ID により、お客様が言及している注文内のアイテムを Google が特定できます。このフィールドは、otherItems を除き必須です。

必須。

項目の名前。これはユーザーに表示される文字列であるため、可能であれば大文字で入力します（「送料」、「サービス料」、「税金」など）。このフィールドは、ユーザーに対しては 100 文字で切り捨てられます。

必須。

type = "REGULAR" の場合は必須です。

項目の数量。ProposedOrder.otherItems には適用されません。

項目の説明。

必須。

商品アイテムの価格。この値には、この行項目のすべての商品またはサービスの合計金額が反映されます（つまり、アドオンの費用を合計して数量を掛けた金額です）。たとえば、10 ドルの商品の数量が 3 個の場合、価格は 30 ドルになります。基本価格が 5 ドルでアドオンが 1 ドルのピザ 1 枚の場合、価格は 6 ドルとなります。ベース価格が 5 ドルで、それぞれに 1 ドルのアドオンが付いた 2 つのピザ（数量 = 2）の場合、価格は 12 ドルになります。価格が「0」の場合でも、各項目には価格が必要です。タイプが DISCOUNT の場合は、値を負の値として指定します（例: -2）。

省略可能で、type が「REGULAR」の場合にのみ有効です。購入手続きリクエストと注文送信リクエストのこのフィールドに、ユーザーからの商品固有のメモが送信される場合があります。メモを送信する際は、販売者に届いたことを確認してください。この値は、リクエストに subLines[0].note として含まれます。この値は、リクエストに存在する場合、このフィールドで指定される唯一の値です。

1 つの項目のみにする必要があります。

type = "REGULAR" の場合は必須です。

商品アイテムの MenuItem のオファー ID。ProposedOrder.otherItems には適用されません。

食品のアドオンを定義します。

場所の住所を表示します。

例: 1350 CHARLESTON ROAD, MOUNTAIN VIEW, CA, United States

例: 90210

都市の名前。

例: Los Angeles

ゲートコードなどの場所に関するメモ。500 文字以内で指定してください。

例: Gate code is #111

販売者の ID。指定した場合、レストラン フィードの Restaurant.@id と一致します。

例: https://www.exampleprovider.com/merchant/id1

必須。

ユーザーに表示される販売者の名前。

例: Falafel Bite

必須。

ISO 4217 形式の 3 文字の通貨コード。

例: USD

金額の整数部分。たとえば、currencyCode が「USD」の場合、1 単位は 1 米ドルです。

例: 36

金額の小数部分をナノ（10^-9）単位で表した数。値は -999,999,999 以上 +999,999,999 以下でなければなりません。次のルールを使用します。units が正の場合、nanos は正またはゼロでなければなりません。units がゼロの場合、nanos は正、ゼロ、または負の値です。単位が負の場合、ナノは負またはゼロでなければなりません。たとえば、$-1.75 は units = -1、nanos = -750,000,000 と表します。

例: 730000000

必須。

注文の原因となった提案された注文。

必須。

Google によって割り当てられた注文 ID。この ID は、注文のライフサイクル全体で安定している必要があります。この ID はエンドユーザーには表示されません。

必須。

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

必須。

この注文の支払いに対応する支払い情報。

必須。

更新が送信される注文を識別するために使用される、インテグレータのシステム内の注文の一意の ID。「CREATED」の注文の OrderUpdate で receipt.user_visible_order_id が 1 回以上指定されていない場合、この ID が入力されたユーザー公開 ID となり、Google の注文カードに表示されます。

必須。

注文の新しい状態。

必須。

注文が更新された日時。

注文後のアクション（サポートへの連絡、注文の詳細の表示など）。

項目は 1 つ以上 6 つ以下にする必要があります。

orderState.state = "REJECTED" の場合は必須です。

orderState.state = "CANCELLED" の場合は必須です。

このフィールドは非推奨になりました。

このフィールドは非推奨になりました。

orderState.state = "CONFIRMED", "IN_PREPARATION", or "READY_FOR_PICKUP" の場合は必須です。

領収書にユーザーに表示される注文 ID を入力します。

注文の合計金額。

配達または受け取りの予定日などの注文の更新の詳細を定義します。

集荷予定時刻（ISO 8601 タイムスタンプ形式: 「{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z」または時間形式: 「P(n)Y(n)M(n)DT(n)H(n)M(n)S」）。たとえば、PT90M は 90 分間の長さを表します。デフォルト値「PT0M」は、できるだけ早い時間に集荷することを希望していることを示します。参照: https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations購入手続きのレスポンス時に、集荷予定時間を更新するために使用します。

例: PT90M

必須。

2 文字の国コード。

例: US

郵便番号です。

例: 94043

その国 / 地域の住所に使用される最上位の行政区域。州、省、都道府県などが該当します。

例: CA

この場所の市区町村。地域区分が明確に定義されていない地域や、この体系が当てはまらない地域では、locality を指定せず、代わりに addressLines フィールドを使用します。

例: Mountain View

住所の指定に使用できる 1 つ以上の行。このフィールドには不明確な地域が含まれる可能性があるため、変更しないでください。

例: [ "1350 Charleston Road" ]

注文の受取人のリスト。このフィールドは billingAddress でのみ使用できます。

必須。

プロモーション クーポンコード。

必須。

必須。

プロモーション クーポンコード。

提案された注文の ID（省略可）。

必須。

ユーザーの項目。

プロバイダが追加した項目（送料、その他の手数料、税金など）。otherItems には、ユーザーが追加したチップや割引も含まれる場合があります。

10 個以下にしてください。

この注文に関連付けられている画像。

必須。

この注文の合計金額。

必須。

フード注文のフルフィルメント情報を定義します。

注文前に UI に表示される免責条項メッセージに対応します。

必須。

必須。

支払い情報を含む注文。

後続のトランザクションがサンドボックス環境で実行されるかどうかを示します。

必須。

カートの購入手続きに必要な引数を指定します。

1 つの項目のみ指定できます。

必須。

会話の一意の ID。

必須。

購入手続きリクエスト メッセージの場合は「actions.foodordering.intent.CHECKOUT」、注文送信リクエスト メッセージの場合は「actions.intent.TRANSACTION_DECISION」に設定します。

必須。

購入手続きを行うカートまたは注文が含まれます

1 つの項目のみ指定できます。

ユーザーがチェックアウトする食品の詳細。

false に設定します。

値: False

必須。

カートの購入手続きに対するレスポンスが含まれます。

必須。

CheckoutRequestMessage または SubmitOrderRequestMessage に対するレスポンスが含まれます。

必須。

取引に使用する注文の候補。

必須。

ユーザーに選択されているデフォルトの支払いオプション。

お客様が利用できる代替のお支払い方法。

必須。

必須。

1 つの項目のみ指定できます。

カートに追加した商品、税金、割引。

この更新が送信された注文がサンドボックス支払いであることを示します。

必須。

リクエストの OrderUpdate が含まれます。

必須。

表示ラベル。正しくレンダリングされるように、最初の語の語頭を大文字にするか、すべて小文字にするか、30 文字以内で入力してください。

例: Contact us

必須。

必須。

OrderState.state が「CANCELLED」の場合の不承認の理由を表示するテキスト。

例: Restaurant closed

この広告表示オプションのタイプ。このフィールドは常に「type.googleapis.com/google.actions.v2.orders.FoodOrderUpdateExtension」に設定されます。

値: type.googleapis.com/google.actions.v2.orders.FoodOrderUpdateExtension

注文した商品が配達される、または受け取り可能になる予定時刻。文字列は ISO 8601 形式で、単一の固定時刻ではなく期間に対応している必要があります。使用できる規則は、区間、期間、日時です。このフィールドは、情報が利用可能になったとき、または到着の早まりや遅れなどの変更があったときに、SubmitOrderResponseMessage または AsyncOrderUpdateRequestMessage で送信できます。

例: 2017-07-17T13:00:00Z/2017-07-17T13:30:00Z

注文後に発生したエラーについて説明します。カートまたは商品アイテムごとに 1 つのエラーを推奨します。RejectionInfo に該当しないエラーには、FoodOrderUpdateExtension.FoodOrderErrors を使用します。

1 つ以上の項目が必要です。

FoodOrderingUpdateExtension メッセージで estimatedFulfillmentTimeIso8601 を使用する

FoodOrderingUpdateExtension メッセージで estimatedFulfillmentTimeIso8601 を使用する

変更の理由。価格変更の場合は必須。

必須。

ボタンのクリックまたはタップによってトリガーされるアクション。適用可能な接頭辞のリストは、orderManagementActionType によって異なります。「EMAIL」: 接頭辞は「mailto」にする必要があります。「CALL」: 接頭辞は「tel」にする必要があります。「CUSTOMER_SERVICE」: 接頭辞は「mailto」、「tel」、「http」、「https」のいずれかである必要があります。

例: https://www.google.com

必須。

必須。

必須。

必須。

状態についてユーザーに表示される表示文字列。文頭を大文字にします（アルファベットの場合）。

例: Your order has been received

必須。

注文ステータスが [CONFIRMED]、[IN_TRANSIT]、[FULFILLED] の場合は必須です。このフィールドは、この注文の単一のユーザー向け ID（通常はレストランの注文 ID）で、インテグレーターの領収書と Google の注文カードの両方に表示されます。ユーザーは、この ID を使用して、プロバイダとインテグレータのカスタマー サービスで注文を参照できる必要があります。この ID は、特定の OrderUpdate で 1 回だけ指定する必要があります。指定されるまで、actionOrderId は userVisibleOrderId です。たとえば、レストランが注文を確認するまで、userVisibleOrderId がない場合もあります。確認が取れたら、OrderUpdate と Receipt を含む AsyncOrderUpdateRequestMessage を送信する必要があります。

必須。

内部ロギングに使用される拒否の理由。このフィールドはユーザーには表示されません。

必須。

必須。

領収書に表示される支払い方法の名前。

例: Taco Points Total

paymentType が「ON_FULFILLMENT」の場合の追加データ。たとえば、このフィールドを使用して、フルフィルメントで現金またはカードがサポートされているかどうかを指定できます。

取引を完了するために必要な請求先住所の形式。MIN: 名前、国コード、郵便番号。FULL: 名前、番地、地域区分、県、国コード、郵便番号。

必須。

カード取引を認証するためにサポートされるフィールド。

1 つ以上の項目が必要です。

必須。

Google Pay API でサポートされているカード ネットワークのうち、お客様がサポートしている 1 つ以上のカード ネットワーク。

1 つ以上の項目が必要です。

請求先住所が必要な場合は true に設定します。請求先住所は、取引の処理に必要な場合にのみリクエストしてください。データ リクエストを追加すると、購入手続きが煩雑になってコンバージョン率が低下する可能性があります。

billingAddressRequired が true に設定されている場合に予期されるフィールド。

TimesofMoney を使用する場合は true、他のすべての決済プロセッサの場合は false に設定します。

必須。

以前に指定した GoogleProvidedPaymentOptions に従って、参加している Google Pay 決済代行業者でユーザーに請求するための支払いトークンを含む Base64 でエンコードされた文字列。

お支払いの請求先住所。

PaymentDataRequest JSON を文字列として指定します。このオブジェクトは、Google Pay API に対するサイトのサポートを構成するために使用します。

代わりに facilitationSpecification を使用してください。エージェントがサポートするカード ネットワークの種類。

このフィールドは非推奨になりました。

代わりに facilitationSpecification を使用してください。プリペイド カードを支払い方法として許可するかどうか。

このフィールドは非推奨になりました。

代わりに facilitationSpecification を使用してください。請求先住所が必須かどうか。

このフィールドは非推奨になりました。

このフィールドは非推奨になりました。

Google Pay から発行された Google 販売者 ID。

必須。

UTF-8 としてエンコードされた販売者名です。販売者名は支払いシートに表示されます。

注文の処理時にユーザーが利用できるお支払い方法のリスト。

必須。

例: braintree

必須。

メジャー API バージョン。

値: 2

必須。

マイナー API バージョン。

値: 0

必須。

（Google Pay 販売者 ID）支払いデータをリクエストしている販売者に関する情報。

必須。

Google Pay API でサポートされている 1 つ以上のお支払い方法のサポートを指定します。

必須。

ユーザーがトランザクションに同意するかどうかに基づく、トランザクションの承認に関する詳細です。このフィールドには、合計金額と価格ステータスが含まれます。

必須。

領収書に表示する支払い方法のユーザーに表示される名前。

必須。

アクションで使用できるトークン。CheckoutResponseMessage で支払い方法として GoogleProvidedPaymentOptions を指定した場合にのみ指定します。

必須。

サポートされているお支払い方法の短い識別子。現在サポートされているのは CARD のみです。

値: CARD

必須。

指定されたお支払い方法の種類を構成するために必要なパラメータ。

必須。

アカウントまたは復号プロバイダが支払い情報を受け取れるように構成します。このプロパティは、CARD のお支払い方法には必須です。

actionProvidedOptions とは相互に排他的です。gPay を使用したオンライン決済に使用します。

必須。

代わりに facilitationSpecification を使用してください。使用できるトークンの種類。

代わりに facilitationSpecification を使用してください。

必須。

必須。

必須。

ISO 4217 のアルファベットの通貨コード。

取引の試行を識別する一意の ID。販売者は既存の ID を使用するか、Google Pay 取引の試行に特定の ID を生成できます。コールバックを Google Transaction Events API に送信する場合、このフィールドは必須です。

必須。

デフォルトでは「ESTIMATED」を使用します。合計金額は、請求先住所に基づいて収集されたレスポンスの詳細（消費税など）に基づいて調整される場合があります。

値: ESTIMATED

必須。

取引の合計金額。小数点以下 2 桁の小数点精度が適用されます。このフィールドの値は cart.totalPrice と同じである必要があります。