Files

{
  "configFiles": [
    {
      object (ConfigFile)
    }
  ]
}

object (ConfigFile)

複数の構成ファイル。

{
  "filePath": string,

  // Union field file can be only one of the following:
  "manifest": {
    object (Manifest)
  },
  "actions": {
    object (Actions)
  },
  "settings": {
    object (Settings)
  },
  "webhook": {
    object (Webhook)
  },
  "intent": {
    object (Intent)
  },
  "type": {
    object (Type)
  },
  "entitySet": {
    object (EntitySet)
  },
  "globalIntentEvent": {
    object (GlobalIntentEvent)
  },
  "scene": {
    object (Scene)
  },
  "staticPrompt": {
    object (StaticPrompt)
  },
  "accountLinkingSecret": {
    object (AccountLinkingSecret)
  },
  "resourceBundle": {
    object
  }
  // End of list of possible types for union field file.
}

string

SDK ファイル構造内のプロジェクト ルートからの構成ファイルの相対パス。以下の各ファイル形式には、使用できるファイルパスがあります。例: settings/settings.yaml

object (Manifest)

単一のマニフェスト ファイル。許可されたファイルパス: manifest.yaml

object (Actions)

すべてのアクションが定義された単一のアクション ファイル。使用できるファイルパス: actions/{language}?/actions.yaml

object (Settings)

ローカライズできない設定と、プロジェクトのデフォルト ロケールの設定（指定されている場合）を含む単一の設定構成。ロケール オーバーライド ファイルの場合は、localizedSettings フィールドのみが設定されます。許可されるファイルパス: settings/{language}?/settings.yaml。書き込みフロー リクエストには、ローカライズされていない設定ファイル settings/settings.yaml が存在する必要があります。

object (Webhook)

単一の Webhook 定義。許可されたファイルパス: webhooks/{WebhookName}.yaml

object (Intent)

単一のインテントの定義。使用できるファイルパス: custom/intents/{language}?/{IntentName}.yaml

object (Type)

単一のタイプの定義。使用できるファイルパス: custom/types/{language}?/{TypeName}.yaml

object (EntitySet)

単一のエンティティ セットの定義。使用できるファイルパス: custom/entitySets/{language}?/{EntitySetName}.yaml

object (GlobalIntentEvent)

単一のグローバル インテント イベントの定義。使用できるファイルパス: custom/global/{GlobalIntentEventName}.yaml ファイル名（GlobalIntentEventName）は、このグローバル インテント イベントが対応するインテントの名前にする必要があります。

object (Scene)

単一シーンの定義。使用できるファイルパス: custom/scenes/{SceneName}.yaml

object (StaticPrompt)

単一の静的プロンプト定義。使用できるファイルパス: custom/prompts/{language}?/{StaticPromptName}.yaml

object (AccountLinkingSecret)

アカウントのリンクで使用されるクライアント シークレットに対応するメタデータ。許可されたファイルパス: settings/accountLinkingSecret.yaml

object (Struct format)

単一のリソース バンドル。文字列から文字列または文字列のリストへのマップです。リソース バンドルを使用すると、静的プロンプトで文字列をローカライズできます。使用できるファイルパス: resources/strings/{language}?/{multiple directories}?/{BundleName}.yaml

{
  "version": string
}

string

ファイル形式のバージョン。現在のファイル形式バージョンは 1.0 です（例: 「1.0」）。

{
  "custom": {
    string: {
      object (CustomAction)
    },
    ...
  }
}

map (key: string, value: object (CustomAction))

インテントからカスタム アクションをマッピングして、プロジェクトの呼び出しを構成します。呼び出しインテントは、「custom/intents/」パッケージで定義されたシステム インテントまたはカスタム インテントのいずれかです。ここで定義するすべてのインテント（システム インテントとカスタム インテント）は、対応するインテント ファイルを「custom/global/」パッケージに格納する必要があります。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

{
  "engagement": {
    object (Engagement)
  }
}

object (Engagement)

エンドユーザーがプッシュ通知や日次更新を受け取るのに役立つ、アクションに関連するエンゲージメントのメカニズム。毎日の更新/プッシュ通知のスロット構成で指定されたインテント名が、エンドユーザーがこれらの更新に登録するためには、このアクションに対応するインテントと一致している必要があります。

{
  "title": string,
  "pushNotification": {
    object (PushNotification)
  },
  "actionLink": {
    object (ActionLink)
  },
  "assistantLink": {
    object (AssistantLink)
  },
  "dailyUpdate": {
    object (DailyUpdate)
  }
}

string

最新情報を受け取る許可を求めるエンドユーザーに送信されるエンゲージメントのタイトル。エンドユーザーに送信されるプロンプトは、「毎日の {title}」を、いつ送信しますか。プッシュ通知の場合は「{title} のプッシュ通知を送信しても大丈夫ですか？」のように表示されます。このフィールドはローカライズ可能です。

object (PushNotification)

このエンゲージメントでサポートされているプッシュ通知の設定。

object (ActionLink)

アクションのリンク構成。アクションでリンクの共有が有効かどうかを決定します。有効な場合は、リンクのユーザー フレンドリーな表示名が含まれます。ActionLink が非推奨になりました。代わりに AssistantLink を使用してください。

object (AssistantLink)

アクションのリンク構成。アクションでリンクの共有が有効かどうかを決定します。有効な場合は、リンクのユーザー フレンドリーな表示名が含まれます。

object (DailyUpdate)

このエンゲージメントでサポートされている日次更新の設定。

{
  "title": string
}

string

リンクのユーザー フレンドリーな表示タイトル。

{
  "title": string
}

string

リンクのユーザー フレンドリーな表示タイトル。

{
  "projectId": string,
  "defaultLocale": string,
  "enabledRegions": [
    string
  ],
  "disabledRegions": [
    string
  ],
  "category": enum (Category),
  "usesTransactionsApi": boolean,
  "usesDigitalPurchaseApi": boolean,
  "usesInteractiveCanvas": boolean,
  "usesHomeStorage": boolean,
  "designedForFamily": boolean,
  "containsAlcoholOrTobaccoContent": boolean,
  "keepsMicOpen": boolean,
  "surfaceRequirements": {
    object (SurfaceRequirements)
  },
  "testingInstructions": string,
  "localizedSettings": {
    object (LocalizedSettings)
  },
  "accountLinking": {
    object (AccountLinking)
  },
  "selectedAndroidApps": [
    string
  ]
}

string

Actions プロジェクト ID。

string

プロジェクトのデフォルトのロケール。パスにロケールが指定されていない resources/ を除くすべてのファイルについては、ローカライズされたデータはこの defaultLocale に関連付けられます。resources/ の下にあるファイルの場合、ロケールがないということは、リソースがすべてのロケールに適用されることを意味します。

string

ユーザーの所在地に基づいて、ユーザーがアクションを呼び出せる地域を表します。disabledRegions が設定されている場合は設定できません。enabledRegions と disabledRegions のどちらも指定されていない場合、ユーザーはすべてのリージョンでアクションを呼び出すことができます。各地域は、AdWords 地域ターゲティングの正規名を使用して表されます。参照: https://developers.google.com/adwords/api/docs/appendix/geotargeting: - "Germany" - "Ghana" - "Greece" - "Grenada" - "United Kingdom" - "United States" - "United States Minor Outlying Irelands" - "Uruguay"

string

ユーザーの所在地に基づいて、アクションがブロックされている地域を表します。enabledRegions が設定されている場合は設定できません。各地域は、AdWords 地域ターゲティングの正規名を使用して表されます。参照: https://developers.google.com/adwords/api/docs/appendix/geotargeting: - "Germany" - "Ghana" - "Greece" - "Grenada" - "United Kingdom" - "United States" - "United States Minor Outlying Irelands" - "Uruguay"

enum (Category)

このアクション プロジェクトのカテゴリ。

boolean

アクションがトランザクション（予約や注文など）を使用できるかどうかを指定します。false の場合、Transactions API の使用は失敗します。

boolean

アクションがデジタル商品のトランザクションを実行できるかどうか。

boolean

アクションが Interactive Canvas を使用するかどうかを指定します。

boolean

アクションがホーム ストレージ機能を使用するかどうかを指定します。

boolean

アクション コンテンツがファミリー向け（DFF）にデザインされているかどうか。

boolean

アクションにアルコールやタバコに関連するコンテンツが含まれているかどうか。

boolean

会話中に、明示的なプロンプトを表示せずにアクションでマイクを開いたままにできるかどうか。

object (SurfaceRequirements)

このプロジェクトでアクションを呼び出すためにクライアント サーフェスがサポートする必要があるサーフェス要件。

string

アクションの審査担当者向けの自由形式のテスト手順（アカウントのリンクの手順など）。

object (LocalizedSettings)

プロジェクトのデフォルトのロケールに合わせてローカライズされた設定。追加するすべての言語 / 地域ごとに、独自のディレクトリに独自の設定ファイルが必要です。

object (AccountLinking)

ユーザーが Google ログインや独自の OAuth サービスを使ってアカウントを作成またはリンクできるようにします。

string

Google Play で取引を行うために選択された Android アプリ。これは、ブランド所有権を確認し、追加機能を有効にするために、アクション プロジェクトに接続されている Android アプリからの選択です。詳しくは、https://developers.google.com/assistant/console/brand-verification をご覧ください。

{
  "minimumRequirements": [
    {
      object (CapabilityRequirement)
    }
  ]
}

object (CapabilityRequirement)

プロジェクト内のアクションを呼び出すために必要な最小限の機能セット。これらのいずれかがないと、アクションはトリガーされません。

{
  "capability": enum (SurfaceCapability)
}

enum (SurfaceCapability)

機能のタイプ。

{
  "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 (ThemeCustomization)
  }
}

string

必須。このアクション プロジェクトのデフォルトの表示名（翻訳がない場合）

string

必須。音声（発話）コンテキスト内で表示する表示名の発音。

string

必須。Actions プロジェクトのデフォルトの簡単な説明（翻訳がない場合）。最大 80 文字。

string

必須。Actions プロジェクトのデフォルトの詳しい説明（利用可能な翻訳がない場合）。最大 4,000 文字。

string

必須。192 × 192 ピクセルの正方形の画像。これは、resources/images/ ディレクトリ内の対応する画像への参照として指定する必要があります。たとえば、resources/images/foo.jpg の画像の場合は $resources.images.foo（拡張子なし）です。コンソールから取得されたプロジェクトで作業する場合、取得された Google 管理の URL を使用できます。外部ソースからの URL は使用できません。

string

（省略可）大きい横長の画像、1,920 x 1,080 ピクセル。これは、resources/images/ ディレクトリ内の対応する画像への参照として指定する必要があります。たとえば、resources/images/foo.jpg の画像の場合は $resources.images.foo（拡張子なし）です。コンソールから取得されたプロジェクトで作業する場合、取得された Google 管理の URL を使用できます。外部ソースからの URL は使用できません。

string

必須。ユーザーに表示するデベロッパーの名前。

string

必須。デベロッパーの連絡先メールアドレス。

string

（省略可）利用規約の URL。

string

必須。ユーザーがアクションを操作したときに読み上げられる Google アシスタントの音声タイプ。サポートされている値は、「male_1」、「male_2」、「female_1」、「female_2」です。

string

（省略可）指定した音声のロケール。指定しない場合、ユーザーのアシスタントの言語 / 地域に解決されます。指定する場合、音声ロケールは LocalizedSettings で指定されたロケールと同じルート言語である必要があります。

string

必須。プライバシー ポリシーの URL。

string

（省略可）アシスタント ディレクトリに Actions プロジェクトの説明の一部として表示されるサンプル呼び出しフレーズ。使い方を知ることができます。

object (ThemeCustomization)

（省略可）アクションのビジュアル コンポーネントのテーマのカスタマイズ。

{
  "backgroundColor": string,
  "primaryColor": string,
  "fontFamily": string,
  "imageCornerStyle": enum (ImageCornerStyle),
  "landscapeBackgroundImage": string,
  "portraitBackgroundImage": string
}

string

カードの背景色。background_image がデベロッパーから提供されていない場合や、background_image が特定のサーフェスに適していない場合のフォールバックとして機能します。使用例: #FAFAFA

string

アクションのメインテーマの色は、タイトルのテキストの色と Actions on Google カードのアクション アイテムの背景色の設定に使用されます。使用例: #FAFAFA

string

カードのタイトルに使用されるフォント ファミリー。サポートされるフォント: - Sans Serif - Sans Serif 中 - Sans Serif Bold - Sans Serif Black - Sans Serif Condensed - Sans Serif Condensed - Serif - Serif Bold - Monospace - 手書きメモ - Sans

enum (ImageCornerStyle)

カードの前景画像の枠線のスタイル。たとえば、ベーシック カードやカルーセル カードのフォアグラウンド画像に適用できます。

string

横表示（最小 1,920 x 1,200 ピクセル）。これは、resources/images/ ディレクトリ内の対応する画像への参照として指定する必要があります。例: resources/images/foo.jpg の画像に $resources.images.foo（拡張子なし）。コンソールから pull したプロジェクトで作業する場合、取得した Google 管理の URL を使用できます。

string

ポートレート モード（最小 1,200 x 1,920 ピクセル）。これは、resources/images/ ディレクトリ内の対応する画像への参照として指定する必要があります。例: resources/images/foo.jpg の画像に $resources.images.foo（拡張子なし）。コンソールから pull したプロジェクトで作業する場合、取得した Google 管理の URL を使用できます。

{
  "enableAccountCreation": boolean,
  "linkingType": enum (LinkingType),
  "authGrantType": enum (AuthGrantType),
  "appClientId": string,
  "authorizationUrl": string,
  "tokenUrl": string,
  "scopes": [
    string
  ],
  "learnMoreUrl": string,
  "useBasicAuthHeader": boolean
}

boolean

必須。true の場合、ユーザーは音声で新しいアカウントに登録できます。false の場合、アカウントの作成はウェブサイトでのみ許可されます。利用規約を表示するか、登録時にユーザーの同意を取得する場合は、このオプションを選択します。この値が false の場合、 linksType を GOOGLE_SIGN_IN にすることはできません。これが true の場合、LinkingType を OAUTH にすることはできません。

enum (LinkingType)

必須。使用するリンクタイプ。リンクの種類について詳しくは、https://developers.google.com/assistant/identity をご覧ください。

enum (AuthGrantType)

（省略可）OAuth LinkingType の認証タイプを示します。

string

（省略可）アプリから Google に発行されたクライアント ID。サービスに対して Google を識別する OAuth2 クライアント ID です。OAuth を使用する場合にのみ設定します。

string

（省略可）OAuth2 コードまたは暗黙的フローをサポートするログイン ウェブページのエンドポイント。URL では HTTPS を使用する必要があります。OAuth を使用する場合にのみ設定します。

string

（省略可）トークン交換用の OAuth2 エンドポイント。URL では HTTPS を使用する必要があります。リンクタイプとして IMPLICIT 権限付与がある OAuth のみを使用する場合には設定されません。OAuth を使用する場合にのみ設定します。

string

（省略可）サービスを使用するためにユーザーが同意する必要がある権限のリスト。OAuth を使用する場合にのみ設定します。このフィールドを指定する場合は、LocalizedSettings.terms_of_service_url セクションのディレクトリ情報で利用規約を指定してください。

string

（省略可）これは、ユーザーが Google に付与する権限を記述するサービスのウェブページです。OAuth と Google ログインを使用する場合にのみ設定します。このフィールドを指定する場合は、LocalizedSettings.terms_of_service_url セクションのディレクトリ情報で利用規約を指定してください。

boolean

（省略可）true の場合、Google が HTTP 基本認証ヘッダーを介してクライアント ID とシークレットを送信することを許可します。それ以外の場合、Google は POST 本文内でクライアント ID とシークレットを使用します。OAuth を使用する場合にのみ設定します。このフィールドを指定する場合は、LocalizedSettings.terms_of_service_url セクションのディレクトリ情報で利用規約を指定してください。

{
  "handlers": [
    {
      object (Handler)
    }
  ],

  // Union field webhook_type can be only one of the following:
  "httpsEndpoint": {
    object (HttpsEndpoint)
  },
  "inlineCloudFunction": {
    object (InlineCloudFunction)
  }
  // End of list of possible types for union field webhook_type.
}

object (Handler)

この Webhook のハンドラのリスト。

object (HttpsEndpoint)

カスタム Webhook HTTPS エンドポイント。

object (InlineCloudFunction)

Webhook フォルダ内のコードからデプロイされた Cloud Functions の関数のメタデータ。

{
  "name": string
}

string

必須。ハンドラの名前。Actions プロジェクトのすべてのハンドラで一意である必要があります。このハンドラの名前を確認することで、フルフィルメントのソースコード内で正しい関数を呼び出すことができます。

{
  "baseUrl": string,
  "httpHeaders": {
    string: string,
    ...
  },
  "endpointApiVersion": integer
}

string

フルフィルメント エンドポイントの HTTPS ベース URL（HTTP はサポートされていません）。ハンドラ名は、ベース URL パスのコロンの後に追加されます（https://cloud.google.com/apis/design/custom_methods) のスタイルガイドに従います）。たとえば、ベース URL「https://gactions.service.com/api」は、URL「https://gactions.service.com/api:{method}」のリクエストを受信します。

map (key: string, value: string)

POST リクエストに含まれる HTTP パラメータのマップ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

integer

エンドポイントで使用されるプロトコルのバージョン。これはすべてのフルフィルメント タイプで共有されるプロトコルで、Google フルフィルメント タイプに固有のものではありません。

{
  "executeFunction": string
}

string

Cloud Functions のエントリ ポイントの名前。このフィールドの値は、ソースコードからエクスポートされたメソッドの名前と一致する必要があります。

{
  "parameters": [
    {
      object (IntentParameter)
    }
  ],
  "trainingPhrases": [
    string
  ]
}

object (IntentParameter)

トレーニング フレーズ内のパラメータのリスト。トレーニング フレーズで使用するすべてのパラメータをここで定義する必要があります。

string

トレーニング フレーズにより、Google の NLU はインテントとユーザー入力を自動的に照合できます。提供されるフレーズのバリエーションが多いほど、このインテントが一致する可能性が高くなります。アノテーションが付けられたトレーニング フレーズのパートの形式は次のとおりです。なお、auto フィールドは省略できます。auto が指定されていない場合は、デフォルトの動作は auto=false と同じになります。($<paramName> '<sample text>' auto=<true or false>) auto = true は、パートに NLU によって自動的にアノテーションが付けられたことを意味します。auto = false: ユーザーによってアノテーションが付けられた部分です。これは、auto が指定されていない場合のデフォルトです。例: 「($source 'San Francisco' auto=false) から ($dest 'Vancouver') までのフライトを予約して」

{
  "name": string,

  // Union field parameter_type can be only one of the following:
  "type": {
    object (ClassReference)
  },
  "entitySetReferences": {
    object (EntitySetReferences)
  }
  // End of list of possible types for union field parameter_type.
}

string

必須。インテント パラメータの一意の名前。条件やレスポンスで使用して、$intent.params.[name].resolved を持つ NLU によって抽出されたインテント パラメータを参照できる

object (ClassReference)

（省略可）このパラメータのデータ型を宣言します。組み込みインテントには設定しないでください。

object (EntitySetReferences)

（省略可）このインテント パラメータで許可されるエンティティ セットへの参照。組み込みインテントのパラメータに対してのみ有効です。これらの参照は、「custom/entitySets」ディレクトリ内のエンティティ セットを参照します。

{
  "name": string,
  "list": boolean
}

string

必須。パラメータの組み込みタイプまたはカスタムタイプの名前。例: PizzaToppings、actions.type.Number

boolean

（省略可）データ型が値のリストを表すかどうかを示します。

{
  "entitySetReferences": [
    {
      object (EntitySetReference)
    }
  ]
}

object (EntitySetReference)

必須。インテント パラメータのエンティティ セット参照です。

{
  "entitySet": string
}

string

必須。特定のパラメータに対して考慮すべきエンティティの特定のコレクションを識別します。対応するエンティティ セットの定義が custom/entitySets/ ディレクトリに存在する必要があります。

{
  "exclusions": [
    string
  ],

  // Union field sub_type can be only one of the following:
  "synonym": {
    object (SynonymType)
  },
  "regularExpression": {
    object (RegularExpressionType)
  },
  "freeText": {
    object (FreeTextType)
  }
  // End of list of possible types for union field sub_type.
}

string

タイプ別に一致しない、例外的な単語やフレーズのセット。注: 単語/フレーズがタイプで一致したものの、除外としてリストされている場合、その語句はパラメータ抽出結果で返されません。このフィールドはローカライズ可能です。

object (SynonymType)

類義語型。基本的には列挙型です。

object (RegularExpressionType)

正規表現タイプ。正規表現一致を許可します。

object (FreeTextType)

FreeText 型。

{
  "matchType": enum (MatchType),
  "acceptUnknownValues": boolean,
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}

enum (MatchType)

（省略可）類義語のマッチタイプ。

boolean

（省略可）true に設定すると、周辺の入力やインテント トレーニング データ（食料品リストに追加される可能性のあるアイテムなど）に基づいて、不明な単語やフレーズが照合されます。

map (key: string, value: object (Entity))

必須。類義語エンティティの名前付きマップ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

{
  "display": {
    object (EntityDisplay)
  },
  "synonyms": [
    string
  ]
}

object (EntityDisplay)

（省略可）エンティティの表示詳細です。

string

（省略可）エンティティの類義語のリスト。このフィールドはローカライズ可能です。

{
  "iconTitle": string,
  "iconUrl": string
}

string

（省略可）アイコンのタイトル。

string

必須。アイコンの URL。

{
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}

map (key: string, value: object (Entity))

必須。それぞれ正規表現文字列を含むエンティティの名前付きマップ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

{
  "display": {
    object (EntityDisplay)
  },
  "regularExpressions": [
    string
  ]
}

object (EntityDisplay)

（省略可）クエリからエンティティが抽出されるとキャンバスに表示される要素。キャンバス対応アプリにのみ該当します。

string

必須。RE2 正規表現の構文を使用します（詳しくは https://github.com/google/re2/wiki/Syntax をご覧ください）。

{
  "display": {
    object (EntityDisplay)
  }
}

object (EntityDisplay)

（省略可）クエリからエンティティが抽出されるとキャンバスに表示される要素。キャンバス対応アプリにのみ該当します。

{
  "entities": [
    {
      object (Entity)
    }
  ]
}

object (Entity)

必須。このエンティティ セットがサポートするエンティティのリスト。

{
  "id": string
}

string

必須。エンティティの ID。組み込みインテントのパラメータとサポートされるエンティティのリストについては、https://developers.google.com/assistant/conversational/build/built-in-intents をご覧ください。

{
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}

string

（省略可）会話のジャンプ先となるデスティネーション シーン。現在のシーンの状態は、遷移時に破棄されます。

object (EventHandler)

（省略可）インテントが一致したときにトリガーされるイベント ハンドラ。移動先のシーンに移行する前に実行する必要があります。イベントに応じてプロンプトを生成する場合に役立ちます。

{
  "webhookHandler": string,

  // Union field prompt can be only one of the following:
  "staticPrompt": {
    object (StaticPrompt)
  },
  "staticPromptName": string
  // End of list of possible types for union field prompt.
}

string

呼び出す Webhook ハンドラの名前。

object (StaticPrompt)

インライン化された静的プロンプトバンドル内の文字列リソースへの参照を含めることができます。

string

呼び出す静的プロンプトの名前。

{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}

object (StaticPromptCandidate)

クライアントに送信されるプロンプト候補のリスト。各プロンプトには、いつ使用できるかを決定するセレクタがあります。リクエストに一致した最初のセレクタが送信され、残りは無視されます。

{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}

object (Selector)

（省略可）このプロンプトがリクエストと一致するかどうかの基準。セレクタが空の場合、このプロンプトは常にトリガーされます。

object (StaticPromptResponse)

セレクタに関連付けられているプロンプト レスポンス。

{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}

object (SurfaceCapabilities)

必要なサーフェス機能のセット。

{
  "capabilities": [
    enum (Capability)
  ]
}

enum (Capability)

必須。アクションにリクエストを行うサーフェスの機能。

{
  "firstSimple": {
    object (StaticSimplePrompt)
  },
  "content": {
    object (StaticContentPrompt)
  },
  "lastSimple": {
    object (StaticSimplePrompt)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (StaticLinkPrompt)
  },
  "override": boolean,
  "canvas": {
    object (StaticCanvasPrompt)
  }
}

object (StaticSimplePrompt)

（省略可）最初の音声とテキストのみのレスポンス。

object (StaticContentPrompt)

（省略可）ユーザーに表示するカード、リスト、メディアなどのコンテンツ。

object (StaticSimplePrompt)

（省略可）最後の音声とテキストのみのレスポンス。

object (Suggestion)

（省略可）ユーザーに表示される候補。レスポンスの最後に常に表示されます。含まれるプロンプトの append フィールドが true の場合、このフィールドで定義されているタイトルは、以前に定義された候補プロンプトで定義されているタイトルに追加され、重複する値が削除されます。

object (StaticLinkPrompt)

（省略可）関連するアプリまたはサイトにリンクできる追加の候補ワード。チップは「Open」というタイトルでレンダリングされます。最大 20 文字。

boolean

（省略可）このメッセージを、以前に定義されたメッセージと統合する方法のモード。true は、以前に定義したメッセージ（最初と最後のシンプル、コンテンツ、候補のリンク、キャンバス）をすべてクリアし、このプロンプトで定義されたメッセージを追加します。false を使用すると、このプロンプトで定義されているメッセージが、以前のレスポンスで定義されているメッセージに追加されます。このフィールドを false に設定すると、Simple プロンプト内の一部のフィールド、Suggestions プロンプト、Canvas プロンプト（Content プロンプトの一部）への追加も可能になります。コンテンツ メッセージとリンク メッセージは、プロンプトで定義されている場合は常に上書きされます。デフォルト値は false です。

object (StaticCanvasPrompt)

インタラクティブなキャンバス エクスペリエンスに使用されるレスポンス。

{
  "variants": [
    {
      object (Variant)
    }
  ]
}

object (Variant)

可能性のあるバリアントのリスト。

{
  "speech": string,
  "text": string
}

string

（省略可）ユーザーに向けて読み上げられる音声を表します。SSML またはテキスト読み上げが可能です。デフォルトでは、音声は前のシンプルなプロンプトの音声に追加されます。含まれるプロンプトの override フィールドが true の場合、このフィールドで定義された音声が、以前の Simple プロンプトの音声をオーバーライドします。

string

（省略可）チャットのふきだしに表示するテキスト。指定しない場合、上記の音声フィールドの表示レンダリングが使用されます。最大 640 文字です。デフォルトでは、テキストは前のシンプルなプロンプトのテキストに付加されます。含まれるプロンプトの override フィールドが true の場合、このフィールドで定義されたテキストが以前の Simple プロンプトのテキストをオーバーライドします。

{

  // Union field content can be only one of the following:
  "card": {
    object (StaticCardPrompt)
  },
  "image": {
    object (StaticImagePrompt)
  },
  "table": {
    object (StaticTablePrompt)
  },
  "media": {
    object (StaticMediaPrompt)
  },
  "list": {
    object (StaticListPrompt)
  },
  "collection": {
    object (StaticCollectionPrompt)
  },
  "collectionBrowse": {
    object (StaticCollectionBrowsePrompt)
  }
  // End of list of possible types for union field content.
}

object (StaticCardPrompt)

ベーシック カード。

object (StaticImagePrompt)

画像。

object (StaticTablePrompt)

テーブルカード。

object (StaticMediaPrompt)

再生するメディアのセットを示すレスポンス。

object (StaticListPrompt)

選択可能なオプションのリストを提示するカード。

object (StaticCollectionPrompt)

選択可能なオプションのリストを示すカード。

object (StaticCollectionBrowsePrompt)

開くウェブページのコレクションを提示するカード。

{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (StaticImagePrompt)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (StaticLinkPrompt)
  }
}

string

（省略可）カードの全体的なタイトル。

string

（省略可）カードのサブタイトル。

string

必須。カードの本文。画像が存在しない場合に必要です。書式設定のために限定されたマークダウン構文をサポートします。

object (StaticImagePrompt)

（省略可）カードのヒーロー画像。高さは 192 dp に固定されています。

enum (ImageFill)

（省略可）画像の背景の塗りつぶし方法。

object (StaticLinkPrompt)

（省略可）カードに表示されるクリック可能なボタン。

{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}

string

必須。画像のソース URL。JPG、PNG、GIF（アニメーション GIF と非アニメーション GIF）を使用できます。例: https://www.agentx.com/logo.png

string

必須。スクリーン リーダーなどのユーザー補助機能で使用する、画像の説明のテキスト。

integer

（省略可）画像の高さ（ピクセル単位）。

integer

（省略可）画像の幅（ピクセル単位）。

{
  "name": string,
  "open": {
    object (OpenUrl)
  }
}

string

リンクの名前

object (OpenUrl)

ユーザーがリンクを開いたときの動作を定義します。

{
  "url": string,
  "hint": enum (UrlHint)
}

string

url フィールドでは、次のいずれかを指定できます。- アプリとリンクしたアプリまたはウェブページを開くための http または https の URL

enum (UrlHint)

URL タイプのヒントを示します。

{
  "title": string,
  "subtitle": string,
  "image": {
    object (StaticImagePrompt)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (StaticLinkPrompt)
  }
}

string

（省略可）テーブルの全体的なタイトル。サブタイトルが設定されている場合に設定する必要があります。

string

（省略可）テーブルのサブタイトル。

object (StaticImagePrompt)

（省略可）テーブルに関連付けられている画像。

object (TableColumn)

（省略可）ヘッダーと列の配置。

object (TableRow)

（省略可）テーブルの行データ。最初の 3 行は表示されることが保証されますが、その他の行はサーフェスによっては切り捨てられる場合があります。特定のサーフェスに対してどの行が表示されるかをシミュレータでテストしてください。WEB_BROWSER 機能をサポートするサーフェスでは、詳細なデータが記載されたウェブページにユーザーを誘導できます。

object (StaticLinkPrompt)

（省略可）ボタン。

{
  "header": string,
  "align": enum (HorizontalAlignment)
}

string

列のヘッダー テキスト。

enum (HorizontalAlignment)

列に対するコンテンツの水平方向の配置。省略した場合、内容は前端に揃えられます。

{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}

object (TableCell)

この行のセル。最初の 3 つのセルは表示されることが保証されますが、その他のセルはサーフェスによっては切り捨てられる場合があります。特定のサーフェスに対してどのセルが表示されるかをシミュレータでテストしてください。

boolean

各行の後に分割線を配置するかどうかを示します。

{
  "text": string
}

string

セルのテキスト コンテンツ。

{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ],
  "repeatMode": enum (RepeatMode)
}

enum (MediaType)

このレスポンスのメディアタイプ。

string (Duration format)

最初のメディア オブジェクトの開始オフセット。

小数点以下 9 桁まで、「s」で終わる秒単位の期間（例: "3.5s"）。

enum (OptionalMediaControls)

このメディア レスポンス セッションがサポートするオプションのメディア コントロール タイプ。設定すると、特定のメディア イベントが発生したときにサードパーティにリクエストが送信されます。設定しない場合、3p は引き続き 2 つのデフォルトのコントロール タイプ（FINISHED と FAILED）を処理する必要があります。

object (MediaObject)

メディア オブジェクトのリスト。

enum (RepeatMode)

メディア オブジェクト リストの繰り返しモード。

{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}

string

このメディア オブジェクトの名前。

string

このメディア オブジェクトの説明。

string

メディア コンテンツを指す URL。

object (MediaImage)

メディアカードとともに表示する画像。

{

  // Union field image can be only one of the following:
  "large": {
    object (StaticImagePrompt)
  },
  "icon": {
    object (StaticImagePrompt)
  }
  // End of list of possible types for union field image.
}

object (StaticImagePrompt)

アルバムのカバーなど、大きな画像

object (StaticImagePrompt)

タイトルの右側に表示される小さな画像アイコン。36×36 dp にサイズ変更されます。

{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}

string

（省略可）リストのタイトル。

string

（省略可）リストのサブタイトル。

object (ListItem)

必須。リストアイテム。

{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}

string

必須。関連するタイプのエントリキー名と一致する NLU キー。アイテムがタップされると、このキーが選択オプション パラメータとしてポストバックされます。

string

必須。商品アイテムのタイトル。タップすると、あたかもユーザーがこのテキストをキーボードから入力したかのように、このテキストが会話にそのままポストバックされます。各タイトルはアイテムのセットの中で一意である必要があります。

string

（省略可）商品アイテムの本文。

object (StaticImagePrompt)

（省略可）項目の画像。

{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}

string

（省略可）コレクションのタイトル。

string

（省略可）コレクションのサブタイトル。

object (CollectionItem)

必須。コレクション アイテム。

enum (ImageFill)

（省略可）画像表示オプションのタイプ。

{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}

string

必須。関連するタイプのエントリキー名と一致する NLU キー。アイテムがタップされると、このキーが選択オプション パラメータとしてポストバックされます。

string

必須。商品アイテムのタイトル。タップすると、あたかもユーザーがこのテキストをキーボードから入力したかのように、このテキストが会話にそのままポストバックされます。各タイトルはアイテムのセットの中で一意である必要があります。

string

（省略可）商品アイテムの本文。

object (StaticImagePrompt)

（省略可）項目の画像。

{
  "items": [
    {
      object (CollectionBrowseItem)
    }
  ],
  "imageFill": enum (ImageFill)
}

object (CollectionBrowseItem)

ブラウズ コレクション内のアイテム。リストのサイズは [2, 10] の範囲で指定してください。

enum (ImageFill)

コレクションの画像表示オプション。

{
  "title": string,
  "description": string,
  "footer": string,
  "image": {
    object (StaticImagePrompt)
  },
  "openUriAction": {
    object (OpenUrl)
  }
}

string

必須。コレクション アイテムのタイトル。

string

コレクション アイテムの説明。

string

説明の下に表示されるコレクション アイテムのフッター テキスト。1 行のテキスト（省略記号で切り捨てられます）。

object (StaticImagePrompt)

コレクション アイテムの画像。

object (OpenUrl)

必須。アイテムが選択されている場合に開く URI。

{
  "title": string
}

string

必須。候補ワードに表示されるテキスト。タップすると、あたかもユーザーがこのテキストをキーボードから入力したかのように、このテキストが会話にそのままポストバックされます。一連の候補ワードの間でタイトルが重複していてはなりません。最大 25 文字

{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "sendStateDataToCanvasApp": boolean,
  "enableFullScreen": boolean
}

string

必須。読み込むウェブビューの URL。

value (Value format)

（省略可）没入型エクスペリエンスのウェブページにイベントとして渡される JSON データ。含まれているプロンプトの override フィールドが false の場合、この Canvas プロンプトで定義されているデータ値は、以前の Canvas プロンプトで定義したデータ値の後に追加されます。

boolean

（省略可）値を true に設定した場合、この没入感のある応答がユーザーに表示された後、入力をキャプチャするためにマイクが開かれません。

boolean

（省略可）true の場合、会話関連のメタデータが含まれ、キャンバス アプリケーションに返されます。

boolean

（省略可）true の場合、キャンバス アプリケーションが全画面表示され、上部にヘッダーは表示されません。読み込み画面にトースト メッセージも表示され、アクションの表示名、デベロッパーの名前、アクションの終了手順などを確認できます。デフォルト値: false

{
  "onEnter": {
    object (EventHandler)
  },
  "intentEvents": [
    {
      object (IntentEvent)
    }
  ],
  "conditionalEvents": [
    {
      object (ConditionalEvent)
    }
  ],
  "slots": [
    {
      object (Slot)
    }
  ],
  "onSlotUpdated": {
    object (EventHandler)
  }
}

object (EventHandler)

このシーンに遷移するときに呼び出すハンドラ。

object (IntentEvent)

インテントに基づいてトリガーされるイベントのリスト。これらのイベントは、on_load ハンドラが呼び出された後、いつでもトリガーできます。重要 - これらのイベントは、このシーンをスコープとするインテントのセットを定義します。また、これらのイベントは、同じインテントまたはトリガー フレーズを持つグローバルに定義されたイベントよりも優先されます。インテント名はシーン内で一意である必要があります。

object (ConditionalEvent)

条件ステートメントに基づいてトリガーするイベントのリスト。これらは、フォームへの入力後、またはこのシーンにフォームがない場合は on_load の直後に評価されます（評価は 1 回だけ行われます）。最初に一致したイベントのみがトリガーされます。

object (Slot)

スロットの順序付きリスト。各スロットで解決するデータのタイプと、その解決（プロンプトなど）のエクスペリエンスをカスタマイズするための設定を定義します。

object (EventHandler)

別の Handler 内の更新以外に起因するスロットの状態の変化があったときに呼び出されるハンドラ。これにより、スロットの無効化、シーンの無効化など、シーン状態の変更が可能になります。

{
  "intent": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}

string

必須。イベントをトリガーするインテント。

string

（省略可）会話のジャンプ先となるデスティネーション シーン。現在のシーンの状態は、遷移時に破棄されます。

object (EventHandler)

（省略可）インテントが一致したときにトリガーされるイベント ハンドラ。移動先のシーンに移行する前に実行する必要があります。イベントに対するプロンプトを生成する場合に役立つ

{
  "condition": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}

string

必須。このイベントをトリガーするフィルタ条件。条件が true と評価されると、関連する handler がトリガーされます。サポートされている変数参照は次のとおりです。$session - セッション ストレージのデータを参照する。$user - ユーザー ストレージ内のデータを参照するため。サポートされているブール演算子（例あり）: && - session.params.counter > 0 && session.params.counter < 100 || - session.params.foo == "John" || session.params.counter == "Adam" ! - !(session.params.counter == 5) 次の比較がサポートされています: ==、!=、<、>、<=、>= 次のリスト演算子と文字列演算子がサポートされています（例あり）。in - session.params.fruitList の "Watermelon" session.params.fruitList size - size(session.params.fruitList) > 2 session.params.fullName.contains("John")substring

string

（省略可）関連付けられた条件が true と評価されたときに会話がジャンプする宛先シーン。現在のシーンの状態は、遷移時に破棄されます。

object (EventHandler)

（省略可）関連付けられた条件が true と評価されたときにトリガーされるイベント ハンドラ。移動先のシーンに移行する前に実行する必要があります。イベントに応じてプロンプトを生成する場合に役立ちます。

{
  "name": string,
  "type": {
    object (ClassReference)
  },
  "required": boolean,
  "promptSettings": {
    object (PromptSettings)
  },
  "commitBehavior": {
    object (CommitBehavior)
  },
  "config": value,
  "defaultValue": {
    object (DefaultValue)
  }
}

string

必須。スロットの名前。

object (ClassReference)

必須。このスロットのデータ型を宣言します。

boolean

（省略可）次に進む前にスロットを埋める必要があるかどうかを示します。必須の時間枠が埋まっていない場合は、カスタマイズ可能なプロンプトがユーザーに表示されます。

object (PromptSettings)

（省略可）スロットフィルのさまざまなステージに対応するプロンプトを登録します。

object (CommitBehavior)

（省略可）スロットに関連付けられた commit 動作。

value (Value format)

（省略可）スロットを埋めるために使用される、スロットに関連付けられた追加の設定。構成の形式は、スロットのタイプに固有のものです。ユーザー パラメータまたはセッション パラメータへのリソース参照をこの構成に追加できます。この構成ファイルは、トランザクションとユーザー エンゲージメントに関連するスロットを埋めるために必要です。

例: actions.type.CompletePurchaseValue タイプのスロットの場合、次の構成では、クライアント定義のセッション パラメータ userSelectedSkuId を参照してデジタル グッド注文を提案します。

{ "@type": "type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec", "skuId": { "skuType": "SKU_TYPE_IN_APP", "id": "$session.params.userSelectedSkuId", "packageName": "com.example.company" } }

object (DefaultValue)

（省略可）このスロットのデフォルト値を入力するための設定。

{
  "initialPrompt": {
    object (EventHandler)
  },
  "noMatchPrompt1": {
    object (EventHandler)
  },
  "noMatchPrompt2": {
    object (EventHandler)
  },
  "noMatchFinalPrompt": {
    object (EventHandler)
  },
  "noInputPrompt1": {
    object (EventHandler)
  },
  "noInputPrompt2": {
    object (EventHandler)
  },
  "noInputFinalPrompt": {
    object (EventHandler)
  }
}

object (EventHandler)

スロット値自体のプロンプト。例: 「どのサイズをご希望ですか？」

object (EventHandler)

初回は、ユーザーの入力がスロットに想定される値のタイプと一致しないときに表示されるプロンプト。例: 「聞き取れませんでした。」

object (EventHandler)

ユーザーの入力が 2 回目のスロットに想定される値のタイプと一致しない場合に表示されるプロンプト。例: 「聞き取れませんでした。」

object (EventHandler)

ユーザーの入力が、前回スロットに想定される値のタイプと一致しない場合に表示されるプロンプト。例: 「聞き取れませんでした。」

object (EventHandler)

ユーザーが初めて入力を行わないときに表示されるプロンプト。例: 「聞き取れませんでした。」

object (EventHandler)

ユーザーが 2 度目に入力しなかった場合に表示されるプロンプト。例: 「聞き取れませんでした。」

object (EventHandler)

ユーザーが前回入力を行わなかったときに表示されるプロンプト。例: 「聞き取れませんでした。」

{
  "writeSessionParam": string
}

string

スロット値が入力された後にスロット値を書き込むセッション パラメータ。ネストされたパスは現在サポートされていません。「$$」は、スロットと同じ名前のセッション パラメータにスロット値を書き込むために使用されます。例: writeSessionParam = "fruit" は "$session.params.fruit" に対応し、writeSessionParam = "ticket" は "$session.params.ticket" に対応します。

{
  "sessionParam": string,
  "constant": value
}

string

（省略可）空でない場合、スロット値の初期化に使用されるセッション パラメータ。値のタイプはスロットのタイプと一致する必要があります。ネストされたパスは現在サポートされていません。たとえば、sessionParam = "fruit" は $session.params.fruit に対応します。sessionParam = "ticket" は $session.params.ticket に対応します。

value (Value format)

（省略可）スロットの定数デフォルト値。これは、このスロットの値が sessionParam を介して入力されなかった場合にのみ使用されます。値のタイプはスロットのタイプと一致する必要があります。

{
  "dataFiles": [
    {
      object (DataFile)
    }
  ]
}

object (DataFile)

複数のデータファイル。

{
  "filePath": string,
  "contentType": string,
  "payload": string
}

string

SDK ファイル構造内のプロジェクト ルートからのデータファイルの相対パス。使用できるファイルパス: - 画像: resources/images/{multiple directories}?/{ImageName}.{extension} - 音声: resources/audio/{multiple directories}?/{AudioFileName}.{extension} - インライン Cloud Functions 関数コード: webhooks/{WebhookName}.zip 許可される拡張機能: - 画像: png、jpg、jpeg - 音声: mp3、mpeg - インライン Cloud Functions: zip

string

必須。このアセットのコンテンツ タイプ。例: text/html。コンテンツ タイプは仕様（http://www.w3.org/Protocols/rfc1341/4_Content-Type.html)）に準拠している必要があります。Cloud Functions は ZIP 形式にする必要があります。コンテンツ タイプは application/zip;zip_type=cloud_function にする必要があります。zip_type パラメータは、zip が Cloud Functions 用の関数であることを示します。

string (bytes format)

データファイルの内容。たとえば、画像、音声ファイル、Cloud Functions の ZIP 形式の RAW バイトなどです。ペイロード サイズには 10 MB の厳格な上限があります。

Base64 でエンコードされた文字列。