Actions
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Представляет список действий, определенных в проекте.
| Поля |
|---|
custom | map (key: string, value: object ( CustomAction )) Сопоставьте намерения с настраиваемыми действиями, чтобы настроить вызов проекта. Намерения вызова могут быть либо системными, либо пользовательскими намерениями, определенными в пакете «custom/intents/». Все намерения, определенные здесь (системные и пользовательские намерения), должны иметь соответствующий файл намерений в пакете «custom/global/». Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } . |
CustomAction
Подробности о специальном действии.
| YAML-представление |
|---|
engagement:
object (Engagement) |
| Поля |
|---|
engagement | object ( Engagement ) Механизмы взаимодействия, связанные с действием, помогают конечным пользователям подписаться на push-уведомления и ежедневные обновления. Обратите внимание, что имя намерения, указанное в конфигурации слота ежедневных обновлений/push-уведомлений, должно совпадать с намерением, соответствующим этому действию, чтобы конечные пользователи могли подписаться на эти обновления. |
Обручение
Определяет механизмы взаимодействия, связанные с этим действием. Это позволяет конечным пользователям подписаться на push-уведомления и ежедневные обновления.
| Поля |
|---|
title | string Название взаимодействия, которое будет отправлено конечным пользователям с просьбой дать разрешение на получение обновлений. Запрос, отправляемый конечным пользователям для ежедневных обновлений, будет выглядеть так: «В какое время вы хотите, чтобы я отправлял ваши ежедневные уведомления по {title}», а для push-уведомлений — «Ничего, если я отправлю push-уведомления для {title}». Это поле является локализуемым. |
pushNotification | object ( PushNotification ) Настройки push-уведомлений, которые поддерживает это взаимодействие. |
actionLink
(deprecated) | object ( ActionLink ) Конфигурация ссылки для действия, которая определяет, включен ли общий доступ к ссылкам для этого действия, и если да, содержит понятное пользователю отображаемое имя для ссылки. ActionLink устарел. Вместо этого используйте AssistantLink. |
assistantLink | object ( AssistantLink ) Конфигурация ссылки для действия, которая определяет, включен ли общий доступ к ссылкам для этого действия, и если да, содержит понятное пользователю отображаемое имя для ссылки. |
dailyUpdate | object ( DailyUpdate ) Настройки ежедневного обновления, которые поддерживает это взаимодействие. |
Push-уведомление
Определяет настройки push-уведомлений, которые поддерживает это взаимодействие.
Ежедневное обновление
Определяет параметры ежедневного обновления, которые поддерживает это взаимодействие.
ActionLink
Указывает, включен ли обмен ссылками для этого действия и соответствующие настройки. Ссылки на действия используются для глубокой ссылки пользователя на конкретное действие. ActionLink устарел. Вместо этого используйте AssistantLink.
| YAML-представление |
|---|
title: string |
| Поля |
|---|
title | string Удобный заголовок для ссылки. |
АссистентСсылка
Указывает, включен ли обмен ссылками для этого действия и соответствующие настройки. Ссылки помощника используются для глубокой ссылки пользователя на конкретное действие.
| YAML-представление |
|---|
title: string |
| Поля |
|---|
title | string Удобный заголовок для ссылки. |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-24 UTC.
[null,null,["Последнее обновление: 2025-07-24 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. |"]]
