UpdateBooking method

الطلب

UpdateBookingRequest

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

  paths: "start_time"
  paths: "duration"

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

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

UpdateBookingResponse

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

• INVALID_ARGUMENT إذا كانت قناع الحقل المقدَّمة تحتوي على قيم غير صالحة أو كانت أي من حقول الحجز المعدَّلة غير صالحة. ويشمل ذلك الحالات التي لا يسمح فيها منطق النشاط التجاري بتعديل الحقل، مثلاً لأنّه تأخّر موعد التمكّن من الإلغاء.
• NOT_FOUND إذا كان رقم تعريف الحجز المقدَّم غير معروف
• 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;
}