- Représentation JSON
- ConfigFiles
- ConfigFile
- Fichier manifeste
- Actions
- CustomAction
- Engagement
- PushNotification
- DailyUpdate
- ActionLink
- AssistantLink
- Paramètres
- Catégorie
- SurfaceRequirements
- CapabilityRequirement
- SurfaceCapability
- LocalizedSettings
- ThemeCustomization
- ImageCornerStyle
- AccountLinking
- LinkingType
- AuthGrantType
- Webhook
- Handler
- HttpsEndpoint
- InlineCloudFunction
- Intention
- IntentParameter
- ClassReference
- EntitySetReferences
- EntitySetReference
- Type
- SynonymType
- MatchType
- Entité
- EntityDisplay
- RegularExpressionType
- Entité
- FreeTextType
- EntitySet
- Entité
- GlobalIntentEvent
- EventHandler
- StaticPrompt
- StaticPromptCandidate
- Sélecteur
- SurfaceCapabilities
- Capacité
- StaticPromptResponse
- StaticSimplePrompt
- Variante
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- ImageFill
- StaticLinkPrompt
- OpenUrl
- UrlHint
- StaticTablePrompt
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- StaticMediaPrompt
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- RepeatMode
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- StaticCollectionBrowsePrompt
- CollectionBrowseItem
- Suggestion
- StaticCanvasPrompt
- Scène
- IntentEvent
- ConditionalEvent
- Encoche
- PromptSettings
- CommitBehavior
- DefaultValue
- DataFiles
- DataFile
Wrapper pour une liste de fichiers.
Représentation JSON | |
---|---|
{ // Union field |
Champs | ||
---|---|---|
Champ d'union file_type . Un seul type de fichier peut être envoyé au serveur à la fois : fichiers de configuration ou fichiers de données. file_type ne peut être qu'un des éléments suivants : |
||
configFiles |
Liste des fichiers de configuration. Cela inclut le fichier manifeste, les paramètres, les bundles de ressources du modèle d'interaction, etc. |
|
dataFiles |
Liste des fichiers de données. Il peut s'agir d'une image, d'un fichier audio ou du code source de la fonction Cloud. |
ConfigFiles
Wrapper pour les fichiers de configuration répétés. Les champs répétés ne peuvent pas exister dans un élément oneof.
Représentation JSON | |
---|---|
{
"configFiles": [
{
object ( |
Champs | |
---|---|
configFiles[] |
Plusieurs fichiers de configuration |
ConfigFile
Représente un seul fichier contenant des données structurées. Les développeurs peuvent définir la majeure partie de leur projet à l'aide d'une configuration structurée, y compris les actions, les paramètres et le traitement.
Représentation JSON | |
---|---|
{ "filePath": string, // Union field |
Champs | ||
---|---|---|
filePath |
Chemin d'accès relatif du fichier de configuration à partir de la racine du projet dans la structure de fichiers du SDK. Chaque type de fichier ci-dessous possède un chemin d'accès autorisé. Exemple: settings/settings.yaml |
|
Champ d'union file . Chaque type de fichier de configuration doit avoir un champ correspondant dans l'un de. file ne peut être qu'un des éléments suivants : |
||
manifest |
Fichier manifeste unique. Chemin d'accès au fichier autorisé: |
|
actions |
Un fichier d'actions unique contenant toutes les actions définies. Chemins d'accès aux fichiers autorisés: |
|
settings |
Configuration de paramètres uniques qui inclut des paramètres non localisables et des paramètres pour les paramètres régionaux par défaut du projet (le cas échéant). Pour un fichier de remplacement des paramètres régionaux, seul le champ localizedSettings est renseigné. Chemins d'accès aux fichiers autorisés: |
|
webhook |
Définition de webhook unique. Chemin d'accès au fichier autorisé: |
|
intent |
Définition d'un intent unique. Chemins d'accès aux fichiers autorisés: |
|
type |
Définition de type unique. Chemins d'accès aux fichiers autorisés: |
|
entitySet |
Définition d'un ensemble d'entités unique. Chemins d'accès aux fichiers autorisés: |
|
globalIntentEvent |
Définition d'un événement d'intent global unique Chemins d'accès aux fichiers autorisés: |
|
scene |
Définition d'une seule scène Chemins d'accès aux fichiers autorisés: |
|
staticPrompt |
Définition d'une seule requête statique. Chemins d'accès aux fichiers autorisés: |
|
accountLinkingSecret |
Métadonnées correspondant au code secret du client utilisé lors de l'association de comptes. Chemin d'accès au fichier autorisé: |
|
resourceBundle |
Groupe de ressources unique, c'est-à-dire le mappage entre une chaîne et une chaîne ou une liste de chaînes. Les bundles de ressources peuvent être utilisés pour localiser des chaînes dans des requêtes statiques. Chemins d'accès aux fichiers autorisés: |
Manifest
Contient des informations "transportables", c'est-à-dire qui ne sont pas spécifiques à un projet donné et qui peuvent être déplacées d'un projet à un autre.
Représentation JSON | |
---|---|
{ "version": string } |
Champs | |
---|---|
version |
Version du format de fichier. La version actuelle du format de fichier est 1.0. Exemple: "1.0" |
Actions
Représente la liste des actions définies dans un projet.
Représentation JSON | |
---|---|
{
"custom": {
string: {
object ( |
Champs | |
---|---|
custom |
Associez les intents aux actions personnalisées pour configurer l'appel du projet. Les intents d'appel peuvent être des intents système ou personnalisés définis dans le package "custom/intents/". Tous les intents définis ici (intents système et personnalisés) doivent être associés à un fichier d'intent correspondant dans le package "custom/global/". Objet contenant une liste de paires |
CustomAction
Informations concernant une action personnalisée.
Représentation JSON | |
---|---|
{
"engagement": {
object ( |
Champs | |
---|---|
engagement |
Mécanismes d'engagement associés à l'action pour aider les utilisateurs finaux à s'abonner aux notifications push et aux mises à jour quotidiennes Notez que le nom de l'intent spécifié dans la configuration des emplacements pour les mises à jour quotidiennes/les notifications push doit correspondre à l'intent correspondant à cette action pour que les utilisateurs finaux puissent s'abonner à ces mises à jour. |
Engagement
Définit les mécanismes d'engagement associés à cette action. Les utilisateurs finaux peuvent ainsi s'abonner aux notifications push et aux mises à jour quotidiennes.
Représentation JSON | |
---|---|
{ "title": string, "pushNotification": { object ( |
Champs | |
---|---|
title |
Titre de l'engagement qui sera envoyé aux utilisateurs finaux pour leur demander l'autorisation de recevoir des informations. L'invite envoyée aux utilisateurs finaux pour des mises à jour quotidiennes se présentera comme suit : "À quelle heure souhaitez-vous que je vous envoie votre {title}" chaque jour, et pour les notifications push, il se présentera comme suit : "Puis-je envoyer des notifications push pour {title}". Ce champ peut être localisé. |
pushNotification |
Paramètres de notification push compatibles avec cet engagement. |
actionLink |
Configuration de lien pour une action qui détermine si les liens de partage sont activés pour l'action et, le cas échéant, contient le nom à afficher convivial du lien. Abandon d'ActionLink. Utilisez plutôt AssistantLink. |
assistantLink |
Configuration de lien pour une action qui détermine si les liens de partage sont activés pour l'action et, le cas échéant, contient le nom à afficher convivial du lien. |
dailyUpdate |
Paramètres de mise à jour quotidienne compatibles avec cet engagement. |
PushNotification
Définit les paramètres de notification push compatibles avec cet engagement.
DailyUpdate
Définit les paramètres de mise à jour quotidienne compatibles avec cet engagement.
ActionLink
Indique si les liens de partage sont activés pour cette action et les paramètres correspondants. Les liens d'action permettent de rediriger un utilisateur vers une action spécifique via un lien profond. Abandon d'ActionLink. Utilisez plutôt AssistantLink.
Représentation JSON | |
---|---|
{ "title": string } |
Champs | |
---|---|
title |
Titre à afficher convivial pour le lien. |
AssistantLink
Indique si les liens de partage sont activés pour cette action et les paramètres correspondants. Les liens de l'Assistant permettent de rediriger un utilisateur vers une action spécifique via un lien profond.
Représentation JSON | |
---|---|
{ "title": string } |
Champs | |
---|---|
title |
Titre à afficher convivial pour le lien. |
Paramètres
Représente les paramètres d'un projet Actions qui ne sont pas spécifiques aux paramètres régionaux. Balise suivante: 22
Représentation JSON | |
---|---|
{ "projectId": string, "defaultLocale": string, "enabledRegions": [ string ], "disabledRegions": [ string ], "category": enum ( |
Champs | |
---|---|
projectId |
ID du projet Actions. |
defaultLocale |
Paramètres régionaux par défaut pour le projet Pour tous les fichiers, à l'exception de |
enabledRegions[] |
Représente les régions dans lesquelles les utilisateurs peuvent appeler vos actions, selon leur emplacement de présence. Ce champ ne peut pas être défini si |
disabledRegions[] |
Représente les régions dans lesquelles vos actions sont bloquées, en fonction de la localisation de l'utilisateur. Ce champ ne peut pas être défini si |
category |
Catégorie de ce projet Actions. |
usesTransactionsApi |
Indique si les actions peuvent utiliser les transactions (par exemple, effectuer des réservations, prendre des commandes, etc.). Si la valeur est "false", les tentatives d'utilisation des API Transactions échouent. |
usesDigitalPurchaseApi |
Indique si les actions peuvent effectuer des transactions pour des produits numériques. |
usesInteractiveCanvas |
Indique si les actions utilisent Interactive Canvas. |
usesHomeStorage |
Indique si les actions utilisent la fonctionnalité de stockage de la maison. |
designedForFamily |
Indique si le contenu Actions est conçu pour les familles. |
containsAlcoholOrTobaccoContent |
L'action comporte-t-elle du contenu lié à l'alcool ou au tabac ? |
keepsMicOpen |
Ce paramètre indique si les actions peuvent laisser le micro activé sans invite explicite pendant la conversation. |
surfaceRequirements |
Exigences de surface qu'une surface client doit prendre en charge pour appeler des actions dans ce projet. |
testingInstructions |
Instructions de test de format libre pour le réviseur Actions (par exemple, instructions sur l'association de comptes) |
localizedSettings |
Paramètres localisés pour les paramètres régionaux par défaut du projet. Chaque paramètre régional supplémentaire doit avoir son propre fichier de paramètres dans son propre répertoire. |
accountLinking |
Autorisez les utilisateurs à créer ou associer des comptes via Google Sign-In et/ou votre propre service OAuth. |
selectedAndroidApps[] |
Applications Android sélectionnées pour accéder aux achats effectués sur Google Play lors des transactions Il s'agit d'une sélection parmi les applications Android associées au projet Actions pour valider la propriété de la marque et activer des fonctionnalités supplémentaires. Pour en savoir plus, consultez la page https://developers.google.com/assistant/console/brand-verification. |
Catégorie
Catégories possibles pour un projet Actions.
Enums | |
---|---|
CATEGORY_UNSPECIFIED |
Inconnu / Non spécifié. |
BUSINESS_AND_FINANCE |
Catégorie Économie et finance. |
EDUCATION_AND_REFERENCE |
Formation et référence. |
FOOD_AND_DRINK |
Alimentation et boissons. |
GAMES_AND_TRIVIA |
Jeux et quiz. |
HEALTH_AND_FITNESS |
dans la catégorie "Santé et remise en forme". |
KIDS_AND_FAMILY |
dans la catégorie "Enfants et famille". |
LIFESTYLE |
dans la catégorie "Style de vie". |
LOCAL |
Catégorie locale. |
MOVIES_AND_TV |
Catégorie Films et TV. |
MUSIC_AND_AUDIO |
dans la catégorie "Musique et audio". |
NEWS |
catégorie Actualités |
NOVELTY_AND_HUMOR |
la catégorie Nouveauté et Humour. |
PRODUCTIVITY |
dans la catégorie "Productivité". |
SHOPPING |
Catégorie Shopping. |
SOCIAL |
Catégorie "Réseaux sociaux". |
SPORTS |
"Sports". |
TRAVEL_AND_TRANSPORTATION |
dans la catégorie Voyages et transports. |
UTILITIES |
dans la catégorie "Utilitaires". |
WEATHER |
Catégorie Météo. |
HOME_CONTROL |
dans la catégorie "Contrôle de la maison". |
SurfaceRequirements
Contient un ensemble d'exigences que la surface client doit prendre en charge pour appeler des actions dans votre projet.
Représentation JSON | |
---|---|
{
"minimumRequirements": [
{
object ( |
Champs | |
---|---|
minimumRequirements[] |
Ensemble minimal de fonctionnalités nécessaires pour appeler les actions dans votre projet. S'il manque l'un de ces éléments sur la surface, l'action ne sera pas déclenchée. |
CapabilityRequirement
Représente une exigence concernant la disponibilité d'une capacité donnée.
Représentation JSON | |
---|---|
{
"capability": enum ( |
Champs | |
---|---|
capability |
Type de capacité. |
SurfaceCapability
Ensemble possible de fonctionnalités de surface.
Enums | |
---|---|
SURFACE_CAPABILITY_UNSPECIFIED |
Inconnu / Non spécifié. |
AUDIO_OUTPUT |
Surface compatible avec la sortie audio. |
SCREEN_OUTPUT |
Surface compatible avec la sortie écran/visuelle. |
MEDIA_RESPONSE_AUDIO |
Surface accepte l'audio de réponse multimédia. |
WEB_BROWSER |
Surface est compatible avec les navigateurs Web. |
ACCOUNT_LINKING |
Surface permet d'associer des comptes. |
INTERACTIVE_CANVAS |
Surface est compatible avec Interactive Canvas. |
HOME_STORAGE |
Surface compatible avec le stockage personnel. |
LocalizedSettings
Représente les paramètres d'un projet Actions spécifiques aux paramètres régionaux de l'utilisateur. Dans ce cas, le terme "utilisateur" désigne l'utilisateur final qui appelle vos actions. Ce message peut être localisé.
Représentation JSON | |
---|---|
{
"displayName": string,
"pronunciation": string,
"shortDescription": string,
"fullDescription": string,
"smallLogoImage": string,
"largeBannerImage": string,
"developerName": string,
"developerEmail": string,
"termsOfServiceUrl": string,
"voice": string,
"voiceLocale": string,
"privacyPolicyUrl": string,
"sampleInvocations": [
string
],
"themeCustomization": {
object ( |
Champs | |
---|---|
displayName |
Obligatoire. Nom à afficher par défaut pour ce projet Actions (si aucune traduction n'est disponible) |
pronunciation |
Obligatoire. Prononciation du nom à afficher pour l'appeler dans un contexte vocal. |
shortDescription |
Obligatoire. Brève description par défaut du projet Actions (si aucune traduction n'est disponible). 80 caractères maximum. |
fullDescription |
Obligatoire. Description longue par défaut du projet Actions (si aucune traduction n'est disponible). Nombre maximal de caractères : 4 000. |
smallLogoImage |
Obligatoire. Petite image carrée, 192 x 192 px Il doit être spécifié comme référence à l'image correspondante dans le répertoire |
largeBannerImage |
Facultatif. Grande image en mode paysage, 1 920 x 1 080 px. Il doit être spécifié comme référence à l'image correspondante dans le répertoire |
developerName |
Obligatoire. Nom du développeur à afficher aux utilisateurs. |
developerEmail |
Obligatoire. Adresse e-mail de contact du développeur. |
termsOfServiceUrl |
Facultatif. URL des conditions d'utilisation. |
voice |
Obligatoire. Type de voix de l'Assistant Google que les utilisateurs entendent lorsqu'ils interagissent avec vos actions. Les valeurs acceptées sont "male_1", "male_2", "female_1" et "female_2". |
voiceLocale |
Facultatif. Paramètres régionaux de la voix spécifiée. S'il n'est pas spécifié, il s'agit des paramètres régionaux de l'Assistant. S'ils sont spécifiés, les paramètres régionaux vocaux doivent être associés à la même langue racine que celle spécifiée dans LocalizedSettings. |
privacyPolicyUrl |
Obligatoire. URL des règles de confidentialité. |
sampleInvocations[] |
Facultatif. Exemples de phrases d'appel affichées dans la description de votre projet Actions dans le répertoire de l'Assistant Cela aidera les utilisateurs à apprendre à l'utiliser. |
themeCustomization |
Facultatif. Personnalisations de thème pour les composants visuels de vos actions. |
ThemeCustomization
Styles appliqués aux fiches présentées aux utilisateurs
Représentation JSON | |
---|---|
{
"backgroundColor": string,
"primaryColor": string,
"fontFamily": string,
"imageCornerStyle": enum ( |
Champs | |
---|---|
backgroundColor |
Couleur d'arrière-plan des cartes Sert de solution de secours si |
primaryColor |
La couleur de thème principale de l'action sera utilisée pour définir la couleur du texte du titre et la couleur d'arrière-plan des éléments d'action pour les cartes Actions on Google. Exemple d'utilisation: #FAFAFA |
fontFamily |
Famille de polices qui sera utilisée pour le titre des fiches. Polices compatibles: - Sans Serif - Sans Serif Medium - Sans Serif Bold - Sans Serif Black - Sans Serif Condensed - Sans Serif Condensed Medium - Serif - Serif Bold - Monospace - Sans Serif Smallcaps |
imageCornerStyle |
Style de bordure de l'image au premier plan des cartes Par exemple, il peut être appliqué à l'image de premier plan d'une fiche de base ou d'une fiche de carrousel. |
landscapeBackgroundImage |
Mode paysage (1 920 x 1 200 pixels minimum). Il doit être spécifié comme référence à l'image correspondante dans le répertoire |
portraitBackgroundImage |
Mode Portrait (1 200 x 1 920 pixels minimum). Il doit être spécifié comme référence à l'image correspondante dans le répertoire |
ImageCornerStyle
Décrit le rendu des bordures des images.
Enums | |
---|---|
IMAGE_CORNER_STYLE_UNSPECIFIED |
Non défini / non spécifié. |
CURVED |
Coin arrondi pour l'image. |
ANGLED |
Angle rectangulaire pour l'image. |
AccountLinking
AccountLinking permet à Google d'aider l'utilisateur à se connecter aux services Web de l'appli.
Pour les types d'associations Google Sign-In et OAuth + Google Sign-In, Google génère un ID client identifiant votre application auprès de Google ("ID client émis par Google pour vos actions" dans l'UI de la console). Ce champ est en lecture seule. Vous pouvez le vérifier en accédant à la page "Association de comptes" dans l'interface utilisateur de la console. Consultez la page https://developers.google.com/assistant/identity/google-sign-in.
Remarque: Pour tous les types de paramètres d'association de comptes (à l'exception de Google Sign-In), vous devez fournir un nom d'utilisateur et un mot de passe pour un compte de test dans Settings.testing_instructions, afin que l'équipe chargée de l'examen puisse examiner l'application (les utilisateurs ne les verront pas).
Représentation JSON | |
---|---|
{ "enableAccountCreation": boolean, "linkingType": enum ( |
Champs | |
---|---|
enableAccountCreation |
Obligatoire. Si la valeur est |
linkingType |
Obligatoire. Type d'association à utiliser. Pour en savoir plus sur les types d'associations, consultez la page https://developers.google.com/assistant/identity. |
authGrantType |
Facultatif. Indique le type d'authentification pour OAUTH LinkingType. |
appClientId |
Facultatif. Identifiant client émis par votre application à Google. Il s'agit de l'ID client OAuth2 permettant d'identifier Google auprès de votre service. Défini uniquement lors de l'utilisation d'OAuth. |
authorizationUrl |
Facultatif. Point de terminaison de votre page Web de connexion compatible avec le code OAuth2 ou les flux implicites. L'URL doit utiliser le protocole HTTPS. Défini uniquement lors de l'utilisation d'OAuth. |
tokenUrl |
Facultatif. Point de terminaison OAuth2 pour l'échange de jetons. L'URL doit utiliser le protocole HTTPS. Ce paramètre n'est pas défini lorsque vous utilisez uniquement OAuth avec une autorisation IMPLICIT comme type d'association. Défini uniquement lors de l'utilisation d'OAuth. |
scopes[] |
Facultatif. Liste des autorisations que l'utilisateur doit accorder pour pouvoir utiliser votre service. Défini uniquement lors de l'utilisation d'OAuth. Si vous spécifiez ce champ, assurez-vous d'indiquer les conditions d'utilisation dans les informations du répertoire dans la section LocalizedSettings.terms_of_service_url. |
learnMoreUrl |
Facultatif. Il s'agit de la page Web de votre service qui décrit les autorisations que l'utilisateur accorde à Google. Défini uniquement si vous utilisez OAuth et Google Sign-In. Si vous spécifiez ce champ, assurez-vous d'indiquer les conditions d'utilisation dans les informations du répertoire dans la section LocalizedSettings.terms_of_service_url. |
useBasicAuthHeader |
Facultatif. Si la valeur est "true", Google peut transmettre l'ID client et le code secret via l'en-tête d'authentification de base HTTP. Sinon, Google utilise l'ID client et le code secret dans le corps du post. Défini uniquement lors de l'utilisation d'OAuth. Si vous spécifiez ce champ, assurez-vous d'indiquer les conditions d'utilisation dans les informations du répertoire dans la section LocalizedSettings.terms_of_service_url. |
LinkingType
Type d'association de comptes à effectuer.
Enums | |
---|---|
LINKING_TYPE_UNSPECIFIED |
URL indéterminée. |
GOOGLE_SIGN_IN |
Type d'association à Google Sign-In. Si vous utilisez ce type d'association, aucun champ lié à OAuth n'a besoin d'être défini ci-dessous. |
OAUTH_AND_GOOGLE_SIGN_IN |
Type d'association OAuth et Google Sign-In |
OAUTH |
Type d'association OAuth |
AuthGrantType
Type d'autorisation OAuth2 que Google utilise pour guider l'utilisateur dans la connexion au service Web de votre application.
Enums | |
---|---|
AUTH_GRANT_TYPE_UNSPECIFIED |
URL indéterminée. |
AUTH_CODE |
Octroi du code d'autorisation. Vous devez indiquer à la fois l'URL d'authentification et l'URL du jeton d'accès. |
IMPLICIT |
Octroi de code implicite. Il vous suffit de fournir une URL d'authentification. |
Webhook
Métadonnées pour différents types de webhooks. Si vous utilisez inlineCloudFunction
, votre code source doit se trouver dans un répertoire portant le même nom que la valeur de la clé executeFunction
. Par exemple, la valeur de my_webhook
pour la clé executeFunction
présente une structure de code semblable à celle-ci: - /webhooks/my_webhook.yaml
- /webhooks/my_webhook/index.js
- /webhooks/my_webhook/package.json
Représentation JSON | |
---|---|
{ "handlers": [ { object ( |
Champs | ||
---|---|---|
handlers[] |
Liste des gestionnaires pour ce webhook. |
|
Champ d'union webhook_type . Un seul type de webhook est accepté. webhook_type ne peut être qu'un des éléments suivants : |
||
httpsEndpoint |
Point de terminaison HTTPS du webhook personnalisé. |
|
inlineCloudFunction |
Métadonnées de la fonction Cloud déployée à partir d'un code dans le dossier des webhooks. |
Handler
Déclare le nom du gestionnaire de webhook. Un webhook peut avoir plusieurs gestionnaires enregistrés. Ces gestionnaires peuvent être appelés à partir de plusieurs emplacements dans votre projet Actions.
Représentation JSON | |
---|---|
{ "name": string } |
Champs | |
---|---|
name |
Obligatoire. Nom du gestionnaire. Doit être unique pour tous les gestionnaires du projet Actions. Vous pouvez vérifier le nom de ce gestionnaire pour appeler la fonction appropriée dans votre code source de traitement. |
HttpsEndpoint
point de terminaison REST pour vous avertir si vous n'utilisez pas l'éditeur intégré.
Représentation JSON | |
---|---|
{ "baseUrl": string, "httpHeaders": { string: string, ... }, "endpointApiVersion": integer } |
Champs | |
---|---|
baseUrl |
L'URL de base HTTPS de votre point de terminaison de traitement (HTTP n'est pas accepté). Les noms des gestionnaires sont ajoutés au chemin de l'URL de base après le signe deux-points (conformément au guide de style disponible à l'adresse https://cloud.google.com/apis/design/custom_methods). Par exemple, l'URL de base https://gactions.service.com/api recevra des requêtes portant l'URL https://gactions.service.com/api:{method}. |
httpHeaders |
Map des paramètres HTTP à inclure dans la requête POST Objet contenant une liste de paires |
endpointApiVersion |
Version du protocole utilisé par le point de terminaison. Il s'agit du protocole partagé par tous les types de traitement, qui n'est pas spécifique au type de traitement Google. |
InlineCloudFunction
Contient les métadonnées d'une fonction Cloud intégrée déployée à partir du dossier des webhooks.
Représentation JSON | |
---|---|
{ "executeFunction": string } |
Champs | |
---|---|
executeFunction |
Nom du point d'entrée de la fonction Cloud. La valeur de ce champ doit correspondre au nom de la méthode exportée à partir du code source. |
Intention
Les intents mappent des entrées utilisateur ouvertes à des objets structurés. Les phrases prononcées sont mises en correspondance avec des intents grâce à la compréhension du langage naturel (NLU) de Google. Les correspondances d'intents peuvent déclencher des événements dans la conception de votre conversation pour faire avancer la conversation de l'utilisateur. Le nom de l'intent est spécifié dans le nom du fichier.
Représentation JSON | |
---|---|
{
"parameters": [
{
object ( |
Champs | |
---|---|
parameters[] |
Liste des paramètres dans les phrases d'entraînement. Tous les paramètres doivent être définis ici pour être utilisés dans la phrase d'entraînement. |
trainingPhrases[] |
Les phrases d'entraînement permettent au NLU de Google de faire automatiquement correspondre les intents à l'entrée utilisateur. Plus vous fournissez d'expressions uniques, plus cet intent a de chances d'être mis en correspondance. Voici le format de la partie de la phrase d'entraînement qui est annotée. Notez que le champ |
IntentParameter
Définition d'un paramètre pouvant être utilisé dans des phrases d'entraînement.
Représentation JSON | |
---|---|
{ "name": string, // Union field |
Champs | ||
---|---|---|
name |
Obligatoire. Nom unique du paramètre d'intent. Peut être utilisé dans des conditions et des réponses pour référencer des paramètres d'intent extraits par NLU avec $intent.params.[name].resolved |
|
Champ d'union parameter_type . Type du paramètre d'intent. parameter_type ne peut être qu'un des éléments suivants : |
||
type |
Facultatif. Déclare le type de données de ce paramètre. Cette règle ne doit pas être définie pour les intents intégrés. |
|
entitySetReferences |
Facultatif. Références aux ensembles d'entités autorisées pour ce paramètre d'intent. Valide uniquement pour les paramètres d'un intent intégré. Ces références pointent vers des ensembles d'entités du répertoire "custom/entitySets". |
ClassReference
Référence à une classe utilisée pour déclarer le type d'un champ ou d'une valeur renvoyée. Les énumérations sont également un type de classe qui peut être référencé à l'aide de ClassReference.
Représentation JSON | |
---|---|
{ "name": string, "list": boolean } |
Champs | |
---|---|
name |
Obligatoire. Nom d'un type intégré ou d'un type personnalisé de paramètre. Exemples : |
list |
Facultatif. Indique si le type de données représente une liste de valeurs. |
EntitySetReferences
Références d'ensemble d'entités pour un paramètre d'intent
Représentation JSON | |
---|---|
{
"entitySetReferences": [
{
object ( |
Champs | |
---|---|
entitySetReferences[] |
Obligatoire. Références d'ensemble d'entités pour un paramètre d'intent |
EntitySetReference
Référence à l'ensemble des entités autorisées pour ce paramètre d'intent.
Représentation JSON | |
---|---|
{ "entitySet": string } |
Champs | |
---|---|
entitySet |
Obligatoire. Identifie la collection spécifique d'entités à prendre en compte pour un paramètre donné. La définition correspondante de l'ensemble d'entités doit être présente dans le répertoire custom/entitySets/. |
Type
Déclaration d'un type personnalisé, par opposition aux types intégrés Les types peuvent être attribués aux emplacements d'une scène ou aux paramètres des phrases d'entraînement d'un intent. Dans la pratique, les types peuvent être considérés comme des énumérations. Notez que le nom du type est indiqué dans le nom du fichier.
Représentation JSON | |
---|---|
{ "exclusions": [ string ], // Union field |
Champs | ||
---|---|---|
exclusions[] |
Ensemble de mots/expressions exceptionnels qui ne doivent pas être mis en correspondance par type. Remarque: Si le mot ou l'expression correspondent au type, mais qu'ils sont répertoriés en tant qu'exclusions, ils ne seront pas renvoyés dans le résultat d'extraction des paramètres. Ce champ peut être localisé. |
|
Champ d'union sub_type . Sélection d'un sous-type en fonction du type de correspondance à effectuer. sub_type ne peut être qu'un des éléments suivants : |
||
synonym |
Type de synonymes, qui est essentiellement une énumération. |
|
regularExpression |
Type d'expression régulière : permet la mise en correspondance des expressions régulières. |
|
freeText |
Texte libre. |
SynonymType
Saisissez du texte correspondant à un ensemble de synonymes.
Représentation JSON | |
---|---|
{ "matchType": enum ( |
Champs | |
---|---|
matchType |
Facultatif. Type de correspondance du synonyme. |
acceptUnknownValues |
Facultatif. Lorsque cette règle est définie sur "true", elle met en correspondance des mots ou des expressions inconnus en fonction des données d'entrée et d'entraînement d'intent environnantes, telles que les articles pouvant être ajoutés à une liste de courses. |
entities |
Obligatoire. Carte nommée d'entités synonymes. Objet contenant une liste de paires |
MatchType
Type de correspondance utilisé par les entrées de ce type. Ainsi, tous les types utiliseront la même méthode de correspondance et autoriseront les variantes pour la correspondance avec des synonymes (floues ou exactes). Si la valeur est UNSPECIFIED
, la valeur par défaut est EXACT_MATCH
.
Enums | |
---|---|
UNSPECIFIED |
La valeur par défaut est EXACT_MATCH . |
EXACT_MATCH |
Recherche une correspondance exacte du synonyme ou du nom. |
FUZZY_MATCH |
Plus faible que EXACT_MATCH . Il recherche des correspondances similaires ainsi que des correspondances exactes. |
Entité
Représente un champ d'entité de synonyme qui contient les détails d'une seule entrée du type.
Représentation JSON | |
---|---|
{
"display": {
object ( |
Champs | |
---|---|
display |
Facultatif. Détails de l'affichage de l'entité. |
synonyms[] |
Facultatif. Liste des synonymes de l'entité. Ce champ peut être localisé. |
EntityDisplay
Éléments qui seront affichés sur le canevas une fois que l'entité d'un type particulier sera extrait d'une requête. Uniquement pertinent pour les applications compatibles avec les canevas. Ce message peut être localisé.
Représentation JSON | |
---|---|
{ "iconTitle": string, "iconUrl": string } |
Champs | |
---|---|
iconTitle |
Facultatif. Titre de l'icône. |
iconUrl |
Obligatoire. URL de l'icône. |
RegularExpressionType
Type faisant correspondre du texte à l'aide d'expressions régulières. Ce message peut être localisé.
Représentation JSON | |
---|---|
{
"entities": {
string: {
object ( |
Champs | |
---|---|
entities |
Obligatoire. Carte nommée d'entités contenant chacune des chaînes d'expressions régulières. Objet contenant une liste de paires |
Entité
Représente un objet d'entité contenant l'expression régulière utilisée pour la comparaison.
Représentation JSON | |
---|---|
{
"display": {
object ( |
Champs | |
---|---|
display |
Facultatif. Éléments qui seront affichés sur le canevas une fois qu'une entité sera extraite d'une requête. Uniquement pertinent pour les applications compatibles avec les canevas. |
regularExpressions[] |
Obligatoire. Utilise la syntaxe Regex RE2 (consultez la page https://github.com/google/re2/wiki/Syntax pour en savoir plus) |
FreeTextType
Type correspondant à n'importe quel texte si le contexte des mots environnants est proche des exemples d'entraînement fournis.
Représentation JSON | |
---|---|
{
"display": {
object ( |
Champs | |
---|---|
display |
Facultatif. Éléments qui seront affichés sur le canevas une fois qu'une entité sera extraite d'une requête. Uniquement pertinent pour les applications compatibles avec les canevas. |
EntitySet
Les ensembles d'entités décrivent l'ensemble prédéfini d'entités d'où peuvent provenir les valeurs des paramètres d'intent intégré. Les ensembles d'entités peuvent être référencés à partir d'entitySet dans les paramètres d'intent intégré.
Représentation JSON | |
---|---|
{
"entities": [
{
object ( |
Champs | |
---|---|
entities[] |
Obligatoire. Liste des entités prises en charge par cet ensemble d'entités. |
Entité
Entité dont peut provenir une valeur de paramètre d'intent intégré.
Représentation JSON | |
---|---|
{ "id": string } |
Champs | |
---|---|
id |
Obligatoire. Identifiant de l'entité. Pour obtenir la liste des paramètres d'intent intégré et des entités compatibles, consultez la page https://developers.google.com/assistant/conversational/build/built-in-intents. |
GlobalIntentEvent
Définit un gestionnaire d'intent global. Les événements d'intent globaux sont limités à l'ensemble du projet Actions et peuvent être remplacés par les gestionnaires d'intents dans une scène. Au sein d'un projet Actions, les noms d'intent doivent être uniques.
Les intents globaux peuvent être mis en correspondance à tout moment au cours d'une session, ce qui permet aux utilisateurs d'accéder à des flux courants tels que "obtenir de l'aide" ou "revenir à l'accueil". Elles peuvent également servir à rediriger les utilisateurs vers des flux spécifiques lorsqu'ils appellent une action.
Notez que le nom de l'intent est spécifié dans le nom du fichier.
Représentation JSON | |
---|---|
{
"transitionToScene": string,
"handler": {
object ( |
Champs | |
---|---|
transitionToScene |
Facultatif. Scène de destination vers laquelle la conversation doit passer. L'état de la scène actuelle est détruit lors de la transition. |
handler |
Facultatif. Gestionnaire d'événements déclenché lorsque l'intent est mis en correspondance Doit s'exécuter avant la transition vers la scène de destination. Utile pour générer des invites en réponse à des événements. |
EventHandler
Définit un gestionnaire à exécuter après un événement. Les événements basés sur un intent et une condition sont des exemples d'événements dans une scène.
Représentation JSON | |
---|---|
{ "webhookHandler": string, // Union field |
Champs | ||
---|---|---|
webhookHandler |
Nom du gestionnaire de webhook à appeler. |
|
Champ d'union prompt . Les requêtes peuvent être intégrées ou référencées par leur nom. prompt ne peut être qu'un des éléments suivants : |
||
staticPrompt |
Invite statique intégrée. Peut contenir des références à des ressources de chaîne dans des bundles. |
|
staticPromptName |
Nom de l'invite statique à appeler. |
StaticPrompt
Représente une liste d'invites candidates, dont l'une sera sélectionnée comme requête à afficher dans la réponse à l'utilisateur. Ce message peut être localisé.
Représentation JSON | |
---|---|
{
"candidates": [
{
object ( |
Champs | |
---|---|
candidates[] |
Liste des invites candidates à envoyer au client. Chaque invite dispose d'un sélecteur permettant de déterminer quand elle peut être utilisée. Le premier sélecteur qui correspond à une requête est envoyé, et les autres sont ignorés. |
StaticPromptCandidate
Représente une requête statique candidate.
Représentation JSON | |
---|---|
{ "selector": { object ( |
Champs | |
---|---|
selector |
Facultatif. Critères permettant de déterminer si cette invite correspond à une requête. Si le sélecteur est vide, cette invite se déclenchera systématiquement. |
promptResponse |
Réponse de l'invite associée au sélecteur. |
Sélecteur
Définit les critères de correspondance entre une requête et une requête.
Représentation JSON | |
---|---|
{
"surfaceCapabilities": {
object ( |
Champs | |
---|---|
surfaceCapabilities |
Ensemble des fonctionnalités de surface requises. |
SurfaceCapabilities
Représente la surface utilisée par l'utilisateur pour envoyer une requête à l'action.
Représentation JSON | |
---|---|
{
"capabilities": [
enum ( |
Champs | |
---|---|
capabilities[] |
Obligatoire. Capacités de la surface à envoyer une requête à l'action. |
Capacité
Fonctionnalités compatibles avec la surface de l'appareil au moment de la requête.
Enums | |
---|---|
UNSPECIFIED |
Capacité de surface 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 telles que des fiches, des listes et des tableaux. |
LONG_FORM_AUDIO |
L'appareil peut lire des contenus audio longs, comme de la musique et des podcasts. |
INTERACTIVE_CANVAS |
L'appareil peut afficher une réponse de canevas interactif. |
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. |
StaticPromptResponse
Représente des réponses structurées à envoyer à l'utilisateur, telles que du texte, des conversations, des cartes, des données de canevas, des chips de suggestion, etc.
Représentation JSON | |
---|---|
{ "firstSimple": { object ( |
Champs | |
---|---|
firstSimple |
Facultatif. Première réponse vocale et textuelle. |
content |
Facultatif. Contenus (par exemple, 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, qui apparaîtront toujours à la fin de la réponse. Si le champ |
link |
Facultatif. Un chip de suggestion supplémentaire qui peut rediriger vers l'application ou le site associés. Le chip s'affiche avec le titre "Ouvrir |
override |
Facultatif. Mode de fusion de ces messages avec les messages précédemment définis. |
canvas |
Réponse à utiliser pour l'expérience de canevas interactif. |
StaticSimplePrompt
Représente une invite simple à envoyer à un utilisateur.
Représentation JSON | |
---|---|
{
"variants": [
{
object ( |
Champs | |
---|---|
variants[] |
Liste des variantes possibles. |
Variant
Représente une variante faisant partie de l'invite simple.
Représentation JSON | |
---|---|
{ "speech": string, "text": string } |
Champs | |
---|---|
speech |
Facultatif. Représente la voix à énoncer. Il peut s'agir d'un balisage SSML ou d'une synthèse vocale. Par défaut, les paroles sont ajoutées à celles de l'invite simple précédente. Si le champ |
text |
Facultatif. Texte à afficher dans la bulle de chat. Si ce champ n'est pas spécifié, le rendu du champ de saisie vocale ci-dessus sera utilisé à l'écran. Limité à 640 caractères. Par défaut, le texte est ajouté au texte de l'invite simple précédente. Si le champ |
StaticContentPrompt
Espace réservé pour la partie "Contenu" d'une requête statique.
Représentation JSON | |
---|---|
{ // Union field |
Champs | ||
---|---|---|
Champ d'union content . Une requête ne peut contenir qu'un seul type de contenu. content ne peut être qu'un des éléments suivants : |
||
card |
Une carte basique |
|
image |
Image. |
|
table |
Fiche tableau. |
|
media |
Réponse indiquant un ensemble de contenus multimédias à lire. |
|
list |
Fiche présentant une liste d'options à sélectionner. |
|
collection |
Fiche présentant une liste d'options à sélectionner. |
|
collectionBrowse |
Fiche présentant un ensemble de pages Web à ouvrir. |
StaticCardPrompt
Fiche de base permettant d'afficher certaines informations, par exemple une image et/ou du texte.
Représentation JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Champs | |
---|---|
title |
Facultatif. Titre général de la fiche. |
subtitle |
Facultatif. Sous-titre de la carte. |
text |
Obligatoire. Corps du texte de la carte (obligatoire, sauf si une image est présente). Accepte un ensemble limité de syntaxes Markdown pour la mise en forme. |
image |
Facultatif. Une hero image pour la fiche. La hauteur est fixée à 192 dp. |
imageFill |
Facultatif. Façon dont l'arrière-plan de l'image sera rempli. |
button |
Facultatif. Bouton cliquable à afficher dans la fiche. |
StaticImagePrompt
Image affichée dans la fiche.
Représentation JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Champs | |
---|---|
url |
Obligatoire. URL source de l'image. Les images peuvent être au format JPG, PNG et GIF (avec ou sans animation). Exemple : |
alt |
Obligatoire. Description textuelle de l'image à utiliser pour l'accessibilité, par exemple les lecteurs d'écran. |
height |
Facultatif. Hauteur de l'image en pixels. |
width |
Facultatif. Largeur de l'image en pixels. |
ImageFill
Options d'affichage des images permettant d'affecter la présentation de l'image. Utilisez cette option lorsque le format de l'image ne correspond pas à celui du conteneur de l'image.
Enums | |
---|---|
UNSPECIFIED |
ImageFill non spécifié. |
GRAY |
Complétez les intervalles entre l'image et son conteneur à l'aide de barres grises. |
WHITE |
Remplissez les intervalles entre l'image et son conteneur à l'aide de barres blanches. |
CROPPED |
L'image est mise à l'échelle de sorte que sa largeur et sa hauteur correspondent ou dépassent les dimensions du conteneur. Cette opération peut recadrer le haut et le bas de l'image si la hauteur de l'image mise à l'échelle est supérieure à la hauteur du conteneur, ou recadrer l'image à gauche et à droite si la largeur de l'image mise à l'échelle est supérieure à la largeur du conteneur. Ce mode est semblable au mode zoom sur un téléviseur grand écran lors de la lecture d'une vidéo 4:3. |
StaticLinkPrompt
Définit un lien qui s'affiche sous la forme d'un chip de suggestion et peut être ouvert par l'utilisateur.
Représentation JSON | |
---|---|
{
"name": string,
"open": {
object ( |
Champs | |
---|---|
name |
Nom du lien |
open |
Définit le comportement lorsque l'utilisateur ouvre le lien. |
OpenUrl
Définit le comportement lorsque l'utilisateur ouvre le lien.
Représentation JSON | |
---|---|
{
"url": string,
"hint": enum ( |
Champs | |
---|---|
url |
Champ d'URL, qui peut correspondre à: - URL http/https pour ouvrir une page Web ou une application associée à une application |
hint |
Indique une indication concernant le type d'URL. |
UrlHint
Différents types de indications d'URL
Enums | |
---|---|
HINT_UNSPECIFIED |
Non spécifié |
AMP |
URL qui redirige directement vers le contenu AMP, ou vers une URL canonique qui renvoie à du contenu AMP via <link rel="amphtml"> . |
StaticTablePrompt
Fiche de tableau permettant d'afficher un tableau de texte.
Représentation JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Champs | |
---|---|
title |
Facultatif. Titre général du tableau. Doit être défini si sous-titre est défini. |
subtitle |
Facultatif. Sous-titre de la table. |
image |
Facultatif. Image associée au tableau. |
columns[] |
Facultatif. En-têtes et alignement des colonnes. |
rows[] |
Facultatif. 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é |
button |
Facultatif. Bouton. |
TableColumn
Décrit une colonne de la table.
Représentation JSON | |
---|---|
{
"header": string,
"align": enum ( |
Champs | |
---|---|
header |
Texte de l'en-tête de la colonne. |
align |
Alignement horizontal du contenu par rapport à la colonne. Si aucune valeur n'est spécifiée, le contenu sera aligné sur le bord avant. |
HorizontalAlignment
L'alignement du contenu dans la cellule.
Enums | |
---|---|
UNSPECIFIED |
HorizontalAlignment n'est pas spécifié. |
LEADING |
Bord de début 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é par rapport au bord de fin de la colonne. |
TableRow
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. |
divider |
Indique si un séparateur doit être présent après chaque ligne. |
TableCell
Décrit une cellule dans une ligne.
Représentation JSON | |
---|---|
{ "text": string } |
Champs | |
---|---|
text |
Contenu textuel de la cellule. |
StaticMediaPrompt
Contient des informations sur le support, telles que le nom, la description, l'URL, etc. Identifiant suivant: 11
Représentation JSON | |
---|---|
{ "mediaType": enum ( |
Champs | |
---|---|
mediaType |
Type de contenu de cette réponse. |
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 facultatifs compatibles avec cette session de réponse multimédia. Si cette règle est définie, la demande sera envoyée aux 3p lorsqu'un événement multimédia spécifique se produit. Si cette règle n'est pas configurée, 3p doit tout de même gérer deux types de contrôle par défaut : FINISHED (Terminé) et FAILED (ÉCHEC). |
mediaObjects[] |
Liste des objets multimédias. |
repeatMode |
Mode de répétition pour la liste des objets Media. |
MediaType
Type de contenu de cette réponse.
Enums | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
Valeur UNSPECIFIED |
AUDIO |
Fichier audio. |
MEDIA_STATUS_ACK |
Réponse pour confirmer la réception d'un rapport sur l'état du média |
OptionalMediaControls
Types de commandes multimédias que la réponse multimédia peut éventuellement prendre en charge
Enums | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Valeur non spécifiée |
PAUSED |
Événement mis en pause. Déclenchement lorsque l'utilisateur met le contenu multimédia en pause. |
STOPPED |
Événement arrêté. Déclenché lorsque l'utilisateur quitte la session tierce pendant la lecture d'un contenu multimédia. |
MediaObject
Représente un seul objet multimédia.
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. |
image |
Image à afficher avec la fiche multimédia. |
MediaImage
Image à afficher dans un MediaPrompt.
Représentation JSON | |
---|---|
{ // Union field |
Champs | ||
---|---|---|
Champ d'union image . Un seul type d'élément MediaImage est autorisé. image ne peut être qu'un des éléments suivants : |
||
large |
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. |
RepeatMode
Types de mode de répétition pour une liste d'objets multimédias.
Enums | |
---|---|
REPEAT_MODE_UNSPECIFIED |
Équivaut à l'état "Désactivé". |
OFF |
Terminer la session multimédia à la fin du dernier objet multimédia. |
ALL |
Lire en boucle le début du premier objet multimédia lorsque la fin du dernier objet multimédia est atteinte. |
StaticListPrompt
Fiche présentant une liste d'options à sélectionner.
Représentation JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Champs | |
---|---|
title |
Facultatif. Titre de la liste. |
subtitle |
Facultatif. Sous-titre de la liste. |
items[] |
Obligatoire. Éléments de liste. |
ListItem
Un élément de la liste.
Représentation JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Champs | |
---|---|
key |
Obligatoire. Clé NLU correspondant au nom de clé d'entrée dans le type associé. Lorsque l'utilisateur appuie sur l'élément, cette clé est publiée à nouveau sous la forme d'un paramètre d'option de sélection. |
title |
Obligatoire. Titre de l'article. 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 l'ensemble d'éléments. |
description |
Facultatif. Corps du texte de l'élément. |
image |
Facultatif. Image de l'article. |
StaticCollectionPrompt
Fiche présentant un ensemble d'options à sélectionner.
Représentation JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Champs | |
---|---|
title |
Facultatif. Titre de la collection. |
subtitle |
Facultatif. Sous-titre de la collection. |
items[] |
Obligatoire. Éléments de collection. |
imageFill |
Facultatif. Type d'option d'affichage d'image. |
CollectionItem
Élément de la collection.
Représentation JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Champs | |
---|---|
key |
Obligatoire. Clé NLU correspondant au nom de clé d'entrée dans le type associé. Lorsque l'utilisateur appuie sur l'élément, cette clé est publiée à nouveau sous la forme d'un paramètre d'option de sélection. |
title |
Obligatoire. Titre de l'article. 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 l'ensemble d'éléments. |
description |
Facultatif. Corps du texte de l'élément. |
image |
Facultatif. Image de l'article. |
StaticCollectionBrowsePrompt
Présente un ensemble de documents Web sous la forme d'une collection d'éléments de grande taille. Vous pouvez sélectionner des éléments pour lancer leur document Web associé dans un lecteur Web.
Représentation JSON | |
---|---|
{ "items": [ { object ( |
Champs | |
---|---|
items[] |
Éléments de la collection "Parcourir". La taille de la liste doit être comprise dans la plage [2, 10]. |
imageFill |
Option d'affichage des images de la collection. |
CollectionBrowseItem
É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'article de collection affiché sous la description. Une seule ligne de texte, tronquée par des points de suspension |
image |
Image de l'élément de la collection. |
openUriAction |
Obligatoire. URI à ouvrir si l'élément est sélectionné. |
Suggestion
Représente un chip de suggestion, un élément d'interface utilisateur présenté à l'utilisateur pour plus de commodité.
Représentation JSON | |
---|---|
{ "title": string } |
Champs | |
---|---|
title |
Obligatoire. 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. |
StaticCanvasPrompt
Représente une réponse Interactive Canvas à envoyer à l'utilisateur. Vous pouvez l'utiliser conjointement avec le champ firstSimple
dans l'invite associée pour parler à l'utilisateur en plus d'afficher une réponse de canevas interactif.
Représentation JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean, "sendStateDataToCanvasApp": boolean, "enableFullScreen": boolean } |
Champs | |
---|---|
url |
Obligatoire. URL de la vue Web à charger. |
data[] |
Facultatif. Données JSON à transmettre à la page Web de l'expérience immersive en tant qu'événement. Si le champ |
suppressMic |
Facultatif. Si la valeur est "true", le micro n'est pas activé pour capturer l'entrée après que cette réponse immersive a été présentée à l'utilisateur. |
sendStateDataToCanvasApp |
Facultatif. Si la valeur est |
enableFullScreen |
Facultatif. Si la valeur est |
Scene
La scène est l'unité de base du flux de contrôle lors de la conception d'une conversation. Ils peuvent être enchaînés avec d'autres scènes, générer des invites pour l'utilisateur final et définir des emplacements. Le nom de la scène est spécifié dans le nom du fichier.
Représentation JSON | |
---|---|
{ "onEnter": { object ( |
Champs | |
---|---|
onEnter |
Gestionnaire à invoquer lors de la transition vers cette scène |
intentEvents[] |
Liste des événements qui se déclenchent en fonction des intents. Ces événements peuvent être déclenchés à tout moment après l'appel du gestionnaire on_load. Important : Ces événements définissent l'ensemble d'intents limités à cette scène et prévalent sur tous les événements définis globalement qui ont les mêmes intents ou leurs phrases de déclenchement. Les noms d'intent doivent être uniques au sein d'une scène. |
conditionalEvents[] |
Liste des événements à déclencher en fonction d'instructions conditionnelles. Elles sont évaluées une fois le formulaire rempli ou immédiatement après on_load si cette scène ne contient pas de formulaire (l'évaluation n'est effectuée qu'une seule fois). Seul le premier événement correspondant sera déclenché. |
slots[] |
Liste numérotée des emplacements. Chaque emplacement définit le type de données qu'il résoudrea et la configuration permettant de personnaliser l'expérience associée à cette résolution (par exemple, les invites). |
onSlotUpdated |
Gestionnaire appelé lorsque l'état d'un emplacement change non causé par des mises à jour dans un autre gestionnaire. Cela permet d'invalider des emplacements, de invalider la scène et d'apporter d'autres changements à l'état de la scène. |
IntentEvent
Enregistre les événements qui se déclenchent à la suite d'une correspondance d'intent.
Représentation JSON | |
---|---|
{
"intent": string,
"transitionToScene": string,
"handler": {
object ( |
Champs | |
---|---|
intent |
Obligatoire. Intent déclenchant l'événement. |
transitionToScene |
Facultatif. Scène de destination vers laquelle la conversation doit passer. L'état de la scène actuelle est détruit lors de la transition. |
handler |
Facultatif. Gestionnaire d'événements déclenché lorsque l'intent est mis en correspondance Doit s'exécuter avant la transition vers la scène de destination. Utile pour générer des requêtes en réponse à des événements. |
ConditionalEvent
Enregistre les événements qui se déclenchent à la suite d'une condition remplie.
Représentation JSON | |
---|---|
{
"condition": string,
"transitionToScene": string,
"handler": {
object ( |
Champs | |
---|---|
condition |
Obligatoire. Condition de filtre de déclenchement de cet événement Si la condition est évaluée "true", l' |
transitionToScene |
Facultatif. Scène de destination à laquelle la conversation doit accéder lorsque la condition associée est évaluée "true". L'état de la scène actuelle est détruit lors de la transition. |
handler |
Facultatif. Gestionnaire d'événements qui se déclenche lorsque la condition associée est évaluée sur |
Encoche
Configuration d'un emplacement. Les emplacements sont des unités de données uniques qui peuvent être remplies via le langage naturel (paramètres d'intent), les paramètres de session et d'autres sources.
Représentation JSON | |
---|---|
{ "name": string, "type": { object ( |
Champs | |
---|---|
name |
Obligatoire. Nom de l'espace publicitaire. |
type |
Obligatoire. Déclare le type de données de cet emplacement. |
required |
Facultatif. Indique si l'espace publicitaire doit être rempli avant l'avancement. Les emplacements obligatoires qui n'ont pas été remplis déclencheront une invite personnalisable destinée à l'utilisateur. |
promptSettings |
Facultatif. Enregistre des invites pour différentes étapes de remplissage d'emplacements. |
commitBehavior |
Facultatif. Comportement de commit associé à l'emplacement |
config |
Facultatif. Configuration supplémentaire associée à l'emplacement utilisé pour le remplir. Le format de la configuration est spécifique au type d'emplacement. Des références de ressources aux paramètres d'utilisateur ou de session peuvent être ajoutées à cette configuration. Cette configuration est nécessaire pour remplir les emplacements liés aux transactions et à l'engagement utilisateur. Exemple: pour un emplacement de type actions.type.CompletePurchaseValue, la configuration suivante propose une commande de produit numérique avec une référence à un paramètre de session défini par le client { "@type": "type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec", "skuId": { "skuType": "SKU_TYPE_IN_APP", "id": "$session.params.userSelectedSkuId", "packageName": "com.example.company" } } |
defaultValue |
Facultatif. Configuration permettant de renseigner une valeur par défaut pour cet emplacement. |
PromptSettings
Un emplacement unique où les invites d'emplacements sont définies.
Représentation JSON | |
---|---|
{ "initialPrompt": { object ( |
Champs | |
---|---|
initialPrompt |
Invite pour la valeur de l'espace publicitaire. Exemple: "Quelle taille souhaitez-vous utiliser ?" |
noMatchPrompt1 |
Invite à être donnée lorsque l'entrée utilisateur ne correspond pas au type de valeur attendu pour l'emplacement pour la première fois. Exemple: "Désolé, je n'ai pas compris." |
noMatchPrompt2 |
Invite à être donnée lorsque l'entrée utilisateur ne correspond pas au type de valeur attendu pour l'emplacement pour la deuxième fois. Exemple: "Désolé, je n'ai pas compris." |
noMatchFinalPrompt |
Invite à être donnée lorsque l'entrée utilisateur ne correspond pas au type de valeur attendu pour l'emplacement pour la dernière fois. Exemple: "Désolé, je n'ai pas compris." |
noInputPrompt1 |
Invite à donner lorsque l'utilisateur ne fournit pas d'entrée pour la première fois. Exemple: "Désolé, je n'ai pas compris." |
noInputPrompt2 |
Invite à donner lorsque l'utilisateur ne fournit pas d'entrée pour la deuxième fois. Exemple: "Désolé, je n'ai pas compris." |
noInputFinalPrompt |
Invite à donner lorsque l'utilisateur n'a pas fourni d'entrée pour la dernière fois. Exemple: "Désolé, je n'ai pas compris." |
CommitBehavior
Message décrivant le comportement de commit associé à l'emplacement une fois celui-ci rempli.
Représentation JSON | |
---|---|
{ "writeSessionParam": string } |
Champs | |
---|---|
writeSessionParam |
Paramètre de session permettant d'écrire la valeur de l'espace publicitaire une fois celui-ci rempli. Notez que les chemins d'accès imbriqués ne sont actuellement pas acceptés. "$$" permet d'écrire la valeur de l'emplacement dans un paramètre de session portant le même nom que l'emplacement. Par exemple: writeSessionParam = "fruit" correspond à "$session.params.fruit". writeSessionParam = "ticket" correspond à "$session.params.ticket". |
DefaultValue
Configuration permettant de renseigner une valeur par défaut pour cet emplacement.
Représentation JSON | |
---|---|
{ "sessionParam": string, "constant": value } |
Champs | |
---|---|
sessionParam |
Facultatif. Paramètre de session à utiliser pour initialiser la valeur de l'emplacement, si la valeur n'est pas vide. Le type de la valeur doit correspondre au type de l'espace publicitaire. Notez que les chemins d'accès imbriqués ne sont actuellement pas acceptés. Par exemple, |
constant |
Facultatif. Valeur par défaut constante de l'espace publicitaire. Il ne sera utilisé que si une valeur n'a pas été renseignée pour cet emplacement via la propriété |
DataFiles
Enveloppe pour le fichier de données répété. Les champs répétés ne peuvent pas exister dans un élément oneof.
Représentation JSON | |
---|---|
{
"dataFiles": [
{
object ( |
Champs | |
---|---|
dataFiles[] |
Plusieurs fichiers de données |
DataFile
Représente un fichier unique contenant des données non structurées. Exemples : fichiers image, fichiers audio et code source de la fonction Cloud.
Représentation JSON | |
---|---|
{ "filePath": string, "contentType": string, "payload": string } |
Champs | |
---|---|
filePath |
Chemin d'accès relatif du fichier de données à partir de la racine du projet dans la structure de fichiers du SDK. Chemins d'accès aux fichiers autorisés : - Images : |
contentType |
Obligatoire. Type de contenu de cet asset. Exemple : |
payload |
Contenu du fichier de données. Il peut s'agir d'octets bruts d'images, de fichiers audio ou de fichiers ZIP au format Cloud Functions. La taille de la charge utile est limitée à 10 Mo. Chaîne encodée en base64. |