Une location détient temporairement la propriété d'un créneau demandé.
Le backend du partenaire vérifie que le créneau horaire demandé est valide et toujours disponible. En interne, le partenaire crée une préservation temporaire pour le créneau demandé, qui est configuré pour expirer automatiquement à l'heure spécifiée dans lease_expiration_time. Le backend est autorisé à modifier la valeur lease_expiration_time (par exemple dans le cas où la durée de location demandée est trop longue).
La location ainsi créée est renvoyée au client.
Notre API de réservation est compatible avec la fonctionnalité facultative de location. Si vous optez pour cette fonctionnalité, la création de la location pour le créneau demandé constitue la première étape de création d'une réservation.
// 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;
}
Informations supplémentaires concernant les locations
L'intégration de la fonctionnalité de location est facultative. Elle ne concerne que les partenaires qui souhaitent l'utiliser. Veuillez contacter le Centre d'actions pour déterminer votre éligibilité avant de commencer.
Pour inclure la fonctionnalité de location, vous devez mettre en œuvre l'ensemble recommandé de l'API v2. En outre :
- CreateLease doit être mis en œuvre ;
- CreateBooking doit être mis en œuvre et doit utiliser la référence de la location. Le backend du partenaire effectue une réservation en incluant la référence de la location.
Les conditions requises pour l'API v2 s'appliquent également aux intégrations compatibles avec la fonctionnalité de location. En outre :
- CreateBooking doit utiliser la référence de la location. Lorsqu'une réservation est effectuée avec la référence de location fournie, le partenaire consume la location et la rend non valide pour toute réservation future. Le partenaire est également tenu de vérifier la réservation créée à l'aide du créneau horaire inclus dans le message de la requête.
- Le code d'erreur gRPC supplémentaire NOT_Found est utilisé si la référence de la location est fournie, mais que le partenaire ne reconnaît pas l'ID.
