UpdateBooking メソッド

クライアントは UpdateBooking を使用して既存の予約を変更またはキャンセルします。

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

リクエスト

UpdateBookingRequest

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

  paths: "slot.start_time"
  paths: "slot.duration"

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

戻り値

UpdateBookingResponse

正規 gRPC エラーコード

• INVALID_ARGUMENT（指定されたフィールド マスクに無効な値が含まれているか、更新された予約フィールドのいずれかが無効な場合）
• NOT_FOUND（提供された予約 ID をパートナーが知らない場合）

// Request to update a [ext.maps.booking.partner.v2.Booking]
message UpdateBookingRequest {
  // Field mask of all booking fields to be updated (optional)
  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.
  // - one of the following is required:
  //   - start_time AND duration in the slot, to reschedule a booking.
  //   - party_size (for dining reservations).
  Booking booking = 2;
}

// Response with the updated [ext.maps.booking.partner.v2.Booking]
message UpdateBookingResponse {
  // The updated booking (required)
  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. (required if altered in update)
  UserPaymentOption user_payment_option = 2;

  // If updating a booking fails, this field should reflect the business logic
  // error (e.g., booking is not cancellable) (required if failure occurs)
  BookingFailure booking_failure = 3;
}