会話型アクションのサポートは 2023 年 6 月 13 日に終了しました。詳細については、
会話型アクションの廃止をご覧ください。
Actions
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
プロジェクトで定義されているアクションのリストを表します。
フィールド |
custom |
map (key: string, value: object (CustomAction ))
インテントからカスタム アクションにマッピングして、プロジェクトの呼び出しを構成する呼び出しインテントは、"custom/intents/"パッケージ化されています。ここで定義するすべてのインテント(システム インテントとカスタム インテント)は、対応するインテント ファイルを「custom/global/」内に置く必要があります。パッケージ化されています。 "key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
|
CustomAction
フィールド |
engagement |
object (Engagement )
アクションに関連付けられたエンゲージメント メカニズムで、エンドユーザーがプッシュ通知や毎日の更新に登録できるようになります。なお、毎日の通知/プッシュ通知のスロット構成で指定されたインテント名が、エンドユーザーがこれらの更新情報を受け取るためには、このアクションに対応するインテントと一致している必要があります。
|
エンゲージメント
このアクションに関連付けられたエンゲージメント メカニズムを定義します。これにより、エンドユーザーはプッシュ通知と毎日の通知に登録できます。
フィールド |
title |
string
更新情報の受信許可を求めるエンドユーザーに送信されるエンゲージメントのタイトル。毎日の更新情報に関してエンドユーザーに送信されるプロンプトは、「何時にご購読いただいていますか?」のようになります。プッシュ通知の場合は、「{title} のプッシュ通知を送信してもいいですか?」と表示されます。このフィールドはローカライズ可能です。
|
pushNotification |
object (PushNotification )
このエンゲージメントでサポートされているプッシュ通知の設定。
|
actionLink (deprecated) |
object (ActionLink )
アクションのリンク共有が有効かどうかを決定するアクションのリンク設定。有効になっている場合はリンクのわかりやすい表示名が含まれます。ActionLink は非推奨になりました。代わりに AssistantLink を使用してください。
|
assistantLink |
object (AssistantLink )
アクションのリンク共有が有効かどうかを決定するアクションのリンク設定。有効になっている場合はリンクのわかりやすい表示名が含まれます。
|
dailyUpdate |
object (DailyUpdate )
このエンゲージメントでサポートされている日次更新の設定。
|
PushNotification
このエンゲージメントがサポートするプッシュ通知設定を定義します。
DailyUpdate
このエンゲージメントがサポートする日次更新設定を定義します。
ActionLink
このアクションと、対応する設定に対して共有リンクが有効になっているかどうかを示します。アクション リンクは、ユーザーを特定のアクションにディープリンクするために使用されます。ActionLink は非推奨になりました。代わりに AssistantLink を使用してください。
フィールド |
title |
string
リンクのユーザー フレンドリーな表示タイトル。
|
AssistantLink
このアクションと、対応する設定に対して共有リンクが有効になっているかどうかを示します。アシスタント リンクは、ユーザーを特定のアクションにディープリンクするために使用されます。
フィールド |
title |
string
リンクのユーザー フレンドリーな表示タイトル。
|
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-26 UTC。
[null,null,["最終更新日 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. |"]]