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 内共享的地图会话。有关示例,请参阅 Fulfillment 中的 conversationName

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

locale

string

此操作包的语言区域。由 BCP-47 语言字符串表示,例如“en”“en-US”“fr”“fr-CA”“sr-Latn”“zh-Hans”“zh-Hans-CN”“zh-Hant”“zh-Hant - HK”等。如果应用支持多种语言,则必须提供此值。每个受支持的语言区域都有自己的 ActionPackage。如果未提供值,系统将隐含代理的默认语言区域。

清单

应用的元数据集。此消息的内容用于多种上下文:

  1. 操作。
  2. 用于显式调用的应用的唯一标识符 (displayName)。
  3. ActionPackage 其他部分的内容(shortDescription 用于在 AccountLinking 中显示,displayNameactions 中用于向用户显示应用名称)。

此消息是只读的。您需要通过操作控制台指定此消息中的字段,而不是直接在操作包中指定。

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)

根据用户的所在位置确定屏蔽应用的地区的 Google Ads 条件 ID。请参阅 https://developers.google.com/adwords/api/docs/appendix/geotargeting

shortDescription

string

应用的默认简短说明(如果没有可用的翻译)。不得超过 80 个字符。

longDescription

string

应用的默认详细说明(如果没有可用的翻译)。不得超过 4000 个字符。

category

string

应用的类别。该值必须是应用允许的类别之一。如需查看允许类别的列表,请查看 Google 控制台中的操作。

smallSquareLogoUrl

string

方形小图片。尺寸必须为 192 x 192 像素。

largeLandscapeLogoUrl

string

横向大图片。尺寸不得超过 2208x1242 像素。

companyName

string

与应用程序关联的公司的名称。

contactEmail

string

供用户就应用事宜与您联系的电子邮件地址。

termsOfServiceUrl

string

应用的服务条款 (TOS) 网址。

privacyUrl

string

应用的隐私权政策的网址。

sampleInvocation[]

string

作为应用说明的一部分显示在“所有应用”目录中的调用短语示例。只能指定 5 个值。

introduction

string

应用的用途摘要。用于向用户介绍应用。这应该是一个动词短语,用来补全“You can use this App to...”之类的句子。

testingInstructions

string

面向应用审核人员的自由格式测试说明。

voiceName

string

要使用的语音名称。支持的值示例:male_1male_2female_1female_2

externalVoiceName

string

此代理的外部语音名称。不包含区域信息。

voiceLocale

string

此代理的语音语言区域。如果设置为空字符串,则在运行时将解析为用户的语言区域。

surfaceRequirements

object (SurfaceRequirements)

针对 Google 助理客户端 surface 的一组要求,必须满足这些要求才能触发应用。

SurfaceRequirements

包含针对客户端 surface 的一组要求,必须满足这些要求才能触发代理。如果未满足此处列出的任何要求,则代理将不会触发。

JSON 表示法
{
  "minimumCapabilities": [
    {
      object (Capability)
    }
  ]
}
字段
minimumCapabilities[]

object (Capability)

代理正常运行所需的最小功能集。如果 surface 缺少其中任何一项,系统将不会触发代理。

能力

表示与给定功能的可用性相关的要求

JSON 表示法
{
  "name": string
}
字段
name

string

功能的名称,例如 actions.capability.AUDIO_OUTPUT

类型

可在 Action 中引用的类型。这些类型可以是操作所独有的自定义类型,也可以是由 Google 定义并在操作中引用的常见类型。

JSON 表示法
{
  "name": string,
  "entities": [
    {
      object (Entity)
    }
  ],
  "isUserDefined": boolean
}
字段
name

string

自定义类型的名称,格式为 type

entities[]
(deprecated)

object (Entity)

此类型的实体列表。每个参数都包含一个键和一系列同义词。

isUserDefined

boolean

实体是否由用户定义(每个用户不同)。

实体

每个 Entity 对应的实体对于此类型都是唯一的。键应该是唯一的,并且同义词列表用于触发。

JSON 表示法
{
  "key": string,
  "synonyms": [
    string
  ]
}
字段
key

string

此项的唯一键。

synonyms[]

string

可用于引用此项的同义词列表。