UpdateBooking method

يستخدم العميل UpdateBooking لتعديل حجز حالي أو إلغائه.

إذا تعذّر تعديل حجز بسبب أي خطأ في منطق النشاط التجاري، يجب أن يتم ملء الخطأ في الاستجابة. اطّلِع على تعذُّر الحجز للحصول على معلومات تفصيلية.

الطلب

UpdateBookingRequest

تحتوي رسالة الطلب على معلومات معدَّلة في حقل الحجز، وتسرد مسارات جميع حقول الحجز التي سيتم تعديلها في حقل update_mask. على سبيل المثال، يحتوي الحقل update_mask لطلب يعيد جدولة حجز حالي على المسارين التاليين:

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

اطّلِع على FieldMask لمزيد من المعلومات.

القيمة المعروضة

UpdateBookingResponse

رموز خطأ gRPC الأساسية

• INVALID_ARGUMENT (إذا كانت قناع الحقل المقدَّم يحتوي على قيم غير صالحة أو كانت أيًا من حقول الحجز المعدَّلة غير صالحة)
• NOT_FOUND (إذا كان رقم تعريف الحجز المقدَّم غير معروف للشريك)

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