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」、「zh-Hant-HK」等。每個支援的語言代碼都有各自的 ActionPackage。如未提供值,系統將默示代理程式的預設語言代碼。

資訊清單

應用程式的中繼資料組合。這則訊息的內容用於多種情境:

  1. 「Google 目錄」清單網頁上的動作
  2. 用於明確叫用的應用程式專屬識別 (displayName)。
  3. ActionPackage 其他部分的內容 (shortDescription 用於 AccountLinkingdisplayName 則用於 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 (SurfaceRequirements)
  }
}
欄位
displayName

string

這個應用程式的預設顯示名稱 (如果沒有翻譯可用),例如:「星巴克」。這個 API 也做為使用者叫用這個應用程式 (除了 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

應用程式的類別。這個值必須是應用程式允許使用的類別。如要查看允許類別清單,請查看 Google 控制台螢幕上的動作。

smallSquareLogoUrl

string

小型正方形圖片。尺寸必須為 192 x 192 像素。

largeLandscapeLogoUrl

string

大型橫向圖片。尺寸解析度為 2208 x 1242 像素。

companyName

string

與應用程式相關聯的公司名稱。

contactEmail

string

這個聯絡電子郵件地址可讓使用者與應用程式相關聯絡。

termsOfServiceUrl

string

應用程式服務條款 (服務條款) 的網址。

privacyUrl

string

應用程式隱私權政策的網址。

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)

代理程式運作所需的最低能力組合。如果途徑缺少上述任一項目,系統就不會觸發代理程式。

功能

代表指定功能可用性的要求

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

實體是否為使用者定義 (每位使用者都不同)。

實體

這種類型的每個 Entity 都各自獨立。索引鍵不得重複,並使用同義詞清單觸發觸發作業。

JSON 表示法
{
  "key": string,
  "synonyms": [
    string
  ]
}
欄位
key

string

這個項目的專屬金鑰。

synonyms[]

string

可用來參照這個項目的同義詞清單。