リースの詳細

リースは、リクエストされた時間枠の所有権を一時的に保持します。

パートナーのバックエンドでは、リクエストされた予約枠が有効で、まだ利用可能であることを確認します。内部的には、パートナーはリクエストされた時間枠に対して一時保留を作成します。この保留は lease_expiration_time に自動的に期限切れになります。リクエストされたリース時間が長すぎる場合などでは、バックエンドで lease_expiration_time を変更できます。作成されたリースがクライアントに返されます。

Google の予約 API では、任意でリースをサポートできます。リースのサポートでは、予約を作成する最初のステップとして、リクエストされた時間枠のリースを作成します。

// Temporary lease for an inventory slot
message Lease {
  // ID of the lease.
  // Not populated in CreateLeaseRequest. The value is chosen by the partner and
  // has to be returned in the response of CreateLease. (required)
  string lease_id = 1;

  // The appointment slot that the lease is created for. (required)
  Slot slot = 2;

  // Unique identifier for this lease, chosen by Reserve with Google. Serves as
  // an idempotency token for [ext.maps.booking.partner.v2.CreateLease]
  // requests. (required)
  string user_reference = 3;

  // Expiration time of the lease in UTC Timestamp (required)
  google.protobuf.Timestamp lease_expiration_time = 4;
}

// Reference to a [ext.maps.booking.partner.v2.Lease] that has been created via
// [ext.maps.booking.partner.v2.CreateLease]
message LeaseReference {
  // Lease ID (required)
  string lease_id = 1;
}

リースに関する追加情報

リースのサポートは任意です。このサポートの実装に関心があるパートナーに適用されます。利用開始の前に、Actions Center までご連絡ください。

リースをサポートするには、推奨の API v2 のセットを実装する必要があります。その他の必須事項は以下のとおりです。

  • CreateLease を実装する必要があります。
  • CreateBooking を実装し、リース参照を使用する必要があります。パートナーのバックエンドでは、指定されたリース参照を使用して予約を行います。

API v2 の要件は、リースのサポートにも適用されます。その他の要件は以下のとおりです。

  • CreateBooking はリース参照を使用する必要があります。指定されたリース参照を使用して予約を行うと、パートナーはそのリースを消費し、それ以降の予約では無効になります。パートナーは、リクエスト メッセージの時間枠を使用して、作成された予約を確認する必要もあります。
  • リース参照が指定され、パートナーがリース ID を知らない場合は、追加の gRPC エラーコードとして、NOT_FOUND が使用されます。
図: リースの予約を作成