CreateLease メソッド

リース作成のサポートは任意です。このメソッドは、この機能の実装に関心があるパートナー向けのものです。開始する前に、アクション センターにお問い合わせのうえ、利用資格の有無をご確認ください。

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

ビジネス ロジックのエラーが原因でリースの作成が失敗した場合は、そのエラーがレスポンスに入力されます。詳しくは、予約の失敗をご覧ください。

リクエスト

CreateLeaseRequest

戻り値

CreateLeaseResponse

要件:

• lease_id はパートナーのバックエンドで作成し、CreateLeaseResponse で設定する必要があります。
• lease_expiration_time は CreateLeaseResponse で設定する必要があります。
• リソース フィールドが CreateLeaseRequest で指定されている場合は、CreateLeaseResponse で設定し、CreateLeaseRequest と一致させる必要があります。
• CreateLeaseResponse のその他すべてのフィールドを設定し、CreateLeaseRequest と一致させる必要があります。

正規 gRPC エラーコード

• INVALID_ARGUMENT（無効な販売者 ID、サービス ID、またはスロットの時間の指定）

// Request to create a [ext.maps.booking.partner.v2.Lease] for a slot in the
// inventory.  The expiration time in the returned Lease may be modified by the
// backend, e.g. if the requested lease period is too long.
message CreateLeaseRequest {
  // The lease to be created with information about the appointment slot
  // (required)
  Lease lease = 1;
}

// Response for the [ext.maps.booking.partner.v2.CreateLease] RPC with the
// created [ext.maps.booking.partner.v2.Lease]
message CreateLeaseResponse {
  // The created [ext.maps.booking.partner.v2.Lease] (required)
  Lease lease = 1;

  // If creating a lease fails, this field should reflect the business logic
  // error (e.g., slot has become unavailable) and lease field is expected to be
  // unset. (required if failure occurs)
  BookingFailure booking_failure = 2;
}