- Représentation JSON
- ExpectedInput
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- InputPrompt
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- SpeechResponse
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- RichResponse
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Élément
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- SimpleResponse
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- BasicCard
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Bouton
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- StructuredResponse
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- OrderUpdate
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Action
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Reçu
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- RejectionInfo
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CancellationInfo
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- InTransitInfo
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- FulfillmentInfo
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ReturnInfo
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- UserNotification
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- MediaResponse
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- MediaObject
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CarouselBrowse
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Élément
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- TableCard
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ColumnProperties
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Ligne
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Cellule
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- HtmlResponse
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Suggestion
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- LinkOutSuggestion
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ExpectedIntent
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- FinalResponse
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CustomPushMessage
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- UserNotification
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Cible
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
AppResponse est la réponse envoyée par le fulfillment à l'Assistant Google. Pour voir comment cela est utilisé dans Actions on Google, consultez 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 qui est recirculé dans l'action à chaque tour de conversation. |
userStorage |
Jeton opaque contrôlé par l'action et conservé dans les conversations d'un utilisateur particulier. S'il est vide ou non spécifié, le jeton persistant existant ne sera pas modifié. La taille maximale de la chaîne est de 10 000 octets. Si plusieurs boîtes de dialogue se produisent simultanément pour le même utilisateur, les mises à jour de ce jeton peuvent s'écraser mutuellement de manière inattendue. |
resetUserStorage |
Indique si l'objet userStorage persistant doit être effacé. S'il est défini 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. Ce paramètre est défini sur "true" lorsque la conversation est en cours, sur "false" lorsque la conversation est terminée. |
expectedInputs[] |
Liste des entrées attendues par l'action. Chaque entrée peut être une action courante sur l'intent Google (commence par "actions") ou une liste d'intents possibles. Une seule entrée est acceptée pour le moment. |
finalResponse |
Réponse finale lorsque l'action n'attend pas l'entrée de l'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 transmettre des données structurées à Google en mode bac à sable. |
ExpectedInput
Représentation JSON | |
---|---|
{ "inputPrompt": { object ( |
Champs | |
---|---|
inputPrompt |
Invite personnalisée utilisée pour demander à l'utilisateur des entrées. |
possibleIntents[] |
Liste des 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 parole. Jusqu'à 1 000 expressions sont autorisées. |
InputPrompt
Invite de saisie utilisée par l'assistant pour aider l'utilisateur à saisir une entrée pour la question de 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 accepté. |
richInitialPrompt |
Charge utile de la requête. |
noInputPrompts[] |
Requête utilisée pour demander à l'utilisateur lorsqu'il ne reçoit aucune entrée. |
SpeechResponse
Réponse qui ne contient que la parole. OBSOLÈTE.
Représentation JSON | |
---|---|
{ // Union field |
Champs | ||
---|---|---|
Champ d'union type . Types de sorties vocales: 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ù veux-tu aller ?"/ |
|
ssml |
Réponse vocale structurée à l'utilisateur au format SSML, par exemple " |
RichResponse
Réponse enrichie pouvant inclure de l'audio, du texte, des fiches, des suggestions et des données structurées.
Représentation JSON | |
---|---|
{ "items": [ { object ( |
Champs | |
---|---|
items[] |
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[] |
Liste de réponses suggérées. Ils apparaîtront toujours à la fin de la réponse. Si elles sont utilisées dans un |
linkOutSuggestion |
Chip de suggestion supplémentaire pouvant rediriger les utilisateurs vers l'application ou le site associé. |
Élément
É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'élément. 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 du tableau. |
|
htmlResponse |
Réponse HTML utilisée pour l'affichage sur Canvas. |
SimpleResponse
Réponse simple contenant des propos 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ù veux-tu aller ?" Exclusion mutuelle avec CSS. |
ssml |
Réponse vocale structurée à l'utilisateur au format SSML, par exemple |
displayText |
Texte facultatif à afficher dans la bulle de chat. S'il n'est pas fourni, un rendu d'affichage de la synthèse vocale ou du fichier ssml ci-dessus sera utilisé. Limité à 640 caractères. |
BasicCard
Une carte basique permettant d'afficher certaines informations (par exemple, une image et/ou un 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 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. |
buttons[] |
Boutons Actuellement, 1 bouton est accepté au maximum. Facultatif. |
imageDisplayOptions |
le type d'affichage des images. Facultatif. |
Bouton
Objet bouton qui apparaît généralement au bas d'une carte.
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 la réponse de charge utile des agents tiers. data ne peut être qu'un des éléments suivants : |
||
orderUpdate |
L'application met à jour la commande (par exemple, |
|
orderUpdateV3 |
L'application met à jour la commande au format API v3 après avoir reçu la commande. |
OrderUpdate
Obsolète: utilisez plutôt V3 Proto. Mise à jour d'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 commande canonique dans leur système, ils peuvent simplement copier la valeur googleOrderId incluse dans l'ordre. |
|
orderState |
Nouvel état de l'ordre. |
|
orderManagementActions[] |
Mise à jour des actions de gestion applicables à la campagne, par exemple gérer, modifier et 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 |
Carte des modifications au niveau de l'élément de campagne, associées par ID d'élément. Facultatif. Objet contenant une liste de paires |
|
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. |
|
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 d'annulation. |
|
inTransitInfo |
Informations sur l'état des transports en commun. |
|
fulfillmentInfo |
Informations sur l'état de 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 CONFIRMÉ ou lorsque tout autre état (par exemple, IN_TRANSIT, FULFILLED) incluant l'état CONFIRMED
Représentation JSON | |
---|---|
{ "confirmedActionOrderId": string, "userVisibleOrderId": string } |
Champs | |
---|---|
confirmedActionOrderId |
ID de commande confirmé lors de la réception de la commande par l'intégrateur. Il s'agit de l'ID de commande canonique utilisé dans le système de l'intégrateur faisant référence à la commande. Il 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 qui apparaîtra sur la fiche de reçu, le cas échéant. Il doit s'agir de l'ID qui figure généralement sur un reçu imprimé ou envoyé à l'e-mail de l'utilisateur. L'utilisateur doit pouvoir utiliser cet identifiant pour faire référence à sa commande concernant le service client fourni par les intégrateurs. Notez que ce champ doit être renseigné si l'intégrateur génère un ID visible par l'utilisateur pour une commande avec un reçu imprimé par e-mail. |
RejectionInfo
Informations de refus lorsque l'état est REJECTED (REFUSÉ). Ce message peut être inséré lors de la mise à jour initiale de la commande dans la conversation ou lors d'une mise à jour ultérieure de la commande asynchrone.
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 de "En transit". 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 |
Date de traitement de la commande. Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : |
ReturnInfo
Obsolète: utilisez plutôt V3 Proto. Les informations renvoyées lorsque l'état est REJECTED (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 |
le 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 |
nom 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 s'affiche à droite du titre. Elle est redimensionnée à 36 x 36 dp. |
CarouselBrowse
Présente un ensemble de documents AMP sous la forme d'un carrousel d'éléments de grande taille. Les éléments peuvent être sélectionnés pour lancer le document AMP associé dans un lecteur AMP.
Représentation JSON | |
---|---|
{ "items": [ { object ( |
Champs | |
---|---|
items[] |
Min. : 2. Max. : 10. |
imageDisplayOptions |
le type d'affichage des images. Facultatif. |
Élément
É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 de 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 héros de l'élément du carrousel. Facultatif. |
openUrlAction |
URL du document associé à l'élément du carrousel. Le document peut inclure du contenu HTML ou, si "urlTypeHint" est défini sur AMP_CONTENT, AMP. Obligatoire. |
TableCard
Fiche du tableau permettant d'afficher un tableau de texte.
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. |
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é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. |
buttons[] |
Boutons Actuellement, 1 bouton est accepté au maximum. 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 de la colonne de pondération du contenu. S'il n'est pas spécifié, le contenu sera aligné sur le bord initial. |
Ligne
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. |
dividerAfter |
Indique s'il doit y avoir un séparateur 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 soit pas activé 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 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 maximum requis |
LinkOutSuggestion
Crée un chip de suggestion permettant à l'utilisateur d'accéder directement à l'application ou au site Web associés à cet agent.
Représentation JSON | |
---|---|
{
"destinationName": string,
"url": string,
"openUrlAction": {
object ( |
Champs | |
---|---|
destinationName |
Nom de l'application ou du site associé à ce chip. Le chip s'affichera avec le titre "Ouvrir |
url |
Obsolète. Utilisez OpenUrlAction à la place. |
openUrlAction |
URL de l'application ou du site à ouvrir lorsque l'utilisateur appuie sur le chip de suggestion. La propriété de cette application ou de cette URL doit être validée dans les actions de la Google Play Console, sans quoi l'utilisateur ne verra pas la suggestion. L'action d'URL ouverte est compatible avec les URL HTTP, HTTPS et d'intent. Pour les URL d'intent, consultez la page https://developer.chrome.com/multidevice/android/intents. |
ExpectedIntent
Intent attendu que l'application demande à l'assistant de fournir.
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é. Uniquement valide pour les intents demandés. Utilisé pour la pondération de la parole. |
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 obligé de fournir une entrée. |
CustomPushMessage
Message push personnalisé contenant les données structurées à transmettre pour l'API Fulfillment des 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 les API de transaction. |
|
userNotification |
Si spécifié, affiche une notification contenant le titre et le texte spécifiés pour l'utilisateur. |
UserNotification
Notification utilisateur à afficher avec une requête.
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 |
Intent à cibler. |
argument |
Argument à cibler pour un intent. Pour la version 1, un seul argument est accepté. |
locale |
Paramètres régionaux à cibler. Respecte le code de langue IETF BCP-47. Peut être utilisée par une application multilingue pour cibler un utilisateur dans une application localisée spécifiée. Si aucune valeur n'est spécifiée, la valeur par défaut est "en-US". |