ActionPackage

O ActionPackage contém o conteúdo do rascunho de um app e de cada versão implantada. Isso inclui detalhes da listagem no diretório, configuração da conversa e vinculação de contas.

Representação JSON
{
  "manifest": {
    object (Manifest)
  },
  "accountLinking": {
    object (AccountLinking)
  },
  "actions": [
    {
      object (Action)
    }
  ],
  "types": [
    {
      object (Type)
    }
  ],
  "conversations": {
    string: {
      object(ConversationFulfillment)
    },
    ...
  },
  "locale": string
}
Campos
manifest

object (Manifest)

Os detalhes do app. É aqui que a listagem do diretório é mantida, além de outras identificações do app, como displayName.

accountLinking

object (AccountLinking)

Os detalhes da vinculação de conta neste app.

actions[]

object (Action)

Lista de ações que o app pode processar.

types[]

object (Type)

Lista de tipos definidos pelo desenvolvedor.

conversations

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

Mapeie as conversas que podem ser compartilhadas no actions. Por exemplo, consulte o conversationName em Fulfillment.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

locale

string

A localidade deste pacote de ações. Isso é representado pelas strings de idioma BCP-47, como "en", "en-US", "fr", "fr-CA", "sr-Latn", "zh-Hans", "zh-Hans-CN", "zh-Hant", "zh-Hant-HK" etc. Isso é necessário quando um aplicativo oferece suporte a mais de um idioma. Cada localidade compatível tem o próprio ActionPackage. Se nenhum valor for fornecido, a localidade padrão do agente ficará implícita.

Manifesto

O conjunto de metadados do app. O conteúdo desta mensagem é usado em vários contextos:

  1. ações na página de listagem do diretório do Google.
  2. Identificação exclusiva de um app para invocação explícita (displayName).
  3. Conteúdo de outras partes de uma ActionPackage (shortDescription é usado para exibição no AccountLinking, e displayName é usado em actions para mostrar o nome do app aos usuários).

Esta mensagem é somente leitura. Você especifica os campos desta mensagem por meio do console de ações, e não diretamente no pacote de ações.

Representação 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)
  }
}
Campos
displayName

string

O nome de exibição padrão do app (se não houver uma tradução disponível), por exemplo, "Starbucks". Ele também é usado como um método para os usuários invocarem esse app (além de invocationName). O nome de exibição precisa ser exclusivo e foneticamente muito semelhante a invocationName.

invocationName

string

Este é o nome exclusivo do app para invocá-lo diretamente em um contexto de voz (falada). As políticas exigem que o nome da invocação seja foneticamente muito semelhante ao campo displayName.

enabledRegions[]

string (int64 format)

IDs de critério do Google AdWords para as regiões onde o aplicativo é permitido com base no local de presença do usuário. Consulte https://developers.google.com/adwords/api/docs/appendix/geotargeting

disabledRegions[]

string (int64 format)

IDs de critério do Google Ads para as regiões onde o aplicativo está bloqueado com base no local de presença do usuário. Consulte https://developers.google.com/adwords/api/docs/appendix/geotargeting

shortDescription

string

A breve descrição padrão do app, se não houver uma tradução disponível. Ele é limitado a 80 caracteres.

longDescription

string

A descrição longa padrão do app (se não houver uma tradução disponível). Isso é limitado a 4.000 caracteres.

category

string

A categoria do app. O valor precisa ser uma das categorias permitidas para apps. Consulte as ações no console do Google para conferir a lista de categorias permitidas.

smallSquareLogoUrl

string

Imagem quadrada pequena. As dimensões devem ser 192 px por 192 px.

largeLandscapeLogoUrl

string

Imagem grande em modo paisagem. As dimensões precisam ser 2.208 pixels por 1.242 pixels.

companyName

string

O nome da empresa a que o app está associado.

contactEmail

string

O endereço de e-mail de contato para que os usuários entrem em contato sobre o app.

termsOfServiceUrl

string

É o URL dos TOS (Termos de Serviço) do app.

privacyUrl

string

É o URL da Política de Privacidade do app.

sampleInvocation[]

string

Exemplo de frase de invocação exibida como parte da descrição no diretório de todos os apps. Somente cinco valores podem ser fornecidos.

introduction

string

Resumo do que um app pode fazer. Usado para apresentar o app aos usuários. Deve ser uma frase verbal que complete uma frase como "Você pode usar este aplicativo para..."

testingInstructions

string

Instruções de teste em formato livre para o revisor do app.

voiceName

string

O nome da voz a ser usada. Exemplos de valores aceitos: male_1, male_2, female_1, female_2.

externalVoiceName

string

O nome da voz externa deste agente. Não contém informações de localidade.

voiceLocale

string

A localidade da voz deste agente. Se definido como uma string vazia, ela será resolvida de acordo com a localidade do usuário no momento da execução.

surfaceRequirements

object (SurfaceRequirements)

Um conjunto de requisitos para a superfície do cliente do Google Assistente que precisam ser atendidos para que o app seja acionado.

SurfaceRequirements

Contém um conjunto de requisitos para a superfície do cliente que precisam ser atendidos para que o agente seja acionado. Se algum dos requisitos listados aqui não for atendido, o agente não será acionado.

Representação JSON
{
  "minimumCapabilities": [
    {
      object (Capability)
    }
  ]
}
Campos
minimumCapabilities[]

object (Capability)

O conjunto mínimo de recursos necessários para o funcionamento do agente. Se faltar algum desses elementos na superfície, o agente não será acionado.

Capacidade

Representa um requisito sobre a disponibilidade de uma determinada capacidade.

Representação JSON
{
  "name": string
}
Campos
name

string

O nome da capacidade, por exemplo, actions.capability.AUDIO_OUTPUT

Tipo

Um tipo que pode ser referenciado em uma ação. Eles podem ser tipos personalizados exclusivos da ação ou tipos comuns definidos pelo Google e referenciados na ação.

Representação JSON
{
  "name": string,
  "entities": [
    {
      object (Entity)
    }
  ],
  "isUserDefined": boolean
}
Campos
name

string

nome do tipo personalizado, no formato de type.

entities[]
(deprecated)

object (Entity)

Lista de entidades para esse tipo. Cada um inclui uma chave e uma lista de sinônimos.

isUserDefined

boolean

Define se as entidades são definidas pelo usuário (diferentes para cada usuário).

Entidade

Cada Entity corresponde é exclusiva para esse tipo. A chave precisa ser exclusiva e a lista de sinônimos é usada para acionamento.

Representação JSON
{
  "key": string,
  "synonyms": [
    string
  ]
}
Campos
key

string

Chave exclusiva para o item.

synonyms[]

string

Lista de sinônimos que podem ser usados para se referir a este item.