עדכון שיטת ההזמנה

שליחת בקשה

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