UpdateBooking 方法

要求

UpdateBookingRequest

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

  paths: "start_time"
  paths: "duration"

詳情 請參閱 FieldMask

傳回值

UpdateBookingResponse

標準 gRPC 錯誤代碼

  • INVALID_ARGUMENT:如果提供的欄位遮罩包含無效的值, 或有任何更新的「預訂」欄位無效,則傳回此值。這包括商業邏輯不允許更新欄位, 例如因為已經太晚而無法取消。
  • 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;
}