v1 事前注文機能

ユーザーが事前に受け取りや配達の食事注文をスケジュールできるように、フルフィルメントでサポートを追加できます。フルフィルメントでこのサポートを実装する前に、インベントリ フィード スキーマ(AdvanceServiceDeliveryHoursSpecification)で説明されているように、ユーザーが事前注文できる時間を指定するサービス インベントリ フィードを作成します。

事前注文の予約枠

Google は、レストランまたはサービスのフルフィルメント時間(AdvanceServiceDeliveryHoursSpecification で定義)に基づいて、最大 7 日前までの事前注文スロットを 15 分刻みで提案します。

提案された事前注文スロットを取得するには、購入手続き時に FoodCartExtension オブジェクトの fulfillmentPreference フィールドの次の値を使用します。

  • PickupInfo.pickupTimeIso8601
  • DeliveryInfo.deliveryTimeIso8601

購入手続きで事前注文を実装する

以下の表に、ユーザーが注文しようとしたときに購入手続き時にフルフィルメントのレスポンスを実装できる方法を示します。

シナリオ フルフィルメントの動作
リクエストされたスロットに対して事前注文を処理できます。 同じスロットで ProposedOrder を作成して、P0M(「できるだけ早く」)または FUTURE_SLOT カートを承認します。スロットを受け入れる購入手続きレスポンスの例については、こちらのコード スニペットをご覧ください。
リクエストされたスロットでは事前注文を処理できません。 フルフィルメントは次のことを行う必要があります。
  1. リクエストされた P0M カートまたは FUTURE_SLOT カートを拒否し、FoodErrorExtension オブジェクトで注文を処理できない理由を指定します。
    • 容量が原因で注文を処理できない場合は、エラータイプ NO_CAPACITYFoodOrderError を指定します。
    • レストランが閉店しているために注文を処理できない場合は、エラータイプ CLOSEDFoodOrderError を指定します。
    • 他の理由で注文を処理できない場合は、エラータイプ UNAVAILABLE_SLOTFoodOrderError を指定します。
  2. 可能であれば、correctedProposedOrder に代替の P0M または FUTURE_SLOT の値を指定します。これらの値は、現在の時刻から 7 日間有効なフルフィルメント スロットである必要があります。該当する場合は、P0M スロットを含めます。

代替スロットを提案する購入手続きレスポンスの例については、こちらのコード スニペットをご覧ください。

注文処理の代替スロット

ご購入手続きの際に、Google が提案する事前注文スロットが適切でない場合は、フルフィルメントが CheckoutResponseMessage オブジェクトを使用して代替スロットを提案できます。

別の事前注文スロットを指定するには、FoodErrorExtension で購入手続きリクエストに応答し、次の値を設定します。

  1. foodOrderErrors パラメータで、エラータイプ(UNAVAILABLE_SLOTNO_CAPACITYCLOSED など)を指定します。
  2. correctedProposedOrder パラメータで、availableFulfillmentOptions を介して代替の P0M 値または FUTURE_SLOT 値を指定します。

代替スロットは、注文の時点から 7 日以内に設定し、ユーザーがリクエストしたカートの処理が可能なすべてのスロットを含める必要があります。

たとえば、ランチ スペシャルは月曜日から金曜日の午前 11 時から午後 1 時までのみ提供される場合、ユーザーがランチ スペシャルをカートに追加しようとすると、選択したスロットを利用できないことがわかります。この場合、フルフィルメントはカート内のランチ スペシャルを保持し、次の 7 日間の午前 11 時から午後 1 時のスロットのみ返します。

レスポンスで correctedProposedOrder.Cart.fulfillmentPreference オブジェクトを省略する必要があります。

予約可能なスロットがない場合や、レストランまたはサービスが事前注文に対応していない場合は、correctedProposedOrder を指定する必要はありません。

レストランやサービスで事前注文を受け付けている場合、事前注文の購入手続きのリクエストとレスポンスのフロー中に、フルフィルメントと Google の間でやり取りされる JSON メッセージの例を以下に示します。

例: 配送スロットを含む CheckoutRequest

以下のスニペットは、事前注文の配送スロットを含む購入手続きリクエストの例を示しています。

{
  "inputs": [
    {
      "intent": "actions.foodordering.intent.CHECKOUT",
      "arguments": [
        {
          "extension": {
            "@type": "type.googleapis.com/google.actions.v2.orders.Cart",
            "merchant": {
              "id": "https://www.exampleprovider.com/merchant/id1",
              "name": "Cucina Venti"
            },
            "lineItems": [
              {
                "name": "Sizzling Prawns Dinner",
                "type": "REGULAR",
                "id": "sample_item_offer_id_1",
                "offerId": "https://www.exampleprovider.com/menu/item/offer/id1",
                "quantity": 1,
                "price": {
                  "type": "ESTIMATE",
                  "amount": {
                    "currencyCode": "USD",
                    "units": "16",
                    "nanos": 750000000
                  }
                },
              }
            ],
            "extension": {
              "@type": "type.googleapis.com/google.actions.v2.orders.FoodCartExtension",
              "fulfillmentPreference": {
                "fulfillmentInfo": {
                  "delivery": {
                    // Deliver at 6:30PM.
                    "deliveryTimeIso8601": "2017-12-14T18:30:00-07:00"
                  }
                }
              },
              "location": {
                ...
              }
            }
          }
        }
      ]
    }
  ]
}

例: スロットを承認する CheckoutResponse

以下のスニペットは、フルフィルメントが提案された先行予約スロットを承認する購入手続きレスポンスの例を示しています。

{
  "expectUserResponse": false,
  "finalResponse": {
    "richResponse": {
      "items": [
        {
          "structuredResponse": {
            "checkoutResponse": {
              "proposedOrder": {
                "id": "sample_proposed_order_id_1",
                "cart": {
                  "merchant": {
                    "id": "https://www.exampleprovider.com/merchant/id1",
                    "name": "Falafel Bite"
                  },
                  "lineItems": [
                    {
                      "name": "Sizzling Prawns Dinner",
                      "type": "REGULAR",
                      "id": "sample_item_offer_id_1",
                      "offerId": "https://www.exampleprovider.com/menu/item/offer/id1",
                      "quantity": 1,
                      "price": {
                        "type": "ESTIMATE",
                        "amount": {
                          "currencyCode": "USD",
                          "units": "16",
                          "nanos": 750000000
                        }
                      },
                    }
                  ],
                  "extension": {
                    "@type": "type.googleapis.com/google.actions.v2.orders.FoodCartExtension",
                    "fulfillmentPreference": {
                      "fulfillmentInfo": {
                        "delivery": {
                          // Same as the time in the request.
                          "deliveryTimeIso8601": "2017-12-14T18:30:00-07:00"
                        }
                      }
                    },
                    "location": {
                      ...
                     }
                   }
                },
                "totalPrice": {
                  "type": "ESTIMATE",
                  "amount": {
                    // Represents $16.75
                    "currencyCode": "USD",
                    "units": "16",
                    "nanos": 750000000
                  }
                },
                "extension": {
                  "@type": "type.googleapis.com/google.actions.v2.orders.FoodOrderExtension",
                  // Send whole proposed order back.
                  "availableFulfillmentOptions": [
                    "fulfillmentInfo": {
                      "delivery": {
                        // Same as the time in the request.
                        "deliveryTimeIso8601": "2017-12-14T18:30:00-07:00"
                      }
                    }
                  ]
                }
              },
              "paymentOptions": {
                ...
              }
            }
          }
        }
      ]
    }
  }
}

例: 代替スロットを含む CheckoutResponse

以下のスニペットは、フルフィルメントが代替の早期注文スロットを提案する購入手続きレスポンスの例を示しています。レスポンスでは correctedProposedOrder.Cart.fulfillmentPreference オブジェクトを省略する必要があります。

{
  "expectUserResponse": false,
  "finalResponse": {
    "richResponse": {
      "items": [
        {
          "structuredResponse": {
            "error": {
              "@type": "type.googleapis.com/google.actions.v2.orders.FoodErrorExtension",
              "foodOrderErrors": [
                {
                  "error": "UNAVAILABLE_SLOT", // Cart level error
                  "description": "The restaurant is closed."
                }
              ],
              "correctedProposedOrder": {
                // Send whole original cart back,
                // without the fulfillmentPreference.
                "cart": {
                  ...
                },
                "otherItems": {
                  ...
                },
                "totalPrice": {
                  ...
                },
                "extension": {
                  "@type": "type.googleapis.com/google.actions.v2.orders.FoodOrderExtension",
                  "availableFulfillmentOptions": [
                    "fulfillmentInfo": {
                      "delivery": {
                        "deliveryTimeIso8601": "2017-12-14T19:00:00-07:00"
                      }
                    },
                    "fulfillmentInfo": {
                      "delivery": {
                        "deliveryTimeIso8601": "2017-12-14T19:30:00-07:00"
                      }
                    },
                    "fulfillmentInfo": {
                      "delivery": {
                        "deliveryTimeIso8601": "2017-12-14T20:00:00-07:00"
                      }
                    }
                  ]
                }
              },
              "paymentOptions": {
                ...
              }
            }
          }
        }
      ]
    }
  }
}

注文の送信時に事前注文を実装する

注文の送信時に、事前注文スロットに問題がある場合は、SubmitOrderResponseMessageRejectionInfo オブジェクトに理由(UNAVAILABLE_SLOTUNKNOWN など)を含める必要があります。

プロバイダが注文を承認したら、OrderState オブジェクトで注文のステータスを CREATED から CONFIRMED に更新します。選択した時間帯をユーザーへの確認メールに含めます。

フルフィルメントがレストランに注文を送信する場合は、非同期注文更新アクションを使用して Google に更新情報を送信します。

フルフィルメントの注文送信レスポンスまたはその後の非同期注文更新の OrderUpdate オブジェクトに、次のように値を設定した estimatedFulfillmentTimeIso8601 を含めます。

  • 注文ステータスが CREATED または CONFIRMED の場合は、ユーザーが事前注文で指定した配送時間または集荷時間に値を設定します。
  • レストランやサービスからより正確な配達予定時刻が提供されている場合は、その値を配達予定時刻または受け取り予定時刻に設定します。

例: 配送スロットを含む SubmitOrderRequest

以下のスニペットは、ユーザーが選択した事前注文スロットを示す注文送信リクエストの例を示しています。

{
  "inputs": [
    {
      "intent": "actions.intent.TRANSACTION_DECISION",
      "arguments": [
        {
          "transactionDecisionValue": {
            "order": {
              "finalOrder": {
                "cart": {
                  "notes": "Guest prefers their food to be hot when it is delivered.",
                  "merchant": {
                    "id": "https://www.exampleprovider.com/merchant/id1",
                    "name": "Cucina Venti"
                  },
                  "lineItems": [
                    {
                      "name": "Sizzling Prawns Dinner",
                      "type": "REGULAR",
                      "id": "sample_item_offer_id_1",
                      "offerId": "https://www.exampleprovider.com/menu/item/offer/id1",
                      "quantity": 1,
                      "price": {
                        "type": "ESTIMATE",
                        "amount": {
                          "currencyCode": "USD",
                          "units": "16",
                          "nanos": 750000000
                        }
                      }
                    }
                  ],
                  "extension": {
                    "@type": "type.googleapis.com/google.actions.v2.orders.FoodCartExtension",
                    "fulfillmentPreference": {
                      "fulfillmentInfo": {
                        "delivery": {
                          "deliveryTimeIso8601": "2017-12-14T18:30:00-07:00"
                        }
                      }
                    }
                    "contact": {
                      ...
                    }
                  }
                },
                "totalPrice": {
                  "type": "ESTIMATE",
                  "amount": {
                    "currencyCode": "USD",
                    "units": "16",
                    "nanos": 750000000
                  }
                },
                "id": "sample_final_order_id",
                "extension": {
                  // Send whole proposed order back.
                  "availableFulfillmentOptions": [
                    "fulfillmentInfo": {
                      "delivery": {
                        "deliveryTimeIso8601": "2017-12-14T18:30:00-07:00"
                      }
                   ]
                }
              },
              "googleOrderId": "sample_google_order_id",
              "orderDate": "2017-07-17T12:00:00Z",
              "paymentInfo": {
                ...
              }
            }
          }
        }
      ]
    }
  ]
}

例: 注文を承認する SubmitOrderResponse

以下のスニペットは、フルフィルメントがユーザーの事前注文を承認したことを確認する注文送信レスポンスを示しています。

{
  "expectUserResponse": false,
  "finalResponse": {
    "richResponse": {
      "items": [
        {
          "structuredResponse": {
            "orderUpdate": {
              "actionOrderId": "sample_action_order_id",
              "orderState": {
                "state": "CREATED",
                "label": "Order placed"
              },
              "receipt": {
                "userVisibleOrderId": "userVisibleId1234"
              },
              "updateTime": "2017-07-17T12:00:00Z",
              "orderManagementActions": [
                ...
              ],
              "infoExtension": {
                 "@type": "type.googleapis.com/google.actions.v2.orders.FoodOrderUpdateExtension",
                 // Same as the user selected time.
                 "estimatedFulfillmentTimeIso8601": "2017-12-14T18:30:00-07:00"
              }
            }
          }
        }
      ]
    }
  }
}

例: スロットが利用できないため注文を拒否する SubmitOrderResponse

以下のスニペットは、空きスロットがないためにフルフィルメントがユーザーの事前注文を拒否した場合の注文送信レスポンスを示しています。

{
  "expectUserResponse": false,
  "finalResponse": {
    "richResponse": {
      "items": [
        {
          "structuredResponse": {
            "orderUpdate": {
              "actionOrderId": "sample_action_order_id",
              "orderState": {
                "state": "REJECTED",
                "label": "Unavailable slot"
              },
              "rejectionInfo": {
                // Note that this UNAVAILABLE_SLOT is different from the enum
                // with the same name proposed for FoodOrderError.
                "state": "UNAVAILABLE_SLOT",
                "label": "Unavailable slot"
              },
              "updateTime": "2017-07-17T12:00:00Z",
              "orderManagementActions": [
                ...
              ]
            }
          }
        }
      ]
    }
  }
}

事前注文の例

AdvanceServiceDeliveryHoursSpecification タイプを使用すると、ユーザーが注文を事前にスケジュールできるように、配達または集荷の時間帯を指定できます。

注: サービス提供のフルフィルメントには、ユーザーが注文できるタイミングを指定する注文可能期間と、注文が処理されるタイミングを指定するフルフィルメント期間の 2 つの時間帯を指定する必要があります。OpeningHoursSpecification オブジェクトは、ユーザーが注文できるタイミングを定義します。子アイテムのフルフィルメント時間(ServiceDeliveryHoursSpecification または AdvanceServiceDeliveryHoursSpecification)で、注文のフルフィルメントが可能になる日時を定義します。

次の例では、15 分間のサービス間隔で、事前注文を受け付けるサービスの営業時間を定義します。

{
  "hoursAvailable": [
    {
      "@type": "OpeningHoursSpecification",
      "opens": "T00:00:00", // Ordering available 24 hours
      "closes": "T23:59:59",
      "deliveryHours": [
        {
          "@type": "ServiceDeliveryHoursSpecification",
          "opens": "T09:00:00", // ASAP orders b/w 9am and 8:59:59pm
          "closes": "T21:00:00",
          "deliveryLeadTime": {
            "value": "60",
            "unitCode": "MIN"
          }
        },
        {
          "@type": "AdvanceServiceDeliveryHoursSpecification",
          "opens": "T10:00:00",  // Delivery between 10AM and 7:59:59PM
          "closes": "T20:00:00",
          "serviceTimeInterval": "PT15M", // in slots spaced 15 minutes apart (ISO8601)
          "advanceBookingRequirement": {
            "minValue": 60,   // The slot should be at least 60 mins away
            "maxValue": 8640, // but not more than 6 days away
            "unitCode": "MIN"
          }
        }
      ]
    }
  ]
}

次の例は、クリスマス当日の当日配達の注文には営業し、その日に予定されている事前注文には営業しないことを指定する方法を示しています。この例は、次のシナリオをサポートしています。

  • 12 月 25 日に注文して当日配達できます
  • 12 月 25 日に事前注文して、12 月 27 日の配送をスケジュールすることはできます
  • 12 月 22 日に 12 月 25 日の配送を予約する事前注文はできません
{
  "specialOpeningHoursSpecification": {
    "@type": "AdvanceServiceDeliveryHoursSpecification",
    "validFrom": "2018-12-25T00:00:00-07:00",
    "validThrough": "2018-12-26T00:00:00-07:00",
    "opens": "T00:00:00", // No advance ordering
    "closes": "T00:00:00"
  }
}

次の例は、クリスマス当日の当日注文や事前注文はサービスが休業で、それ以降の日付にスケジュールされた事前注文は営業であることを指定する方法を示しています。この例は、次のシナリオをサポートしています。

  • 12 月 25 日に当日配達を注文することはできません
  • 12 月 25 日に事前注文して、12 月 27 日の配送をスケジュールすることはできます
  • 12 月 22 日に 12 月 25 日の配送を予約する事前注文はできません
{
  "specialOpeningHoursSpecification": [
    {
      "@type": "ServiceDeliveryHoursSpecification",
      "validFrom": "2018-12-25T00:00:00-07:00",
      "validThrough": "2018-12-26T00:00:00-07:00",
      "opens": "T00:00:00", // No ASAP ordering on Christmas
      "closes": "T00:00:00"
    },
    {
      "@type": "AdvanceServiceDeliveryHoursSpecification",
      "validFrom": "2018-12-25T00:00:00-07:00",
      "validThrough": "2018-12-26T00:00:00-07:00",
      "opens": "T00:00:00", // Orders cannot be scheduled for Christmas
      "closes": "T00:00:00"
    }
  ]
}

次のサンプル Service は、24 時間 365 日注文を受け付け、平日は午前 10 時から午後 2 時 59 分 59 秒まで配達します。

...
{
  "@type": "OpeningHoursSpecification",
  "opens": "T00:00:00",
  "closes": "T23:59:59",
  "deliveryHours": {
    "@type": "AdvanceServiceDeliveryHoursSpecification",
    "opens": "T10:00:00", // Delivery starts at 10:00AM
    "closes": "T15:00:00", // Delivery ends at 3:00PM. Delivery from 10AM-2:59:59PM.
    "dayOfWeek": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "serviceTimeInterval": "PT15M", // in slots spaced 15 minutes apart
    "advanceBookingRequirement": {
      "minValue": 60,   // The slot should be at least 60 mins away
      "maxValue": 8640, // but not more than 6 days away
      "unitCode": "MIN"
    }
  }
}
...

次のサンプル Service では、毎日午前 8 時から午後 4 時 59 分 59 秒まで注文を受け付けます。お客様は、1 時間以内の配達を選択するか、次のいずれかの時間帯を選択できます。

...
{
  "@type": "OpeningHoursSpecification",
  "opens": "T08:00:00",  // Ordering opens at 8:00AM
  "closes": "T17:00:00",  // Ordering closes at 5:00PM, last order at 4:59:59PM
  "deliveryHours": [
    {
      "@type": "ServiceDeliveryHoursSpecification",
      "opens": "T08:00:00",
      "closes": "T17:00:00",
      "deliveryLeadTime": {
        "@type": "QuantitativeValue",
        "value": "60", // If no exact deliveryLeadTime, put a maximum time
        "unitCode": "MIN"
      }
    },
    {
      "@type": "AdvanceServiceDeliveryHoursSpecification",
      "opens": "T08:00:00",
      "closes": "T17:00:00",
      "serviceTimeInterval": "PT15M", // in slots spaced 15 minutes apart
      "advanceBookingRequirement": {
        "minValue": 90,   // The slot should be at least 90 mins away
        "maxValue": 8640, // but not more than 6 days away
        "unitCode": "MIN"
      }
    }
  ]
}
...

次の例は、平日は午前 8 時から午後 4 時 59 分 59 秒まで、週末は午前 8 時から午後 6 時 59 分 59 秒まで営業する場合を示しています。注文は 24 時間 365 日受け付けていません。

...
{
  // On weekdays, ordering open from 8AM-4:59:59PM.
  "@type": "OpeningHoursSpecification",
  "opens": "T08:00:00",
  "closes": "T17:00:00",
  "dayOfWeek": [
    "Monday",
    "Tuesday",
    "Wednesday",
    "Thursday",
    "Friday"
  ],
  "deliveryHours": [
    {
      // Fulfillment between 8AM-4:59:59PM on weekdays.
      "@type": "AdvanceServiceDeliveryHoursSpecification",
      "opens": "T08:00:00",
      "closes": "T17:00:00",
      "dayOfWeek": [
        "Monday",
        "Tuesday",
        "Wednesday",
        "Thursday",
        "Friday"
      ],
      "serviceTimeInterval": "PT15M",
      "advanceBookingRequirement": {
        "minValue": 60,
        "maxValue": 8640,
        "unitCode": "MIN"
      }
    },
    {
      // Fulfillment between 8AM-6:59:59PM on weekends (even for orders placed on a
      // weekday).
      "@type": "AdvanceServiceDeliveryHoursSpecification",
      "opens": "T08:00:00",
      "closes": "T19:00:00",
      "dayOfWeek": [
        "Saturday",
        "Sunday"
      ],
      "serviceTimeInterval": "PT15M",
      "advanceBookingRequirement": {
        "minValue": 60,
        "maxValue": 8640,
        "unitCode": "MIN"
      }
    }
  ]
},
{
  // On weekends, one can place orders upto 6:59:59PM.
  "@type": "OpeningHoursSpecification",
  "opens": "T08:00:00",
  "closes": "T19:00:00",
  "dayOfWeek": [
    "Saturday",
    "Sunday"
  ],
  "deliveryHours": [
    {
      // But fulfillment on weekdays is only till 4:59:59PM.
      "@type": "AdvanceServiceDeliveryHoursSpecification",
      "opens": "T08:00:00",
      "closes": "T17:00:00",
      "dayOfWeek": [
        "Monday",
        "Tuesday",
        "Wednesday",
        "Thursday",
        "Friday"
      ],
      "serviceTimeInterval": "PT15M",
      "advanceBookingRequirement": {
        "minValue": 60,
        "maxValue": 8640,
        "unitCode": "MIN"
      }
    },
    {
      // Fulfillment on weekends is till 6:59:59PM.
      "@type": "AdvanceServiceDeliveryHoursSpecification",
      "opens": "T08:00:00",
      "closes": "T19:00:00",
      "dayOfWeek": [
        "Saturday",
        "Sunday"
      ],
      "serviceTimeInterval": "PT15M",
      "advanceBookingRequirement": {
        "minValue": 60,
        "maxValue": 8640,
        "unitCode": "MIN"
      }
    }
  ]
}
...