UpdateBooking メソッド

リクエスト

UpdateBookingRequest

リクエスト メッセージには、予約フィールドの更新情報が含まれ、update_mask フィールドで更新されるすべての予約フィールドのパスがリストされています。たとえば、既存の予約のスケジュールを変更するリクエストの update_mask フィールドには、次の 2 つのパスが含まれます。

  paths: "start_time"
  paths: "duration"

詳しくは、FieldMask をご覧ください。

戻り値

UpdateBookingResponse

正規 gRPC エラーコード

• INVALID_ARGUMENT。指定されたフィールド マスクに無効な値が含まれているか、更新された Booking フィールドのいずれかが無効な場合。これには、キャンセル可能期間が過ぎているなど、ビジネス ロジックが原因でフィールドを更新できない場合も含まれます。
• NOT_FOUND。指定された予約 ID が不明な場合。
• RESOURCE_EXHAUSTED。更新された開始時間に対応する予約枠が空いていなくて予約できない場合。

// Request to update a [ext.maps.booking.partner.v0.Booking]
message UpdateBookingRequest {
  // Field mask of all booking fields to be updated
  google.protobuf.FieldMask update_mask = 1;

  // The booking to be updated
  // The following fields can be set in a booking:
  // - status, to cancel a booking.
  // - start_time and duration to reschedule a booking.
  Booking booking = 2;
}

// Response with the updated [ext.maps.booking.partner.v0.Booking]
message UpdateBookingResponse {
  // The updated booking
  Booking booking = 1;

  // The updated user payment option originally used to pay for this booking.
  // This should be set if the UpdateBookingRequest results in a change to
  // the UserPaymentOption.
  // For instance, if the booking is canceled, the UserPaymentOption should
  // reflect an additional credit to the user. In the case of a multi-use
  // payment option, the current_count should be increased by one to
  // allow the user to create another booking with this payment option. In the
  // case of a single-use payment option, a new single-use user payment option
  // should be returned.
  UserPaymentOption user_payment_option = 2;
}