- Requête HTTP
- Corps de la requête
- Corps de la réponse
- Gestionnaire
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Intention
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- IntentParameterValue
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Scène
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- SlotFillingStatus
- Encoche
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- SlotMode
- SlotStatus
- Requête
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Simple
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Contenu
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Carte
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Image
- ImageFill
- Lien
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- OpenUrl
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- UrlHint
- Table
- TableColumn
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- HorizontalAlignment
- TableRow
- TableCell
- Multimédia
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- MediaType
- OptionalMediaControls
- MediaObject
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- MediaImage
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- RepeatMode
- Collection
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CollectionItem
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Liste
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ListItem
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CollectionBrowse
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Élément
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Suggestion
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Dessin
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ContinuousMatchConfig
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ExpectedPhrase
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- OrderUpdate
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Type
- Commander
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Informations relatives à l'utilisateur
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PhoneNumber
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Image
- Marchand
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Emplacement
- LatLng
- PostalAddress
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Sommaire
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- LineItem
- PriceAttribute
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Type
- État
- Argent
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Action
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Type
- OpenUrlAction
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- AndroidApp
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- VersionFilter
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- UrlTypeHint
- ActionMetadata
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Divulgation
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- DisclosureText
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- TextLink
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- DisclosurePresentationOptions
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PresentationRequirement
- PurchaseItemExtension
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PurchaseStatus
- PurchaseType
- MerchantUnitMeasure
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Unité
- PurchaseReturnsInfo
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PurchaseFulfillmentInfo
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Type
- Heure
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PickupInfo
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PickupType
- CurbsideInfo
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CurbsideFulfillmentType
- Véhicule
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CheckInInfo
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CheckInType
- ItemOption
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ProductDetails
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ReservationItemExtension
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ReservationStatus
- ReservationType
- StaffFacilitator
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PaymentData
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PaymentResult
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PaymentInfo
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PaymentMethodDisplayInfo
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PaymentType
- PaymentMethodProvenance
- Promotion
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PurchaseOrderExtension
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PurchaseLocationType
- PurchaseError
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ErrorType
- TicketOrderExtension
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- TicketEvent
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Type
- EventCharacter
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Type
- UserNotification
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- NextScene
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Session
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- TypeOverride
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- TypeOverrideMode
- SynonymType
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Entrée
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- EntryDisplay
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Utilisateur
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- AccountLinkingStatus
- UserVerificationStatus
- Engagement
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- IntentSubscription
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PackageEntitlements
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Droit d'accès
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- SkuType
- SignedData
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Autorisation
- Accueil
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Appareil
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Capacité
- Emplacement
- TimeZone
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Contexte
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- MediaContext
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CanvasContext
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Disponibilité
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
RPC qui représente l'API de fulfillment
Requête HTTP
POST https://webhook_handler_service.googleapis.com/fulfill
L'URL utilise la syntaxe de transcodage gRPC.
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
Représentation JSON | |
---|---|
{ "handler": { object ( |
Champs | |
---|---|
handler |
Obligatoire. Informations au fulfillment sur la manière de traiter la requête. Par exemple, une requête destinée à obtenir un fait peut avoir un gestionnaire nommé "getFact". |
intent |
Obligatoire. Représente le dernier intent mis en correspondance. Consultez https://developers.google.com/assistant/conversational/intents. |
scene |
Facultatif. Informations sur les scènes actuelle et suivante lorsque la fonction a été appelée. Sera rempli lorsque l'appel de fulfillment est effectué dans le champ d'application d'une scène. Consultez la page https://developers.google.com/assistant/conversational/scenes. |
session |
Obligatoire. Contient les données de session telles que l'ID et les paramètres de session. |
user |
Obligatoire. Utilisateur ayant initié la conversation. |
home |
Facultatif. Informations concernant la structure HomeGraph à laquelle appartient l'appareil cible. Consultez la page https://developers.google.com/actions/smarthome/concepts/homegraph. |
device |
Obligatoire. Informations sur l'appareil utilisé par l'utilisateur pour interagir avec l'action. |
context |
Facultatif. Informations sur le contexte actuel de la demande. Inclut, sans s'y limiter, les informations sur les sessions multimédias actives ou les canevas. |
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Représente une réponse envoyée par le fulfillment d'un développeur à Actions on Google.
Représentation JSON | |
---|---|
{ "prompt": { object ( |
Champs | |
---|---|
prompt |
Facultatif. Représente les invites à envoyer à l'utilisateur. Elles seront ajoutées aux messages ajoutés précédemment, sauf si elles sont explicitement remplacées. |
scene |
Facultatif. Représente la scène actuelle et la scène suivante. Si |
session |
Facultatif. Décrit les données de la session en cours. Les paramètres de session peuvent être créés, mis à jour ou supprimés par le fulfillment. |
user |
Facultatif. Permet de spécifier les paramètres utilisateur à renvoyer. |
home |
Facultatif. Permet de spécifier les paramètres liés à la structure HomeGraph à laquelle appartient l'appareil cible. Consultez la page https://developers.google.com/actions/smarthome/concepts/homegraph. |
device |
Facultatif. Permet de passer d'un appareil doté de l'Assistant auquel l'utilisateur a accès. |
expected |
Facultatif. Décrit les attentes pour le prochain tour de dialogue. |
Handler
Représente un gestionnaire de fulfillment qui mappe les informations d'événement d'Actions on Google au fulfillment. Utilisez le nom du gestionnaire pour déterminer le code à exécuter dans le fulfillment. Par exemple, un gestionnaire peut être utilisé pour obtenir des informations sur les commandes d'un utilisateur à l'aide d'un nom de gestionnaire tel que "OrderLookup". tandis qu'un autre peut récupérer des informations produit à partir d'une base de données, avec un nom de gestionnaire tel que "GetProductInfo".
Représentation JSON | |
---|---|
{ "name": string } |
Champs | |
---|---|
name |
Facultatif. Nom du gestionnaire. |
Intention
Représente un intent. Consultez https://developers.google.com/assistant/conversational/intents.
Représentation JSON | |
---|---|
{
"name": string,
"params": {
string: {
object ( |
Champs | |
---|---|
name |
Obligatoire. Nom du dernier intent mis en correspondance. |
params |
Obligatoire. Représente les paramètres identifiés comme faisant partie de la mise en correspondance de l'intent. Il s'agit d'un mappage du nom du paramètre identifié à la valeur du paramètre identifié à partir de l'entrée utilisateur. Tous les paramètres définis dans l'intent correspondant qui sont identifiés sont affichés ici. Objet contenant une liste de paires |
query |
Facultatif. Entrée saisie ou vocale de l'utilisateur final correspondant à cet intent. Ce champ sera renseigné lorsqu'un intent sera mis en correspondance, en fonction de l'entrée utilisateur. |
IntentParameterValue
Représente une valeur pour le paramètre d'intent. Consultez la page https://developers.google.com/assistant/conversational/types.
Représentation JSON | |
---|---|
{ "original": string, "resolved": value } |
Champs | |
---|---|
original |
Obligatoire. Valeur textuelle d'origine extraite de l'énoncé de l'utilisateur. |
resolved |
Obligatoire. Valeur structurée du paramètre extrait de l'entrée utilisateur. Ce champ n'est renseigné que si le paramètre est défini dans l'intent mis en correspondance et que sa valeur peut être identifiée lors de la mise en correspondance de l'intent. |
Scene
Représente une scène. Les scènes peuvent appeler le fulfillment, ajouter des invites et collecter des valeurs d'emplacements auprès de l'utilisateur. Les scènes sont déclenchées par des événements ou des intents. Elles peuvent déclencher des événements et faire correspondre des intents pour passer à d'autres scènes.
Représentation JSON | |
---|---|
{ "name": string, "slotFillingStatus": enum ( |
Champs | |
---|---|
name |
Obligatoire. Nom de la scène actuelle. |
slotFillingStatus |
Obligatoire. État actuel du remplissage de cases. Ce champ est en lecture seule. |
slots |
Emplacements associés à la scène actuelle. Les réponses du gestionnaire ne peuvent pas renvoyer d'emplacements qui n'ont pas été envoyés dans la requête. Objet contenant une liste de paires |
next |
Facultatif. Informations sur la scène à exécuter ensuite. |
SlotFillingStatus
Représente l'état actuel du remplissage d'emplacements.
Enums | |
---|---|
UNSPECIFIED |
Valeur de remplacement lorsque le champ d'utilisation n'est pas renseigné. |
INITIALIZED |
Les emplacements ont été initialisés, mais le remplissage d'emplacements n'a pas commencé. |
COLLECTING |
Les valeurs des emplacements sont en cours de collecte. |
FINAL |
Toutes les valeurs des espaces publicitaires sont définitives et ne peuvent pas être modifiées. |
Encoche
Représente un espace publicitaire.
Représentation JSON | |
---|---|
{ "mode": enum ( |
Champs | |
---|---|
mode |
Mode de l'emplacement (obligatoire ou facultatif). Peut être défini par le développeur. |
status |
État du créneau. |
value |
Valeur de l'emplacement. La modification de cette valeur dans la réponse modifiera la valeur du remplissage de cases. |
updated |
Indique si la valeur de l'emplacement a été collectée lors du dernier tour. Ce champ est en lecture seule. |
prompt |
Facultatif. Cette invite est envoyée à l'utilisateur lorsqu'il doit remplir un emplacement obligatoire. Cette requête remplace l'invite existante définie dans la console. Ce champ n'est pas inclus dans la requête webhook. |
SlotMode
Représente le mode d'un emplacement, s'il est requis ou non.
Enums | |
---|---|
MODE_UNSPECIFIED |
Valeur de remplacement lorsque le champ d'utilisation n'est pas renseigné. |
OPTIONAL |
Indique que l'emplacement n'est pas nécessaire pour terminer le remplissage d'emplacements. |
REQUIRED |
Indique que l'emplacement est requis pour terminer le remplissage d'emplacements. |
SlotStatus
Représente l'état d'un espace publicitaire.
Enums | |
---|---|
SLOT_UNSPECIFIED |
Valeur de remplacement lorsque le champ d'utilisation n'est pas renseigné. |
EMPTY |
Indique que l'emplacement ne comporte aucune valeur. Cet état ne peut pas être modifié via la réponse. |
INVALID |
Indique que la valeur de l'emplacement n'est pas valide. Cet état peut être défini via la réponse. |
FILLED |
Indique que l'emplacement a une valeur. Cet état ne peut pas être modifié via la réponse. |
Requête
Représente une réponse à un utilisateur. Consultez la page https://developers.google.com/assistant/conversational/prompts.
Représentation JSON | |
---|---|
{ "override": boolean, "firstSimple": { object ( |
Champs | |
---|---|
override |
Facultatif. Mode de fusion des messages avec des messages définis précédemment. "vrai" efface tous les messages précédemment définis (premier et dernier message simple, contenu, lien de suggestions et canevas) et ajoute les messages définis dans cette invite. "faux" ajoute les messages définis dans cette requête à ceux définis dans les réponses précédentes. Laisser ce champ sur "false" permet également d'ajouter des champs dans les invites simples, les invites Suggestions et les invites Canvas (une partie de l'invite Contenu). Les messages "Content" (Contenu) et "Link" (Lien) sont toujours écrasés s'ils sont définis dans l'invite. La valeur par défaut est "false". |
firstSimple |
Facultatif. Première réponse vocale et texte uniquement. |
content |
Facultatif. Contenu tel qu'une carte, une liste ou un contenu multimédia à présenter à l'utilisateur. |
lastSimple |
Facultatif. Dernière réponse vocale et textuelle. |
suggestions[] |
Facultatif. Suggestions à présenter à l'utilisateur et apparaîtront toujours à la fin de la réponse. Si la fonction de "remplacement" dans la requête associée est "false", les titres définis dans ce champ seront ajoutés aux titres définis dans les invites de suggestions précédemment définies et les valeurs en double seront supprimées. |
link |
Facultatif. Chip de suggestion supplémentaire pouvant rediriger les utilisateurs vers l'application ou le site associé. Le chip s'affichera avec le titre "Ouvrir (nom)". 20 caractères maximum. |
canvas |
Facultatif. Représente une réponse Interactive Canvas à envoyer à l'utilisateur. |
orderUpdate |
Optional Action répond par une mise à jour OrderUpdate après avoir reçu la commande lors du flux de transactions. À la réception de celle-ci, Google enregistre la modification de la commande et, en cas de succès, affiche une fiche de reçu avec la synthèse vocale envoyée sur les écrans. |
Simple
Représente une requête simple à envoyer à un utilisateur. Consultez la page https://developers.google.com/assistant/conversational/prompts-simple.
Représentation JSON | |
---|---|
{ "speech": string, "text": string } |
Champs | |
---|---|
speech |
Facultatif. Représente le discours à prononcer à l'utilisateur. Il peut s'agir de messages SSML ou de synthèse vocale. Si la fonction de "remplacement" de la requête associée est "true", la voix définie dans ce champ remplace celle de la requête Simple précédente. Consultez la page https://developers.google.com/assistant/conversational/ssml. |
text |
Texte facultatif à afficher dans la bulle de chat. S'il n'est pas fourni, un rendu par affichage du champ vocal ci-dessus sera utilisé. Limité à 640 caractères. Si la fonction de "remplacement" de la requête associée est "true", le texte défini dans ce champ est remplacé par le texte de la requête Simple précédente. |
Contenu
Objet conteneur pour des requêtes enrichies ou des invites de sélection.
Représentation JSON | |
---|---|
{ // Union field |
Champs | ||
---|---|---|
Champ d'union
|
||
card |
Une carte basique. |
|
image |
Image. |
|
table |
Fiche du tableau. |
|
media |
Réponse indiquant un ensemble de contenus multimédias à lire. |
|
collection |
Fiche présentant un ensemble d'options disponibles. |
|
list |
Fiche présentant une liste d'options disponibles. |
|
collectionBrowse |
Fiche présentant un ensemble de pages Web à ouvrir. |
Fiche
Une carte basique permettant d'afficher certaines informations (par exemple, une image et/ou un texte. Consultez la page https://developers.google.com/assistant/conversational/prompts-rich#basic_card.
Représentation JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Champs | |
---|---|
title |
Titre général de la fiche. Facultatif. |
subtitle |
Facultatif. |
text |
Corps du texte de la carte. Accepte un ensemble limité de syntaxes Markdown pour la mise en forme. Obligatoire, sauf si une image est présente. |
image |
Une image héros pour la carte. La hauteur est fixe à 192 dp. Facultatif. |
imageFill |
Mode de remplissage de l'arrière-plan de l'image. Facultatif. |
button |
Bouton avec un lien sortant. Facultatif. |
Image
Une image affichée dans la carte. Consultez la page https://developers.google.com/assistant/conversational/prompts-rich#image-cards.
Représentation JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Champs | |
---|---|
url |
URL source de l'image. Les images peuvent être au format JPG, PNG et GIF (animé ou non). Exemple : |
alt |
Description textuelle de l'image à utiliser pour l'accessibilité, par exemple avec des lecteurs d'écran. Obligatoire. |
height |
Hauteur de l'image en pixels. Facultatif. |
width |
Largeur de l'image en pixels. Facultatif. |
ImageFill
Options d'affichage possibles pour modifier la présentation de l'image. Utilisez cette option lorsque les proportions de l'image ne correspondent pas à celles du conteneur de l'image.
Enums | |
---|---|
UNSPECIFIED |
|
GRAY |
Utilisez des barres grises pour combler les espaces entre l'image et le conteneur de l'image. |
WHITE |
Utilisez des barres blanches pour remplir les espaces entre l'image et le conteneur de l'image. |
CROPPED |
L'image est mise à l'échelle de sorte que sa largeur et sa hauteur correspondent ou dépassent les dimensions du conteneur. Cela peut recadrer le haut et le bas de l'image si la hauteur de l'image mise à l'échelle est supérieure à celle du conteneur, ou recadrer l'image à gauche et à droite si la largeur de l'image mise à l'échelle est supérieure à celle du conteneur. Semblable au mode Zoom sur un téléviseur grand écran lors de la lecture d'une vidéo 4:3. |
Lien
Chip de suggestion supplémentaire pouvant rediriger les utilisateurs vers l'application ou le site associé. Le chip s'affichera avec le titre "Ouvrir (nom)".
Représentation JSON | |
---|---|
{
"name": string,
"open": {
object ( |
Champs | |
---|---|
name |
Nom du lien. 20 caractères maximum. |
open |
Que se passe-t-il lorsqu'un utilisateur ouvre le lien ? |
OpenUrl
Représentation JSON | |
---|---|
{
"url": string,
"hint": enum ( |
Champs | |
---|---|
url |
Champ d'URL qui peut contenir l'un des éléments suivants: - URL http/https permettant d'ouvrir une application associée à une application ou une page Web |
hint |
Indique une indication pour le type d'URL. |
UrlHint
Différents types d'indications d'URL.
Enums | |
---|---|
LINK_UNSPECIFIED |
Non spécifié |
AMP |
URL qui redirige directement vers un contenu AMP ou vers une URL canonique faisant référence à du contenu AMP via . Consultez https://amp.dev/. |
Tableau
Fiche du tableau permettant d'afficher un tableau de texte. Consultez la page https://developers.google.com/assistant/conversational/prompts-rich#table_cards.
Représentation JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Champs | |
---|---|
title |
Titre général de la table. Facultatif, mais doit être défini si "Sous-titre" est défini. |
subtitle |
Sous-titre du tableau. Facultatif. |
image |
Image associée au tableau. Facultatif. |
columns[] |
En-têtes et alignement des colonnes. |
rows[] |
Données de ligne de la table. L'affichage des trois premières lignes est garanti, mais d'autres peuvent être coupés sur certaines surfaces. Effectuez un test avec le simulateur pour voir quelles lignes seront affichées pour une surface donnée. Sur les surfaces compatibles avec la fonctionnalité WEB_BROWSER, vous pouvez rediriger l'utilisateur vers une page Web contenant davantage de données. |
button |
Bouton. |
TableColumn
Représentation JSON | |
---|---|
{
"header": string,
"align": enum ( |
Champs | |
---|---|
header |
Texte de l'en-tête de la colonne. |
align |
Alignement horizontal de la colonne de pondération du contenu. S'il n'est pas spécifié, le contenu sera aligné sur le bord initial. |
HorizontalAlignment
Alignement du contenu dans la cellule.
Enums | |
---|---|
UNSPECIFIED |
|
LEADING |
Bord initial de la cellule. Il s'agit de la valeur par défaut. |
CENTER |
Le contenu est aligné au centre de la colonne. |
TRAILING |
Le contenu est aligné sur le bord final de la colonne. |
Ligne de tableau
Décrit une ligne du tableau.
Représentation JSON | |
---|---|
{
"cells": [
{
object ( |
Champs | |
---|---|
cells[] |
Cellules de cette ligne. L'affichage des trois premières cellules est garanti, mais d'autres peuvent être coupés sur certaines surfaces. Effectuez un test avec le simulateur pour voir quelles cellules seront affichées pour une surface donnée. |
divider |
Indique s'il doit y avoir un séparateur après chaque ligne. |
TableCell
Décrit une cellule dans une ligne.
Représentation JSON | |
---|---|
{ "text": string } |
Champs | |
---|---|
text |
Contenu textuel de la cellule. |
Multimédia
Représente un objet multimédia. Contient des informations sur le contenu multimédia, telles que son nom, sa description, son URL, etc. Consultez https://developers.google.com/assistant/conversational/prompts-media.
Représentation JSON | |
---|---|
{ "mediaType": enum ( |
Champs | |
---|---|
mediaType |
|
startOffset |
Décalage de début du premier objet multimédia. Durée en secondes avec neuf chiffres au maximum après la virgule. Se termine par " |
optionalMediaControls[] |
Types de commandes multimédias facultatives compatibles avec cette session de réponse multimédia. Si cette règle est définie, la requête est envoyée à 3p lorsqu'un événement multimédia donné se produit. Si cette règle n'est pas configurée, 3p doit tout de même gérer deux types de commandes par défaut : FINISHED et FAILED. |
mediaObjects[] |
Liste des objets Media |
repeatMode |
Mode de répétition pour la liste des objets Media. |
firstMediaObjectIndex |
Index basé sur 0 du premier objet Media dans MediaObjects à lire Si aucune valeur n'est spécifiée, ou si la valeur est nulle ou hors limites, la lecture démarre au niveau du premier objet multimédia dans mediaObjects. |
MediaType
Type de support de cette réponse.
Enums | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
|
AUDIO |
Fichier audio. |
MEDIA_STATUS_ACK |
Réponse pour accuser réception d'un rapport d'état du contenu multimédia. |
OptionalMediaControls
Types de commandes multimédias facultatifs compatibles avec la réponse multimédia
Enums | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Valeur non spécifiée |
PAUSED |
Événement mis en veille. Déclenchement lorsque l'utilisateur met le contenu multimédia en pause. |
STOPPED |
Événement arrêté. Déclenchement lorsque l'utilisateur quitte la session 3p pendant la lecture d'un contenu multimédia. |
MediaObject
Représente un objet multimédia unique.
Représentation JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
Champs | |
---|---|
name |
Nom de cet objet multimédia. |
description |
Description de cet objet multimédia. |
url |
URL pointant vers le contenu multimédia. Les fichiers MP3 doivent être hébergés sur un serveur Web et accessibles publiquement via une URL HTTPS. La diffusion en direct n'est compatible qu'avec le format MP3. |
image |
Image à afficher avec la fiche multimédia. |
MediaImage
Représentation JSON | |
---|---|
{ // Union field |
Champs | ||
---|---|---|
Champ d'union
|
||
large |
Une grande image, comme la couverture de l'album, etc. |
|
icon |
Une petite icône d'image s'affiche à droite du titre. Elle est redimensionnée à 36 x 36 dp. |
RepeatMode
Types de mode de répétition pour une liste d'objets multimédias.
Enums | |
---|---|
REPEAT_MODE_UNSPECIFIED |
Équivaut à OFF. |
OFF |
La session multimédia s'arrête à la fin du dernier objet multimédia. |
ALL |
Effectuez une boucle jusqu'au début du premier objet multimédia lorsque la fin du dernier objet multimédia est atteinte. |
Collection
Fiche présentant un ensemble d'options disponibles. Consultez la page https://developers.google.com/assistant/conversational/prompts-selection#collection.
Représentation JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Champs | |
---|---|
title |
Titre de la collection. Facultatif. |
subtitle |
Sous-titre de la collection. Facultatif. |
items[] |
Liste d'éléments. Elle peut avoir une valeur minimale de 2 et une valeur maximale de 10. |
imageFill |
Manière dont l'arrière-plan des images des éléments de la collection sera rempli. Facultatif. |
CollectionItem
Un élément de la collection
Représentation JSON | |
---|---|
{ "key": string } |
Champs | |
---|---|
key |
Obligatoire. Clé NLU correspondant au nom de la clé d'entrée dans le type associé. |
Liste
Fiche présentant une liste d'options disponibles. Consultez la page https://developers.google.com/assistant/conversational/prompts-selection#list.
Représentation JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Champs | |
---|---|
title |
Titre de la liste. Facultatif. |
subtitle |
Sous-titre de la liste. Facultatif. |
items[] |
Liste d'éléments. Elle peut avoir une valeur minimale de 2 et une valeur maximale de 30. |
ListItem
Un élément de la liste
Représentation JSON | |
---|---|
{ "key": string } |
Champs | |
---|---|
key |
Obligatoire. Clé NLU correspondant au nom de la clé d'entrée dans le type associé. |
CollectionBrowse
Présente un ensemble de documents Web sous la forme d'une collection d'éléments de grande taille. Les éléments peuvent être sélectionnés pour lancer le document Web associé dans un lecteur Web. Consultez la page https://developers.google.com/assistant/conversational/prompts-selection#collectionBrowse.
Représentation JSON | |
---|---|
{ "items": [ { object ( |
Champs | |
---|---|
items[] |
Liste d'éléments. Elle peut avoir une valeur minimale de 2 et une valeur maximale de 10. |
imageFill |
Type d'option d'affichage de l'image. |
Élément
Élément de la collection.
Représentation JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Champs | |
---|---|
title |
Obligatoire. Titre de l'élément de la collection. |
description |
Description de l'élément de la collection. |
footer |
Texte de pied de page de l'élément de la collection, affiché sous la description. Une seule ligne de texte, tronquée par des points de suspension. |
image |
Image de l'élément de collection. |
openUriAction |
Obligatoire. URI à ouvrir si l'élément est sélectionné. |
Suggestion
Les suggestions fournissent aux utilisateurs d'appareils dotés de fonctionnalités d'affichage des chips de suggestion lorsque l'Assistant affiche l'invite. Utilisez les chips de suggestion pour suggérer des réponses de l'utilisateur afin de poursuivre ou de faire pivoter la conversation. Lorsqu'un utilisateur appuie dessus, un chip de suggestion renvoie le texte affiché mot à mot dans la conversation, comme si l'utilisateur l'avait saisi. Consultez la page https://developers.google.com/assistant/conversational/prompts#suggestions.
Représentation JSON | |
---|---|
{ "title": string } |
Champs | |
---|---|
title |
Obligatoire. Texte affiché dans le chip de suggestion. Lorsque l'utilisateur appuiera sur ce texte, il sera publié tel quel dans la conversation, comme si l'utilisateur l'avait saisi. Chaque titre doit être unique parmi les chips de suggestion. 25 caractères max. |
Canevas
Représente une réponse Interactive Canvas à envoyer à l'utilisateur. Elle peut être utilisée en conjonction avec la méthode "firstSimple" dans l'invite associée pour parler à l'utilisateur en plus d'afficher une réponse de canevas interactive. La taille maximale de la réponse est de 50 000 octets. Consultez la page https://developers.google.com/assistant/interactivecanvas.
Représentation JSON | |
---|---|
{
"url": string,
"data": [
value
],
"suppressMic": boolean,
"continuousMatchConfig": {
object ( |
Champs | |
---|---|
url |
URL de l'application Web du canevas interactif à charger. Si cette règle n'est pas configurée, l'URL du canevas actif actuel sera réutilisée. |
data[] |
Facultatif. Données JSON à transmettre à la page Web de l'expérience immersive en tant qu'événement. Si la fonction de "remplacement" dans la requête associée est "false" les valeurs de données définies dans cette requête Canvas seront ajoutées après celles définies dans les requêtes Canvas précédentes. |
suppressMic |
Facultatif. Valeur par défaut : "false". |
continuousMatchConfig |
Configuration utilisée pour lancer le mode de correspondance continue. |
ContinuousMatchConfig
Configuration utilisée pour lancer le mode de correspondance continue.
Représentation JSON | |
---|---|
{
"expectedPhrases": [
{
object ( |
Champs | |
---|---|
expectedPhrases[] |
Toutes les expressions attendues possibles au cours de cette session en mode de correspondance continue. |
durationSeconds |
Durée pendant laquelle le mode de correspondance continue reste activé. Si elle est spécifiée, le micro sera désactivé une fois le temps écoulé. La valeur maximale autorisée est de 180. |
ExpectedPhrase
Représentation JSON | |
---|---|
{ "phrase": string, "alternativePhrases": [ string ] } |
Champs | |
---|---|
phrase |
Expression à mettre en correspondance lors de la session en mode de correspondance continue. |
alternativePhrases[] |
Certaines expressions peuvent être mal reconnues par le modèle de reconnaissance vocale, même avec la pondération de la parole. Cela permet aux développeurs de spécifier d'autres déclencheurs pour les homophones. |
OrderUpdate
Mise à jour d'une commande
Représentation JSON | |
---|---|
{ "type": enum ( |
Champs | |
---|---|
type |
Obsolète: utilisez OrderUpdate.update_mask à la place. Si la valeur est de type SNAPSHOT, OrderUpdate.order doit correspondre à l'intégralité de la commande. Si le type est ORDER_STATUS, il s'agit de la modification de l'état au niveau de la commande. Seuls "order.last_update_time" et cet état vertical sont pris en compte. Remarque: Le type.ORDER_STATUS prend uniquement en charge les mises à jour de l'état de PurcahaseOrderExtension. Nous ne prévoyons pas d'étendre cette prise en charge. Nous vous recommandons plutôt d'utiliser updateMask, car il est plus générique, extensible et peut être utilisé pour tous les secteurs. |
order |
|
updateMask |
Remarque: Voici quelques considérations/recommandations concernant les champs spéciaux suivants: 1. order.last_update_time sera toujours mis à jour dans le cadre de la demande de mise à jour. 2. Les commandes "order.create_time", "order.google_order_id" et "order.merchant_order_id" seront ignorées si elles sont fournies dans le cadre de "updateMask". Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : |
userNotification |
Le cas échéant, affiche une notification contenant le titre et le texte spécifiés pour l'utilisateur. La spécification d'une notification est une suggestion de notification et n'entraîne pas nécessairement une notification. |
reason |
Motif de la modification/mise à jour. |
Type
Obsolète: utilisez OrderUpdate.update_mask à la place. Mises à jour autorisées d'une commande.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Type non spécifié, ne doit pas être défini explicitement. |
ORDER_STATUS |
Mettre à jour uniquement l'état de la commande |
SNAPSHOT |
Mettre à jour l'instantané de la commande |
Commande
Entité de commande. Remarque: 1. Sauf indication contraire, toutes les chaînes, quel que soit leur niveau, doivent comporter moins de 1 000 caractères. 2. Sauf indication contraire, tous les champs répétés, à tous les niveaux, doivent être inférieurs à 50. 3. S'ils sont spécifiés, tous les codes temporels de tous les niveaux doivent être valides.
Représentation JSON | |
---|---|
{ "googleOrderId": string, "merchantOrderId": string, "userVisibleOrderId": string, "userVisibleStateLabel": string, "buyerInfo": { object ( |
Champs | ||
---|---|---|
googleOrderId |
ID de commande attribué par Google. |
|
merchantOrderId |
Obligatoire: ID de commande interne attribué par le marchand. Cet identifiant doit être unique. Il est obligatoire pour toute opération ultérieure de mise à jour de commandes. Cet identifiant peut être défini sur l'ID googleOrderId fourni ou sur toute autre valeur unique. Notez que l'ID présenté aux utilisateurs est "userVisibleOrderId", qui peut être une valeur différente et plus conviviale. La longueur maximale autorisée est de 128 caractères. |
|
userVisibleOrderId |
ID visible par l'utilisateur qui fait référence à la commande en cours. Cet identifiant doit correspondre à celui affiché pour cette commande dans les autres contextes, y compris sur les sites Web, les applications et les e-mails. |
|
userVisibleStateLabel |
Obsolète: utilisez plutôt l'état OrderExtensions. Libellé visible par l'utilisateur indiquant l'état de cette commande. |
|
buyerInfo |
Informations sur l'acheteur. |
|
image |
Image associée à la commande. |
|
createTime |
(obligatoire) : date et heure de création de la commande. Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
|
lastUpdateTime |
Date et heure de la dernière mise à jour de la commande. Obligatoire pour OrderUpdate. Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
|
transactionMerchant |
Marchand ayant facilité le paiement. Il peut être différent de celui d'un fournisseur au niveau de l'élément de campagne. Exemple: Commande Expedia avec une ligne de l'ANA. |
|
contents |
Obligatoire: contenu de la campagne (groupe d'éléments de campagne). |
|
priceAttributes[] |
Prix, remises, taxes, etc. |
|
followUpActions[] |
Actions de suivi au niveau de la commande |
|
paymentData |
Données relatives au paiement de la commande. |
|
termsOfServiceUrl |
Lien vers les conditions d'utilisation qui s'appliquent à la commande/commande proposée. |
|
note |
Notes associées à un ordre. |
|
promotions[] |
Toutes les promotions associées à cette commande. |
|
disclosures[] |
Divulgation associée à cette ordonnance |
|
vertical |
Obsolète: utilisez plutôt des secteurs. Ces propriétés s'appliqueront à tous les éléments de ligne, sauf si elles sont remplacées dans certains éléments de ligne. Ce secteur doit correspondre au type de secteur au niveau de l'élément de campagne. Valeurs possibles: Objet contenant des champs d'un type arbitraire. Un champ supplémentaire |
|
Champ d'union verticals . Ces propriétés s'appliqueront à tous les éléments de ligne, sauf si elles sont remplacées dans certains éléments de ligne. Ce secteur doit correspondre au type de secteur au niveau de l'élément de campagne. verticals ne peut être qu'un des éléments suivants : |
||
purchase |
Bon de commande |
|
ticket |
Commande de billets |
UserInfo
Informations sur l'utilisateur. Il s'agit d'informations sur l'utilisateur associé à une commande.
Représentation JSON | |
---|---|
{
"email": string,
"firstName": string,
"lastName": string,
"displayName": string,
"phoneNumbers": [
{
object ( |
Champs | |
---|---|
email |
Adresse e-mail de l'utilisateur (par exemple, janedoe@gmail.com). |
firstName |
Prénom de l'utilisateur. |
lastName |
Nom de l'utilisateur. |
displayName |
Nom à afficher de l'utilisateur, qui peut être différent du prénom ou du nom de famille. |
phoneNumbers[] |
Numéros de téléphone de l'utilisateur. |
PhoneNumber
Représentation standard d'un numéro de téléphone.
Représentation JSON | |
---|---|
{ "e164PhoneNumber": string, "extension": string, "preferredDomesticCarrierCode": string } |
Champs | |
---|---|
e164PhoneNumber |
Numéro de téléphone au format E.164, tel que défini dans la recommandation E.164 de l'Union internationale des télécommunications (UIT). Lien wiki: https://en.wikipedia.org/wiki/E.164 |
extension |
L'extension n'est pas standardisée dans les recommandations de l'UIT, sauf qu'elle est définie comme une série de nombres d'une longueur maximale de 40 chiffres. Il est défini comme une chaîne pour permettre l'utilisation possible d'un zéro au début de l'extension (les organisations ont une liberté totale de le faire, car aucune norme n'est définie). À l'exception des chiffres, d'autres caractères d'appel tels que "," (indiquant une attente) peut être stockée ici. Par exemple, dans le poste xxx-xxx-xxxx poste 123, "123" est l'extension. |
preferredDomesticCarrierCode |
Code de sélection de l'opérateur à privilégier pour appeler ce numéro de téléphone dans le pays. Cela comprend également les codes qui doivent être composés dans certains pays pour les appels passés depuis une ligne fixe vers un mobile, ou inversement. Par exemple, en Colombie, un "3" doit être composé avant le numéro de téléphone lorsque vous passez un appel depuis un mobile vers un téléphone fixe national, et inversement. https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia https://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code Notez qu'il s'agit de la solution "préférée" ce qui signifie que d'autres codes peuvent également fonctionner. |
Image
Une image affichée dans la carte.
Représentation JSON | |
---|---|
{ "url": string, "accessibilityText": string, "height": integer, "width": integer } |
Champs | |
---|---|
url |
URL source de l'image. Les images peuvent être au format JPG, PNG et GIF (animé ou non). Exemple : |
accessibilityText |
Description textuelle de l'image à utiliser pour l'accessibilité, par exemple avec des lecteurs d'écran. Obligatoire. |
height |
Hauteur de l'image en pixels. Facultatif. |
width |
Largeur de l'image en pixels. Facultatif. |
Marchand
Marchand pour le panier/la commande/l'article.
Représentation JSON | |
---|---|
{ "id": string, "name": string, "image": { object ( |
Champs | |
---|---|
id |
ID facultatif attribué au marchand, le cas échéant. |
name |
Nom du marchand (par exemple, "Panera Bread"). |
image |
Image associée au marchand. |
phoneNumbers[] |
Numéros de téléphone du marchand. |
address |
Adresse du marchand. |
Lieu
Conteneur qui représente un emplacement.
Représentation JSON | |
---|---|
{ "coordinates": { object ( |
Champs | |
---|---|
coordinates |
Coordonnées géographiques Nécessite [DEVICE_PRECISE_LOCATION] Autorisation [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
formattedAddress |
Adresse affichée (par exemple, "1600 Amphitheatre Pkwy, Mountain View, CA 94043", États-Unis Nécessite [DEVICE_PRECISE_LOCATION] Autorisation [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
zipCode |
Code postal. Nécessite [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] ou [DEVICE_COARSE_LOCATION] Autorisation [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
city |
Ville. Nécessite [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] ou [DEVICE_COARSE_LOCATION] Autorisation [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
postalAddress |
Adresse postale. Nécessite [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] ou [DEVICE_COARSE_LOCATION] Autorisation [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
name |
Nom du lieu. |
phoneNumber |
Numéro de téléphone de l'établissement (par exemple, le numéro de téléphone de l'établissement ou le numéro de téléphone du lieu de livraison. |
notes |
Notes sur le lieu. |
placeId |
placeId est utilisé avec l'API Places pour récupérer les détails d'un lieu. Consultez la page https://developers.google.com/places/web-service/place-id. |
LatLng
Objet représentant une paire latitude/longitude. Elle est exprimée par une paire de doubles représentant les degrés de latitude et de longitude. Sauf indication contraire, cet objet doit être conforme à la norme WGS84. Les valeurs doivent se situer dans les limites normalisées.
Représentation JSON | |
---|---|
{ "latitude": number, "longitude": number } |
Champs | |
---|---|
latitude |
Latitude en degrés. Elle doit être comprise dans la plage [-90.0, +90.0]. |
longitude |
Longitude en degrés. Elle doit être comprise dans la plage [-180.0, +180.0]. |
PostalAddress
Représente une adresse postale, telles que des adresses de livraison ou de paiement. Les services postaux peuvent effectuer une livraison à cette adresse, boîte postale ou autre. Ce champ n'a pas vocation à modéliser des emplacements géographiques (routes, villes ou montagnes).
Généralement, une adresse est créée via une saisie utilisateur ou lors de l'importation de données existantes, en fonction du type de processus.
Conseils pour la saisie ou la modification d'adresse : utilisez un widget d'adresse compatible i18n, tel que https://github.com/google/libaddressinput. Les utilisateurs ne doivent pas voir d'éléments d'interface utilisateur permettant de saisir ou de modifier des champs en dehors des pays où ce champ est utilisé.
Pour en savoir plus sur l'utilisation de ce schéma, consultez la page https://support.google.com/business/answer/6397478.
Représentation JSON | |
---|---|
{ "revision": integer, "regionCode": string, "languageCode": string, "postalCode": string, "sortingCode": string, "administrativeArea": string, "locality": string, "sublocality": string, "addressLines": [ string ], "recipients": [ string ], "organization": string } |
Champs | |
---|---|
revision |
Révision du schéma de Toutes les nouvelles révisions doivent être rétrocompatibles avec les anciennes révisions. |
regionCode |
Obligatoire. Code pays/région CLDR de l'adresse. Il n'est jamais déduit, et il revient à l'utilisateur de s'assurer que la valeur est correcte. Pour en savoir plus, consultez les pages http://cldr.unicode.org/ et http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Exemple : "CH" pour la Suisse. |
languageCode |
Facultatif. Code de langue BCP-47 du contenu de cette adresse (s'il est connu). Il s'agit souvent de la langue d'UI du formulaire de saisie. Sinon, il doit correspondre à l'une des langues utilisées dans le pays/la région mentionnés dans l'adresse ou leurs équivalents translittérés. Ce champ peut modifier la mise en forme dans certains pays, mais cela ne risque pas de nuire à l'exactitude des données et n'affectera jamais aucune validation ni aucune opération ne concernant pas la mise en forme. Si cette valeur est inconnue, vous devez l'omettre (plutôt que de spécifier une valeur par défaut éventuellement incorrecte). Exemples : "zh-Hant", "ja", "ja-Latn" et "en". |
postalCode |
Facultatif. Code postal de l'adresse. Tous les pays n'utilisent pas ou n'exigent pas de codes postaux, mais lorsqu'ils s'en servent, ils peuvent déclencher une validation supplémentaire avec d'autres parties de l'adresse (par exemple, validation par État/code postal aux États-Unis). |
sortingCode |
Facultatif. Code de tri supplémentaire, spécifique à chaque pays. La plupart des régions ne s'en servent pas. Lorsqu'il est utilisé, sa valeur comprend une chaîne de type CEDEX, éventuellement suivie d'un numéro (par exemple CEDEX 7), ou tout simplement un nombre représentant un "code de secteur" (Jamaïque), un "indicateur de zone de livraison" (Malawi) ou un "indicateur postal" (Côte d'Ivoire, par exemple). |
administrativeArea |
Facultatif. Plus haute subdivision administrative utilisée pour les adresses postales d'un pays ou d'une région. Par exemple, il peut s'agir d'un État, d'une province, d'un oblast ou d'une préfecture. Plus précisément, pour l'Espagne, il s'agit de la province et non de la communauté autonome (par exemple, "Barcelone" et non "Catalogne"). De nombreux pays n'utilisent pas de région administrative dans leurs adresses postales. Par exemple, ce champ doit rester vide en Suisse. |
locality |
Facultatif. Fait généralement référence à la ville de l'adresse. Exemples : une "city" aux États-Unis, une "comune" en Italie, une "post town" au Royaume-Uni. Dans les régions du monde où les localités ne sont pas bien définies ou ne s'intègrent pas bien dans cette structure, laissez le champ de localité vide et utilisez addressLines. |
sublocality |
Facultatif. Sous-localité de l'adresse. Il peut s'agir, par exemple, de quartiers, d'arrondissements ou de districts. |
addressLines[] |
Lignes d'adresse non structurées décrivant les niveaux inférieurs d'une adresse. Étant donné que les valeurs dans "addressLines" ne contiennent pas d'informations de type et peuvent parfois comprendre plusieurs valeurs dans un seul champ (par exemple, "Austin, TX"), il est important que l'ordre des lignes soit bien clair. L'ordre des lignes d'adresse doit correspondre à l'ordre suivi sur les enveloppes pour le pays/la région de l'adresse. Dans les pays où cet ordre peut varier (par exemple, au Japon), "address_language" est utilisé pour le rendre explicite (par exemple, "ja" pour un ordre décroissant et "ja-Latn" ou "en" pour un ordre croissant). De cette façon, la ligne la plus spécifique d'une adresse peut être sélectionnée en fonction de la langue. La représentation structurelle minimale autorisée d'une adresse consiste en un code "regionCode" avec toutes les informations restantes placées dans les lignes "adresseLines". Il serait possible de mettre en forme une telle adresse de manière très approximative sans géocodage, mais aucun raisonnement sémantique ne pourrait être réalisé quant à l'un des composants d'adresse avant qu'il n'ait été au moins partiellement résolu. La création d'une adresse contenant uniquement un code "regionCode" et des lignes "addressLines" suivi d'un géocodage est la méthode recommandée pour gérer les adresses complètement déstructurées (plutôt que de deviner quelles parties de l'adresse sont des localités ou des régions administratives). |
recipients[] |
Facultatif. Destinataire. Ce champ peut, dans certaines circonstances, contenir des informations multilignes. Par exemple, il peut comporter la ligne "chez". |
organization |
Facultatif. Nom de l'entreprise. |
Sommaire
Enveloppe pour les éléments de campagne.
Représentation JSON | |
---|---|
{
"lineItems": [
{
object ( |
Champs | |
---|---|
lineItems[] |
Liste des éléments de campagne. Vous devez ajouter au moins un article, et 50 éléments maximum. Tous les éléments de campagne doivent appartenir au même secteur. |
LineItem
Un élément de campagne contient un secteur. Une commande ou un panier peut comporter plusieurs lignes du même secteur. Les éléments de sous-lignes, les modules complémentaires, etc. doivent être définis dans des prototypes verticaux en fonction de leurs cas d'utilisation. Remarque: 1. Sauf indication contraire, toutes les chaînes, quel que soit leur niveau, doivent comporter moins de 1 000 caractères. 2. Sauf indication contraire, tous les champs répétés, à tous les niveaux, doivent être inférieurs à 50. 3. S'ils sont spécifiés, tous les codes temporels de tous les niveaux doivent être valides.
Représentation JSON | |
---|---|
{ "id": string, "name": string, "userVisibleStateLabel": string, "provider": { object ( |
Champs | ||
---|---|---|
id |
Obligatoire: identifiant attribué par le marchand pour l'article. Permet d'identifier les éléments de campagne existants lors de l'application de mises à jour partielles. La longueur maximale autorisée est de 64 caractères. |
|
name |
Nom de la ligne, tel qu'il apparaît sur le reçu. La longueur maximale autorisée est de 100 caractères. |
|
userVisibleStateLabel |
Obsolète. Utilisez plutôt l'état au niveau vertical. Par exemple, pour les achats, utilisez "PurchaseOrderExtension.status". Libellé visible par l'utilisateur correspondant à l'état de cet élément de campagne. |
|
provider |
Fournisseur de l'élément de campagne concerné, s'il est différent de la commande globale. Exemple: Commande Expedia avec ANA du fournisseur d'éléments de campagne. |
|
priceAttributes[] |
Prix et ajustements au niveau de l'élément de campagne. |
|
followUpActions[] |
Actions de suivi au niveau de l'élément de campagne. |
|
recipients[] |
Clients au niveau de l'élément de campagne, ce paramètre peut être différent de celui de l'acheteur au niveau de la commande. Exemple: L'utilisateur X a effectué une réservation au restaurant sous le nom de l'utilisateur Y. |
|
image |
Petite image associée à cet article, le cas échéant. |
|
description |
Description de l'élément de campagne. |
|
notes[] |
Remarques supplémentaires applicables à cette ligne spécifique (par exemple, les modalités d'annulation). |
|
disclosures[] |
Divulgation associée à cet élément de campagne. |
|
vertical |
Obsolète: utilisez plutôt des secteurs. Obligatoire: contenu sémantique de l'élément de campagne en fonction de son type/secteur. Chaque secteur doit inclure ses propres détails de traitement des commandes. Doit correspondre à l'une des valeurs suivantes: Objet contenant des champs d'un type arbitraire. Un champ supplémentaire |
|
Champ d'union verticals . Obligatoire: contenu sémantique de l'élément de campagne en fonction de son type/secteur. Chaque secteur doit inclure ses propres détails de traitement des commandes. verticals ne peut être qu'un des éléments suivants : |
||
purchase |
Bons de commande (produits, nourriture, etc.) |
|
reservation |
Commandes pour réservation (restaurant, coupe de cheveux, etc.) |
PriceAttribute
Attribut prix d'une commande ou d'une ligne de commande.
Représentation JSON | |
---|---|
{ "type": enum ( |
Champs | ||
---|---|---|
type |
Obligatoire: type d'attribut monétaire. |
|
name |
Obligatoire: chaîne affichée par l'utilisateur pour l'attribut de prix. Cette information est envoyée et localisée par le marchand. |
|
id |
Facultatif: ID de la ligne à laquelle ce prix correspond. |
|
state |
Obligatoire : état du prix (estimation ou réel) |
|
taxIncluded |
Indique si le prix est TTC. |
|
Champ d'union spec . Représente la valeur monétaire ou le pourcentage en millisecondes. spec ne peut être qu'un des éléments suivants : |
||
amount |
Montant monétaire. |
|
amountMillipercentage |
Spécification de pourcentage, au 1/1 000e de pourcentage. Par exemple, 8,750% est représenté par 8 750, et les pourcentages négatifs représentent un pourcentage de remise. Abandon de ce champ. Vous pouvez envisager d'ajouter de nouveau l'outil lorsqu'un cas d'utilisation solide est requis. |
Type
Représente le type d'argent.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Le type n'est pas spécifié, les clients ne devraient pas avoir à le définir explicitement. |
REGULAR |
Prix standard à afficher avant l'application des éventuelles remises, etc. |
DISCOUNT |
À soustraire du sous-total. |
TAX |
À ajouter au sous-total. |
DELIVERY |
À ajouter au sous-total. |
SUBTOTAL |
Sous-total avant ajout de frais. |
FEE |
Frais supplémentaires. |
GRATUITY |
À ajouter au sous-total. |
TOTAL |
Prix de la commande ou de l'élément de campagne affiché. |
État
Représente l'état du prix.
Enums | |
---|---|
STATE_UNSPECIFIED |
Non spécifié. |
ESTIMATE |
Il ne s'agit que d'une estimation, mais le montant final se rapproche de ce montant. Exemple: dans les cas où la taxe n'est pas précisément connue au moment de la transaction, le montant total est de ESTIMATE. |
ACTUAL |
Prix réel qui sera facturé à l'utilisateur. |
Valeur monétaire
Représente un montant associé à un type de devise.
Représentation JSON | |
---|---|
{ "currencyCode": string, "amountInMicros": string } |
Champs | |
---|---|
currencyCode |
Code de devise à trois lettres défini par la norme ISO 4217. |
amountInMicros |
Montant en micros. Par exemple, ce champ doit être défini sur 1990000 pour 1,99 $. |
Action
Action de suivi associée à la campagne ou à l'élément de campagne.
Représentation JSON | |
---|---|
{ "type": enum ( |
Champs | |
---|---|
type |
Obligatoire: type d'action. |
title |
Titre ou libellé de l'action, présenté à l'utilisateur. La longueur maximale autorisée est de 100 caractères. |
openUrlAction |
Mesure à prendre. |
actionMetadata |
Métadonnées associées à une action. |
Type
Actions de suivi possibles
Enums | |
---|---|
TYPE_UNSPECIFIED |
Action non spécifiée. |
VIEW_DETAILS |
Afficher les détails de la commande |
MODIFY |
Modifier la commande |
CANCEL |
Action d'annulation de la commande. |
RETURN |
Action de retour de la commande. |
EXCHANGE |
Action pour la commande sur la place de marché. |
EMAIL |
Action sur l'e-mail. Les types EMAIL et CALL sont obsolètes. openUrlAction.url peut être utilisé comme numéro de téléphone ou comme adresse e-mail. |
CALL |
Action d'appel |
REORDER |
Action de réorganisation. |
REVIEW |
Vérifiez l'action de la commande. |
CUSTOMER_SERVICE |
Contactez le service client. |
FIX_ISSUE |
Redirigez les utilisateurs vers le site ou l'application du marchand pour résoudre le problème. |
DIRECTION |
Lien vers l'itinéraire. |
OpenUrlAction
Ouvre l'URL donnée.
Représentation JSON | |
---|---|
{ "url": string, "androidApp": { object ( |
Champs | |
---|---|
url |
Champ d'URL qui peut contenir l'un des éléments suivants: - URL http/https permettant d'ouvrir une application associée à une application ou une page Web |
androidApp |
Informations sur l'application Android si l'URL doit être traitée par une application Android. |
urlTypeHint |
Indique une indication pour le type d'URL. |
AndroidApp
Spécification de l'application Android pour les restrictions de traitement
Représentation JSON | |
---|---|
{
"packageName": string,
"versions": [
{
object ( |
Champs | |
---|---|
packageName |
Nom du package Le nom du package doit être spécifié lorsque vous spécifiez Android Fulfillment. |
versions[] |
Lorsque plusieurs filtres sont spécifiés, toute correspondance de filtre déclenche l'application. |
VersionFilter
Incluez un filtre de version si une ou plusieurs versions spécifiques de l'application sont requises.
Représentation JSON | |
---|---|
{ "minVersion": integer, "maxVersion": integer } |
Champs | |
---|---|
minVersion |
Code de version minimal ou 0 inclus. |
maxVersion |
Code de version maximal, inclus. La plage prise en compte est [minVersion:maxVersion]. Une plage nulle implique n'importe quelle version. Exemples : Pour ne spécifier qu'une seule version, indiquez [target_version:target_version]. Pour spécifier n'importe quelle version, ne spécifiez pas les valeurs minVersion et maxVersion. Pour spécifier toutes les versions jusqu'à maxVersion, ne spécifiez pas minVersion. Pour spécifier toutes les versions à partir de minVersion, ne spécifiez pas maxVersion. |
UrlTypeHint
Différents types d'indications d'URL.
Enums | |
---|---|
URL_TYPE_HINT_UNSPECIFIED |
Non spécifié |
AMP_CONTENT |
URL qui redirige directement vers le contenu AMP ou vers une URL canonique faisant référence à du contenu AMP via <link rel="amphtml">. |
ActionMetadata
Métadonnées associées par action.
Représentation JSON | |
---|---|
{ "expireTime": string } |
Champs | |
---|---|
expireTime |
Heure d'expiration de cette action. Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
Divulgation
Déclaration concernant un produit, un service ou un règlement susceptible d'être présentée à l'utilisateur.
Représentation JSON | |
---|---|
{ "title": string, "disclosureText": { object ( |
Champs | |
---|---|
title |
Titre du communiqué. Exemple : "Informations sur la sécurité". |
disclosureText |
Contenu du communiqué. Les liens Web sont autorisés. |
presentationOptions |
Options de présentation du communiqué. |
DisclosureText
Représente un texte brut avec des liens Web.
Représentation JSON | |
---|---|
{
"template": string,
"textLinks": [
{
object ( |
Champs | |
---|---|
template |
Texte à afficher, contenant des espaces réservés tels que "{0}" et "{1}" pour chaque lien textuel à insérer. Exemple : "AVERTISSEMENT: Ce produit peut vous exposer à des substances chimiques connues de l'État de Californie pour provoquer le cancer. Pour plus d'informations, accédez à {0}." Le texte de la mention ne doit pas comporter de contenu promotionnel ou de type publicitaire. |
textLinks[] |
Liens textuels à substituer dans le modèle. Le premier sera remplacé par "{0}". dans la chaîne du modèle et la seconde pour "{1}", etc. |
TextLink
Lien textuel qui doit être substitué dans le modèle.
Représentation JSON | |
---|---|
{ "displayText": string, "url": string } |
Champs | |
---|---|
displayText |
Texte devant être présenté aux utilisateurs. |
url |
URL vers laquelle rediriger les utilisateurs lorsque le lien est activé. |
DisclosurePresentationOptions
Options de présentation d'une déclaration.
Représentation JSON | |
---|---|
{
"presentationRequirement": enum ( |
Champs | |
---|---|
presentationRequirement |
Exigence de présentation de la divulgation. |
initiallyExpanded |
Indique si le contenu de la déclaration doit être développé initialement. Dans un premier temps, il est réduit par défaut. |
PresentationRequirement
Exigence concernant la présentation du communiqué.
Enums | |
---|---|
REQUIREMENT_UNSPECIFIED |
Exigence non spécifiée. Ne doit pas la définir explicitement. |
REQUIREMENT_OPTIONAL |
Cette divulgation est facultative. Elle peut être ignorée si l'appareil ne permet pas d'afficher les mentions légales. |
REQUIREMENT_REQUIRED |
La divulgation est obligatoire. Si l'appareil ne permet pas d'afficher des informations, la conversation est transmise au téléphone. |
PurchaseItemExtension
Contenu des lignes de commande du secteur "Achat".
Représentation JSON | |
---|---|
{ "status": enum ( |
Champs | |
---|---|
status |
Obligatoire: état au niveau de l'élément de campagne. |
userVisibleStatusLabel |
Obligatoire: étiquette/chaîne visible par l'utilisateur pour l'état. La longueur maximale autorisée est de 50 caractères. |
type |
Obligatoire: type d'achat. |
productId |
Identifiant du produit ou de l'offre associé à cette ligne. |
quantity |
Quantité de l'article. |
unitMeasure |
Unité de mesure. Indique la taille de l'article dans les unités choisies. La taille et le prix actif sont utilisés pour déterminer le prix unitaire. |
returnsInfo |
Renvoie les informations sur cette ligne. Si cette règle n'est pas configurée, cet élément de campagne hérite des informations sur les retours au niveau de la campagne. |
fulfillmentInfo |
Informations de traitement pour cet article. Si cette règle n'est pas configurée, cet élément de campagne hérite des informations de traitement au niveau de la commande. |
itemOptions[] |
Modules complémentaires ou sous-éléments supplémentaires. |
productDetails |
Informations sur le produit. |
extension |
Tout champ supplémentaire échangé entre le marchand et Google. Remarque: L'utilisation de cette extension est vivement déconseillée. En fonction du cas d'utilisation ou des circonstances, envisagez l'une des solutions suivantes: 1. Définissez les champs dans BuyItemExtension s'il peut être utilisé pour d'autres cas d'utilisation (par exemple, une capacité ou une fonctionnalité générique). 2. Utilisez vertical_extension s'il est spécifique à un cas d'utilisation ou à une fonctionnalité personnalisés et non génériques. Objet contenant des champs d'un type arbitraire. Un champ supplémentaire |
PurchaseStatus
État d'achat associé à un bon de commande ou à une ligne spécifique.
Enums | |
---|---|
PURCHASE_STATUS_UNSPECIFIED |
État non spécifié. |
READY_FOR_PICKUP |
Prêt pour le retrait. |
SHIPPED |
Expédiée. |
DELIVERED |
Distribué. |
OUT_OF_STOCK |
Non disponible. |
IN_PREPARATION |
"IN_PREPARATION" (EN_PREPARATION) peuvent avoir différentes significations dans différents contextes. Pour la commande FOOD, cela peut indiquer que le repas est en cours de préparation. Pour le commerce de détail, il peut s'agir d'un article en cours de conditionnement. |
CREATED |
La commande est créée. |
CONFIRMED |
Le marchand a confirmé la commande. |
REJECTED |
Le marchand a refusé la commande ou l'article. |
RETURNED |
L'article a été renvoyé par l'utilisateur. |
CANCELLED |
La commande ou l'élément de campagne a été annulé par l'utilisateur. |
CHANGE_REQUESTED |
L'utilisateur a demandé la modification de la commande. L'intégrateur est en train de la traiter. La commande doit passer à un autre état une fois la requête traitée. |
PurchaseType
Catégorie d'achat.
Enums | |
---|---|
PURCHASE_TYPE_UNSPECIFIED |
Valeur inconnue. |
RETAIL |
Cela inclut les achats de biens physiques. |
FOOD |
Cela inclut l'achat des commandes de repas. |
GROCERY |
Achat de produits alimentaires. |
MOBILE_RECHARGE |
Achat d'une recharge mobile prépayée. |
MerchantUnitMeasure
Mesure de prix unitaire du marchand.
Représentation JSON | |
---|---|
{
"measure": number,
"unit": enum ( |
Champs | |
---|---|
measure |
Valeur: exemple 1.2. |
unit |
Unité: exemple POUND, GRAM. |
Unité
Enums | |
---|---|
UNIT_UNSPECIFIED |
Unité non spécifiée. |
MILLIGRAM |
Milligramme. |
GRAM |
Gramme. |
KILOGRAM |
Kilogramme. |
OUNCE |
On ne s'arrête jamais ! |
POUND |
Livre. |
PurchaseReturnsInfo
Renvoie les informations associées à une campagne ou à une ligne spécifique.
Représentation JSON | |
---|---|
{ "isReturnable": boolean, "daysToReturn": integer, "policyUrl": string } |
Champs | |
---|---|
isReturnable |
Si la valeur est "true", le renvoi est autorisé. |
daysToReturn |
Le retour est autorisé pendant ce délai. |
policyUrl |
Lien vers les conditions de retour. |
PurchaseFulfillmentInfo
Informations de traitement associées à un bon de commande ou à une ligne spécifique.
Représentation JSON | |
---|---|
{ "id": string, "fulfillmentType": enum ( |
Champs | |
---|---|
id |
Identifiant unique de cette option de service. |
fulfillmentType |
Obligatoire: type de traitement. |
expectedFulfillmentTime |
Fenêtre si une période est spécifiée ou heure d'arrivée prévue si une seule heure est spécifiée. Heure de livraison ou de retrait prévue. |
expectedPreparationTime |
Fenêtre si une période est spécifiée ou heure d'arrivée prévue si une seule heure est spécifiée. Temps prévu pour préparer la nourriture. De préférence une seule fois. |
location |
Lieu de retrait ou de livraison. |
expireTime |
Heure d'expiration de cette option de traitement. Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
price |
Coût de cette option. |
fulfillmentContact |
Contact de l'utilisateur pour ce traitement. |
shippingMethodName |
Nom du mode de livraison sélectionné par l'utilisateur. |
storeCode |
StoreCode de l'établissement. Exemple: Walmart est le marchand et storeCode est le magasin Walmart où le traitement a eu lieu. https://support.google.com/business/answer/3370250?ref_topic=4596653. |
pickupInfo |
Informations supplémentaires sur le mode de retrait de la commande. Ce champ n'est applicable que lorsque le type de traitement est PICKUP. |
Type
Type de traitement.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Type non spécifié |
DELIVERY |
Cette commande sera livrée. |
PICKUP |
Cette commande doit être retirée. |
Heure
Construction temporelle représentant l'heure d'un événement à utiliser lors de l'affichage d'une commande auprès de l'utilisateur.
Représentation JSON | |
---|---|
{ "timeIso8601": string } |
Champs | |
---|---|
timeIso8601 |
Représente l'heure d'un événement de commande, telle que l'heure de réservation, l'heure de livraison, etc. Il peut s'agir d'une durée (heure de début et de fin), de la date, de la date et de l'heure, etc. Consultez la page https://en.wikipedia.org/wiki/ISO_8601 pour connaître tous les formats acceptés. |
PickupInfo
Détails sur la façon dont une commande est retirée. Il inclut des détails tels que le type de retrait en magasin et des métadonnées supplémentaires associées à chaque type, le cas échéant.
Représentation JSON | |
---|---|
{ "pickupType": enum ( |
Champs | |
---|---|
pickupType |
Méthode de retrait en magasin telle que INSTORE, CURBSIDE, etc. |
curbsideInfo |
Détails spécifiques aux informations liées au drive. Si pickupType n'est pas "CURBSIDE", ce champ sera ignoré. |
checkInInfo[] |
Liste des différentes méthodes acceptées par le partenaire pour l'enregistrement. |
PickupType
Liste des types de retrait acceptés.
Enums | |
---|---|
UNSPECIFIED |
Type de retrait non spécifié. |
INSTORE |
Aller chercher de la nourriture à l'intérieur du restaurant. |
CURBSIDE |
Garez le véhicule à un endroit désigné à l'extérieur du restaurant, où quelqu'un y livrerait de la nourriture. |
CurbsideInfo
Détails sur la façon dont les commandes au drive seraient facilitées.
Représentation JSON | |
---|---|
{ "curbsideFulfillmentType": enum ( |
Champs | |
---|---|
curbsideFulfillmentType |
Les partenaires ont besoin d'informations supplémentaires pour faciliter les commandes de drive. Selon le type de traitement choisi, les informations correspondantes sont recueillies auprès de l'utilisateur. |
userVehicle |
Informations sur le véhicule de l'utilisateur qui passe la commande. |
CurbsideFulfillmentType
Valeurs possibles pour les types de commandes Drive disponibles.
Enums | |
---|---|
UNSPECIFIED |
Type de traitement au drive non spécifié. |
VEHICLE_DETAIL |
Informations sur le véhicule requises pour faciliter le retrait au drive. |
Véhicule
Informations sur un véhicule
Représentation JSON | |
---|---|
{
"make": string,
"model": string,
"licensePlate": string,
"colorName": string,
"image": {
object ( |
Champs | |
---|---|
make |
Marque du véhicule (par exemple, "Honda"). Il est présenté à l'utilisateur et doit être localisé. Obligatoire. |
model |
Modèle du véhicule (par exemple, "Grom"). Il est présenté à l'utilisateur et doit être localisé. Obligatoire. |
licensePlate |
Numéro de plaque d'immatriculation (par exemple, "1ABC234"). Obligatoire. |
colorName |
Nom de la couleur du véhicule, par exemple noir Facultatif. |
image |
URL d'une photo du véhicule. La photo s'affiche au format 256 x 256 pixels environ. L'image doit être au format jpg ou png. Facultatif. |
CheckInInfo
Métadonnées requises par le partenaire pour proposer une méthode d'enregistrement.
Représentation JSON | |
---|---|
{
"checkInType": enum ( |
Champs | |
---|---|
checkInType |
Méthode utilisée pour envoyer les instructions d'enregistrement. |
CheckInType
Différentes méthodes utilisées pour envoyer des instructions d'enregistrement.
Enums | |
---|---|
CHECK_IN_TYPE_UNSPECIFIED |
Valeur inconnue. |
EMAIL |
Les informations d'enregistrement seront envoyées par e-mail. |
SMS |
Les informations d'enregistrement seront envoyées par SMS. |
ItemOption
Représente des modules complémentaires ou des sous-éléments.
Représentation JSON | |
---|---|
{ "id": string, "name": string, "prices": [ { object ( |
Champs | |
---|---|
id |
Pour les options qui sont des articles : code d'article unique. |
name |
Nom de l'option. |
prices[] |
Prix total de l'option. |
note |
Remarque concernant l'option. |
quantity |
Pour les options qui sont des articles, quantité. |
productId |
Identifiant du produit ou de l'offre associé à cette option. |
subOptions[] |
Pour définir d'autres sous-options imbriquées. |
ProductDetails
Informations sur le produit.
Représentation JSON | |
---|---|
{ "productId": string, "gtin": string, "plu": string, "productType": string, "productAttributes": { string: string, ... } } |
Champs | |
---|---|
productId |
Identifiant du produit ou de l'offre associé à cette ligne. |
gtin |
Code article international (GTIN) du produit. Cette valeur est utile si l'identifiant "offerId" n'est pas présent dans Merchant Center. Facultatif. |
plu |
Les codes de consultation des prix, communément appelés codes PLU, numéros PLU, PLU, codes de produits frais ou étiquettes de produits, sont un système de nombres qui identifient de manière unique les produits frais vendus en gros dans les épiceries et les supermarchés. |
productType |
Catégorie du produit définie par le marchand. Exemple : Accueil > Courses > Produits laitiers et Œufs > Lait > Lait entier" |
productAttributes |
Informations sur le produit fournies par le marchand (par exemple, { "allergen": "peanut" }. Cette valeur est utile si l'identifiant "offerId" n'est pas présent dans Merchant Center. Facultatif. Objet contenant une liste de paires |
ReservationItemExtension
Contenu des lignes de commande pour les ordres de réservation tels que "restaurant", "coiffeur", etc.
Représentation JSON | |
---|---|
{ "status": enum ( |
Champs | |
---|---|
status |
Obligatoire: état de la réservation. |
userVisibleStatusLabel |
Obligatoire: étiquette/chaîne visible par l'utilisateur pour l'état. La longueur maximale autorisée est de 50 caractères. |
type |
Type de réservation. Peut être désactivé si aucune des options de type ne s'applique. |
reservationTime |
Heure à laquelle le service ou l'événement est planifié. Il peut s'agir d'une période, d'une date ou d'une date/heure exacte. |
userAcceptableTimeRange |
Période acceptable pour l'utilisateur. |
confirmationCode |
Code de confirmation de cette réservation. |
partySize |
Nombre de personnes. |
staffFacilitators[] |
Des animateurs du personnel qui s'occuperont de la réservation. Ex. : Le coiffeur. |
location |
Lieu du service/de l'événement. |
ReservationStatus
État de la réservation.
Enums | |
---|---|
RESERVATION_STATUS_UNSPECIFIED |
État non spécifié. |
PENDING |
La réservation est en attente. |
CONFIRMED |
La réservation est confirmée. |
CANCELLED |
La réservation est annulée par l'utilisateur. |
FULFILLED |
La réservation est effectuée. |
CHANGE_REQUESTED |
Le changement de réservation est demandé |
REJECTED |
La réservation a expiré ou a été refusée par l'intégrateur. |
ReservationType
Type de réservation.
Enums | |
---|---|
RESERVATION_TYPE_UNSPECIFIED |
Type non spécifié. |
RESTAURANT |
Réservation au restaurant. |
HAIRDRESSER |
Réservation chez le coiffeur. |
StaffFacilitator
Informations sur le membre des forces armées.
Représentation JSON | |
---|---|
{
"name": string,
"image": {
object ( |
Champs | |
---|---|
name |
Nom de l'animateur du personnel. Ex. : "Jean Dupont" |
image |
Images de l'artiste. |
PaymentData
Données de paiement liées à une commande.
Représentation JSON | |
---|---|
{ "paymentResult": { object ( |
Champs | |
---|---|
paymentResult |
Résultat du paiement utilisé par l'intégrateur pour finaliser une transaction. Ce champ sera renseigné par Actions on Google si l'expérience de paiement est gérée par Actions-on-Google. |
paymentInfo |
Informations de paiement concernant la commande, permettant une interaction directe avec l'utilisateur. |
PaymentResult
Résultat du paiement utilisé par l'intégrateur pour finaliser une transaction.
Représentation JSON | |
---|---|
{ // Union field |
Champs | ||
---|---|---|
Champ d'union result . Les données de paiement Google ou le mode de paiement du marchand sont fournis. result ne peut être qu'un des éléments suivants : |
||
googlePaymentData |
Google a fourni les données du mode de paiement. Si votre société de traitement des paiements est répertoriée comme société de traitement des paiements acceptée par Google: https://developers.google.com/pay/api/, cliquez sur le lien afin d'obtenir plus d'informations. Sinon, reportez-vous à la documentation suivante pour en savoir plus sur la charge utile. https://developers.google.com/pay/api/payment-data-cryptography |
|
merchantPaymentMethodId |
Mode de paiement fourni par le marchand/l'action, choisi par l'utilisateur. |
PaymentInfo
Informations de paiement concernant la commande en cours de réalisation. Ce proto capture des informations utiles pour les interactions avec l'utilisateur.
Représentation JSON | |
---|---|
{ "paymentMethodDisplayInfo": { object ( |
Champs | |
---|---|
paymentMethodDisplayInfo |
Informations à afficher sur le mode de paiement utilisé pour la transaction. |
paymentMethodProvenance |
Provenance du mode de paiement utilisé pour la transaction. Il est possible que l'utilisateur ait enregistré le même mode de paiement auprès de Google et du marchand. |
PaymentMethodDisplayInfo
Résultat du paiement utilisé par l'intégrateur pour finaliser une transaction.
Représentation JSON | |
---|---|
{
"paymentType": enum ( |
Champs | |
---|---|
paymentType |
Type de paiement. |
paymentMethodDisplayName |
Nom visible de l'utilisateur pour le mode de paiement. Par exemple, VISA **** 1234 Compte courant **** 5678 |
paymentMethodVoiceName |
Nom du mode de paiement à énoncer à voix haute à l'utilisateur pour les appareils dotés de l'Assistant vocal. Par exemple, "visa se terminant par un deux trois quatre" ou "compte courant se terminant par cinq six sept huit". Remarque: Il s'agit de la chaîne à optimisation vocale à utiliser à la place de paymentMethodDisplayName pour les appareils dotés d'un assistant vocal uniquement. Si cette chaîne n'est pas définie, l'utilisateur reçoit la valeur paymentMethodDisplayName. |
PaymentType
PaymentType indique le mode de paiement utilisé pour le mode de paiement fourni par le marchand. L'action doit également fournir un nom à afficher pour le mode de paiement.
Enums | |
---|---|
PAYMENT_TYPE_UNSPECIFIED |
Type de paiement non spécifié. |
PAYMENT_CARD |
Une carte de crédit/débit ou une carte prépayée. |
BANK |
Le mode de paiement est un compte bancaire. |
LOYALTY_PROGRAM |
Le mode de paiement est un programme de fidélité. |
CASH |
Le mode de paiement est en espèces. |
GIFT_CARD |
Le mode de paiement est une carte cadeau. |
WALLET |
Portefeuille tiers (Paypal, par exemple) |
PaymentMethodProvenance
Représente la provenance du mode de paiement utilisé pour la transaction.
Enums | |
---|---|
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED |
La provenance n'est pas spécifiée. |
PAYMENT_METHOD_PROVENANCE_GOOGLE |
La provenance est Google. |
PAYMENT_METHOD_PROVENANCE_MERCHANT |
La provenance est un marchand. |
Promotion
Promotions/offres ajoutées au panier.
Représentation JSON | |
---|---|
{ "coupon": string } |
Champs | |
---|---|
coupon |
Obligatoire: code promotionnel appliqué à cette offre. |
PurchaseOrderExtension
Extension de commande pour le secteur des achats. Ces propriétés s'appliquent à tous les éléments de ligne dans l'ordre, sauf si elles sont remplacées dans un élément de ligne.
Représentation JSON | |
---|---|
{ "status": enum ( |
Champs | |
---|---|
status |
Obligatoire: état général de la commande. |
userVisibleStatusLabel |
Libellé/Chaîne visible par l'utilisateur de l'état. La longueur maximale autorisée est de 50 caractères. |
type |
Obligatoire: type d'achat. |
returnsInfo |
Informations de retour pour la commande. |
fulfillmentInfo |
Informations de traitement de la commande. |
purchaseLocationType |
Lieu de l'achat (en magasin / en ligne) |
errors[] |
Facultatif: erreurs entraînant le refus de cette commande. |
extension |
Tout champ supplémentaire échangé entre le marchand et Google. Remarque: L'utilisation de cette extension est vivement déconseillée. En fonction du cas d'utilisation ou des circonstances, envisagez l'une des solutions suivantes: 1. Définissez les champs dans BuyOrderExtension s'il peut être utilisé pour d'autres cas d'utilisation (par exemple, une capacité ou une fonctionnalité générique). 2. Utilisez vertical_extension s'il est spécifique à un cas d'utilisation ou à une fonctionnalité personnalisés et non génériques. Objet contenant des champs d'un type arbitraire. Un champ supplémentaire |
PurchaseLocationType
Type de lieu de l'achat.
Enums | |
---|---|
UNSPECIFIED_LOCATION |
Valeur inconnue. |
ONLINE_PURCHASE |
Tous les achats effectués en ligne. |
INSTORE_PURCHASE |
Tous les achats en magasin. |
PurchaseError
Erreurs pour lesquelles un bon de commande peut être refusé.
Représentation JSON | |
---|---|
{ "type": enum ( |
Champs | |
---|---|
type |
Obligatoire: explique précisément pourquoi une commande est refusée par le marchand. |
description |
Description supplémentaire de l'erreur. |
entityId |
ID d'entité correspondant à l'erreur. Exemple : cela peut correspondre à LineItemId / ItemOptionId. |
updatedPrice |
Pertinent si le type d'erreur est de PRICE_CHANGED / INCORRECT_PRICE. |
availableQuantity |
Quantité disponible. Applicable en cas de AVAILABILITY_CHANGED. |
ErrorType
Types d'erreurs possibles.
Enums | |
---|---|
ERROR_TYPE_UNSPECIFIED |
Erreur inconnue |
NOT_FOUND |
L'entité est introuvable. Il pourrait s'agir d'un article, d'un FulfillmentOption ou d'une promotion. Veuillez indiquer un ID d'entité. |
INVALID |
Données d'entité non valides. pourrait être Item, FulfillmentOption, Promotion. Veuillez indiquer un ID d'entité. |
AVAILABILITY_CHANGED |
Article indisponible ou insuffisant pour répondre à la demande. Veuillez indiquer un ID d'entité. |
PRICE_CHANGED |
Prix de l'article différent du prix indiqué dans l'entité "Article". L'ID d'entité et le prix mis à jour sont obligatoires. |
INCORRECT_PRICE |
Erreurs de prix dans les Frais, Total. L'ID d'entité et le prix mis à jour sont obligatoires. |
REQUIREMENTS_NOT_MET |
Contraintes d'acceptation de la commande non respectées - taille minimale du panier, etc. |
TOO_LATE |
FulfillmentOption expiré. |
NO_CAPACITY |
Aucune capacité de service disponible. Utilisez ce code d'erreur si aucun des types d'erreurs plus précis ne s'applique. |
NO_COURIER_AVAILABLE |
Aucun coursier n'a été trouvé. Type d'erreur précis pouvant être classé dans la catégorie NO_CAPACITY. |
INELIGIBLE |
Utilisateur inéligible à la commande (ajouté à la liste noire). |
OUT_OF_SERVICE_AREA |
Impossible de livrer à l'adresse demandée en raison de règles aux frontières, etc. |
CLOSED |
Le restaurant est fermé au moment de la commande. |
PROMO_NOT_APPLICABLE |
Code d'erreur générique permettant de détecter tous les cas d'échec d'application du code promotionnel, si aucun des cas ci-dessous ne convient. Ajoutez un code promotionnel en tant qu'ID d'entité. |
PROMO_NOT_RECOGNIZED |
Le partenaire n'a pas reconnu le code promotionnel. Ajoutez un code promotionnel en tant qu'ID d'entité. |
PROMO_EXPIRED |
Impossible d'appliquer la promotion, car elle a expiré. Ajoutez un code promotionnel en tant qu'ID d'entité. |
PROMO_USER_INELIGIBLE |
L'utilisateur actuel ne peut pas bénéficier de ce bon de réduction. Ajoutez un code promotionnel en tant qu'ID d'entité. |
PROMO_ORDER_INELIGIBLE |
La commande en cours ne permet pas d'utiliser ce bon de réduction. Ajoutez un code promotionnel en tant qu'ID d'entité. |
UNAVAILABLE_SLOT |
Le créneau pour commander à l'avance n'est pas disponible. |
FAILED_PRECONDITION |
Contraintes d'acceptation de la commande non respectées - taille minimale du panier, etc. |
PAYMENT_DECLINED |
Paiement non valide. |
MERCHANT_UNREACHABLE |
Le marchand n'est pas joignable. Cela peut être utile lorsqu'un partenaire est un agrégateur et qu'il ne parvient pas à contacter le marchand. |
ACCOUNT_LINKING_FAILED |
Le marchand a essayé d'associer le compte Google de l'utilisateur à un compte de son système, mais une erreur s'est produite. |
TicketOrderExtension
Ordonnez le contenu des billets (films, sports, etc.).
Représentation JSON | |
---|---|
{
"ticketEvent": {
object ( |
Champs | |
---|---|
ticketEvent |
Événement appliqué à tous les tickets d'éléments de campagne. |
TicketEvent
Représente un seul événement.
Représentation JSON | |
---|---|
{ "type": enum ( |
Champs | |
---|---|
type |
Obligatoire: type de billet (par exemple, film, concert. |
name |
Obligatoire: nom de l'événement. Par exemple, s'il s'agit d'un film, il doit s'agir du nom du film. |
description |
Description de l'événement. |
url |
URL des informations sur l'événement. |
location |
Lieu où se déroule l'événement ou où se trouve une organisation. |
eventCharacters[] |
Personnages associés à cet événement. Il peut s'agir de réalisateurs ou d'acteurs d'un film, d'artistes de concert, etc. |
startDate |
Heure de début |
endDate |
Heure de fin |
doorTime |
Heure d'entrée, qui peut être différente de l'heure de début de l'événement. Ex. : l'événement commence à 9h, mais l'heure d'entrée est 8h30. |
Type
Le type d'événement.
Enums | |
---|---|
EVENT_TYPE_UNKNOWN |
Type d'événement inconnu. |
MOVIE |
Film. |
CONCERT |
Concert. |
SPORTS |
Sports. |
EventCharacter
Un caractère d'événement, par exemple organisateur, artiste, etc.
Représentation JSON | |
---|---|
{ "type": enum ( |
Champs | |
---|---|
type |
Type du caractère de l'événement (par exemple, un acteur ou un réalisateur. |
name |
Nom du personnage. |
image |
Images du personnage. |
Type
Type de caractère.
Enums | |
---|---|
TYPE_UNKNOWN |
Type inconnu. |
ACTOR |
Acteur. |
PERFORMER |
L'artiste. |
DIRECTOR |
Un réalisateur. |
ORGANIZER |
Organisateur. |
UserNotification
Notification utilisateur facultative à afficher dans le cadre de la mise à jour de la commande.
Représentation JSON | |
---|---|
{ "title": string, "text": string } |
Champs | |
---|---|
title |
Titre de la notification utilisateur. La longueur maximale autorisée est de 30 caractères. |
text |
Contenu de la notification. La longueur maximale autorisée est de 100 caractères. |
NextScene
Représente la scène à exécuter ensuite.
Représentation JSON | |
---|---|
{ "name": string } |
Champs | |
---|---|
name |
Nom de la scène à exécuter ensuite. |
Session
Contient des informations sur la session de conversation en cours
Représentation JSON | |
---|---|
{
"id": string,
"params": {
string: value,
...
},
"typeOverrides": [
{
object ( |
Champs | |
---|---|
id |
Obligatoire. ID unique global de la session de conversation en cours. Ce champ est en lecture seule. |
params |
Obligatoire. Liste de tous les paramètres collectés à partir des formulaires et des intents pendant la session. La clé correspond au nom du paramètre. Les paramètres définis ici seront fusionnés avec ceux déjà définis dans la session. Les paramètres ayant une valeur nulle sont supprimés de la session. Consultez la documentation sur le stockage de session: https://developers.google.com/assistant/conversational/storage-session. Objet contenant une liste de paires |
typeOverrides[] |
Facultatif. Types limités à la session. Les définitions de type de session peuvent compléter ou remplacer les types existants. Les noms de type doivent être uniques. |
languageCode |
Langue de la session de conversation en cours. Suit le code de langue IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt. Elle peut être différente des paramètres régionaux de l'utilisateur si l'action utilise des fonctionnalités multilingues. Par exemple, lorsque handler_response.expected.language_code est défini, la langue de la conversation est modifiée pour tous les tours suivants, ce qui se reflète dans ce champ. |
TypeOverride
Représente un forçage pour un type.
Représentation JSON | |
---|---|
{ "name": string, "mode": enum ( |
Champs | |
---|---|
name |
Obligatoire. Nom du type à compléter ou à remplacer. |
mode |
Obligatoire. Mode de fusion de ce type avec d'autres valeurs de type. |
synonym |
|
TypeOverrideMode
Types de modifications d'un type d'entité de session.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Non spécifié. Cette valeur ne doit jamais être utilisée. |
TYPE_REPLACE |
Les définitions de type figurant dans cette réponse remplaceront celles qui ont été définies précédemment. |
TYPE_MERGE |
Les définitions de type de cette réponse seront fusionnées avec les définitions de type définies précédemment. Les nouvelles définitions de type remplaceront les définitions de type existantes. |
SynonymType
Représente un type avec des synonymes.
Représentation JSON | |
---|---|
{
"entries": [
{
object ( |
Champs | |
---|---|
entries[] |
Obligatoire. Liste des entrées pour le type de synonymes. |
Entrée
Représente une entrée pour un type de synonyme.
Représentation JSON | |
---|---|
{
"name": string,
"synonyms": [
string
],
"display": {
object ( |
Champs | |
---|---|
name |
Obligatoire. Nom de l'entrée (par exemple, "vélo"). L'entrée dans ce champ doit être incluse dans le champ des synonymes répétés pour être reconnue comme une valeur de type valide. |
synonyms[] |
Obligatoire. Liste de synonymes de l'entrée (par exemple, "vélo", "cycle"). |
display |
Facultatif. Informations sur l'élément affiché. |
EntryDisplay
Représentation JSON | |
---|---|
{ "title": string, "description": string, "image": { object ( |
Champs | |
---|---|
title |
Obligatoire. Titre de l'article. Lorsque l'utilisateur appuiera sur ce texte, il sera publié tel quel dans la conversation, comme si l'utilisateur l'avait saisi. Chaque titre doit être unique parmi les éléments de la collection. |
description |
Facultatif. Corps du texte de la carte. |
image |
Facultatif. Image à afficher. |
footer |
Facultatif. Texte de pied de page de l'élément de la collection de navigation, affiché sous la description. Une seule ligne de texte, tronquée par des points de suspension. |
openUrl |
URL du document associé à la navigation dans l'élément du carrousel. Obligatoire pour parcourir le carrousel. |
Utilisateur
Représente l'utilisateur qui envoie une requête à l'action.
Représentation JSON | |
---|---|
{ "locale": string, "params": { string: value, ... }, "accountLinkingStatus": enum ( |
Champs | |
---|---|
locale |
Paramètre régional principal de l'utilisateur à l'origine de la requête. Suit le code de langue IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt. Toutefois, le sous-tag de script n'est pas inclus. |
params |
Facultatif. Liste de tous les paramètres associés à l'utilisateur actuel. Consultez la documentation sur le stockage utilisateur: https://developers.google.com/assistant/conversational/storage-user. Objet contenant une liste de paires |
accountLinkingStatus |
Indique si le compte utilisateur est associé à l'application. |
verificationStatus |
Indique l'état de validation de l'utilisateur. |
lastSeenTime |
Code temporel de la dernière interaction avec cet utilisateur. Ce champ sera omis si l'utilisateur n'a jamais interagi avec l'agent auparavant. Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
engagement |
Engagement de l'utilisateur actuel, y compris tout abonnement à des intents. |
packageEntitlements[] |
Droits d'accès de l'utilisateur liés au package Android associé à l'action en cours. |
permissions[] |
Contient les autorisations accordées par l'utilisateur à cette action. |
AccountLinkingStatus
Indique si l'utilisateur final a associé son compte à cette application. Consultez la documentation sur l'association de comptes: https://developers.google.com/assistant/identity.
Enums | |
---|---|
ACCOUNT_LINKING_STATUS_UNSPECIFIED |
Inconnu. |
NOT_LINKED |
L'utilisateur n'a pas associé son compte à cette application. |
LINKED |
L'utilisateur a associé son compte à cette application. |
UserVerificationStatus
Indique si Google a validé l'utilisateur. L'état VALIDÉ indique que vous pouvez enregistrer des données dans les conversations à l'aide du champ "params" ou de l'association de comptes.
Enums | |
---|---|
USER_VERIFICATION_STATUS_UNSPECIFIED |
Inconnu. |
GUEST |
Utilisateur invité. |
VERIFIED |
Utilisateur validé. |
Engagement
Fournit des informations supplémentaires en lecture seule sur les mécanismes d'engagement auxquels l'utilisateur actuel s'est inscrit. Par exemple, il peut être utile de connaître les intents auxquels l'utilisateur est déjà abonné afin d'éviter de lui demander de s'abonner à nouveau au même intent. Par exemple, ces informations peuvent être utilisées pour acheminer de manière conditionnelle vers une scène afin de configurer des DailyUpdates ou des notifications push, uniquement si l'utilisateur ne s'est pas encore abonné. Consultez la documentation sur l'engagement utilisateur: https://developers.google.com/assistant/engagement.
Représentation JSON | |
---|---|
{ "pushNotificationIntents": [ { object ( |
Champs | |
---|---|
pushNotificationIntents[] |
Contient une liste des intents pour lesquels l'utilisateur a activé les notifications push. |
dailyUpdateIntents[] |
Contient une liste des intents pour lesquels l'utilisateur a activé la mise à jour quotidienne. |
IntentSubscription
Décrit un IntentSubscription existant.
Représentation JSON | |
---|---|
{ "intent": string, "contentTitle": string } |
Champs | |
---|---|
intent |
Nom de l'intent auquel vous êtes abonné. |
contentTitle |
Brève description de l'abonnement. Il est utilisé comme libellé de notification et lorsque l'Assistant demande l'autorisation de l'utilisateur. |
PackageEntitlements
Liste des droits d'accès de l'utilisateur liés à un nom de package. Consultez la documentation sur les transactions de biens numériques: https://developers.google.com/assistant/transactions/digital/dev-guide-digital-non-consumables.
Représentation JSON | |
---|---|
{
"packageName": string,
"entitlements": [
{
object ( |
Champs | |
---|---|
packageName |
Nom du package Android spécifié dans le package d'actions. |
entitlements[] |
Droits d'accès de l'utilisateur pour le package donné. |
Droit d'accès
Définit les droits d'accès numériques d'un utilisateur.
Représentation JSON | |
---|---|
{ "sku": string, "skuType": enum ( |
Champs | |
---|---|
sku |
SKU du produit Nom du package de l'application payante, suffixe de Finsky Docid pour les achats et les abonnements via l'application. Mise en correspondance de getSku() dans l'API Play InApp Billing. Consultez la documentation sur la facturation des achats in-app dans Google Play: https://developer.android.com/google/play/billing. |
skuType |
Type de SKU. |
inAppDetails |
Présent uniquement pour les achats via l'application et les abonnements via l'application. |
SkuType
Enums | |
---|---|
SKU_TYPE_UNSPECIFIED |
|
IN_APP |
Achat via l'application |
SUBSCRIPTION |
Abonnements |
APP |
Les applications payantes |
SignedData
Représentation JSON | |
---|---|
{ "inAppPurchaseData": { object }, "inAppDataSignature": string } |
Champs | |
---|---|
inAppPurchaseData |
Contient toutes les données d'achat via une application au format JSON. Pour en savoir plus, consultez le tableau 6 de la page https://developer.android.com/google/play/billing/billing_reference.html. |
inAppDataSignature |
Correspond à IN_APP_DATA_SIGNATURE de la méthode getPurchases() de l'API Play InApp Billing. |
Autorisation
Valeurs possibles pour l'autorisation.
Enums | |
---|---|
PERMISSION_UNSPECIFIED |
Autorisation non spécifiée. |
DEVICE_PRECISE_LOCATION |
Demandez à l'utilisateur sa position exacte, ses coordonnées (latitude/longitude) et son adresse formatée. |
DEVICE_COARSE_LOCATION |
Demandez à l'utilisateur la position approximative, le code postal, la ville et l'indicatif du pays de l'utilisateur. |
UPDATE |
Demandez l'autorisation d'envoyer des mises à jour. Consultez la page https://developers.google.com/assistant/engagement/daily. |
Accueil
Représente la structure HomeGraph à laquelle appartient l'appareil cible de l'utilisateur.
Représentation JSON | |
---|---|
{ "params": { string: value, ... } } |
Champs | |
---|---|
params |
Facultatif. Liste des paramètres associés à la structure HomeGraph à laquelle appartient l'appareil cible. Consultez la documentation sur le stockage de la maison: https://developers.google.com/assistant/conversational/storage-home. Objet contenant une liste de paires |
Appareil
Représente l'appareil utilisé par l'utilisateur pour envoyer une requête à l'action.
Représentation JSON | |
---|---|
{ "capabilities": [ enum ( |
Champs | |
---|---|
capabilities[] |
Obligatoire. les capacités de l'appareil qui envoie une demande à l'action. |
currentLocation |
Facultatif. Position de l'appareil de l'utilisateur. Notez que ces informations ne sont renseignées qu'une fois que l'utilisateur final a accordé l'autorisation d'accéder à la position. Consultez le message d'emplacement pour en savoir plus sur les champs définis en fonction d'une autorisation approximative ou précise. Consultez la documentation sur les autorisations: https://developers.google.com/assistant/conversational/permissions. |
timeZone |
Facultatif. Fuseau horaire associé à l'appareil client. Elle peut être utilisée pour résoudre les valeurs de date et d'heure. |
Capacité
Fonctionnalités compatibles avec la surface de l'appareil au moment de la requête.
Enums | |
---|---|
UNSPECIFIED |
Capacité de l'appareil non spécifiée. |
SPEECH |
L'appareil peut communiquer avec l'utilisateur via la synthèse vocale ou SSML. |
RICH_RESPONSE |
L'appareil peut afficher des réponses enrichies, comme des fiches, des listes et des tableaux. |
LONG_FORM_AUDIO |
L'appareil peut lire des contenus multimédias audio longs comme de la musique et des podcasts. |
INTERACTIVE_CANVAS |
L'appareil peut afficher une réponse de canevas interactive. |
WEB_LINK |
L'appareil peut utiliser des liens Web dans les réponses enrichies pour ouvrir un navigateur Web. |
HOME_STORAGE |
L'appareil permet d'enregistrer et de récupérer l'espace de stockage de la maison. |
Lieu
Conteneur qui représente un emplacement.
Représentation JSON | |
---|---|
{ "coordinates": { object ( |
Champs | |
---|---|
coordinates |
Coordonnées géographiques Nécessite l'autorisation [DEVICE_PRECISE_LOCATION]. |
postalAddress |
Adresse postale. Nécessite l'autorisation [DEVICE_PRECISE_LOCATION] ou [DEVICE_COARSE_LOCATION]. Lorsque l'autorisation d'accéder à la position approximative est accordée, seul le code postal et "Localité" les champs doivent être renseignés. L'autorisation d'accéder à la position exacte remplira d'autres champs, comme "administrativeArea". et "addressLines". |
TimeZone
Représente un fuseau horaire de la base de données des fuseaux horaires IANA.
Représentation JSON | |
---|---|
{ "id": string, "version": string } |
Champs | |
---|---|
id |
Fuseau horaire de la base de données des fuseaux horaires IANA, par exemple "America/New_York". |
version |
Facultatif. Numéro de version de la base de données des fuseaux horaires IANA, par exemple "2019a". |
Contexte
Contient des informations contextuelles lorsque l'utilisateur effectue une requête. Ce contexte inclut, sans s'y limiter, les informations sur la session multimédia active, l'état de l'application Web de canevas, etc.
Représentation JSON | |
---|---|
{ "media": { object ( |
Champs | |
---|---|
media |
Contient des informations contextuelles sur la session multimédia active en cours. |
canvas |
Contient des informations contextuelles sur le canevas actuel. |
MediaContext
Contient des informations contextuelles sur la session multimédia active en cours.
Représentation JSON | |
---|---|
{ "progress": string, "index": integer } |
Champs | |
---|---|
progress |
Progression du fichier multimédia actif en cours. Durée en secondes avec neuf chiffres au maximum après la virgule. Se termine par " |
index |
Index basé sur 0 du fichier multimédia actif dans la liste des fichiers multimédias de la réponse multimédia. |
CanvasContext
Contient des informations contextuelles sur le canevas actuel.
Représentation JSON | |
---|---|
{ "state": value } |
Champs | |
---|---|
state |
Facultatif. État défini par l'application tierce Interactive Canvas. Il n'est défini que pour la requête, pas pour la réponse. Par exemple, s'il s'agit d'une application de recettes, l'état peut être une valeur de struct : { "current_page" : 5, "last_page" : 3, } La taille ne doit pas dépasser 50 Ko. |
Heure attendue
Décrit les attentes pour le prochain tour de dialogue.
Représentation JSON | |
---|---|
{ "speech": [ string ] } |
Champs | |
---|---|
speech[] |
Liste des expressions que l'action attend de l'énoncé de l'utilisateur pour la pondération de la parole. Jusqu'à 1 000 expressions sont autorisées. Remarque: Ce champ a la même signification que ExpectInput.speech_biasing_hints dans la version 2 de l'API. |