購入手続きを設定する

ユーザーがカートを作成すると、購入手続きは呼び出されます。ユーザーのカートの内容と注文の詳細が Order with Google ウェブサービスに送信されます。この情報はウェブサービスによって検証され、必要に応じて続行するか、カートに調整を加えることができます。

ウェブサービスの購入手続きハンドラは、POST リクエストに応答する必要があります。お客様が購入を選択すると、Google は Order with Google ウェブサービスを、顧客の Cart の詳細を含む CheckoutRequestMessage の形式で JSON リクエスト本文を送信します。ウェブサービスは CheckoutResponseMessage で応答します。次の図は、このプロセスを示しています。

CheckoutResponseMessage は、顧客が変更していないカートまたはエラーを返します。

購入手続きリクエストを受信すると、Order with Google ウェブサービスは次のことを行う必要があります。

  • 現在のアイテム価格、在庫状況、プロバイダ サービスに基づいて、カートの有効性を確認します。
  • 合計金額(割引、税金、送料を含む)を計算します。
  • 成功した場合は、変更せずにカートで応答します。
  • 失敗した場合は、エラー メッセージと提案された新しい注文を返します。

購入手続きを開始する前に、フルフィルメントの概要のドキュメントを確認することをおすすめします。

決済リクエスト メッセージ

ユーザーのカートを検証するために、顧客が決済を選択すると、Google は CheckoutRequestMessage という形式の JSON 本文を含むリクエストをウェブサービスに送信します。お客様の注文は、Order with Google のフローの後半まで送信されません。

CheckoutRequestMessage に含まれるデータは次のとおりです。

  • インテント: すべての購入手続きリクエスト本文の inputs[0].intent フィールドに、actions.foodordering.intent.CHECKOUT 文字列値が含まれます。
  • カート: 購入手続きリクエストの inputs[0].arguments[0].extension フィールドには、顧客のカートを表す Cart オブジェクトが含まれます。
  • 配信またはデータ エクスポート: Cart オブジェクトの拡張フィールドには、配信またはデータ エクスポートのプロパティを指定する FoodCartExtension オブジェクトが含まれます。
    • 配送注文の場合、FoodCartExtension オブジェクトには配送先住所が含まれます。
    • テイクアウトやテイクアウトの注文の場合、FoodCartExtension オブジェクトに位置情報は含まれません。
  • サンドボックス: トランザクションの isInSandbox フィールドに、トランザクションでサンドボックス支払いが使用されているかどうかを示すブール値が含まれます。

購入手続きリクエストの例

CheckoutRequestMessage の例を次に示します。

{
    "user": {},
    "conversation": {
        "conversationId": "CTZbZfUlHCybEdcz_5PB3Ttf"
    },
    "inputs": [
        {
            "intent": "actions.foodordering.intent.CHECKOUT",
            "arguments": [
                {
                    "extension": {
                        "@type": "type.googleapis.com/google.actions.v2.orders.Cart",
                        "merchant": {
                            "id": "restaurant/Restaurant/QWERTY",
                            "name": "Tep Tep Chicken Club"
                        },
                        "lineItems": [
                            {
                                "name": "Spicy Fried Chicken",
                                "type": "REGULAR",
                                "id": "299977679",
                                "quantity": 2,
                                "price": {
                                    "type": "ESTIMATE",
                                    "amount": {
                                        "currencyCode": "AUD",
                                        "units": "39",
                                        "nanos": 600000000
                                    }
                                },
                                "offerId": "MenuItemOffer/QWERTY/scheduleId/496/itemId/143",
                                "extension": {
                                    "@type": "type.googleapis.com/google.actions.v2.orders.FoodItemExtension"
                                }
                            }
                        ],
                        "extension": {
                            "@type": "type.googleapis.com/google.actions.v2.orders.FoodCartExtension",
                            "fulfillmentPreference": {
                                "fulfillmentInfo": {
                                    "delivery": {
                                        "deliveryTimeIso8601": "P0M"
                                    }
                                }
                            },
                            "location": {
                                "coordinates": {
                                    "latitude": -33.8376441,
                                    "longitude": 151.0868736
                                },
                                "formattedAddress": "Killoola St, 1, Concord West NSW 2138",
                                "zipCode": "2138",
                                "city": "Concord West",
                                "postalAddress": {
                                    "regionCode": "AU",
                                    "postalCode": "2138",
                                    "administrativeArea": "NSW",
                                    "locality": "Concord West",
                                    "addressLines": [
                                        "Killoola St",
                                        "1"
                                    ]
                                }
                            }
                        }
                    }
                }
            ]
        }
    ],
    "directActionOnly": true,
    "isInSandbox": true
}

購入手続きレスポンス メッセージ

Order with Google サービスからリクエストを受け取った後、購入手続きのウェブサービスはそれを処理して、CheckoutResponseMessage で応答する必要があります。CheckoutResponseMessage は、成功したリクエストも失敗したリクエストもカバーする必要があります。

成功したリクエスト

チェックアウト リクエストが成功した場合、CheckoutResponseMessageProposedOrderPaymentOptions を含む必要があります。

  • ProposedOrder

    • cart: CheckoutRequestMessage で提供されるカートと同一の cart オブジェクト。カートの中身を変更する必要がある場合は、CheckoutResponseMessage代わりにFoodErrorExtension修正した ProposedOrder を含める必要があります。
    • otherItems: 送料、税金、その他の料金など、プロバイダによって追加されたアイテム。ユーザーが追加したチップも含まれる場合があります。
    • totalPrice: 注文の合計額。
    • extension: お届け日数など、注文のフルフィルメント情報を定義する FoodOrderExtension
  • PaymentOptions

    • 支払い処理の設定については、後の Google Pay の設定で説明します。支払い処理を実装する準備が整うまで、CheckoutResponseMessage でプレースホルダ JSON を使用できます。
    • CheckoutResponseMessage にプレースホルダ支払いオプションを追加するには、PaymentOptions の支払いゲートウェイの例を使用する、次のをご覧ください。

成功レスポンスの例

{
    "finalResponse": {
        "richResponse": {
            "items": [
                {
                    "structuredResponse": {
                        "checkoutResponse": {
                            "proposedOrder": {
                                "cart": {
                                    "merchant": {
                                        "id": "restaurant/Restaurant/QWERTY",
                                        "name": "Tep Tep Chicken Club"
                                    },
                                    "lineItems": [
                                        {
                                            "name": "Spicy Fried Chicken",
                                            "type": "REGULAR",
                                            "id": "299977679",
                                            "quantity": 2,
                                            "price": {
                                                "type": "ESTIMATE",
                                                "amount": {
                                                    "currencyCode": "AUD",
                                                    "units": "39",
                                                    "nanos": 600000000
                                                }
                                            },
                                            "offerId": "MenuItemOffer/QWERTY/scheduleId/496/itemId/143",
                                            "extension": {
                                                "@type": "type.googleapis.com/google.actions.v2.orders.FoodItemExtension"
                                            }
                                        }
                                    ],
                                    "extension": {
                                        "@type": "type.googleapis.com/google.actions.v2.orders.FoodCartExtension",
                                        "fulfillmentPreference": {
                                            "fulfillmentInfo": {
                                                "delivery": {
                                                    "deliveryTimeIso8601": "P0M"
                                                }
                                            }
                                        },
                                        "location": {
                                            "coordinates": {
                                                "latitude": -33.8376441,
                                                "longitude": 151.0868736
                                            },
                                            "formattedAddress": "Killoola St, 1, Concord West NSW 2138",
                                            "zipCode": "2138",
                                            "city": "Concord West",
                                            "postalAddress": {
                                                "regionCode": "AU",
                                                "postalCode": "2138",
                                                "administrativeArea": "NSW",
                                                "locality": "Concord West",
                                                "addressLines": [
                                                    "Killoola St",
                                                    "1"
                                                ]
                                            }
                                        }
                                    }
                                },
                                "totalPrice": {
                                    "type": "ESTIMATE",
                                    "amount": {
                                        "currencyCode": "AUD",
                                        "units": "43",
                                        "nanos": 100000000
                                    }
                                },
                                "extension": {
                                    "@type": "type.googleapis.com/google.actions.v2.orders.FoodOrderExtension",
                                    "availableFulfillmentOptions": [
                                        {
                                            "fulfillmentInfo": {
                                                "delivery": {
                                                    "deliveryTimeIso8601": "P0M"
                                                }
                                            }
                                        }
                                    ]
                                },
                                "otherItems": [
                                    {
                                        "name": "Delivery fee",
                                        "price": {
                                            "type": "ESTIMATE",
                                            "amount": {
                                                "currencyCode": "AUD",
                                                "units": "3",
                                                "nanos": 500000000
                                            }
                                        },
                                        "type": "DELIVERY"
                                    }
                                ]
                            },
                            "paymentOptions": {
                                "googleProvidedOptions": {
                                    "facilitationSpecification": "{\"apiVersion\":2,\"apiVersionMinor\":0,\"merchantInfo\":{\"merchantName\":\"merchantName\"},\"allowedPaymentMethods\":[{\"type\":\"CARD\",\"parameters\":{\"allowedAuthMethods\":[\"PAN_ONLY\"],\"allowedCardNetworks\":[\"VISA\",\"MASTERCARD\"],\"billingAddressRequired\":true,\"cvcRequired\":false},\"tokenizationSpecification\":{\"type\":\"PAYMENT_GATEWAY\",\"parameters\":{\"gatewayMerchantId\":\"YOUR_MERCHANT_ID\",\"gateway\":\"cybersource\"}}}],\"transactionInfo\":{\"currencyCode\":\"AUD\",\"totalPriceStatus\":\"ESTIMATED\",\"totalPrice\":\"43.1\"}} "
                                }
                            },
                            "additionalPaymentOptions": [
                                {
                                    "actionProvidedOptions": {
                                        "paymentType": "ON_FULFILLMENT",
                                        "displayName": "Pay when you get your food.",
                                        "onFulfillmentPaymentData": {
                                            "supportedPaymentOptions": []
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            ]
        }
    }
}

リクエストに失敗しました

チェックアウト リクエストが失敗した場合、CheckoutResponseMessage には、発生したエラーを記述する FoodOrderError アイテムのリストを含む FoodErrorExtension を含める必要があります。カート内の商品の価格変更など、注文の回復可能なエラーがある場合は、FoodErrorExtensioncorrectedProposedOrder を含める必要があります。

失敗レスポンスの例

{
  "expectUserResponse": false,
  "finalResponse": {
    "richResponse": {
      "items": [
        {
          "structuredResponse": {
            "error": {
              "@type": "type.googleapis.com/google.actions.v2.orders.FoodErrorExtension",
              "foodOrderErrors": [
                {
                  "error": "CLOSED",
                  "description": "The restaurant is closed."
                }
              ]
            }
          }
        }
      ]
    }
  }
}