- JSON 表示法
- 清单
          <ph type="x-smartling-placeholder">- </ph>
            
- JSON 表示法
 
- SurfaceRequirements
          <ph type="x-smartling-placeholder">- </ph>
            
- JSON 表示法
 
- 权限
- 类型
          <ph type="x-smartling-placeholder">- </ph>
            
- JSON 表示法
 
- Entity
ActionPackage 包含应用草稿以及每个已部署版本的内容。包括目录详情、对话配置和账号关联。
| JSON 表示法 | |
|---|---|
| { "manifest": { object ( | |
| 字段 | |
|---|---|
| manifest | 
 应用的详细信息。这是保存目录列表以及其他应用标识(如 displayName)的位置。 | 
| accountLinking | 
 此应用中账号关联的详细信息。 | 
| actions[] | 
 应用能够处理的操作的列表。 | 
| types[] | 
 开发者定义的类型的列表。 | 
| conversations | 
 映射可在  包含一系列  | 
| locale | 
 此操作包的语言区域。由 BCP-47 语言字符串表示,例如“en”“en-US”“fr”“fr-CA”“sr-Latn”“zh-Hans”“zh-Hans-CN”“zh-Hant”“zh-Hant-HK”等。如果应用支持多种语言,则必须执行此操作。每个受支持的语言区域都有自己的 ActionPackage。如果未提供值,系统将默认表示代理的默认语言区域。 | 
清单
应用的元数据集。此消息的内容用于多种上下文:
- 操作。
- 用于显式调用的应用唯一标识 (displayName)。
- ActionPackage中其他部分的内容(- shortDescription用于在- AccountLinking中显示,- displayName在- actions中用于向用户显示应用名称)。
此消息为只读。您可以通过操作控制台指定此消息中的字段,而不是直接在操作包中指定。
| 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 ( | |
| 字段 | |
|---|---|
| displayName | 
 此应用的默认显示名称(如果没有翻译版本),例如“Starbucks”。除  | 
| invocationName | 
 这是此应用在语音(讲话)上下文中直接调用它的唯一名称。政策要求调用名称的发音必须与  | 
| enabledRegions[] | 
 允许应用所面向的区域的 AdWords 条件 ID(根据用户所在位置确定)。请参阅 https://developers.google.com/adwords/api/docs/appendix/geotargeting | 
| disabledRegions[] | 
 根据用户所在位置确定应用被屏蔽区域的 AdWords 条件 ID。请参阅 https://developers.google.com/adwords/api/docs/appendix/geotargeting | 
| shortDescription | 
 应用的默认简短说明(如果没有翻译版本)。不得超过 80 个字符。 | 
| longDescription | 
 应用的默认详细说明(如果没有翻译版本)。不得超过 4000 个字符。 | 
| category | 
 应用的类别。该值必须是允许的应用类别之一。如需查看允许的类别列表,请查看 Google 控制台上的操作。 | 
| smallSquareLogoUrl | 
 小方形图片。尺寸必须为 192px x 192px。 | 
| largeLandscapeLogoUrl | 
 横向大型图片。尺寸必须为 2208 x 1242 像素。 | 
| companyName | 
 与应用关联的公司的名称。 | 
| contactEmail | 
 允许用户就应用事宜进行联系的联系电子邮件地址。 | 
| termsOfServiceUrl | 
 应用的服务条款 (ToS) 的网址。 | 
| privacyUrl | 
 应用的隐私权政策网址。 | 
| sampleInvocation[] | 
 作为应用说明的一部分显示在所有应用的目录中的调用短语示例。只能提供 5 个值。 | 
| introduction | 
 应用功能摘要。用于向用户介绍应用。这应该是完成句子的动词短语,如“您可以使用此应用...” | 
| testingInstructions | 
 面向应用审核者的自由形式测试说明。 | 
| voiceName | 
 要使用的语音名称。支持的示例值: | 
| externalVoiceName | 
 此代理的外部语音名称。不包含语言区域信息。 | 
| voiceLocale | 
 此代理的语音的语言区域。如果设置为空字符串,则系统会在运行时将其解析为用户的语言区域。 | 
| surfaceRequirements | 
 针对 Google 助理客户端 Surface 的一系列要求,应用必须满足这些要求,才能触发。 | 
SurfaceRequirements
包含针对客户端 surface 的一组要求,这些要求必须满足才能触发代理。如果未满足此处所列的任何要求,代理就不会被触发。
| JSON 表示法 | |
|---|---|
| {
  "minimumCapabilities": [
    {
      object ( | |
| 字段 | |
|---|---|
| minimumCapabilities[] | 
 代理正常运行所需的最小功能集。如果平台缺少其中任何一项,代理都不会触发。 | 
能力
表示关于给定功能可用性的要求
| JSON 表示法 | |
|---|---|
| { "name": string } | |
| 字段 | |
|---|---|
| name | 
 功能的名称,例如actions.capability.AUDIO_OUTPUT | 
类型
可在 Action 内引用的类型。这些类型可以是相应操作独有的自定义类型,也可以是 Google 定义并在操作中引用的常见类型。
| JSON 表示法 | |
|---|---|
| {
  "name": string,
  "entities": [
    {
      object ( | |
| 字段 | |
|---|---|
| name | 
 自定义类型的名称,格式为  | 
| entities[] | 
 此类型的实体列表。每个都包含一个键和同义词列表。 | 
| isUserDefined | 
 实体是否是用户定义的(对每个用户都不同)。 | 
实体
每个 Entity 对应对于该类型都是唯一的。键应该是唯一的,并且同义词列表用于触发。
| JSON 表示法 | |
|---|---|
| { "key": string, "synonyms": [ string ] } | |
| 字段 | |
|---|---|
| key | 
 此项的唯一键。 | 
| synonyms[] | 
 可用于指代此项目的同义词列表。 | 
