UpdateBooking 方法

用戶端可使用 UpdateBooking 修改或取消現有的預訂。

如果因任何商業邏輯錯誤而導致預訂更新失敗，則應在回應中填入該錯誤。詳情請參閱預訂失敗。

要求

UpdateBookingRequest

要求訊息會在預訂欄位中提供更新的資訊，並在 update_mask 欄位 中列出要更新的所有預訂欄位的路徑。舉例來說， 在重新安排現有預訂行程的要求中，update_mask 欄位會包含 以下兩個路徑：

  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;
}