Metoda UpdateBooking

Klient używa usługi UpdateBooking do zmiany lub anulowania istniejącej rezerwacji.

Jeśli aktualizacja rezerwacji nie powiedzie się z powodu błędu logiki biznesowej, komunikat o błędzie powinien zostać wypełnione w odpowiedzi. Zobacz rezerwację Błąd w przypadku bardziej szczegółowe informacje.

Wyślij prośbę

UpdateBookingRequest

Wiadomość z prośbą zawiera zaktualizowane informacje w polu rezerwacji oraz listy ścieżek wszystkich pól rezerwacji do zaktualizowania w polu update_mask. Przykład: pole update_mask żądania zmiany harmonogramu istniejącej rezerwacji zawiera te dwie ścieżki:

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

Zobacz FieldMask w celu uzyskania dodatkowych informacji.

Zwracana wartość

UpdateBookingResponse

Kanoniczne kody błędów gRPC

  • INVALID_ARGUMENT (jeśli podana maska pola zawiera nieprawidłowe wartości lub zaktualizowanych pól rezerwacji jest nieprawidłowych)
  • NOT_FOUND (jeśli podany identyfikator rezerwacji jest nieznany partnerowi)
// 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;
}