- Représentation JSON
- ConfigFiles
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ConfigFile
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Fichier manifeste
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Actions
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CustomAction
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Engagement
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PushNotification
- DailyUpdate
- ActionLink
- AssistantLink
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Paramètres
- Catégorie
- SurfaceRequirements
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CapabilityRequirement
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- SurfaceCapability
- LocalizedSettings
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ThemeCustomization
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ImageCornerStyle
- AccountLinking
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- LinkingType
- AuthGrantType
- Webhook
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Gestionnaire
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- HttpsEndpoint
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- InlineCloudFunction
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Intention
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- IntentParameter
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ClassReference
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- EntitySetReferences
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- EntitySetReference
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Type
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- SynonymType
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- MatchType
- Entity
- EntityDisplay
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- RegularExpressionType
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Entity
- FreeTextType
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- EntitySet
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Entity
- GlobalIntentEvent
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- EventHandler
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- StaticPrompt
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- StaticPromptCandidate
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Sélecteur
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- SurfaceCapabilities
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Capacité
- StaticPromptResponse
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- StaticSimplePrompt
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Variante
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- StaticContentPrompt
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- StaticCardPrompt
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- StaticImagePrompt
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ImageFill
- StaticLinkPrompt
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- OpenUrl
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- UrlHint
- StaticTablePrompt
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- TableColumn
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- HorizontalAlignment
- TableRow
- TableCell
- StaticMediaPrompt
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- MediaType
- OptionalMediaControls
- MediaObject
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- MediaImage
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- RepeatMode
- StaticListPrompt
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ListItem
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- StaticCollectionPrompt
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CollectionItem
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- StaticCollectionBrowsePrompt
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CollectionBrowseItem
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Suggestion
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- StaticCanvasPrompt
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Scène
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- IntentEvent
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ConditionalEvent
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Encoche
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PromptSettings
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CommitBehavior
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- DefaultValue
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- DataFiles
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- DataFile
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
Enveloppe pour une liste de fichiers.
Représentation JSON | |
---|---|
{ // Union field |
Champs | ||
---|---|---|
Champ d'union file_type . Un seul type de fichiers 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. Cela inclut l'image, le fichier audio et le code source de la fonction Cloud. |
ConfigFiles
Enveloppe pour les fichiers de configuration répétés. Un champ oneof ne peut pas contenir de champs répétés.
Représentation JSON | |
---|---|
{
"configFiles": [
{
object ( |
Champs | |
---|---|
configFiles[] |
Plusieurs fichiers de configuration. |
ConfigFile
Représente un fichier unique 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 fulfillment.
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 est associé à 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 le oneof. file ne peut être qu'un des éléments suivants : |
||
manifest |
Fichier manifeste unique. Chemin d'accès au fichier autorisé: |
|
actions |
Fichier unique contenant toutes les actions définies. Chemins d'accès aux fichiers autorisés: |
|
settings |
Configuration de paramètres unique qui inclut des paramètres non localisables et ceux des paramètres régionaux par défaut du projet (si spécifiés). Dans le cas d'un fichier de remplacement des paramètres régionaux, seul le champ localizedSettings sera renseigné. Chemins d'accès aux fichiers autorisés: |
|
webhook |
Définition d'un 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 scène unique Chemins d'accès aux fichiers autorisés: |
|
staticPrompt |
Définition d'une requête statique unique. Chemins d'accès aux fichiers autorisés: |
|
accountLinkingSecret |
Métadonnées correspondant au code secret du client utilisé pour l'association de comptes. Chemin d'accès au fichier autorisé: |
|
resourceBundle |
Groupe de ressources unique, qui consiste à mapper une chaîne avec une chaîne ou une liste de chaînes. Les groupes de ressources peuvent être utilisés pour localiser des chaînes dans des requêtes statiques. Chemins d'accès aux fichiers autorisés: |
Fichier manifeste
Contient des informations qui sont "transportables" Elles ne sont donc pas spécifiques à un projet donné et peuvent être déplacées d'un projet à l'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 |
Mappez les intents à des actions personnalisées pour configurer un appel pour le projet. Les intents d'appel peuvent être des intents système ou personnalisés définis dans la section "custom/intents/" d'un package. Tous les intents définis ici (intents système et intents personnalisés) doivent avoir un fichier d'intent correspondant dans la section "custom/global/" d'un package. Objet contenant une liste de paires |
CustomAction
Informations sur 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 actualités quotidiennes. Notez que le nom de l'intent spécifié dans la configuration de l'emplacement des mises à jour quotidiennes/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 demander leur autorisation pour recevoir des informations. L'invite envoyée aux utilisateurs finaux pour les notifications quotidiennes sera du type "À quelle heure voulez-vous que je vous envoie votre {title}" chaque jour et pour les notifications push, il s'affichera 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 d'un lien pour une action qui détermine si le partage de liens est activé pour l'action et, le cas échéant, contient le nom à afficher convivial du lien. ActionLink est obsolète. Utilisez AssistantLink à la place. |
assistantLink |
Configuration d'un lien pour une action qui détermine si le partage de liens est activé 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 le partage de liens est activé pour cette action et les paramètres correspondants. Les liens d'action sont utilisés pour rediriger un utilisateur vers une action spécifique via un lien profond. ActionLink est obsolète. Utilisez AssistantLink à la place.
Représentation JSON | |
---|---|
{ "title": string } |
Champs | |
---|---|
title |
Titre à afficher convivial pour le lien. |
AssistantLink
Indique si le partage de liens est activé 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, qui sont les paramètres par défaut du projet. Pour tous les fichiers, à l'exception des fichiers |
enabledRegions[] |
Représente les régions dans lesquelles les utilisateurs peuvent appeler vos actions, en fonction de leur position géographique. Ne peut pas être défini si |
disabledRegions[] |
Représente les régions dans lesquelles vos actions sont bloquées, en fonction de l'emplacement de l'utilisateur. Ne peut pas être défini si |
category |
Catégorie de ce projet Actions. |
usesTransactionsApi |
Indique si les actions peuvent utiliser des transactions (par exemple, effectuer des réservations, accepter des commandes, etc.) Si elle est définie sur "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 personnel. |
designedForFamily |
Indique si le contenu Actions est destiné à tous les publics |
containsAlcoholOrTobaccoContent |
Indique si les actions incluent du contenu lié à l'alcool ou au tabac |
keepsMicOpen |
Indique si les actions peuvent laisser le micro ouvert sans invite explicite pendant la conversation. |
surfaceRequirements |
Exigences concernant la surface qu'une surface client doit prendre en charge pour appeler des actions dans ce projet. |
testingInstructions |
Instructions de test au format libre pour l'examinateur des actions (instructions d'association de comptes, par exemple) |
localizedSettings |
Paramètres localisés pour les paramètres régionaux par défaut du projet. Chaque paramètre régional supplémentaire doit disposer de 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 Google Play lors des transactions Cette sélection fait partie des 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
Choix des catégories pour un projet Actions.
Enums | |
---|---|
CATEGORY_UNSPECIFIED |
Inconnu / Non spécifié. |
BUSINESS_AND_FINANCE |
Entreprises 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 |
Catégorie "Santé et remise en forme". |
KIDS_AND_FAMILY |
catégorie "Enfants et famille". |
LIFESTYLE |
Catégorie "Style de vie". |
LOCAL |
Catégorie locale. |
MOVIES_AND_TV |
Films et séries. |
MUSIC_AND_AUDIO |
dans la catégorie "Musique et audio". |
NEWS |
Catégorie Actualités, |
NOVELTY_AND_HUMOR |
Catégorie Fantaisie et Humour. |
PRODUCTIVITY |
Catégorie de productivité. |
SHOPPING |
Catégorie "Achat". |
SOCIAL |
Catégorie sociale. |
SPORTS |
Sports. |
TRAVEL_AND_TRANSPORTATION |
Voyage et transports. |
UTILITIES |
Catégorie "Utilitaires". |
WEATHER |
Catégorie "Météo". |
HOME_CONTROL |
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 requis pour appeler les actions dans votre projet. S'il manque l'un de ces éléments sur la surface, l'action n'est 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 capacités de surface.
Enums | |
---|---|
SURFACE_CAPABILITY_UNSPECIFIED |
Inconnu / Non spécifié. |
AUDIO_OUTPUT |
Le Surface est compatible avec la sortie audio. |
SCREEN_OUTPUT |
Surface prend en charge la sortie écran/visuelle. |
MEDIA_RESPONSE_AUDIO |
Le Surface est compatible avec les réponses audio de contenus multimédias. |
WEB_BROWSER |
Le Surface est compatible avec les navigateurs Web. |
ACCOUNT_LINKING |
Surface est compatible avec l'association de comptes. |
INTERACTIVE_CANVAS |
Surface est compatible avec Interactive Canvas. |
HOME_STORAGE |
Le Surface est compatible avec le stockage domestique. |
LocalizedSettings
Représente les paramètres d'un projet Actions spécifiques aux paramètres régionaux de l'utilisateur. Dans ce cas, "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 permettant de l'appeler dans un contexte vocal (prononcé). |
shortDescription |
Obligatoire. Brève description par défaut du projet Actions (si aucune traduction n'est disponible). Limite de 80 caractères. |
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 de 192 x 192 pixels. Il doit être spécifié comme référence à l'image correspondante dans le répertoire |
largeBannerImage |
Facultatif. Grande image en mode paysage de 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 pour les 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é, les paramètres régionaux sont appliqués à l'Assistant pour l'utilisateur. Si elle est spécifiée, les paramètres régionaux de la voix doivent avoir 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. Agit comme une solution de secours si |
primaryColor |
La couleur du thème principal de l'action sera utilisée pour définir la couleur du texte du titre et de l'arrière-plan de l'action pour les cartes Actions on Google. Exemple d'utilisation: #FAFA |
fontFamily |
Famille de polices qui sera utilisée pour le titre des cartes. Polices compatibles: - Sans Serif - Sans Serif Medium - Sans Serif Bold - Sans Serif Black - Sans Serif Condensed - Sans Serif Condensed Medium - Serif - Serif Bold - Monospace - Cursive - Sans Serif Smallcaps |
imageCornerStyle |
Style de bordure de l'image au premier plan de cartes. Par exemple, il peut s'appliquer à l'image de premier plan d'une fiche basique 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 de guider l'utilisateur pour qu'il se connecte aux services Web de l'application.
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'interface utilisateur de la console). Ce champ est en lecture seule et peut être vérifié 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 test dans Settings.testing_instructions afin que l'équipe chargée de l'examen puisse examiner l'application (ils ne seront pas visibles par les utilisateurs).
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 le type de liaison OAUTH. |
appClientId |
Facultatif. ID client attribué par votre application à Google. Il s'agit de l'ID client OAuth2 qui identifie 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 le protocole OAuth avec l'attribution 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 utiliser votre service. Défini uniquement lors de l'utilisation d'OAuth. Si vous spécifiez ce champ, veillez à fournir des conditions d'utilisation dans les informations du répertoire de 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, veillez à fournir des conditions d'utilisation dans les informations du répertoire de la section LocalizedSettings.terms_of_service_url. |
useBasicAuthHeader |
Facultatif. Si la valeur est "true", autorisez Google à 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 de l'article. Défini uniquement lors de l'utilisation d'OAuth. Si vous spécifiez ce champ, veillez à fournir des conditions d'utilisation dans les informations du répertoire de la section LocalizedSettings.terms_of_service_url. |
LinkingType
Type d'association de comptes à effectuer.
Enums | |
---|---|
LINKING_TYPE_UNSPECIFIED |
Non spécifié. |
GOOGLE_SIGN_IN |
Type d'association à Google Sign-In. Si vous utilisez ce type d'association, aucun champ lié à OAuth ne doit ê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 utilisé par Google pour guider l'utilisateur à se connecter au service Web de votre application.
Enums | |
---|---|
AUTH_GRANT_TYPE_UNSPECIFIED |
Non spécifié. |
AUTH_CODE |
Octroi du code d'autorisation. Vous devez fournir une URL d'authentification et une URL de jeton d'accès. |
IMPLICIT |
Attribution 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, une valeur 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 de 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 de webhook personnalisé. |
|
inlineCloudFunction |
Métadonnées de la fonction Cloud déployée à partir du code du 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 le code source de votre fulfillment. |
HttpsEndpoint
Point de terminaison REST à 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 compatible). Les noms de gestionnaire sont ajoutés au chemin de l'URL de base après le signe deux-points (en suivant le 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 les requêtes comportant l'URL "https://gactions.service.com/api:{method}". |
httpHeaders |
Carte 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 traitements et non 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 "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 les entrées utilisateur ouvertes avec des objets structurés. Les expressions vocales sont mises en correspondance avec des intents à l'aide de la technologie Natural Language Understanding (NLU) de Google. Les correspondances d'intent 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 pouvoir être utilisés dans la phrase d'entraînement. |
trainingPhrases[] |
Les phrases d'entraînement permettent à la NLU de Google de mettre automatiquement en correspondance les intents avec les entrées utilisateur. Plus le nombre d'expressions uniques fournies est important, plus cet intent a de chances d'être mis en correspondance. Voici le format de la partie de phrase d'entraînement annotée. Notez que le champ |
IntentParameter
Définition d'un paramètre pouvant être utilisé dans les 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 les conditions et les réponses pour référencer des paramètres d'intent extraits par la 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 valeur 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. N'est valide que pour les paramètres d'un intent intégré. Ces références pointent vers les ensembles d'entités de l'ensemble "custom/entitySets" . |
ClassReference
Référence à une classe utilisée pour déclarer le type d'un champ ou d'une valeur de retour. 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é du paramètre. Exemples : |
list |
Facultatif. Indique si le type de données représente une liste de valeurs. |
EntitySetReferences
Références d'ensembles d'entités pour un paramètre d'intent.
Représentation JSON | |
---|---|
{
"entitySetReferences": [
{
object ( |
Champs | |
---|---|
entitySetReferences[] |
Obligatoire. Références d'ensembles 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 de l'ensemble d'entités correspondant doit figurer 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 à des emplacements dans 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 spécifié dans le nom du fichier.
Représentation JSON | |
---|---|
{ "exclusions": [ string ], // Union field |
Champs | ||
---|---|---|
exclusions[] |
Ensemble de mots ou expressions exceptionnels ne devant pas correspondre à leur type. Remarque: Si un mot/une expression est mis en correspondance par le type, mais qu'il est répertorié en tant qu'exclusion, il n'est pas renvoyé dans le résultat de l'extraction du paramètre. 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 |
de type 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 |
FreeText. |
SynonymType
Type qui correspond au texte par ensemble de synonymes.
Représentation JSON | |
---|---|
{ "matchType": enum ( |
Champs | |
---|---|
matchType |
Facultatif. Type de correspondance du synonyme. |
acceptUnknownValues |
Facultatif. Si cette règle est définie sur "true", cela met en correspondance des mots ou des expressions inconnus en fonction des données d'entraînement d'entrée et d'intent environnantes, tels que les articles qui peuvent être ajoutés à une liste de courses. |
entities |
Obligatoire. Mappage nommé 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 utilisent la même méthode de mise en correspondance et permettent des variantes pour les correspondances de synonymes (par exemple, partielles 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 bas que EXACT_MATCH . Recherche des correspondances exactes et des correspondances exactes. |
Entité
Représente un champ d'entité de synonymes contenant les détails d'une seule entrée du type.
Représentation JSON | |
---|---|
{
"display": {
object ( |
Champs | |
---|---|
display |
Facultatif. Détails d'affichage de l'entité. |
synonyms[] |
Facultatif. Liste des synonymes de l'entité. Ce champ peut être localisé. |
EntityDisplay
Éléments qui s'afficheront sur le canevas une fois que l'entité d'un type particulier sera extraite 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 qui correspond au texte par expressions régulières. Ce message peut être localisé.
Représentation JSON | |
---|---|
{
"entities": {
string: {
object ( |
Champs | |
---|---|
entities |
Obligatoire. Mappage nommé des entités, qui contiennent chacune des chaînes d'expression régulière. Objet contenant une liste de paires |
Entité
Représente un objet d'entité contenant l'expression régulière utilisée à des fins de 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 d'expression régulière RE2. Pour en savoir plus, consultez https://github.com/google/re2/wiki/Syntax. |
FreeTextType
Saisissez le texte 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 dont peuvent provenir les valeurs des paramètres d'intent intégrés. Les ensembles d'entités peuvent être référencés à partir d'entités "entitySet" dans les paramètres d'intent intégrés.
Représentation JSON | |
---|---|
{
"entities": [
{
object ( |
Champs | |
---|---|
entities[] |
Obligatoire. Liste des entités compatibles avec 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és et des entités compatibles, consultez 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'intent dans une scène. Les noms d'intent doivent être uniques au sein d'un projet Actions.
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 « retourner à 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 à laquelle la conversation doit accéder. L'état de la scène actuelle est détruit lors de la transition. |
handler |
Facultatif. Gestionnaire d'événements qui est 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. |
EventHandler
Définit un gestionnaire à exécuter après un événement. Les événements basés sur des intents et des conditions dans une scène sont des exemples d'événements.
Représentation JSON | |
---|---|
{ "webhookHandler": string, // Union field |
Champs | ||
---|---|---|
webhookHandler |
Nom du gestionnaire de webhooks à 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 |
Requête statique intégrée. Peut contenir des références à des ressources de chaîne dans les bundles. |
|
staticPromptName |
Nom de la requête statique à appeler. |
StaticPrompt
Représente une liste de propositions d'invites, dont l'une sera sélectionnée en tant qu'invite à 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 requête est associée à un sélecteur pour déterminer quand l'utiliser. 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 pour déterminer si cette requête correspond à une requête. Si le sélecteur est vide, cette invite est toujours déclenchée. |
promptResponse |
Réponse d'invite associée au sélecteur. |
Sélecteur
Définit les critères pour déterminer si une requête correspond à 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. Les capacités de la surface qui envoie 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, comme des fiches, des listes et des tableaux. |
LONG_FORM_AUDIO |
L'appareil peut lire des contenus multimédias audio longs comme de la musique et des podcasts. |
INTERACTIVE_CANVAS |
L'appareil peut afficher une réponse de canevas interactive. |
WEB_LINK |
L'appareil peut utiliser des liens Web dans les réponses enrichies pour ouvrir un navigateur Web. |
HOME_STORAGE |
L'appareil permet d'enregistrer et de récupérer l'espace de stockage de la maison. |
StaticPromptResponse
Représente les réponses structurées à envoyer à l'utilisateur, telles que du texte, des conversations, des fiches, des données de canevas, des chips de suggestion, etc.
Représentation JSON | |
---|---|
{ "firstSimple": { object ( |
Champs | |
---|---|
firstSimple |
Facultatif. Première réponse vocale et texte uniquement. |
content |
Facultatif. Contenu tel qu'une carte, une liste ou un contenu multimédia à présenter à l'utilisateur. |
lastSimple |
Facultatif. Dernière réponse vocale et textuelle. |
suggestions[] |
Facultatif. Suggestions à présenter à l'utilisateur et apparaîtront toujours à la fin de la réponse. Si le champ |
link |
Facultatif. Chip de suggestion supplémentaire pouvant rediriger les utilisateurs vers l'application ou le site associé. Le chip s'affichera avec le titre "Ouvrir |
override |
Facultatif. Mode de fusion des messages avec des messages définis précédemment. |
canvas |
Réponse à utiliser pour l'expérience interactive sur le canevas. |
StaticSimplePrompt
Représente une requête simple à envoyer à un utilisateur.
Représentation JSON | |
---|---|
{
"variants": [
{
object ( |
Champs | |
---|---|
variants[] |
Liste des variantes possibles. |
Variant
Représente une variante qui fait partie de la requête simple.
Représentation JSON | |
---|---|
{ "speech": string, "text": string } |
Champs | |
---|---|
speech |
Facultatif. Représente le discours à prononcer à l'utilisateur. Il peut s'agir de messages SSML ou de synthèse vocale. Par défaut, les paroles sont ajoutées à celles de la requête Simple précédente. Si le champ |
text |
Facultatif. Texte à afficher dans la bulle de chat. S'il n'est pas fourni, un rendu par affichage du champ vocal ci-dessus sera utilisé. Limité à 640 caractères. Par défaut, le texte est ajouté au texte de la requête 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 du tableau. |
|
media |
Réponse indiquant un ensemble de contenus multimédias à lire. |
|
list |
Fiche présentant une liste d'options disponibles. |
|
collection |
Fiche présentant une liste d'options disponibles. |
|
collectionBrowse |
Fiche présentant un ensemble de pages Web à ouvrir. |
StaticCardPrompt
Une carte basique permettant d'afficher certaines informations (par exemple, une image et/ou un 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 fiche. |
text |
Obligatoire. Corps du texte de la carte, qui est nécessaire à moins qu'une image ne soit présente. Accepte un ensemble limité de syntaxes Markdown pour la mise en forme. |
image |
Facultatif. Une image héros pour la carte. La hauteur est fixe à 192 dp. |
imageFill |
Facultatif. Mode de remplissage de l'arrière-plan de l'image. |
button |
Facultatif. Bouton cliquable à afficher dans la fiche. |
StaticImagePrompt
Une image affichée dans la carte.
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 (animé ou non). Exemple : |
alt |
Obligatoire. Description textuelle de l'image à utiliser pour l'accessibilité, par exemple avec des lecteurs d'écran. |
height |
Facultatif. Hauteur de l'image en pixels. |
width |
Facultatif. Largeur de l'image en pixels. |
ImageFill
Options d'affichage possibles pour modifier la présentation de l'image. Utilisez cette option lorsque les proportions de l'image ne correspondent pas à celles du conteneur de l'image.
Enums | |
---|---|
UNSPECIFIED |
ImageFill non spécifiée. |
GRAY |
Utilisez des barres grises pour combler les espaces entre l'image et le conteneur de l'image. |
WHITE |
Utilisez des barres blanches pour remplir les espaces entre l'image et le conteneur de l'image. |
CROPPED |
L'image est mise à l'échelle de sorte que sa largeur et sa hauteur correspondent ou dépassent les dimensions du conteneur. Cela peut recadrer le haut et le bas de l'image si la hauteur de l'image mise à l'échelle est supérieure à celle du conteneur, ou recadrer l'image à gauche et à droite si la largeur de l'image mise à l'échelle est supérieure à celle du conteneur. Semblable au mode Zoom sur un téléviseur grand écran lors de la lecture d'une vidéo 4:3. |
StaticLinkPrompt
Définit un lien qui s'affichera sous forme de 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 contenir l'un des éléments suivants: - URL http/https permettant d'ouvrir une application associée à une application ou une page Web |
hint |
Indique une indication pour le type d'URL. |
UrlHint
Différents types d'indications d'URL.
Enums | |
---|---|
HINT_UNSPECIFIED |
Non spécifié |
AMP |
URL qui redirige directement vers un contenu AMP ou vers une URL canonique faisant référence à du contenu AMP via <link rel="amphtml"> . |
StaticTablePrompt
Fiche du tableau permettant d'afficher un tableau de texte.
Représentation JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Champs | |
---|---|
title |
Facultatif. Titre général de la table. Doit être défini si sous-titre est défini. |
subtitle |
Facultatif. Sous-titre du tableau. |
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é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é |
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 de la colonne de pondération du contenu. S'il n'est pas spécifié, le contenu sera aligné sur le bord initial. |
HorizontalAlignment
Alignement du contenu dans la cellule.
Enums | |
---|---|
UNSPECIFIED |
HorizontalAlignment non spécifié. |
LEADING |
Bord initial de la cellule. Il s'agit de la valeur par défaut. |
CENTER |
Le contenu est aligné au centre de la colonne. |
TRAILING |
Le contenu est aligné sur le bord final de la colonne. |
Ligne de tableau
Décrit une ligne du tableau.
Représentation JSON | |
---|---|
{
"cells": [
{
object ( |
Champs | |
---|---|
cells[] |
Cellules de cette ligne. L'affichage des trois premières cellules est garanti, mais d'autres peuvent être coupés sur certaines surfaces. Effectuez un test avec le simulateur pour voir quelles cellules seront affichées pour une surface donnée. |
divider |
Indique s'il doit y avoir un séparateur après chaque ligne. |
TableCell
Décrit une cellule dans une ligne.
Représentation JSON | |
---|---|
{ "text": string } |
Champs | |
---|---|
text |
Contenu textuel de la cellule. |
StaticMediaPrompt
Contient des informations sur le contenu multimédia, telles que le nom, la description, l'URL, etc. Identifiant suivant: 11
Représentation JSON | |
---|---|
{ "mediaType": enum ( |
Champs | |
---|---|
mediaType |
Type de support 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 facultatives compatibles avec cette session de réponse multimédia. Si cette règle est définie, la requête est envoyée à 3p lorsqu'un événement multimédia donné se produit. Si cette règle n'est pas configurée, 3p doit tout de même gérer deux types de commandes par défaut : FINISHED et FAILED. |
mediaObjects[] |
Liste des objets multimédias. |
repeatMode |
Mode de répétition pour la liste des objets Media. |
MediaType
Type de support de cette réponse.
Enums | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
Valeur NON SPÉCIFIÉE |
AUDIO |
Fichier audio. |
MEDIA_STATUS_ACK |
Réponse pour accuser réception d'un rapport d'état du contenu multimédia. |
OptionalMediaControls
Types de commandes multimédias compatibles avec la réponse multimédia
Enums | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Valeur non spécifiée |
PAUSED |
Événement mis en veille. Déclenchement lorsque l'utilisateur met le contenu multimédia en pause. |
STOPPED |
Événement arrêté. Déclenchement lorsque l'utilisateur quitte la session 3p pendant la lecture d'un contenu multimédia. |
MediaObject
Représente un objet multimédia unique.
Représentation JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
Champs | |
---|---|
name |
Nom de cet objet multimédia. |
description |
Description de cet objet multimédia. |
url |
URL pointant vers le contenu multimédia. |
image |
Image à afficher avec la fiche multimédia. |
MediaImage
Image à afficher dans une MediaPrompt.
Représentation JSON | |
---|---|
{ // Union field |
Champs | ||
---|---|---|
Champ d'union image . Un seul type est autorisé pour MediaImage. 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 s'affiche à droite du titre. Elle est redimensionnée à 36 x 36 dp. |
RepeatMode
Types de mode de répétition pour une liste d'objets multimédias.
Enums | |
---|---|
REPEAT_MODE_UNSPECIFIED |
Équivaut à OFF. |
OFF |
La session multimédia s'arrête à la fin du dernier objet multimédia. |
ALL |
Effectuez une boucle jusqu'au début du premier objet multimédia lorsque la fin du dernier objet multimédia est atteinte. |
StaticListPrompt
Fiche présentant une liste d'options disponibles.
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
Élément dans la liste.
Représentation JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Champs | |
---|---|
key |
Obligatoire. Clé NLU correspondant au nom de la clé d'entrée dans le type associé. Lorsque l'utilisateur appuie sur l'élément, cette clé est publiée en tant que paramètre d'option de sélection. |
title |
Obligatoire. Titre de l'article. Lorsque l'utilisateur appuiera sur ce texte, il sera publié tel quel dans la conversation, comme si l'utilisateur l'avait saisi. Chaque titre doit être unique parmi 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 disponibles.
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 la collection. |
imageFill |
Facultatif. Type d'option d'affichage de l'image. |
CollectionItem
Un é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 la clé d'entrée dans le type associé. Lorsque l'utilisateur appuie sur l'élément, cette clé est publiée en tant que paramètre d'option de sélection. |
title |
Obligatoire. Titre de l'article. Lorsque l'utilisateur appuiera sur ce texte, il sera publié tel quel dans la conversation, comme si l'utilisateur l'avait saisi. Chaque titre doit être unique parmi 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. Les éléments peuvent être sélectionnés pour lancer le 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'élément de la collection, affiché sous la description. Une seule ligne de texte, tronquée par des points de suspension. |
image |
Image de l'élément de collection. |
openUriAction |
Obligatoire. URI à ouvrir si l'élément est sélectionné. |
Suggestion
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 appuiera sur ce texte, il sera publié tel quel dans la conversation, comme si l'utilisateur l'avait saisi. Chaque titre doit être unique parmi les chips de suggestion. 25 caractères max. |
StaticCanvasPrompt
Représente une réponse Interactive Canvas à envoyer à l'utilisateur. Cette option peut être utilisée en conjonction avec le champ firstSimple
dans l'invite associée pour parler à l'utilisateur en plus d'afficher une réponse interactive du canevas.
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. La valeur "true" signifie que le micro ne sera pas activé pour la capture d'entrée une fois que cette réponse immersive aura é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. Elles peuvent être enchaînées 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 dans 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 une fois que le gestionnaire on_load a été appelé. Important : Ces événements définissent l'ensemble des intents limités à cette scène et sont prioritaires sur tous les événements définis globalement qui ont les mêmes intents ou leurs expressions 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. Celles-ci sont évaluées après que le formulaire a été rempli ou immédiatement après on_load si cette scène n'a 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 d'emplacements. Chaque emplacement définit le type de données qu'il va résoudre, ainsi que la configuration permettant de personnaliser l'utilisation de cette résolution (par exemple, des invites). |
onSlotUpdated |
Handler appelé en cas de changement d'état d'un emplacement non causé par des mises à jour dans un autre gestionnaire. Cela permet d'invalider les emplacements, la scène ou d'autres changements d'é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 à laquelle la conversation doit accéder. L'état de la scène actuelle est détruit lors de la transition. |
handler |
Facultatif. Gestionnaire d'événements qui est 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 vraie.
Représentation JSON | |
---|---|
{
"condition": string,
"transitionToScene": string,
"handler": {
object ( |
Champs | |
---|---|
condition |
Obligatoire. Condition de filtre pour que cet événement se déclenche. Si la condition est évaluée sur "True", l'événement |
transitionToScene |
Facultatif. Scène de destination à laquelle la conversation doit accéder lorsque la condition associée est évaluée comme étant vraie. L'état de la scène actuelle est détruit lors de la transition. |
handler |
Facultatif. Gestionnaire d'événements qui est déclenché lorsque la condition associée est évaluée sur |
Encoche
Configuration d'un emplacement. Les emplacements sont des unités uniques de données 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'emplacement. |
type |
Obligatoire. Déclare le type de données de cet emplacement. |
required |
Facultatif. Indique si l'emplacement doit être rempli avant de pouvoir avancer. Les emplacements obligatoires non remplis déclencheront une invite personnalisable à l'utilisateur. |
promptSettings |
Facultatif. Enregistre des invites pour différentes étapes du remplissage de cases. |
commitBehavior |
Facultatif. Comportement de commit associé à l'emplacement. |
config |
Facultatif. Configuration supplémentaire associée à l'emplacement utilisé pour remplir l'emplacement. Le format de la configuration est spécifique au type de l'emplacement. Des références de ressources au paramètre 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 un bon de commande numérique en faisant 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
Emplacement unique où les invites d'emplacements sont définies.
Représentation JSON | |
---|---|
{ "initialPrompt": { object ( |
Champs | |
---|---|
initialPrompt |
Invite pour la valeur de l'emplacement lui-même. Exemple : "Quelle taille voulez-vous ?" |
noMatchPrompt1 |
Invite à afficher 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 à afficher 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 à afficher lorsque l'entrée utilisateur ne correspond pas au type de valeur attendu pour l'emplacement lors de 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 ne fournit aucune entrée pour la dernière fois. Exemple : "Désolé, je n'ai pas compris." |
CommitBehavior
Message décrivant le comportement du commit associé à l'emplacement une fois qu'il a été rempli.
Représentation JSON | |
---|---|
{ "writeSessionParam": string } |
Champs | |
---|---|
writeSessionParam |
Paramètre de session permettant d'écrire la valeur de l'emplacement une fois qu'il a été rempli. Notez que les chemins d'accès imbriqués ne sont pas acceptés pour le moment. "€€" permet d'écrire la valeur de l'emplacement dans un paramètre de session portant le même nom que l'emplacement. 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 elle 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 pas acceptés pour le moment. Par exemple: |
constant |
Facultatif. Valeur constante par défaut pour l'emplacement Il ne sera utilisé que si aucune valeur pour cet emplacement n'a été renseignée via |
DataFiles
Enveloppe pour un fichier de données répété Un champ oneof ne peut pas contenir de champs répétés.
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 élément. Exemple : |
payload |
Contenu du fichier de données. Il peut s'agir, par exemple, d'octets bruts des images, de fichiers audio ou du format ZIP de la fonction Cloud. La taille de la charge utile est soumise à une limite stricte de 10 Mo. Chaîne encodée en base64. |