Actions
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Représente la liste des actions définies dans un projet.
| Champs |
custom |
map (key: string, value: object (CustomAction))
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 "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
|
CustomAction
Informations sur une action personnalisée
| Représentation YAML |
engagement:
object (Engagement) |
| Champs |
engagement |
object (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.
| Champs |
title |
string
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 |
object (PushNotification)
Paramètres de notification push compatibles avec cet engagement.
|
actionLink
(deprecated) |
object (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 |
object (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 |
object (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 YAML |
title: string |
| Champs |
title |
string
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 YAML |
title: string |
| Champs |
title |
string
Titre à afficher convivial pour le lien.
|
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 2025/07/26 (UTC)."],[[["\u003cp\u003eThis document outlines the schema for defining Actions within a project, including custom actions, engagement mechanisms, and supporting features.\u003c/p\u003e\n"],["\u003cp\u003eActions can be customized by mapping intents to specific functionalities and configuring engagement features like push notifications and daily updates.\u003c/p\u003e\n"],["\u003cp\u003eEngagement features allow users to subscribe to updates and are controlled through settings like titles and notification preferences.\u003c/p\u003e\n"],["\u003cp\u003eAssistant Links enable deep linking into specific actions, providing a streamlined user experience.\u003c/p\u003e\n"],["\u003cp\u003eThe schema utilizes YAML for representation and provides detailed descriptions for each field and its purpose.\u003c/p\u003e\n"]]],["The content outlines various action types and their configurations within a project. `CustomAction` maps intents to actions, and `Engagement` handles user subscriptions to updates. `Engagement` includes `title`, `pushNotification`, `dailyUpdate`, and `assistantLink` (replaces deprecated `actionLink`). `AssistantLink` and `ActionLink` define link sharing settings. `PushNotification` and `DailyUpdate` define settings for respective engagements. Configuration is represented in YAML and explained in detail with fields and data types.\n"],null,["# Actions\n\n- [YAML representation](#SCHEMA_REPRESENTATION)\n- [CustomAction](#CustomAction)\n - [YAML representation](#CustomAction.SCHEMA_REPRESENTATION)\n- [Engagement](#Engagement)\n - [YAML representation](#Engagement.SCHEMA_REPRESENTATION)\n- [PushNotification](#PushNotification)\n- [DailyUpdate](#DailyUpdate)\n- [ActionLink](#ActionLink)\n - [YAML representation](#ActionLink.SCHEMA_REPRESENTATION)\n- [AssistantLink](#AssistantLink)\n - [YAML representation](#AssistantLink.SCHEMA_REPRESENTATION)\n\nRepresents the list of Actions defined in a project.\n\n| YAML representation ||\n|-------------------------------------------------------------------------------------------------|---|\n| custom: string: object (/assistant/actionssdk/reference/rest/Shared.Types/Actions#CustomAction) |\n\n| Fields ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `custom` | `map (key: string, value: object (`[CustomAction](/assistant/actionssdk/reference/rest/Shared.Types/Actions#CustomAction)`))` Map from intents to custom Actions to configure invocation for the project. The invocation intents could either be system or custom intents defined in the \"custom/intents/\" package. All intents defined here (system intents \\& custom intents) must have a corresponding intent file in the \"custom/global/\" package. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n\nCustomAction\n------------\n\nDetails regarding a custom action.\n\n| YAML representation ||\n|---------------------------------------------------------------------------------------------------|---|\n| ``` engagement: object (/assistant/actionssdk/reference/rest/Shared.Types/Actions#Engagement) ``` |\n\n| Fields ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `engagement` | `object (`[Engagement](/assistant/actionssdk/reference/rest/Shared.Types/Actions#Engagement)`)` Engagement mechanisms associated with the action to help end users subscribe to push notifications and daily updates. Note that the intent name specified in daily updates/push notifications slot config needs to match the intent corresponding to this action for end users to subscribe to these updates. |\n\nEngagement\n----------\n\nDefines the engagement mechanisms associated with this action. This allows end users to subscribe to push notification and daily update.\n\n| YAML representation ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` title: string pushNotification: object (/assistant/actionssdk/reference/rest/Shared.Types/Actions#PushNotification) actionLink: object (/assistant/actionssdk/reference/rest/Shared.Types/Actions#ActionLink) assistantLink: object (/assistant/actionssdk/reference/rest/Shared.Types/Actions#AssistantLink) dailyUpdate: object (/assistant/actionssdk/reference/rest/Shared.Types/Actions#DailyUpdate) ``` |\n\n| Fields ||\n|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `title` | `string` The title of the engagement that will be sent to end users asking for their permission to receive updates. The prompt sent to end users for daily updates will look like \"What time would you like me to send your daily {title}\" and for push notifications will look like \"Is it ok if I send push notifications for {title}\". **This field is localizable.** |\n| `pushNotification` | `object (`[PushNotification](/assistant/actionssdk/reference/rest/Shared.Types/Actions#PushNotification)`)` Push notification settings that this engagement supports. |\n| `actionLink` **(deprecated)** | `object (`[ActionLink](/assistant/actionssdk/reference/rest/Shared.Types/Actions#ActionLink)`)` | This item is deprecated! Link config for an action which determines whether sharing links is enabled for the action and if so, contains the user friendly display name for the link. ActionLink is deprecated. Use AssistantLink instead. |\n| `assistantLink` | `object (`[AssistantLink](/assistant/actionssdk/reference/rest/Shared.Types/Actions#AssistantLink)`)` Link config for an action which determines whether sharing links is enabled for the action and if so, contains the user friendly display name for the link. |\n| `dailyUpdate` | `object (`[DailyUpdate](/assistant/actionssdk/reference/rest/Shared.Types/Actions#DailyUpdate)`)` Daily update settings that this engagement supports. |\n\nPushNotification\n----------------\n\nDefines push notification settings that this engagement supports.\n\nDailyUpdate\n-----------\n\nDefines daily update settings that this engagement supports.\n\nActionLink\n----------\n\n| This item is deprecated!\nIndicates whether sharing links is enabled for this action and the corresponding settings. Action links are used to deep link a user into a specific action. ActionLink is deprecated. Use AssistantLink instead.\n\n| YAML representation ||\n|-----------------------|---|\n| ``` title: string ``` |\n\n| Fields ||\n|---------|----------------------------------------------------|\n| `title` | `string` User friendly display title for the link. |\n\nAssistantLink\n-------------\n\nIndicates whether sharing links is enabled for this action and the corresponding settings. Assistant links are used to deep link a user into a specific action.\n\n| YAML representation ||\n|-----------------------|---|\n| ``` title: string ``` |\n\n| Fields ||\n|---------|----------------------------------------------------|\n| `title` | `string` User friendly display title for the link. |"]]
