- Ressource : Availability
- Ressources
- Recurrence
- ScheduleException
- DurationRequirement
- SchedulingRuleOverrides
- ConfirmationMode
- Méthodes
Ressource : Availability
Un créneau de disponibilité du service du marchand, indiquant l'heure et le nombre de créneaux.
Représentation JSON |
---|
{ "startTime": string, "duration": string, "spotsTotal": string, "spotsOpen": string, "availabilityTag": string, "resources": { object ( |
Champs | |
---|---|
startTime |
Heure de début du créneau horaire. Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
duration |
Durée du créneau horaire Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par " |
spotsTotal |
Nombre total de créneaux et de créneaux disponibles pour cette disponibilité. Exemples :
Remarque : Si vous envoyez des requêtes à l'aide du format de compression applicable au flux de disponibilité défini ci-dessous, le système infère la valeur de ces deux champs.
|
spotsOpen |
Nombre de créneaux libres. |
availabilityTag |
Chaîne opaque facultative permettant d'identifier ce créneau de disponibilité. Si la valeur est définie, elle est incluse dans les demandes de réservation/de mise à jour/d'annulation de rendez-vous. |
resources |
Ressources facultatives permettant de faire la distinction entre ce créneau de disponibilité et d'autres créneaux, lorsque plusieurs membres du personnel ou salles ont été définis pour le service. Par exemple, le même cours de yoga avec deux enseignants :
|
paymentOptionId[] |
Liste d'ID faisant référence aux options de paiement pouvant être utilisées pour le paiement de ce créneau. Les options de paiement réelles sont définies au niveau du marchand et peuvent également s'appliquer à plusieurs marchands. Ce champ remplace tout ID payment_option_ids éventuellement spécifié dans le message du service. De même, les identifiants payment_option_ids spécifiés ici ne doivent PAS OBLIGATOIREMENT être inclus dans le message du service, mais doivent l'être au niveau du marchand. |
recurrence |
Informations de récurrence sur la disponibilité, représentant plusieurs heures de début. Une récurrence doit contenir des rendez-vous sur un jour ouvré. |
scheduleException[] |
Nombre de fois où ce service ne peut pas être planifié. Pour limiter le nombre de messages scheduleException, envisagez d'agréger les exceptions adjacentes. |
deposit |
Acompte facultatif à verser pour ce créneau de disponibilité. Remplace l'acompte éventuellement défini au niveau du service. |
noShowFee |
Frais de non-présentation facultatifs pour cette disponibilité. Remplace les frais de non-présentation éventuellement définis au niveau du service. |
requireCreditCard |
Indique si une carte de crédit est requise pour réserver ce créneau de disponibilité. Si la valeur n'est pas définie, elle est héritée le cas échéant du niveau service. (facultatif) |
ticketTypeId[] |
Indique la liste des types de billets acceptés pour ce créneau de disponibilité. Si ce paramètre n'est pas défini, tous les types de demandes du service parent sont disponibles pour ce créneau. Notez que les valeurs de ce champ doivent être définies dans le service parent. Exemples :
Pour représenter l'inventaire en semaine :
Pour indiquer que les trois types de billets sont disponibles pour ce créneau horaire, utilisez soit (facultatif) |
durationRequirement |
Obligation d'indiquer la durée et/ou l'heure de fin des créneaux. Ce champ sera ignoré si le créneau n'est pas disponible. Non utilisé pour le secteur des activités à découvrir. (facultatif) |
schedulingRuleOverrides |
Règles de planification des créneaux de disponibilité. Si des champs sont renseignés, ils remplacent toutes les règles de planification correspondantes dans SchedulingRules au niveau du service. |
confirmationMode |
Mode de confirmation utilisé lors de la réservation de cette disponibilité. Les tentatives de création de réservations pour des disponibilités avec un mode de confirmation CONFIRMATION_MODE_SYNCHRONOUS doivent être immédiatement confirmées ou refusées. Les tentatives de création de réservations pour des créneaux de disponibilité dont le mode de confirmation est CONFIRMATION_MODE_ASYNCHRONOUS doivent être immédiatement refusées ou créées avec l'état PENDING. |
Ressources
Une ressource permet de faire la distinction entre différents créneaux de disponibilité lorsque plusieurs membres du personnel ou salles ont été définis pour le service. Plusieurs créneaux pour le même service et le même intervalle de temps peuvent coexister, si leurs ressources sont différentes.
Représentation JSON |
---|
{ "staffId": string, "staffName": string, "roomId": string, "roomName": string, "partySize": integer } |
Champs | |
---|---|
staffId |
ID facultatif d'un membre du personnel fournissant le service. Ce champ identifie le membre du personnel pour tous les marchands, services et enregistrements de disponibilité. La valeur doit rester la même au fil du temps afin de pouvoir établir des corrélations avec les réservations passées. Si le champ staffName est défini, celui-ci doit l'être aussi. |
staffName |
Nom facultatif d'un membre du personnel fournissant le service. La valeur de ce champ est présentée aux utilisateurs qui effectuent une réservation. Elle doit être lisible (et ne doit donc pas être un identifiant opaque). Si le champ staffId est défini, celui-ci doit l'être aussi. |
roomId |
ID facultatif de la salle dans laquelle le service est fourni. Ce champ identifie la salle pour tous les marchands, services et enregistrements de disponibilité. La valeur doit rester la même au fil du temps afin de pouvoir établir des corrélations avec les réservations passées. Si le champ roomName est défini, celui-ci doit l'être aussi. |
roomName |
Nom facultatif de la salle dans laquelle est fourni le service. Ce champ sera présenté aux utilisateurs effectuant une réservation. Il doit être lisible et ne pas être un identifiant opaque. (Facultatif, mais obligatoire si roomId est présent) Dans le restaurant, le nom d'une salle ne doit être utilisé que pour les coins salon tels que le bar ou le patio. Il ne doit pas être utilisé pour les menus à prix fixe, les activités spéciales ou toute autre valeur qui ne correspond pas à la chambre (réservation ou dîner, par exemple). Il est fortement recommandé de ne pas associer de pièce au coin salon par défaut. |
partySize |
Applicable uniquement au secteur de la restauration : nombre de personnes pouvant être incluses dans la réservation de ce créneau. Un restaurant peut être associé à plusieurs Slots pour le même créneau horaire, chacun spécifiant un nombre de personnes (partySize) différent, si par exemple 2, 3 ou 4 personnes peuvent réserver une table. |
Recurrence
Les messages de récurrence sont facultatifs, mais ils permettent de représenter de façon plus compacte les créneaux de disponibilité qui se réitèrent. Ces messages correspondent généralement au planning d'une journée ouvrée. Les messages ScheduleException sont ensuite utilisés pour représenter des périodes réservées/non disponibles pendant la journée ouvrée.
Conditions requises :
- Veillez à ce qu'une fois développés, les créneaux de disponibilité ou les récurrences ne génèrent pas des créneaux identiques. Si l'ID, la valeur startTime, la durée et les ressources sont les mêmes, les créneaux sont considérés comme identiques.
- N'utilisez pas en même temps le format de disponibilité standard et la récurrence pour les créneaux du même service. La fonctionnalité de récurrence est particulièrement adaptée aux marchands/services qui proposent des rendez-vous. Le format standard est conçu pour les marchands/services dont les séances suivent un planning régulier.
- Les récurrences ne doivent pas durer plus de 24 heures.
Représentation JSON |
---|
{ "repeatUntil": string, "repeatEvery": string } |
Champs | |
---|---|
repeatUntil |
Horodatage au format UTC maximal et inclusif jusqu'auquel ce créneau de disponibilité se répète. Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
repeatEvery |
Définit l'intervalle entre des créneaux de disponibilité successifs. Exemple : Un créneau de disponibilité d'une durée de 20 min, une valeur repeatEvery de 30 min, une valeur startTime de 9h00 et une valeur repeatUntil de 11h00 généreront des créneaux à 9h-9h20, 9h30-9h50, 10h-10h20, 10h30-10h50 et à 11h-11h20. (obligatoire) Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par " |
ScheduleException
Les messages ScheduleException représentent des périodes réservées/indisponibles au cours de la journée ouvrée, qui constituent des exceptions à la récurrence décrite ci-dessus. À mesure que les créneaux horaires sont réservés, la liste des exceptions doit être mise à jour afin de prendre en compte les créneaux qui ne sont désormais plus disponibles. La récurrence elle-même ne doit pas être modifiée.
Représentation JSON |
---|
{
"timeRange": {
object ( |
Champs | |
---|---|
timeRange |
Période à laquelle l'exception s'applique. Tous les créneaux décrits par la récurrence qui chevauchent cette période ouvert-fermé seront considérés comme non disponibles. Exemple : Une récurrence spécifiant une durée de 20 min, une valeur repeatEvery de 30 min, une valeur startTime de 9h00 et une valeur repeatUntil de 11h00, puis une exception ScheduleException dont la valeur timeRange est de 9h45-11h00 rendraient les créneaux 9h30-9h50, 10h-10h20 et 10h30-10h50 non disponibles. Notez que, comme la période est de type ouvert-fermé, le créneau commençant à 11h n'est pas affecté. |
DurationRequirement
Cette énumération indique les conditions requises pour que l'utilisateur puisse prendre connaissance ou afficher la durée/l'heure de fin des emplacements demandés.
Enums | |
---|---|
DURATION_REQUIREMENT_UNSPECIFIED |
Le traitement de l'heure de fin n'est pas spécifié. Il s'agit de la valeur par défaut. |
DO_NOT_SHOW_DURATION |
L'heure de fin n'est pas visible par l'utilisateur. |
MUST_SHOW_DURATION |
L'heure de fin doit être indiquée à l'utilisateur avant qu'un rendez-vous puisse être pris. |
SchedulingRuleOverrides
Règles de planification au niveau du créneau de disponibilité.
Représentation JSON |
---|
{ "lastBookableSec": string, "firstBookableSec": string, "lastOnlineCancellableSec": string } |
Champs | |
---|---|
lastBookableSec |
Dernière heure (en secondes) à laquelle ce créneau peut être réservé. Cet horodatage doit être situé avant la valeur startSec du créneau (si les utilisateurs ont la possibilité de réserver après l'heure de début, utilisez le niveau de service SchedulingRules.min_booking_before_end_time). Lorsque cette valeur est définie, elle remplace toute valeur spécifiée dans le champ min_booking_buffer des règles SchedulingRules correspondantes définies au niveau du service. |
firstBookableSec |
Première heure (en secondes) à laquelle ce créneau peut être réservé. Cet horodatage doit être situé avant la valeur startSec du créneau (ou avant la valeur lastBookableSec si elle est spécifiée). |
lastOnlineCancellableSec |
Si cette option est définie, il s'agit de la dernière heure (en secondes depuis l'epoch Unix) à laquelle ce créneau horaire spécifique peut être annulé via Réserver avec Google. Ce champ remplace les règles d'annulation définies au niveau du service. (facultatif) |
ConfirmationMode
Modes de confirmation utilisés lors de la réservation de créneaux de disponibilité.
Énumérations | |
---|---|
CONFIRMATION_MODE_UNSPECIFIED |
Le mode de confirmation n'a pas été spécifié. La confirmation synchrone sera utilisée. |
CONFIRMATION_MODE_SYNCHRONOUS |
Les réservations pour ce créneau de disponibilité seront confirmées de manière synchrone. |
CONFIRMATION_MODE_ASYNCHRONOUS |
Les réservations pour ce créneau de disponibilité seront confirmées de manière asynchrone. |
Méthodes |
|
---|---|
|
Remplace la valeur Availability d'un Service existant associé à un marchand géré par l'agrégateur spécifié, puis renvoie cette valeur. |