מפרט שכירות

הערה: השכירות היא אופציונלית בגרסה 2 של ה-API, ומומלץ להשתמש ב-CheckAvailabilty במקום זאת.

יצירת החכירה היא השלב הראשון בקביעת תור. הקצה העורפי של השותף יוודא שמשבצת הפגישה המבוקשת תקפה ועדיין זמינה. בתוך הארגון, השותף יוצר השהיה זמנית למשבצת הזמן המבוקשת, שהתוקף שלה מוגדר לפוג באופן אוטומטי ב-lease_expiration_time. אפשר לשנות את lease_expiration_time בקצה העורפי, למשל אם זמן השכירות המבוקש ארוך מדי. השכירות שנוצרה מוחזרת ללקוח.

// Temporary lease for an inventory slot
message Lease {
  // ID of the lease. Ignored when creating a lease.
  string lease_id = 1;

  // ID of the merchant for the slot
  string merchant_id = 2;

  // ID of the merchant service
  string service_id = 3;

  // Start time of the appointment slot
  google.protobuf.Timestamp start_time = 4;

  // Duration of the appointment slot
  google.protobuf.Duration duration = 5;

  // Opaque tag that identifies the availability slot and matches the value
  // provided in the availability feed.
  string availability_tag = 8;

  // The set of resources that disambiguates the appointment slot, e.g. by
  // indicating the staff member and room selected by the user.
  Resources resources = 9;

  // Unique identifier for this lease, chosen by the client. Serves as an
  // idempotency token for [ext.maps.booking.partner.v0.CreateLease] requests.
  string client_reference = 6;

  // Expiration time of the lease
  google.protobuf.Timestamp lease_expiration_time = 7;
}

// Reference to a [ext.maps.booking.partner.v0.Lease] that has been created via
// [ext.maps.booking.partner.v0.CreateLease]
message LeaseReference {
  // Lease ID
  string lease_id = 1;
}