- Représentation JSON
- ExpectedInput
- InputPrompt
- SpeechResponse
- RichResponse
- Élément
- SimpleResponse
- BasicCard
- Bouton
- StructuredResponse
- OrderUpdate
- Action
- Reçu
- RejectionInfo
- CancellationInfo (Informations d'annulation)
- InTransitInfo
- FulfillmentInfo
- ReturnInfo
- UserNotification
- MediaResponse
- MediaObject
- CarouselBrowse
- Élément
- TableCard
- ColumnProperties
- Ligne
- Cellule
- HtmlResponse
- Suggestion
- LinkOutSuggestion
- ExpectedIntent
- FinalResponse
- CustomPushMessage
- UserNotification
- Cible
"AppResponse" est la réponse envoyée par le fulfillment à l'Assistant Google. Pour voir comment cela est utilisé dans Actions on Google, consultez la page https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json#conversation-response-body.
Représentation JSON | |
---|---|
{ "conversationToken": string, "userStorage": string, "resetUserStorage": boolean, "expectUserResponse": boolean, "expectedInputs": [ { object ( |
Champs | |
---|---|
conversationToken |
Jeton opaque remis à l'action à chaque tour de conversation. |
userStorage |
Jeton opaque contrôlé par l'action qui est conservé dans toutes les conversations d'un utilisateur particulier. Si ce champ n'est pas spécifié, le jeton persistant existant n'est pas modifié. La taille maximale de la chaîne est de 10 000 octets. Si plusieurs boîtes de dialogue s'affichent simultanément pour un même utilisateur, les mises à jour de ce jeton peuvent s'écraser de manière inattendue. |
resetUserStorage |
Indique s'il faut effacer l'espace de stockage persistant userStorage. Si cette valeur est définie sur "true", le champ "userStorage" sera vide lors de la prochaine interaction avec l'utilisateur. |
expectUserResponse |
Indique si l'action attend une réponse de l'utilisateur. Cela est vrai lorsque la conversation est en cours et "false" lorsqu'elle est terminée. |
expectedInputs[] |
Liste des entrées attendues par l'action. Chaque entrée peut être une action courante sur un intent Google (commençant par "actions.") ou une entrée acceptant une liste d'intents possibles. Une seule entrée est acceptée pour le moment. |
finalResponse |
Réponse finale lorsque l'action ne nécessite pas d'entrée utilisateur. |
customPushMessage |
Message push personnalisé qui permet aux développeurs d'envoyer des données structurées à des actions sur Google. |
isInSandbox |
Indique si la réponse doit être gérée en mode bac à sable. Ce bit est nécessaire pour envoyer les données structurées à Google en mode bac à sable. |
ExpectedInput
Représentation JSON | |
---|---|
{ "inputPrompt": { object ( |
Champs | |
---|---|
inputPrompt |
Invite personnalisée utilisée pour demander une saisie à l'utilisateur. |
possibleIntents[] |
Liste d'intents pouvant être utilisés pour traiter cette entrée. Pour que les actions sur Google ne renvoient que l'entrée utilisateur brute, l'application doit demander l'intent |
speechBiasingHints[] |
Liste des expressions que l'action souhaite que Google utilise pour la pondération de la voix. Vous pouvez ajouter jusqu'à 1 000 expressions. |
InputPrompt
Invite de saisie utilisée par l'assistant pour guider l'utilisateur afin qu'il saisisse une entrée pour la question dans l'application.
Représentation JSON | |
---|---|
{ "initialPrompts": [ { object ( |
Champs | |
---|---|
initialPrompts[] |
Invites initiales demandant à l'utilisateur de fournir une entrée. Un seul élément initial_prompt est pris en charge. |
richInitialPrompt |
Charge utile de l'invite. |
noInputPrompts[] |
Invite utilisée pour demander à l'utilisateur s'il n'y a aucune entrée de sa part. |
SpeechResponse
Réponse ne contenant que des paroles. OBSOLÈTE.
Représentation JSON | |
---|---|
{ // Union field |
Champs | ||
---|---|---|
Champ d'union type . Types de sortie vocale: synthèse vocale ou SSML. type ne peut être qu'un des éléments suivants : |
||
textToSpeech |
Texte brut de la sortie vocale, par exemple : "Où voulez-vous aller ?"/ |
|
ssml |
Réponse orale structurée à l'utilisateur au format SSML, par exemple " |
RichResponse
Réponse enrichie pouvant inclure du contenu audio, du texte, des fiches, des suggestions et des données structurées.
Représentation JSON | |
---|---|
{ "items": [ { object ( |
Champs | |
---|---|
items[] |
Une liste des éléments d'interface utilisateur qui composent la réponse. Ces éléments doivent répondre aux exigences suivantes: 1. Le premier élément doit être un |
suggestions[] |
Une liste de réponses suggérées Ceux-ci apparaîtront toujours à la fin de la réponse. Si elles sont utilisées dans un |
linkOutSuggestion |
Un chip de suggestion supplémentaire qui peut rediriger vers l'application ou le site associés. |
Article
Éléments de la réponse.
Représentation JSON | |
---|---|
{ "name": string, // Union field |
Champs | ||
---|---|---|
name |
Identifiant facultatif nommé de cet article. |
|
Champ d'union item . Type d'article. item ne peut être qu'un des éléments suivants : |
||
simpleResponse |
Réponse vocale et textuelle uniquement |
|
basicCard |
Une carte basique |
|
structuredResponse |
Charge utile structurée à traiter par Google. |
|
mediaResponse |
Réponse indiquant un ensemble de contenus multimédias à lire. |
|
carouselBrowse |
Fiche de navigation du carrousel, utilisez plutôt collectionBrowse. |
|
tableCard |
Fiche tableau. |
|
htmlResponse |
Réponse HTML utilisée pour l'affichage dans Canvas. |
SimpleResponse
Réponse simple contenant des paroles ou du texte à montrer à l'utilisateur.
Représentation JSON | |
---|---|
{ "textToSpeech": string, "ssml": string, "displayText": string } |
Champs | |
---|---|
textToSpeech |
Texte brut de la sortie vocale, par exemple : "Où voulez-vous aller ?" Exclusivité mutuelle avec ssml. |
ssml |
Réponse vocale structurée à l'utilisateur au format SSML (par exemple, |
displayText |
Texte facultatif à afficher dans la bulle de chat. Si cette valeur n'est pas indiquée, un rendu visuel de textToSpeech ou du format ssml ci-dessus est utilisé. Limité à 640 caractères. |
BasicCard
Fiche de base permettant d'afficher certaines informations, par exemple une image et/ou du texte.
Représentation JSON | |
---|---|
{ "title": string, "subtitle": string, "formattedText": string, "image": { object ( |
Champs | |
---|---|
title |
Titre général de la fiche. Facultatif. |
subtitle |
Facultatif. |
formattedText |
Corps du texte de la fiche. Accepte un ensemble limité de syntaxes Markdown pour la mise en forme. Obligatoire, sauf si une image est présente. |
image |
Une hero image pour la fiche. La hauteur est fixée à 192 dp. Facultatif. |
buttons[] |
Boutons Actuellement, un seul bouton est accepté. Facultatif. |
imageDisplayOptions |
Type d'option d'affichage des images. Facultatif. |
Bouton
Objet bouton qui apparaît généralement au bas d'une fiche.
Représentation JSON | |
---|---|
{
"title": string,
"openUrlAction": {
object ( |
Champs | |
---|---|
title |
titre du bouton. Obligatoire. |
openUrlAction |
Action à effectuer lorsqu'un utilisateur appuie sur le bouton. Obligatoire. |
StructuredResponse
Réponse définie pour que l'application réponde avec des données structurées.
Représentation JSON | |
---|---|
{ // Union field |
Champs | ||
---|---|---|
Champ d'union data . Conteneur de réponse de charge utile des agents tiers. data ne peut être qu'un des éléments suivants : |
||
orderUpdate |
L'application fournit une mise à jour de la commande (par exemple, |
|
orderUpdateV3 |
L'application fournit une mise à jour de la commande au format API v3 après réception de la commande. |
OrderUpdate
Obsolète: utilisez plutôt V3 Proto. Mettre à jour une commande
Représentation JSON | |
---|---|
{ "googleOrderId": string, "actionOrderId": string, "orderState": { object ( |
Champs | ||
---|---|---|
googleOrderId |
L'ID de la commande correspond à la pièce d'identité délivrée par Google. |
|
actionOrderId |
Obligatoire. ID de commande canonique faisant référence à cette commande. Si les intégrateurs ne génèrent pas l'ID de campagne canonique dans leur système, ils peuvent simplement copier sur googleOrderId inclus dans l'ordre. |
|
orderState |
Nouvel état de la commande. |
|
orderManagementActions[] |
Mise à jour des actions de gestion applicables à la commande (par exemple, gérer, modifier ou contacter l'assistance). |
|
receipt |
Reçu de la commande. |
|
updateTime |
Date à laquelle la commande a été mise à jour du point de vue de l'application. Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : |
|
totalPrice |
Nouveau prix total de la commande |
|
lineItemUpdates |
Mappage des modifications au niveau de l'élément de campagne, classées par ID d'élément. Facultatif. Objet contenant une liste de paires |
|
userNotification |
Si spécifié, affiche une notification à l'utilisateur avec le titre et le texte spécifiés. La spécification d'une notification est une suggestion d'envoi de notification. Il n'est pas garanti qu'une notification aboutisse. |
|
infoExtension |
Données supplémentaires basées sur un état de commande personnalisé ou en plus des informations sur un état standard. Objet contenant des champs d'un type arbitraire. Un champ supplémentaire |
|
Champ d'union info . Informations supplémentaires associées à l'état de la commande. info ne peut être qu'un des éléments suivants : |
||
rejectionInfo |
Informations sur l'état de refus. |
|
cancellationInfo |
Informations sur l'état de l'annulation. |
|
inTransitInfo |
Informations sur l'état des transports en commun. |
|
fulfillmentInfo |
Informations sur l'état du traitement. |
|
returnInfo |
Informations sur l'état renvoyé. |
Action
Action de suivi associée à la mise à jour de la commande.
Représentation JSON | |
---|---|
{ "type": enum ( |
Champs | |
---|---|
type |
type d'action. |
button |
Libellé et lien du bouton. |
Reçu
Obsolète: utilisez plutôt V3 Proto. Reçu lorsque l'état est CONFIRMED ou tout autre (par exemple, IN_TRANSIT, FULFILLED), y compris l'état CONFIRMED.
Représentation JSON | |
---|---|
{ "confirmedActionOrderId": string, "userVisibleOrderId": string } |
Champs | |
---|---|
confirmedActionOrderId |
Numéro de commande confirmé lorsque l'intégrateur a reçu la commande. Il s'agit de l'ID de commande canonique utilisé dans le système de l'intégrateur qui fait référence à la commande, qui peut ensuite être utilisé pour identifier la commande comme Notez que ce champ est obsolète. Veuillez plutôt transmettre le champ via OrderUpdate.action_order_id. |
userVisibleOrderId |
Facultatif. Identifiant visible par l'utilisateur qui fait référence à la commande en cours et s'affiche sur la fiche de reçu, le cas échéant. Il s'agit de l'identifiant qui figure généralement sur un reçu imprimé ou un reçu envoyé à l'adresse e-mail de l'utilisateur. L'utilisateur doit pouvoir utiliser cet identifiant pour faire référence à sa commande de service client fourni par les intégrateurs. Notez que ce champ doit être renseigné si l'intégrateur génère un identifiant visible par l'utilisateur pour une commande avec un reçu imprimé ou un reçu par e-mail. |
RejectionInfo
Informations de refus lorsque l'état est REFUSÉ. Ce message peut être inséré lors de la mise à jour initiale de la commande dans une conversation ou lors de la mise à jour asynchrone ultérieure de la commande.
Représentation JSON | |
---|---|
{
"type": enum ( |
Champs | |
---|---|
type |
Type de refus. |
reason |
Cause de l'erreur. |
CancellationInfo
Obsolète: utilisez plutôt V3 Proto. Informations d'annulation lorsque l'état est CANCELLED.
Représentation JSON | |
---|---|
{ "reason": string } |
Champs | |
---|---|
reason |
Motif de l'annulation. |
InTransitInfo
Obsolète: utilisez plutôt V3 Proto. Informations sur les transports en commun lorsque l'état est IN_TRANSIT.
Représentation JSON | |
---|---|
{ "updatedTime": string } |
Champs | |
---|---|
updatedTime |
Heure de la dernière mise à jour du mode d'acheminement. Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : |
FulfillmentInfo
Obsolète: utilisez plutôt V3 Proto. Informations de traitement lorsque l'état est FULFILLED.
Représentation JSON | |
---|---|
{ "deliveryTime": string } |
Champs | |
---|---|
deliveryTime |
La date à laquelle la commande sera traitée. Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : |
ReturnInfo
Obsolète: utilisez plutôt V3 Proto. Informations renvoyées lorsque l'état est REFUSÉ.
Représentation JSON | |
---|---|
{ "reason": string } |
Champs | |
---|---|
reason |
Motif du retour. |
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. |
text |
Contenu de la notification. |
MediaResponse
Réponse indiquant un ensemble de contenus multimédias à lire dans la conversation.
Représentation JSON | |
---|---|
{ "mediaType": enum ( |
Champs | |
---|---|
mediaType |
type de média dans cette réponse. |
mediaObjects[] |
Liste des objets multimédias. |
MediaObject
Représente un objet multimédia renvoyé avec MediaResponse. Contient des informations sur le contenu multimédia, telles que le nom, la description, l'URL, etc.
Représentation JSON | |
---|---|
{ "name": string, "description": string, "contentUrl": string, // Union field |
Champs | ||
---|---|---|
name |
de cet objet multimédia. |
|
description |
description de cet objet multimédia. |
|
contentUrl |
URL pointant vers le contenu multimédia. |
|
Champ d'union image . Image à afficher avec la fiche multimédia. image ne peut être qu'un des éléments suivants : |
||
largeImage |
Une grande image, comme la couverture de l'album, etc. |
|
icon |
Une petite icône d'image affichée à droite du titre Elle est redimensionnée au format 36 x 36 dp. |
CarouselBrowse
Présente un ensemble de documents AMP sous la forme d'un carrousel d'éléments de grande taille d'emplacement. Vous pouvez sélectionner des éléments pour lancer leur document AMP associé dans un lecteur AMP.
Représentation JSON | |
---|---|
{ "items": [ { object ( |
Champs | |
---|---|
items[] |
Min. : 2. Max. : 10 |
imageDisplayOptions |
Type d'option d'affichage des images. Facultatif. |
Article
Élément du carrousel.
Représentation JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Champs | |
---|---|
title |
titre de l'élément du carrousel. Obligatoire. |
description |
description de l'élément du carrousel. Facultatif. |
footer |
Texte en pied de page de l'élément du carrousel, affiché sous la description. Une seule ligne de texte, tronquée par des points de suspension Facultatif. |
image |
Image principale de l'élément du carrousel. Facultatif. |
openUrlAction |
URL du document associé à l'élément du carrousel. Le document peut comporter du contenu HTML ou, si "urlTypeHint" est défini sur AMP_CONTENT, du contenu AMP. Obligatoire. |
TableCard
Fiche de tableau permettant d'afficher un tableau de texte.
Représentation JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Champs | |
---|---|
title |
Titre général du tableau. Facultatif, mais doit être défini si "sous-titre" est défini. |
subtitle |
Sous-titre de la table. Facultatif. |
image |
Image associée au tableau. Facultatif. |
columnProperties[] |
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ées sur certaines surfaces. Effectuez un test avec le simulateur afin d'identifier les lignes qui 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 plus de données. |
buttons[] |
Boutons Actuellement, un seul bouton est accepté. Facultatif. |
ColumnProperties
Conserve les propriétés des colonnes (y compris les en-têtes).
Représentation JSON | |
---|---|
{
"header": string,
"horizontalAlignment": enum ( |
Champs | |
---|---|
header |
Texte de l'en-tête de la colonne. |
horizontalAlignment |
Alignement horizontal du contenu par rapport à la colonne. Si aucune valeur n'est spécifiée, le contenu sera aligné sur le bord avant. |
Ligne
Décrit une ligne de la table.
Représentation JSON | |
---|---|
{
"cells": [
{
object ( |
Champs | |
---|---|
cells[] |
Cellules sur cette ligne. L'affichage des trois premières cellules est garanti, mais d'autres peuvent être coupées sur certaines surfaces. Effectuez un test avec le simulateur pour identifier les cellules qui seront affichées pour une surface donnée. |
dividerAfter |
Indique si un séparateur doit être présent après chaque ligne. |
Cell
Décrit une cellule dans une ligne.
Représentation JSON | |
---|---|
{ "text": string } |
Champs | |
---|---|
text |
Contenu textuel de la cellule. |
HtmlResponse
Réponse qui affiche le code HTML à l'aide de la fonctionnalité de canevas interactif. La taille maximale de la réponse est de 50 000 octets.
Représentation JSON | |
---|---|
{ "updatedState": value, "suppressMic": boolean, "url": string } |
Champs | |
---|---|
updatedState |
Communiquez l'objet JSON suivant à l'application. |
suppressMic |
Indiquez une option pour que le micro ne s'active pas après cette réponse immersive. |
url |
URL de l'application. |
Suggestion
Chip de suggestion sur lequel l'utilisateur peut appuyer pour publier rapidement une réponse à la conversation.
Représentation JSON | |
---|---|
{ "title": string } |
Champs | |
---|---|
title |
Texte affiché dans le chip de suggestion. Lorsque l'utilisateur appuie dessus, ce texte est republié dans la conversation, comme si l'utilisateur l'avait saisi. Chaque titre doit être unique parmi les chips de suggestion. 25 caractères max. requis |
LinkOutSuggestion
Crée un chip de suggestion qui permet à l'utilisateur d'accéder à l'application ou au site Web associé à cet agent.
Représentation JSON | |
---|---|
{
"destinationName": string,
"url": string,
"openUrlAction": {
object ( |
Champs | |
---|---|
destinationName |
Nom de l'application ou du site vers lequel ce chip redirige. Le chip s'affiche avec le titre "Ouvrir <ph type="x-smartling-placeholder"> |
url |
Obsolète. Utilisez plutôt OpenUrlAction. |
openUrlAction |
URL de l'application ou du site à ouvrir lorsque l'utilisateur appuie sur le chip de suggestion. La propriété de cette application/URL doit être validée dans les actions de la Google Play Console. Sinon, l'utilisateur ne verra pas la suggestion. Les actions d'URL ouvertes sont compatibles avec les URL HTTP, HTTPS et d'intent. Pour les URL d'intent, reportez-vous à https://developer.chrome.com/multidevice/android/intents. |
ExpectedIntent
Intent attendu que l'application demande à l'Assistant.
Représentation JSON | |
---|---|
{ "intent": string, "inputValueData": { "@type": string, field1: ..., ... }, "parameterName": string } |
Champs | |
---|---|
intent |
Nom de l'intent intégré (par exemple, |
inputValueData |
Données de configuration supplémentaires requises par un intent intégré. Valeurs possibles pour les intents intégrés: Objet contenant des champs d'un type arbitraire. Un champ supplémentaire |
parameterName |
Éventuellement, un paramètre de l'intent demandé. Valide uniquement pour les intents demandés. Utilisé pour la pondération de la voix. |
FinalResponse
Réponse finale lorsque l'entrée utilisateur n'est pas attendue.
Représentation JSON | |
---|---|
{ // Union field |
Champs | ||
---|---|---|
Champ d'union response . Types de réponses possibles. response ne peut être qu'un des éléments suivants : |
||
speechResponse |
Réponse vocale lorsque l'utilisateur n'est pas tenu de fournir une entrée. |
|
richResponse |
Réponse enrichie lorsque l'utilisateur n'est pas tenu de fournir une entrée. |
CustomPushMessage
Message push personnalisé contenant les données structurées à envoyer pour l'API Fulfillment d'actions.
Représentation JSON | |
---|---|
{ "target": { object ( |
Champs | ||
---|---|---|
target |
Cible spécifiée pour la requête push. |
|
Champ d'union content . Les différents types de charges utiles. content ne peut être qu'un des éléments suivants : |
||
orderUpdate |
Mise à jour d'une commande mettant à jour les commandes passées via des API de transaction. |
|
userNotification |
Si cette option est spécifiée, une notification s'affiche pour l'utilisateur avec le titre et le texte spécifiés. |
UserNotification
Notification utilisateur à afficher avec une demande.
Représentation JSON | |
---|---|
{ "title": string, "text": string } |
Champs | |
---|---|
title |
Titre de la notification. |
text |
Contenu de la notification. |
Cible
Cible spécifiée pour la requête push.
Représentation JSON | |
---|---|
{
"userId": string,
"intent": string,
"argument": {
object ( |
Champs | |
---|---|
userId |
Utilisateur à cibler. |
intent |
Intention à cibler. |
argument |
Argument à cibler pour un intent. Un seul argument est accepté pour la version 1. |
locale |
Paramètres régionaux à cibler. Suit le code de langue IETF BCP-47. Peut être utilisé par une application multilingue pour cibler un utilisateur sur une application localisée spécifiée. Si aucune valeur n'est spécifiée, la langue par défaut est l'anglais des États-Unis (en-US). |