Freigabe – Spezifikation

Eine Freigabe (Lease) ist ein temporärer Hold für einen angeforderten Slot.

Das Back-End des Partners prüft, ob der angeforderte Slot gültig und noch verfügbar ist. Intern erstellt der Partner einen temporären Hold für den angeforderten Slot, der automatisch um lease_expiration_time abläuft. Das Back-End darf lease_expiration_time ändern, z.B. wenn die angeforderte Zeit für die Freigabe zu lang ist. Die erstellte Freigabe wird an den Client zurückgegeben.

Die Maps Booking API bietet optionale Unterstützung für Freigaben. Wenn Freigaben unterstützt werden und eine Buchung erstellt wird, muss zuerst eine Freigabe für den angeforderten Slot erstellt werden.

// Temporary lease for an inventory slot
message Lease {
  // ID of the lease.
  // Not populated in CreateLeaseRequest. The value is chosen by the partner and
  // has to be returned in the response of CreateLease. (required)
  string lease_id = 1;

  // The appointment slot that the lease is created for. (required)
  Slot slot = 2;

  // Unique identifier for this lease, chosen by Reserve with Google. Serves as
  // an idempotency token for [ext.maps.booking.partner.v2.CreateLease]
  // requests. (required)
  string user_reference = 3;

  // Expiration time of the lease in UTC Timestamp (required)
  google.protobuf.Timestamp lease_expiration_time = 4;
}

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

Weitere Informationen zu Freigaben

Die Unterstützung von Freigaben ist optional und ist für interessierte Partner verfügbar. Bevor Sie beginnen, fragen Sie bitte im Actions Center nach, ob Sie die Voraussetzungen erfüllen.

Um Freigaben zu unterstützen, müssen die empfohlenen APIs (Version 2) implementiert werden. Außerdem muss…

  • CreateLease implementiert werden.
  • CreateBooking implementiert werden und die Freigabe-Referenz verwenden. Das Partner-Back-End nimmt mit der angegebenen Freigabe-Referenz eine Buchung vor.

Die Anforderungen von API Version 2 gelten auch für die Unterstützung von Freigaben. Außerdem muss…

  • CreateBooking eine Freigabe-Referenz verwenden. Wenn eine Buchung mit der angegebenen Freigabe-Referenz vorgenommen wird, wird die Freigabe vom Partner "aufgebraucht". Sie kann dann für keine weiteren Buchungen verwendet werden. Der Partner ist auch dafür verantwortlich, die erstellte Buchung anhand des Slots in der Anfragenachricht zu überprüfen.
  • "NOT_FOUND" wird als zusätzlicher gRPC-Fehlercode verwendet, wenn eine Freigabe-Referenz angegeben wird und die Freigabe-ID dem Partner nicht bekannt ist.
Abbildung: Buchung für eine Lease erstellen