השיטה UpdateBooking

בקשה

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 {
  option features.(pb.java).nest_in_file_class = YES;

  // 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 {
  option features.(pb.java).nest_in_file_class = YES;

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