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