ActionPackage

ActionPackage は、アプリのドラフトやデプロイ済みの各バージョンのコンテンツを保持します。これには、ディレクトリ リスティングの詳細、会話の構成、アカウント リンクが含まれます。

JSON 表現
{
  "manifest": {
    object (Manifest)
  },
  "accountLinking": {
    object (AccountLinking)
  },
  "actions": [
    {
      object (Action)
    }
  ],
  "types": [
    {
      object (Type)
    }
  ],
  "conversations": {
    string: {
      object(ConversationFulfillment)
    },
    ...
  },
  "locale": string
}
フィールド
manifest

object (Manifest)

アプリの詳細。ここに、ディレクトリ リスティングに加え、displayName などのアプリの識別情報も保存されます。

accountLinking

object (AccountLinking)

このアプリでのアカウントのリンクの詳細。

actions[]

object (Action)

アプリが処理できるアクションのリスト。

types[]

object (Type)

デベロッパーが定義したタイプのリスト。

conversations

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

actions 間で共有できる会話をマッピングします。たとえば、FulfillmentconversationName をご覧ください。

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

locale

string

このアクション パッケージの言語 / 地域。「en」「en-US」「fr」「fr-CA」「sr-Latn」「zh-Hans」「zh-Hans-CN」「zh-Hant」「zh-Hant-HK」などの BCP-47 言語文字列で表現されます。アプリが複数の言語をサポートする場合は必須です。サポートされるロケールごとに固有の ActionPackage があります。値を指定しないと、エージェントのデフォルトのロケールが暗黙的に指定されます。

Manifest

アプリのメタデータのセットです。このメッセージの内容は次のような複数のコンテキストで使用されます。

  1. Actions on Google のディレクトリ リスティング ページ。
  2. 明示的呼び出し用のアプリの一意の ID(displayName)。
  3. ActionPackage の他の部分のコンテンツ(shortDescriptionAccountLinking での表示に、displayNameactions でユーザーにアプリ名を表示するために使用)。

このメッセージは読み取り専用です。このメッセージのフィールドは Actions Console で指定し、アクション パッケージでは直接指定しません。

JSON 表現
{
  "displayName": string,
  "invocationName": string,
  "enabledRegions": [
    string
  ],
  "disabledRegions": [
    string
  ],
  "shortDescription": string,
  "longDescription": string,
  "category": string,
  "smallSquareLogoUrl": string,
  "largeLandscapeLogoUrl": string,
  "companyName": string,
  "contactEmail": string,
  "termsOfServiceUrl": string,
  "privacyUrl": string,
  "sampleInvocation": [
    string
  ],
  "introduction": string,
  "testingInstructions": string,
  "voiceName": string,
  "externalVoiceName": string,
  "voiceLocale": string,
  "surfaceRequirements": {
    object (SurfaceRequirements)
  }
}
フィールド
displayName

string

このアプリのデフォルトの表示名(翻訳がない場合)。例: 「Starbucks」。これは、ユーザーが(invocationName に加えて)このアプリを呼び出す方法としても使用されます。表示名は一意で、発音が invocationName と非常によく似ている必要があります。

invocationName

string

これは、このアプリが音声(音声)コンテキスト内で直接呼び出すための一意の名前です。ポリシーにより、呼び出し名は発音が displayName フィールドによく似ている必要があります。

enabledRegions[]

string (int64 format)

ユーザーの所在地に基づいてアプリが許可されている地域の AdWords 条件 ID。https://developers.google.com/adwords/api/docs/appendix/geotargeting をご覧ください。

disabledRegions[]

string (int64 format)

ユーザーの所在地に基づいてアプリがブロックされている地域の AdWords 条件 ID。https://developers.google.com/adwords/api/docs/appendix/geotargeting をご覧ください。

shortDescription

string

アプリのデフォルトの簡単な説明(翻訳がない場合)。最大 80 文字に制限されています。

longDescription

string

アプリのデフォルトの詳しい説明(翻訳がない場合)。最大 4,000 文字に制限されています。

category

string

アプリのカテゴリ。この値は、アプリで許可されているカテゴリのいずれかである必要があります。許可されているカテゴリのリストについては、Actions on Google Console をご覧ください。

smallSquareLogoUrl

string

小さい正方形の画像。寸法は 192×192 ピクセルでなければなりません。

largeLandscapeLogoUrl

string

大きい横長の画像。寸法は 2,208×1,242 ピクセルでなければなりません。

companyName

string

アプリが関連付けられている会社の名前。

contactEmail

string

ユーザーがアプリに関する連絡に使用できる連絡先メールアドレス。

termsOfServiceUrl

string

アプリの利用規約の URL。

privacyUrl

string

アプリのプライバシー ポリシーの URL です。

sampleInvocation[]

string

すべてのアプリのディレクトリに、アプリの説明の一部として表示される呼び出しフレーズのサンプル。指定できる値は 5 つだけです。

introduction

string

アプリの機能の概要です。ユーザーにアプリを紹介する場合に使用されます。これは「このアプリを使用して...」のような動詞で完成させる必要があります。

testingInstructions

string

アプリ審査担当者向けの自由形式のテスト手順。

voiceName

string

使用する音声の名前。サポートされている値の例: male_1male_2female_1female_2

externalVoiceName

string

このエージェントの外部音声名。言語 / 地域情報は含まれません。

voiceLocale

string

このエージェントの音声の言語 / 地域。空の文字列に設定すると、実行時にユーザーのロケールに解決されます。

surfaceRequirements

object (SurfaceRequirements)

アプリをトリガーするために満たす必要がある、Google アシスタント クライアント サーフェスの要件のセット。

SurfaceRequirements

このエージェントを呼び出すために満たされていなければならないクライアント サーフェスの要件のセットが含まれます。ここに記述された要件が満たされていない場合、エージェントは呼び出されません。

JSON 表現
{
  "minimumCapabilities": [
    {
      object (Capability)
    }
  ]
}
フィールド
minimumCapabilities[]

object (Capability)

エージェントが機能するために最低限必要な機能セット。これらのいずれか 1 つでも欠けている場合、エージェントは呼び出されません。

Capability

ある特定の機能が備わっていなければならないことを表します。

JSON 表現
{
  "name": string
}
フィールド
name

string

機能の名前(例: actions.capability.AUDIO_OUTPUT)

種類

アクション内で参照できる型。これらは、そのアクションに固有のカスタム型、または Google によって定義されアクション内で参照される共通型にすることができます。

JSON 表現
{
  "name": string,
  "entities": [
    {
      object (Entity)
    }
  ],
  "isUserDefined": boolean
}
フィールド
name

string

カスタムタイプの名前。type の形式で指定します。

entities[]
(deprecated)

object (Entity)

この型のエンティティのリスト。各エンティティにはキーと同義語のリストが含まれます。

isUserDefined

boolean

エンティティがユーザー定義かどうか(ユーザーごとに異なる)。

エンティティ

対応する各エンティティはこの型に固有です。キーは一意である必要があり、同義語のリストはトリガーに使用されます。

JSON 表現
{
  "key": string,
  "synonyms": [
    string
  ]
}
フィールド
key

string

このアイテムの一意のキーです。

synonyms[]

string

このアイテムを指す場合に使用できる類義語のリスト。