Actions
Stay organized with collections
Save and categorize content based on your preferences.
Represents the list of Actions defined in a project.
CustomAction
Details regarding a custom action.
Engagement
Defines the engagement mechanisms associated with this action. This allows end users to subscribe to push notification and daily update.
PushNotification
Defines push notification settings that this engagement supports.
DailyUpdate
Defines daily update settings that this engagement supports.
ActionLink
Indicates 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.
AssistantLink
Indicates 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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 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. |"]]
