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 . Например, см. conversationName в Fulfillment .

Объект, содержащий список пар "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. действия на странице со списком каталогов Google.
  2. Уникальный идентификатор приложения для явного вызова ( displayName ).
  3. Содержимое для других частей 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 (SurfaceRequirements)
  }
}
Поля
displayName

string

Отображаемое имя по умолчанию для этого приложения (если перевод недоступен), например «Starbucks». Это также используется пользователями как метод для вызова этого приложения (в дополнение к invocationName ). Отображаемое имя должно быть уникальным и фонетически очень похожим на invocationName .

invocationName

string

Это уникальное имя для этого приложения, позволяющее напрямую вызывать его в голосовом (речевом) контексте. Политики требуют, чтобы имя вызова фонетически было очень похоже на поле displayName .

enabledRegions[]

string ( int64 format)

Идентификаторы критериев AdWords для регионов, в которых разрешено использование приложения, в зависимости от местоположения пользователя. См. https://developers.google.com/adwords/api/docs/appendix/geotargeting .

disabledRegions[]

string ( int64 format)

Идентификаторы критериев AdWords для регионов, в которых приложение блокируется, в зависимости от местоположения пользователя. См. https://developers.google.com/adwords/api/docs/appendix/geotargeting .

shortDescription

string

Краткое описание приложения по умолчанию (если перевод недоступен). Это ограничено 80 символами.

longDescription

string

Полное описание приложения по умолчанию (если перевод недоступен). Оно ограничено 4000 символами.

category

string

Категория приложения. Значение должно быть одной из разрешенных категорий для приложений. Список разрешенных категорий см. в действиях в консоли Google.

smallSquareLogoUrl

string

Небольшое квадратное изображение. Размеры должны быть 192 х 192 пикселя.

largeLandscapeLogoUrl

string

Большое пейзажное изображение. Размеры должны быть 2208х1242 пикселей.

companyName

string

Название компании, с которой связано приложение.

contactEmail

string

Контактный адрес электронной почты, по которому пользователи смогут связаться по поводу Приложения.

termsOfServiceUrl

string

URL-адрес ToS (Условий обслуживания) для приложения.

privacyUrl

string

URL-адрес политики конфиденциальности приложения.

sampleInvocation[]

string

Пример фразы вызова, отображаемой как часть описания приложения в каталоге всех приложений. Можно указать только 5 значений.

introduction

string

Краткое описание возможностей приложения. Используется для ознакомления пользователей с приложением. Это должна быть глагольная группа, завершающая предложение типа «Вы можете использовать это приложение, чтобы…».

testingInstructions

string

Инструкции по тестированию в свободной форме для рецензента приложения.

voiceName

string

Голосовое имя, которое будет использоваться. Поддерживаемые примеры значений: male_1 , male_2 , female_1 , female_2 .

externalVoiceName

string

Внешнее голосовое имя этого агента. Не содержит информации о локали.

voiceLocale

string

Язык голоса этого агента. Если задана пустая строка, она будет преобразована в локаль пользователя во время выполнения.

surfaceRequirements

object ( SurfaceRequirements )

Набор требований к клиентской поверхности Google Assistant, которые должны быть выполнены для запуска приложения.

Требования к поверхности

Содержит набор требований к клиентской поверхности, которые должны быть выполнены для запуска агента. Если какое-либо из перечисленных здесь требований не выполнено, агент не запустится.

JSON-представление 
{
  "minimumCapabilities": [
    {
      object (Capability)
    }
  ]
}
Поля
minimumCapabilities[]

object ( Capability )

Минимальный набор возможностей, необходимый для функционирования агента. Если на поверхности отсутствует какой-либо из них, агент не сработает.

Возможность

Представляет требование о доступности данной возможности.

JSON-представление 
{
  "name": string
}
Поля
name

string

Имя возможности, например action.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

Список синонимов, которые можно использовать для обозначения этого элемента.