Files

Wrapper para uma lista de arquivos.

Representação JSON 
{

  // Union field file_type can be only one of the following:
  "configFiles": {
    object (ConfigFiles)
  },
  "dataFiles": {
    object (DataFiles)
  }
  // End of list of possible types for union field file_type.
}
Campos
Campo de união file_type. Somente um tipo de arquivo pode ser enviado por vez ao servidor: arquivos de configuração ou arquivos de dados. file_type pode ser apenas de um dos tipos a seguir:
configFiles

object (ConfigFiles)

Lista de arquivos de configuração. Isso inclui manifesto, configurações, pacotes de recursos do modelo de interação e muito mais.
dataFiles

object (DataFiles)

Lista de arquivos de dados. Isso inclui imagem, arquivo de áudio e código-fonte da função do Cloud.

ConfigFiles

Wrapper para arquivos de configuração repetidos. Não é possível haver campos repetidos em um oneof.

Representação JSON 
{
  "configFiles": [
    {
      object (ConfigFile)
    }
  ]
}
Campos
configFiles[]

object (ConfigFile)

Vários arquivos de configuração.

ConfigFile

Representa um único arquivo que contém dados estruturados. Os desenvolvedores podem definir a maior parte do projeto usando uma configuração estruturada, incluindo Actions, Settings, Fulfillment.

Representação JSON 
{
  "filePath": string,

  // Union field file can be only one of the following:
  "manifest": {
    object (Manifest)
  },
  "actions": {
    object (Actions)
  },
  "settings": {
    object (Settings)
  },
  "webhook": {
    object (Webhook)
  },
  "intent": {
    object (Intent)
  },
  "type": {
    object (Type)
  },
  "entitySet": {
    object (EntitySet)
  },
  "globalIntentEvent": {
    object (GlobalIntentEvent)
  },
  "scene": {
    object (Scene)
  },
  "staticPrompt": {
    object (StaticPrompt)
  },
  "accountLinkingSecret": {
    object (AccountLinkingSecret)
  },
  "resourceBundle": {
    object
  }
  // End of list of possible types for union field file.
}
Campos
filePath

string

O caminho relativo do arquivo de configuração da raiz do projeto na estrutura de arquivos do SDK. Cada tipo de arquivo abaixo tem um caminho de arquivo permitido. Por exemplo: settings/settings.yaml
Campo de união file. Cada tipo de arquivo de configuração precisa ter um campo correspondente em oneof. file pode ser apenas de um dos tipos a seguir:
manifest

object (Manifest)

Arquivo de manifesto único. Caminho de arquivo permitido: manifest.yaml
actions

object (Actions)

Um único arquivo de ações com todas as ações definidas. Caminhos de arquivo permitidos: actions/{language}?/actions.yaml
settings

object (Settings)

Configuração de configurações únicas que inclui configurações e definições não localizáveis para a localidade padrão do projeto (se especificada). Para um arquivo de substituição de localidade, somente o campo localizedSettings será preenchido. Caminhos de arquivo permitidos: settings/{language}?/settings.yaml O arquivo de configurações não localizado settings/settings.yaml precisa estar presente nas solicitações de fluxo de gravação.
webhook

object (Webhook)

Definição de webhook único. Caminho de arquivo permitido: webhooks/{WebhookName}.yaml
intent

object (Intent)

Definição de intent única. Caminhos de arquivo permitidos: custom/intents/{language}?/{IntentName}.yaml
type

object (Type)

Definição de tipo único. Caminhos de arquivo permitidos: custom/types/{language}?/{TypeName}.yaml
entitySet

object (EntitySet)

Definição de conjunto de entidades únicas. Caminhos de arquivo permitidos: custom/entitySets/{language}?/{EntitySetName}.yaml
globalIntentEvent

object (GlobalIntentEvent)

Definição única de evento de intent global. Caminhos de arquivo permitidos: custom/global/{GlobalIntentEventName}.yaml O nome do arquivo (GlobalIntentEventName) precisa ser o nome da intent a que esse evento de intent global corresponde.
scene

object (Scene)

Definição de cena única. Caminhos de arquivo permitidos: custom/scenes/{SceneName}.yaml
staticPrompt

object (StaticPrompt)

Definição de comando estático único. Caminhos de arquivo permitidos: custom/prompts/{language}?/{StaticPromptName}.yaml
accountLinkingSecret

object (AccountLinkingSecret)

Metadados correspondentes à chave secreta do cliente usada na vinculação da conta. Caminho de arquivo permitido: settings/accountLinkingSecret.yaml
resourceBundle

object (Struct format)

Pacote de recursos únicos, que é um mapa de uma string para uma string ou lista de strings. É possível usar pacotes de recursos para localizar strings em comandos estáticos. Caminhos de arquivo permitidos: resources/strings/{language}?/{multiple directories}?/{BundleName}.yaml

Manifesto

Contém informações "transportáveis" ou seja, não é específico para um determinado projeto e pode ser movido entre projetos.

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

string

Versão do formato do arquivo. A versão atual do formato de arquivo é 1.0 Exemplo: "1.0"

Ações

Representa a lista de ações definidas em um projeto.

Representação JSON 
{
  "custom": {
    string: {
      object (CustomAction)
    },
    ...
  }
}
Campos
custom

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

Mapeie as intents para ações personalizadas para configurar a invocação do projeto. As intents de invocação podem ser intents personalizadas ou do sistema definidas no arquivo . Todas as intents definidas aqui (intents do sistema e personalizadas) precisam ter um arquivo de intent correspondente no campo "custom/global/" .

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

CustomAction

Detalhes sobre uma ação personalizada.

Representação JSON 
{
  "engagement": {
    object (Engagement)
  }
}
Campos
engagement

object (Engagement)

Mecanismos de engajamento associados à ação para ajudar os usuários finais a se inscreverem em notificações push e atualizações diárias. O nome da intent especificado na configuração do slot das atualizações diárias/notificações push precisa corresponder à intent correspondente a essa ação para que os usuários finais se inscrevam nessas atualizações.

Engajamento

Define os mecanismos de engajamento associados a essa ação. Isso permite que os usuários finais se inscrevam para receber notificações push e atualizações diárias.

Representação JSON 
{
  "title": string,
  "pushNotification": {
    object (PushNotification)
  },
  "actionLink": {
    object (ActionLink)
  },
  "assistantLink": {
    object (AssistantLink)
  },
  "dailyUpdate": {
    object (DailyUpdate)
  }
}
Campos
title

string

O título do engajamento que será enviado aos usuários finais pedindo permissão para receber atualizações. O aviso enviado aos usuários finais para atualizações diárias é assim: "A que horas vocês querem que eu envie seu {title}" diário? e, para as notificações push, será "Tudo bem se eu enviar notificações push para {title}". Esse campo pode ser localizado.
pushNotification

object (PushNotification)

Configurações de notificação push compatíveis com este engajamento.
dailyUpdate

object (DailyUpdate)

Configurações de atualização diária compatíveis com esse engajamento.

PushNotification

Define as configurações de notificação push compatíveis com esse engajamento.

DailyUpdate

Define as configurações de atualização diária que esse engajamento oferece.

Configurações

Representa as configurações de um projeto do Actions que não são específicas da localidade. Próxima tag: 22

Representação JSON 
{
  "projectId": string,
  "defaultLocale": string,
  "enabledRegions": [
    string
  ],
  "disabledRegions": [
    string
  ],
  "category": enum (Category),
  "usesTransactionsApi": boolean,
  "usesDigitalPurchaseApi": boolean,
  "usesInteractiveCanvas": boolean,
  "usesHomeStorage": boolean,
  "designedForFamily": boolean,
  "containsAlcoholOrTobaccoContent": boolean,
  "keepsMicOpen": boolean,
  "surfaceRequirements": {
    object (SurfaceRequirements)
  },
  "testingInstructions": string,
  "localizedSettings": {
    object (LocalizedSettings)
  },
  "accountLinking": {
    object (AccountLinking)
  },
  "selectedAndroidApps": [
    string
  ]
}
Campos
projectId

string

ID do projeto das ações.
defaultLocale

string

Localidade padrão do projeto. Para todos os arquivos, exceto em resources/ e sem localidade no caminho, os dados localizados são atribuídos a este defaultLocale. Para arquivos em resources/, "sem localidade" significa que o recurso é aplicável a todas as localidades.
enabledRegions[]

string

Representa as regiões em que os usuários podem invocar suas ações, com base no local de presença deles. Não é possível definir se disabledRegions está definido. Se enabledRegions e disabledRegions não forem especificados, os usuários poderão invocar suas ações em todas as regiões. Cada região é representada usando o nome canônico das segmentações por área geográfica do Google AdWords. Consulte https://developers.google.com/adwords/api/docs/appendix/geotargeting. Os exemplos incluem: - "Alemanha". - "Gana" - "Grécia" - "Granada" – "Reino Unido" – "Estados Unidos" – "Ilhas Menores Distantes dos Estados Unidos" - "Uruguai"
disabledRegions[]

string

Representa as regiões onde suas ações estão bloqueadas, com base no local de presença do usuário. Não é possível definir se enabledRegions está definido. Cada região é representada usando o nome canônico das segmentações por área geográfica do Google AdWords. Consulte https://developers.google.com/adwords/api/docs/appendix/geotargeting Os exemplos incluem: - "Alemanha" - "Gana" - "Grécia" - "Granada" - "Reino Unido" – "Estados Unidos" – "Ilhas Menores Distantes dos Estados Unidos" - "Uruguai"
category

enum (Category)

A categoria deste projeto do Actions.
usesTransactionsApi

boolean

Define se as ações podem usar transações (por exemplo, fazer reservas, receber pedidos etc.). Se for falso, as tentativas de usar as APIs de transações vão falhar.
usesDigitalPurchaseApi

boolean

Define se o Actions pode realizar transações para produtos e softwares digitais.
usesInteractiveCanvas

boolean

Define se as ações usam a tela interativa.
usesHomeStorage

boolean

Define se as ações usam o recurso de armazenamento doméstico.
designedForFamily

boolean

Indica se o conteúdo do Actions foi criado para a família (DFF, na sigla em inglês).
containsAlcoholOrTobaccoContent

boolean

se as ações têm conteúdo relacionado a bebidas alcoólicas ou tabaco;
keepsMicOpen

boolean

Se o Actions pode deixar o microfone aberto sem uma solicitação explícita durante a conversa.
surfaceRequirements

object (SurfaceRequirements)

Os requisitos de plataforma que uma plataforma do cliente precisa oferecer para invocar ações neste projeto.
testingInstructions

string

Instruções de teste em formato livre para o revisor do Actions (por exemplo, instruções de vinculação de contas).
localizedSettings

object (LocalizedSettings)

Configurações localizadas para a localidade padrão do projeto. Cada localidade adicional precisa ter o próprio arquivo de configurações no próprio diretório.
accountLinking

object (AccountLinking)

Permitir que os usuários criem ou vinculem contas pelo Login do Google e/ou seu próprio serviço OAuth.
selectedAndroidApps[]

string

Apps Android selecionados para acessar compras no Google Play por transações. Esta é uma seleção dos apps Android conectados ao projeto de ações para verificar a propriedade da marca e ativar outros recursos. Consulte https://developers.google.com/assistant/console/brand-verification para mais informações.

Categoria

As opções de categoria para um projeto do Actions.

Enums
CATEGORY_UNSPECIFIED Desconhecido / não especificado.
BUSINESS_AND_FINANCE Categoria Negócios e Finanças.
EDUCATION_AND_REFERENCE Categoria Educação e referência.
FOOD_AND_DRINK Categoria Comer e beber.
GAMES_AND_TRIVIA Categoria Jogos e curiosidades.
HEALTH_AND_FITNESS Categoria "Saúde e fitness".
KIDS_AND_FAMILY Categoria "Crianças e família".
LIFESTYLE Categoria "Estilo de vida".
LOCAL Categoria local.
MOVIES_AND_TV Categoria "Filmes e TV".
MUSIC_AND_AUDIO Categoria Música e áudio.
NEWS Categoria "Notícias",
NOVELTY_AND_HUMOR categoria Inovação e Humor.
PRODUCTIVITY Categoria de produtividade.
SHOPPING Categoria "Compras".
SOCIAL Categoria "Social".
SPORTS Categoria de esportes.
TRAVEL_AND_TRANSPORTATION Categoria "Viagem e transporte".
UTILITIES Categoria de serviços públicos.
WEATHER Categoria de clima.
HOME_CONTROL Categoria Automação residencial.

SurfaceRequirements

Contém um conjunto de requisitos que a superfície do cliente precisa oferecer para invocar ações no projeto.

Representação JSON 
{
  "minimumRequirements": [
    {
      object (CapabilityRequirement)
    }
  ]
}
Campos
minimumRequirements[]

object (CapabilityRequirement)

O conjunto mínimo de recursos necessários para invocar as ações no seu projeto. Se algum desses itens estiver ausente na superfície, a ação não será acionada.

CapabilityRequirement

Representa um requisito sobre a disponibilidade de um determinado recurso.

Representação JSON 
{
  "capability": enum (SurfaceCapability)
}
Campos
capability

enum (SurfaceCapability)

O tipo de capacidade.

SurfaceCapability

Possível conjunto de recursos de superfície.

Enums
SURFACE_CAPABILITY_UNSPECIFIED Desconhecido / não especificado.
AUDIO_OUTPUT O Surface oferece suporte à saída de áudio.
SCREEN_OUTPUT O Surface oferece suporte à tela/saída visual.
MEDIA_RESPONSE_AUDIO O Surface oferece suporte a áudio de resposta de mídia.
WEB_BROWSER O Surface é compatível com navegadores da Web.
ACCOUNT_LINKING O Surface é compatível com a vinculação de contas.
INTERACTIVE_CANVAS O Surface oferece suporte à tela interativa.
HOME_STORAGE O Surface é compatível com o armazenamento doméstico.

LocalizedSettings

Representa as configurações de um projeto do Actions específicas para uma localidade do usuário. Nesse caso, "usuário" se refere ao usuário final que invoca suas ações. Esta mensagem pode ser localizada.

Representação JSON 
{
  "displayName": string,
  "pronunciation": string,
  "shortDescription": string,
  "fullDescription": string,
  "smallLogoImage": string,
  "largeBannerImage": string,
  "developerName": string,
  "developerEmail": string,
  "termsOfServiceUrl": string,
  "voice": string,
  "voiceLocale": string,
  "privacyPolicyUrl": string,
  "sampleInvocations": [
    string
  ],
  "themeCustomization": {
    object (ThemeCustomization)
  }
}
Campos
displayName

string

Obrigatório. O nome de exibição padrão para este projeto do Actions (se não houver tradução disponível)
pronunciation

string

Obrigatório. A pronúncia do nome de exibição para invocá-lo em um contexto de voz (fala).
shortDescription

string

Obrigatório. É a breve descrição padrão do projeto do Actions (se não houver tradução disponível). Limite de 80 caracteres.
fullDescription

string

Obrigatório. É a descrição longa padrão do projeto do Actions (se não houver tradução disponível). Limite de 4.000 caracteres.
smallLogoImage

string

Obrigatório. Imagem quadrada pequena de 192 x 192 pixels. Isso precisa ser especificado como uma referência à imagem correspondente no diretório resources/images/. Por exemplo, $resources.images.foo (sem a extensão) para a imagem no resources/images/foo.jpg. Ao trabalhar em um projeto extraído do console, é possível usar o URL gerenciado pelo Google. Não são permitidos URLs de fontes externas.
largeBannerImage

string

Opcional. Imagem grande em modo paisagem de 1920 x 1080 pixels. Isso precisa ser especificado como uma referência à imagem correspondente no diretório resources/images/. Por exemplo, $resources.images.foo (sem a extensão) para a imagem no resources/images/foo.jpg. Ao trabalhar em um projeto extraído do console, é possível usar o URL gerenciado pelo Google. Não são permitidos URLs de fontes externas.
developerName

string

Obrigatório. É o nome do desenvolvedor que vai ser mostrado aos usuários.
developerEmail

string

Obrigatório. O endereço de e-mail de contato do desenvolvedor.
termsOfServiceUrl

string

Opcional. O URL dos Termos de Serviço.
voice

string

Obrigatório. O tipo de voz do Google Assistente que os usuários ouvem quando interagem com suas ações. Os valores aceitos são "male_1", "male_2", "female_1" e "female_2".
voiceLocale

string

Opcional. Local da voz especificada. Se não for especificada, ela será resolvida para a localidade do Google Assistente do usuário. Se especificada, a localidade da voz precisa ter o mesmo idioma base da localidade especificada em LocalizedSettings.
privacyPolicyUrl

string

Obrigatório. O URL da Política de Privacidade.
sampleInvocations[]

string

Opcional. Exemplos de frases de invocação exibidas como parte da descrição do seu projeto do Actions no diretório do Assistente. Isso ajudará os usuários a aprender a usá-lo.
themeCustomization

object (ThemeCustomization)

Opcional. Personalizações de tema para componentes visuais das ações.

ThemeCustomization

Estilos aplicados a cards apresentados aos usuários

Representação JSON 
{
  "backgroundColor": string,
  "primaryColor": string,
  "fontFamily": string,
  "imageCornerStyle": enum (ImageCornerStyle),
  "landscapeBackgroundImage": string,
  "portraitBackgroundImage": string
}
Campos
backgroundColor

string

Cor de segundo plano dos cards. Funciona como um substituto se background_image não for fornecido pelos desenvolvedores ou background_image não for adequado para determinadas plataformas. Exemplo de uso: #FAFAFA
primaryColor

string

A cor principal do tema da ação é usada para definir a cor do texto do título e a cor do plano de fundo das ações necessárias nos cards do Actions on Google. Exemplo de uso: #FAFAFA
fontFamily

string

A família de fontes que será usada para o título dos cartões. Fontes compatíveis: - Sans Serif - Sans Serif Medium - Sans Serif Negrito - Sans Serif Preto - Sans Serif condensado - Sans Serif condensado médio - Serif - Serif Negrito - Monospace - Cursivo - Sans Serif Condensed
imageCornerStyle

enum (ImageCornerStyle)

Estilo da borda da imagem de primeiro plano dos cards. Por exemplo, podem ser aplicadas à imagem de primeiro plano de um card básico ou de carrossel.
landscapeBackgroundImage

string

Modo paisagem (mínimo de 1920 x 1200 pixels). Isso precisa ser especificado como uma referência à imagem correspondente no diretório resources/images/. Por exemplo: $resources.images.foo (sem a extensão) para a imagem no resources/images/foo.jpg. Ao trabalhar em um projeto extraído do console, o URL gerenciado pelo Google pode ser usado.
portraitBackgroundImage

string

Modo retrato (mínimo de 1.200 x 1.920 pixels). Isso precisa ser especificado como uma referência à imagem correspondente no diretório resources/images/. Por exemplo: $resources.images.foo (sem a extensão) para a imagem no resources/images/foo.jpg. Ao trabalhar em um projeto extraído do console, o URL gerenciado pelo Google pode ser usado.

ImageCornerStyle

Descreve como as bordas das imagens devem ser renderizadas.

Enums
IMAGE_CORNER_STYLE_UNSPECIFIED Indefinida / não especificada.
CURVED Canto arredondado para a imagem.
ANGLED Canto retangular para imagem.

AccountLinking

A vinculação de contas permite que o Google oriente o usuário a fazer login nos serviços da Web do app.

Para os tipos de vinculação Login do Google e OAuth + Login do Google, o Google gera um ID do cliente que identifica seu app para o Google ("ID do cliente emitido pelo Google para suas ações" na interface do Console). Esse campo é somente leitura e pode ser verificado na página "Vinculação de contas" da interface do console. Acesse: https://developers.google.com/assistant/identity/google-sign-in

Observação: para todos os tipos de configuração de vinculação de contas (exceto para o Login do Google), é necessário informar um nome de usuário e uma senha de uma conta de teste em Settings.testing_instructions para que a equipe de análise possa analisar o app. Eles não aparecem para os usuários.

Representação JSON 
{
  "enableAccountCreation": boolean,
  "linkingType": enum (LinkingType),
  "authGrantType": enum (AuthGrantType),
  "appClientId": string,
  "authorizationUrl": string,
  "tokenUrl": string,
  "scopes": [
    string
  ],
  "learnMoreUrl": string,
  "useBasicAuthHeader": boolean
}
Campos
enableAccountCreation

boolean

Obrigatório. Se true, os usuários poderão se inscrever em novas contas por voz. Se for false, a criação de contas só será permitida no seu site. Selecione esta opção se quiser exibir seus Termos de Serviço ou obter o consentimento do usuário durante a inscrição. LinkingType não pode ser GOOGLE_SIGN_IN quando for false. vinculaçãoType não pode ser OAUTH quando for true.
linkingType

enum (LinkingType)

Obrigatório. O tipo de vinculação a ser usado. Consulte https://developers.google.com/assistant/identity para mais detalhes sobre os tipos de vinculação.
authGrantType

enum (AuthGrantType)

Opcional. Indica o tipo de autenticação para LinkingType de OAUTH.
appClientId

string

Opcional. ID do cliente emitido pelo seu app para o Google. Esse é o ID do cliente OAuth2 que identifica o Google para seu serviço. Definido apenas ao usar o OAuth.
authorizationUrl

string

Opcional. Endpoint para sua página da Web de login compatível com códigos OAuth2 ou fluxos implícitos. O URL precisa usar HTTPS. Definido apenas ao usar o OAuth.
tokenUrl

string

Opcional. Endpoint OAuth2 para troca de tokens. O URL precisa usar HTTPS. Isso não será definido quando você usar apenas OAuth com concessão IMPLICIT como tipo de vinculação. Definido apenas ao usar o OAuth.
scopes[]

string

Opcional. Lista de permissões com as quais o usuário precisa consentir para usar seu serviço. Definido apenas ao usar o OAuth. Inclua os Termos de Serviço nas informações do diretório na seção LocalizedSettings.terms_of_service_url se especificar esse campo.
learnMoreUrl

string

Opcional. Essa é a página da Web do serviço que descreve as permissões que o usuário está concedendo ao Google. Defina apenas se estiver usando o OAuth e o Login do Google. Inclua os Termos de Serviço nas informações do diretório na seção LocalizedSettings.terms_of_service_url se especificar esse campo.
useBasicAuthHeader

boolean

Opcional. Se verdadeiro, permite que o Google transmita o ID e a chave secreta do cliente por meio do cabeçalho de autenticação HTTP básica. Caso contrário, o Google usará o ID e a chave secreta do cliente no corpo da postagem. Definido apenas ao usar o OAuth. Inclua os Termos de Serviço nas informações do diretório na seção LocalizedSettings.terms_of_service_url se especificar esse campo.

LinkingType

O tipo de vinculação de conta que será realizada.

Enums
LINKING_TYPE_UNSPECIFIED Não especificado.
GOOGLE_SIGN_IN Tipo de vinculação do Login do Google. Se você estiver usando esse tipo de vinculação, nenhum campo relacionado ao OAuth precisará ser definido abaixo.
OAUTH_AND_GOOGLE_SIGN_IN Tipo de vinculação entre OAuth e Login do Google.
OAUTH Tipo de vinculação OAuth.

AuthGrantType

O tipo de concessão OAuth2 que o Google usa para orientar o usuário a fazer login no serviço da Web do seu app.

Enums
AUTH_GRANT_TYPE_UNSPECIFIED Não especificado.
AUTH_CODE Concessão do código de autorização. Exige que você forneça o URL de autenticação e o URL do token de acesso.
IMPLICIT Concessão de código implícito. Exige apenas que você forneça o URL de autenticação.

Webhook

Metadados para diferentes tipos de webhooks. Se você estiver usando inlineCloudFunction, seu código-fonte precisará estar em um diretório com o mesmo nome do valor da chave executeFunction. Por exemplo, um valor de my_webhook para a chave executeFunction teria uma estrutura de código como esta: - /webhooks/my_webhook.yaml - /webhooks/my_webhook/index.js - /webhooks/my_webhook/package.json

Representação JSON 
{
  "handlers": [
    {
      object (Handler)
    }
  ],

  // Union field webhook_type can be only one of the following:
  "httpsEndpoint": {
    object (HttpsEndpoint)
  },
  "inlineCloudFunction": {
    object (InlineCloudFunction)
  }
  // End of list of possible types for union field webhook_type.
}
Campos
handlers[]

object (Handler)

Lista de gerenciadores para esse webhook.
Campo de união webhook_type. Há suporte para apenas um tipo de webhook. webhook_type pode ser apenas de um dos tipos a seguir:
httpsEndpoint

object (HttpsEndpoint)

Endpoint HTTPS do webhook personalizado.
inlineCloudFunction

object (InlineCloudFunction)

Metadados da função do Cloud implantados com base no código na pasta de webhooks.

Handler

Declara o nome do gerenciador do webhoook. Um webhook pode ter vários gerenciadores registrados. Esses gerenciadores podem ser chamados de vários lugares no projeto do Actions.

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

string

Obrigatório. Nome do gerenciador. Precisa ser exclusivo em todos os gerenciadores do projeto do Actions. Verifique o nome desse gerenciador para invocar a função correta no código-fonte do fulfillment.

HttpsEndpoint

Endpoint REST para notificar se você não estiver usando o editor in-line.

Representação JSON 
{
  "baseUrl": string,
  "httpHeaders": {
    string: string,
    ...
  },
  "endpointApiVersion": integer
}
Campos
baseUrl

string

O URL base HTTPS para o endpoint de fulfillment (não é compatível com HTTP). Os nomes dos gerenciadores são anexados ao caminho do URL de base após dois-pontos (seguindo o guia de estilo em https://cloud.google.com/apis/design/custom_methods). Por exemplo, um URL base de "https://gactions.service.com/api" receberia solicitações com o URL "https://gactions.service.com/api:{method}".
httpHeaders

map (key: string, value: string)

Mapa de parâmetros HTTP a serem incluídos na solicitação POST.

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

integer

Versão do protocolo usado pelo endpoint. Esse é o protocolo compartilhado por todos os tipos de atendimento de pedidos e não é específico pelo tipo de atendimento do Google.

InlineCloudFunction

Mantém os metadados de uma função in-line do Cloud implantada a partir da pasta de webhooks.

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

string

O nome do ponto de entrada da função do Cloud. O valor desse campo deve corresponder ao nome do método exportado do código-fonte.

Intenção

As intents mapeiam entradas abertas do usuário para objetos estruturados. As frases faladas são combinadas a intents com o processamento de linguagem natural (PLN) do Google. As correspondências de intents podem acionar eventos no design da conversa para avançar na conversa do usuário. O nome da intent é especificado no nome do arquivo.

Representação JSON 
{
  "parameters": [
    {
      object (IntentParameter)
    }
  ],
  "trainingPhrases": [
    string
  ]
}
Campos
parameters[]

object (IntentParameter)

A lista de parâmetros nas frases de treinamento. Todos os parâmetros precisam ser definidos aqui para serem usados na frase de treinamento.
trainingPhrases[]

string

As frases de treinamento permitem que o PLN do Google faça a correspondência automática das intents com as entradas do usuário. Quanto mais frases exclusivas forem fornecidas, maior será a chance de correspondência com a intent. Confira a seguir o formato da parte da frase de treinamento anotada. O campo auto é opcional, e o comportamento padrão quando auto não é especificado é equivalente a auto=false. ($<paramName> '<sample text>' auto=<true or false>) auto = true significa que a parte foi anotada automaticamente pelo PLN. auto = false significa que a parte foi anotada pelo usuário. Este é o padrão quando a opção automática não está especificada. Exemplo: "Reservar um voo de ($source 'São Francisco' auto=false) para ($dest 'Vancouver')"

IntentParameter

Definição de um parâmetro que pode ser usado em frases de treinamento

Representação JSON 
{
  "name": string,

  // Union field parameter_type can be only one of the following:
  "type": {
    object (ClassReference)
  },
  "entitySetReferences": {
    object (EntitySetReferences)
  }
  // End of list of possible types for union field parameter_type.
}
Campos
name

string

Obrigatório. Nome exclusivo do parâmetro da intent. Pode ser usado em condições e respostas para fazer referência a parâmetros de intent extraídos pelo PLN com $intent.params.[name].resolved
Campo de união parameter_type. O tipo do parâmetro da intent. parameter_type pode ser apenas de um dos tipos a seguir:
type

object (ClassReference)

Opcional. Declara o tipo de dados desse parâmetro. Isso não deve ser definido para intents integradas.
entitySetReferences

object (EntitySetReferences)

Opcional. Referências aos conjuntos de entidades permitidas para esse parâmetro de intent. Válido apenas para parâmetros de uma intent integrada. Essas referências apontam para grupos de entidades na classe "custom/entitySets" diretório.

ClassReference

Referência a uma classe usada para declarar o tipo de um campo ou valor de retorno. Enums também são um tipo de classe que pode ser referenciada usando ClassReference.

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

string

Obrigatório. Nome de um tipo integrado ou personalizado do parâmetro. Por exemplo: PizzaToppings, actions.type.Number
list

boolean

Opcional. Indica se o tipo de dados representa uma lista de valores.

EntitySetReferences

Referências de conjunto de entidades para um parâmetro de intent.

Representação JSON 
{
  "entitySetReferences": [
    {
      object (EntitySetReference)
    }
  ]
}
Campos
entitySetReferences[]

object (EntitySetReference)

Obrigatório. Referências de conjunto de entidades para um parâmetro de intent.

EntitySetReference

Uma referência ao conjunto de entidades permitidas para esse parâmetro de intent.

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

string

Obrigatório. Identifica o conjunto específico de entidades a serem consideradas para um determinado parâmetro. A definição do conjunto de entidades correspondente precisa estar presente no diretório custom/entitySets/.

Tipo

Declaração de um tipo personalizado, em oposição a tipos integrados. Os tipos podem ser atribuídos a slots em um cenário ou parâmetros das frases de treinamento de uma intent. Na prática, os tipos podem ser considerados enums. Observação: o nome do tipo é especificado no nome do arquivo.

Representação JSON 
{
  "exclusions": [
    string
  ],

  // Union field sub_type can be only one of the following:
  "synonym": {
    object (SynonymType)
  },
  "regularExpression": {
    object (RegularExpressionType)
  },
  "freeText": {
    object (FreeTextType)
  }
  // End of list of possible types for union field sub_type.
}
Campos
exclusions[]

string

Conjunto de palavras/frases excepcionais que não devem ser correspondidas por tipo. Observação: se palavra/frase corresponder ao tipo, mas listada como uma exclusão, ela não será retornada no resultado da extração do parâmetro. Esse campo pode ser localizado.
Campo de união sub_type. Seleção de subtipo com base no tipo de correspondência a ser feita. sub_type pode ser apenas de um dos tipos a seguir:
synonym

object (SynonymType)

Tipo de sinônimos, que é essencialmente um tipo enumerado.
regularExpression

object (RegularExpressionType)

O tipo de regex permite a correspondência com expressões regulares.
freeText

object (FreeTextType)

FreeText.

SynonymType

Tipo que corresponde ao texto por conjunto de sinônimos.

Representação JSON 
{
  "matchType": enum (MatchType),
  "acceptUnknownValues": boolean,
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}
Campos
matchType

enum (MatchType)

Opcional. O tipo de correspondência do sinônimo.
acceptUnknownValues

boolean

Opcional. Quando definido como verdadeiro, ele corresponde palavras ou frases desconhecidas com base nos dados de treinamento da intent e da entrada ao redor, como itens que podem ser adicionados a uma lista de supermercado.
entities

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

Obrigatório. Mapa nomeado de entidades sinônimas.

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

MatchType

O tipo de correspondência que as entradas desse tipo usarão. Isso garante que todos os tipos usem o mesmo método de correspondência e permite a variação da correspondência para a correspondência de sinônimos (ou seja, difusa versus exata). Se o valor for UNSPECIFIED, o padrão será EXACT_MATCH.

Enums
UNSPECIFIED O valor padrão é EXACT_MATCH.
EXACT_MATCH Procura uma correspondência exata do sinônimo ou do nome.
FUZZY_MATCH Menor que EXACT_MATCH. Procura correspondências semelhantes e exatas.

Entidade

Representa um campo de entidade sinônimo que contém os detalhes de uma única entrada dentro do tipo.

Representação JSON 
{
  "display": {
    object (EntityDisplay)
  },
  "synonyms": [
    string
  ]
}
Campos
display

object (EntityDisplay)

Opcional. Os detalhes de exibição da entidade.
synonyms[]

string

Opcional. A lista de sinônimos da entidade. Esse campo pode ser localizado.

EntityDisplay

Elementos que serão exibidos na tela depois que a entidade de um tipo específico for extraída de uma consulta. Relevante apenas para apps com tela ativada. Esta mensagem pode ser localizada.

Representação JSON 
{
  "iconTitle": string,
  "iconUrl": string
}
Campos
iconTitle

string

Opcional. Título do ícone.
iconUrl

string

Obrigatório. URL do ícone.

RegularExpressionType

Tipo que corresponde a texto por expressões regulares. Esta mensagem pode ser localizada.

Representação JSON 
{
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}
Campos
entities

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

Obrigatório. Mapa nomeado de entidades que contêm cada string de regex.

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

Entidade

Representa um objeto de entidade que contém a expressão regular usada para comparação.

Representação JSON 
{
  "display": {
    object (EntityDisplay)
  },
  "regularExpressions": [
    string
  ]
}
Campos
display

object (EntityDisplay)

Opcional. Elementos que serão exibidos na tela depois que uma entidade for extraída de uma consulta. Relevante apenas para apps com tela ativada.
regularExpressions[]

string

Obrigatório. Usa a sintaxe de regex RE2 (consulte https://github.com/google/re2/wiki/Syntax para mais detalhes).

FreeTextType

Digite que corresponda a qualquer texto se o contexto das palavras ao redor estiver próximo aos exemplos de treinamento fornecidos.

Representação JSON 
{
  "display": {
    object (EntityDisplay)
  }
}
Campos
display

object (EntityDisplay)

Opcional. Elementos que serão exibidos na tela depois que uma entidade for extraída de uma consulta. Relevante apenas para apps com tela ativada.

EntitySet

Os conjuntos de entidades descrevem o conjunto predefinido de entidades de onde podem vir os valores dos parâmetros de intent integrados. Os conjuntos de entidades podem ser referenciados por entitySet em parâmetros de intents integrados.

Representação JSON 
{
  "entities": [
    {
      object (Entity)
    }
  ]
}
Campos
entities[]

object (Entity)

Obrigatório. A lista de entidades que este conjunto de entidades suporta.

Entidade

Uma entidade de onde pode vir o valor de parâmetro da intent integrada.

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

string

Obrigatório. O ID da entidade. Para conferir uma lista de parâmetros integrados de intent e as entidades compatíveis, consulte https://developers.google.com/assistant/conversational/build/built-in-intents

GlobalIntentEvent

Define um gerenciador global de intents. Eventos de intent globais têm o escopo de todo o projeto do Actions e podem ser substituídos por gerenciadores de intent em uma cena. Os nomes das intents precisam ser exclusivos em um projeto do Actions.

Intents globais podem ser correspondidas a qualquer momento durante uma sessão, permitindo que os usuários acessem fluxos comuns como “recebimento de ajuda” ou "voltar para o início". Eles também podem ser usados para vincular usuários a fluxos específicos quando invocam uma ação.

O nome da intent é especificado no nome do arquivo.

Representação JSON 
{
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
Campos
transitionToScene

string

Opcional. Cena de destino para a qual a conversa deve pular. O estado da cena atual é destruído na transição.
handler

object (EventHandler)

Opcional. Manipulador de eventos, que é acionado quando a intent é correspondida. Precisa ser executado antes da transição para a cena de destino. Útil para gerar comandos em resposta a eventos.

EventHandler

Define um manipulador a ser executado após um evento. Exemplos de eventos são aqueles baseados em intent e condição em uma cena.

Representação JSON 
{
  "webhookHandler": string,

  // Union field prompt can be only one of the following:
  "staticPrompt": {
    object (StaticPrompt)
  },
  "staticPromptName": string
  // End of list of possible types for union field prompt.
}
Campos
webhookHandler

string

Nome do gerenciador de webhook a ser chamado.
Campo de união prompt. Os comandos podem ser inline ou referenciados por nome. prompt pode ser apenas de um dos tipos a seguir:
staticPrompt

object (StaticPrompt)

Comando estático inline. Pode conter referências a recursos de string em pacotes.
staticPromptName

string

Nome do prompt estático a ser invocado.

StaticPrompt

Representa uma lista de candidatos de prompt, e um deles será selecionado como o prompt a ser exibido na resposta ao usuário. Esta mensagem pode ser localizada.

Representação JSON 
{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}
Campos
candidates[]

object (StaticPromptCandidate)

A lista de possíveis prompts a serem enviados ao cliente. Cada comando tem um seletor para determinar quando pode ser usado. O primeiro seletor que corresponder a uma solicitação será enviado e o restante será ignorado.

StaticPromptCandidate

Representa um candidato a comando estático.

Representação JSON 
{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}
Campos
selector

object (Selector)

Opcional. Os critérios para determinar se esse comando corresponde a uma solicitação. Se o seletor estiver vazio, essa solicitação será sempre acionada.
promptResponse

object (StaticPromptResponse)

A resposta de solicitação associada ao seletor.

Seletor

Define os critérios para que um comando corresponda a uma solicitação.

Representação JSON 
{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}
Campos
surfaceCapabilities

object (SurfaceCapabilities)

O conjunto de recursos de superfície necessários.

SurfaceCapabilities

Representa a superfície que o usuário está usando para fazer uma solicitação para a ação.

Representação JSON 
{
  "capabilities": [
    enum (Capability)
  ]
}
Campos
capabilities[]

enum (Capability)

Obrigatório. Os recursos da superfície que faz uma solicitação à ação.

Capacidade

Recursos compatíveis com a superfície do dispositivo no momento da solicitação.

Enums
UNSPECIFIED Capacidade de superfície não especificada.
SPEECH O dispositivo pode falar com o usuário por conversão de texto em voz ou SSML.
RICH_RESPONSE O dispositivo pode exibir respostas avançadas, como cartões, listas e tabelas.
LONG_FORM_AUDIO O dispositivo pode abrir mídias de áudio de formato longo, como músicas e podcasts.
INTERACTIVE_CANVAS O dispositivo pode exibir uma resposta de tela interativa.
HOME_STORAGE O dispositivo oferece suporte ao salvamento e à busca do armazenamento doméstico.

StaticPromptResponse

Representa respostas estruturadas que serão enviadas ao usuário, como texto, fala, cartões, dados da tela, ícones de sugestão etc.

Representação JSON 
{
  "firstSimple": {
    object (StaticSimplePrompt)
  },
  "content": {
    object (StaticContentPrompt)
  },
  "lastSimple": {
    object (StaticSimplePrompt)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (StaticLinkPrompt)
  },
  "override": boolean,
  "canvas": {
    object (StaticCanvasPrompt)
  }
}
Campos
firstSimple

object (StaticSimplePrompt)

Opcional. A primeira resposta somente de voz e de texto.
content

object (StaticContentPrompt)

Opcional. Um conteúdo como um card, uma lista ou uma mídia para mostrar ao usuário.
lastSimple

object (StaticSimplePrompt)

Opcional. A última resposta somente de texto e voz.
suggestions[]

object (Suggestion)

Opcional. São sugestões a serem exibidas para o usuário e sempre aparecem no final da resposta. Se o campo append no comando que contém for true, os títulos definidos neste campo serão adicionados àqueles definidos em qualquer solicitação de sugestão definida anteriormente, e os valores duplicados serão removidos.
override

boolean

Opcional. Modo de como essas mensagens devem ser mescladas com mensagens definidas anteriormente. O true vai apagar todas as mensagens definidas anteriormente (a primeira e a última mensagem simples, conteúdo, link de sugestões e tela) e adicionar as mensagens definidas neste comando. O false vai adicionar as mensagens definidas nesse comando às mensagens definidas nas respostas anteriores. Definir este campo como false também vai ativar a anexação em alguns campos nos comandos simples, nas opções "Suggestions" e "Canvas", que são parte da instrução "Content". As mensagens "Conteúdo" e "Link" sempre serão substituídas se forem definidas no comando. O valor padrão é false.
canvas

object (StaticCanvasPrompt)

Uma resposta a ser usada para a experiência de tela interativa.

StaticSimplePrompt

Representa um comando simples a ser enviado a um usuário.

Representação JSON 
{
  "variants": [
    {
      object (Variant)
    }
  ]
}
Campos
variants[]

object (Variant)

Lista de possíveis variantes.

Variante

Representa uma variante que faz parte do comando simples.

Representação JSON 
{
  "speech": string,
  "text": string
}
Campos
speech

string

Opcional. Representa a fala a ser falada ao usuário. Pode ser SSML ou conversão de texto em voz. Por padrão, a fala será anexada à fala do comando simples anterior. Se o campo override no comando que contém for true, a fala definida nesse campo vai substituir a fala do comando simples anterior.
text

string

Opcional. Texto a ser exibido no balão do chat. Se não for informado, será usada uma renderização de exibição do campo de fala acima. Limitado a 640 caracteres. Por padrão, o texto será anexado ao texto do comando simples anterior. Se o campo override no comando for true, o texto definido nesse campo vai substituir o texto do comando simples anterior.

StaticContentPrompt

Um marcador para a parte "Content" de um StaticPrompt.

Representação JSON 
{

  // Union field content can be only one of the following:
  "card": {
    object (StaticCardPrompt)
  },
  "image": {
    object (StaticImagePrompt)
  },
  "table": {
    object (StaticTablePrompt)
  },
  "media": {
    object (StaticMediaPrompt)
  },
  "list": {
    object (StaticListPrompt)
  },
  "collection": {
    object (StaticCollectionPrompt)
  },
  "collectionBrowse": {
    object (StaticCollectionBrowsePrompt)
  }
  // End of list of possible types for union field content.
}
Campos
Campo de união content. Apenas um tipo de conteúdo pode estar presente em um comando. content pode ser apenas de um dos tipos a seguir:
card

object (StaticCardPrompt)

Um cartão básico.
image

object (StaticImagePrompt)

Uma imagem.
table

object (StaticTablePrompt)

Card da tabela.
media

object (StaticMediaPrompt)

Resposta indicando um conjunto de mídia a ser reproduzido.
list

object (StaticListPrompt)

Um card para apresentar uma lista de opções.
collection

object (StaticCollectionPrompt)

Um card com uma lista de opções para seleção.
collectionBrowse

object (StaticCollectionBrowsePrompt)

Um card que apresenta uma coleção de páginas da Web a serem abertas.

StaticCardPrompt

Um card básico para exibir algumas informações, por exemplo, uma imagem e/ou texto.

Representação JSON 
{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (StaticImagePrompt)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (StaticLinkPrompt)
  }
}
Campos
title

string

Opcional. Título geral do card.
subtitle

string

Opcional. Subtítulo do card.
text

string

Obrigatório. Corpo de texto do card, que é necessário, a menos que haja uma imagem. Oferece suporte a um conjunto limitado de sintaxes de marcação para formatação.
image

object (StaticImagePrompt)

Opcional. Uma imagem principal para o cartão. A altura é fixada em 192 dp.
imageFill

enum (ImageFill)

Opcional. Como o plano de fundo da imagem será preenchido.
button

object (StaticLinkPrompt)

Opcional. Um botão clicável que será mostrado no card.

StaticImagePrompt

Uma imagem exibida no card.

Representação JSON 
{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}
Campos
url

string

Obrigatório. O URL de origem da imagem. As imagens podem ser JPG, PNG e GIF (animadas ou não). Por exemplo,https://www.agentx.com/logo.png.
alt

string

Obrigatório. Uma descrição de texto da imagem a ser usada para acessibilidade, por exemplo, e leitores de tela.
height

integer

Opcional. A altura da imagem, em pixels.
width

integer

Opcional. A largura da imagem, em pixels.

ImageFill

Possíveis opções de exibição de imagem para afetar a apresentação da imagem. Isso deve ser usado quando a proporção da imagem não corresponder à do contêiner da imagem.

Enums
UNSPECIFIED ImageFill não especificado.
GRAY Preencha as lacunas entre a imagem e o contêiner da imagem com barras cinza.
WHITE Preencha as lacunas entre a imagem e o contêiner da imagem com barras brancas.
CROPPED A imagem é dimensionada de modo que a largura e a altura dela correspondam ou excedam as dimensões do contêiner. Isso poderá cortar as partes de cima e de baixo da imagem se a altura dimensionada for maior que a do contêiner ou cortar a esquerda e a direita da imagem se ela for maior que a largura do contêiner. É semelhante ao "Modo zoom" em uma TV widescreen ao reproduzir um vídeo 4:3.

StaticLinkPrompt

Define um link que será exibido como um ícone de sugestão e que poderá ser aberto pelo usuário.

Representação JSON 
{
  "name": string,
  "open": {
    object (OpenUrl)
  }
}
Campos
name

string

Nome do link
open

object (OpenUrl)

Define o comportamento quando o usuário abre o link.

OpenUrl

Define o comportamento quando o usuário abre o link.

Representação JSON 
{
  "url": string,
  "hint": enum (UrlHint)
}
Campos
url

string

O campo de URL, que pode ser qualquer um destes: URLs http/https para abrir um app vinculado a um app ou uma página da Web
hint

enum (UrlHint)

Indica uma dica para o tipo de URL.

UrlHint

Diferentes tipos de dicas de URL.

Enums
HINT_UNSPECIFIED Não especificado
AMP É um URL que leva diretamente ao conteúdo de AMP ou a um URL canônico que se refere ao conteúdo de AMP via <link rel="amphtml">.

StaticTablePrompt

Um cartão de tabela para exibir uma tabela de texto.

Representação JSON 
{
  "title": string,
  "subtitle": string,
  "image": {
    object (StaticImagePrompt)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (StaticLinkPrompt)
  }
}
Campos
title

string

Opcional. Título geral da tabela. Precisa ser definido se o subtítulo estiver definido.
subtitle

string

Opcional. Subtítulo da tabela.
image

object (StaticImagePrompt)

Opcional. Imagem associada à tabela.
columns[]

object (TableColumn)

Opcional. Cabeçalhos e alinhamento de colunas.
rows[]

object (TableRow)

Opcional. Dados de linha da tabela. As primeiras três linhas serão exibidas, mas outras poderão ser cortadas em determinadas superfícies. Teste com o simulador para saber quais linhas serão exibidas para uma determinada superfície. Em plataformas com suporte ao recurso WEB_BROWSER, você pode direcionar o usuário para uma página da Web com mais dados.
button

object (StaticLinkPrompt)

Opcional. Botão.

TableColumn

Descreve uma coluna na tabela.

Representação JSON 
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
Campos
header

string

Texto do cabeçalho da coluna.
align

enum (HorizontalAlignment)

Alinhamento horizontal da coluna de texto do conteúdo. Se não for especificado, o conteúdo será alinhado à borda inicial.

HorizontalAlignment

O alinhamento do conteúdo dentro da célula.

Enums
UNSPECIFIED HorizontalAlignment não especificado.
LEADING Borda superior da célula. Esse é o padrão.
CENTER O conteúdo é alinhado ao centro da coluna.
TRAILING O conteúdo é alinhado à borda final da coluna.

TableRow

Descreve uma linha na tabela.

Representação JSON 
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
Campos
cells[]

object (TableCell)

Células nesta linha. As primeiras três células serão exibidas, mas outras poderão ser cortadas em determinadas superfícies. Faça o teste com o simulador para ver quais células serão exibidas em uma determinada superfície.
divider

boolean

Indica se deve haver um divisor após cada linha.

TableCell

Descreve uma célula em uma linha.

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

string

Conteúdo de texto da célula.

StaticMediaPrompt

Contém informações sobre a mídia, como nome, descrição, URL etc. Próximo ID: 11

Representação JSON 
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ],
  "repeatMode": enum (RepeatMode)
}
Campos
mediaType

enum (MediaType)

Tipo de mídia dessa resposta.
startOffset

string (Duration format)

Deslocamento inicial do primeiro objeto de mídia.

Uma duração em segundos com até nove dígitos fracionários, encerrada por "s". Exemplo: "3.5s".
optionalMediaControls[]

enum (OptionalMediaControls)

Tipos de controle de mídia opcionais compatíveis com esta sessão de resposta de mídia. Se definido, a solicitação será feita para 3p quando um determinado evento de mídia acontecer. Se não definido, 3p ainda deve lidar com dois tipos de controle padrão, FINISHED e FAILED.
mediaObjects[]

object (MediaObject)

Lista de objetos de mídia.
repeatMode

enum (RepeatMode)

Modo de repetição para a lista de objetos de mídia.

MediaType

Tipo de mídia dessa resposta.

Enums
MEDIA_TYPE_UNSPECIFIED Valor NÃO ESPECIFICADO
AUDIO Arquivo de áudio.
MEDIA_STATUS_ACK Resposta para confirmar um relatório de status de mídia.

OptionalMediaControls

Tipos de controle de mídia com os quais a resposta de mídia pode ser suportada opcionalmente

Enums
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED Valor não especificado
PAUSED Evento pausado. Acionado quando o usuário pausa a mídia.
STOPPED Evento interrompido. Acionado quando o usuário sai da sessão de terceiros durante a reprodução de mídia.

MediaObject

Representa um único objeto de mídia.

Representação JSON 
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
Campos
name

string

Nome desse objeto de mídia.
description

string

Descrição desse objeto de mídia.
url

string

O URL que aponta para o conteúdo de mídia.
image

object (MediaImage)

Imagem a ser exibida com o card de mídia.

MediaImage

Imagem que será mostrada dentro de um MediaPrompt.

Representação JSON 
{

  // Union field image can be only one of the following:
  "large": {
    object (StaticImagePrompt)
  },
  "icon": {
    object (StaticImagePrompt)
  }
  // End of list of possible types for union field image.
}
Campos
Campo de união image. Somente um tipo de MediaImage é permitido. image pode ser apenas de um dos tipos a seguir:
large

object (StaticImagePrompt)

Uma imagem grande, como a capa do álbum etc.
icon

object (StaticImagePrompt)

Um pequeno ícone de imagem exibido à direita do título. Ela é redimensionada para 36 x 36 dp.

RepeatMode

Os tipos de modo de repetição para uma lista de objetos de mídia.

Enums
REPEAT_MODE_UNSPECIFIED Equivalente a OFF.
OFF Encerra a sessão de mídia no final do último objeto de mídia.
ALL Vai para o início do primeiro objeto de mídia quando o fim do último objeto de mídia for alcançado.

StaticListPrompt

Um card para apresentar uma lista de opções.

Representação JSON 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
Campos
title

string

Opcional. Título da lista.
subtitle

string

Opcional. Subtítulo da lista.
items[]

object (ListItem)

Obrigatório. Itens da lista.

ListItem

Um item na lista.

Representação JSON 
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Campos
key

string

Obrigatório. A chave PLN que corresponde ao nome da chave de entrada no tipo associado. Quando o item for tocado, essa chave será postada de volta como um parâmetro de opção de seleção.
title

string

Obrigatório. Título do item. Quando tocado, esse texto é postado de volta na conversa como se o usuário o tivesse digitado. Cada título precisa ser exclusivo entre o conjunto de itens.
description

string

Opcional. Corpo de texto do item.
image

object (StaticImagePrompt)

Opcional. Imagem do item.

StaticCollectionPrompt

Um card para apresentar uma coleção de opções.

Representação JSON 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
Campos
title

string

Opcional. Título da coleção.
subtitle

string

Opcional. Subtítulo da coleção.
items[]

object (CollectionItem)

Obrigatório. Itens da coleção
imageFill

enum (ImageFill)

Opcional. Tipo de opção de exibição de imagem.

CollectionItem

Um item na coleção.

Representação JSON 
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Campos
key

string

Obrigatório. A chave PLN que corresponde ao nome da chave de entrada no tipo associado. Quando o item for tocado, essa chave será postada de volta como um parâmetro de opção de seleção.
title

string

Obrigatório. Título do item. Quando tocado, esse texto é postado de volta na conversa como se o usuário o tivesse digitado. Cada título precisa ser exclusivo entre o conjunto de itens.
description

string

Opcional. Corpo de texto do item.
image

object (StaticImagePrompt)

Opcional. Imagem do item.

StaticCollectionBrowsePrompt

Apresenta um conjunto de documentos da Web como uma coleção de itens grandes em blocos. Os itens podem ser selecionados para abrir o documento da Web associado em um visualizador da Web.

Representação JSON 
{
  "items": [
    {
      object (CollectionBrowseItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
Campos
items[]

object (CollectionBrowseItem)

Itens da coleção "Procurar". O tamanho da lista deve estar no intervalo [2, 10].
imageFill

enum (ImageFill)

Opção de exibição de imagens na coleção.

CollectionBrowseItem

Item na coleção.

Representação JSON 
{
  "title": string,
  "description": string,
  "footer": string,
  "image": {
    object (StaticImagePrompt)
  },
  "openUriAction": {
    object (OpenUrl)
  }
}
Campos
title

string

Obrigatório. Título do item da coleção.
description

string

Descrição do item da coleção.
footer

string

Texto do rodapé do item da coleção, exibido abaixo da descrição. Linha única de texto, truncada com reticências.
image

object (StaticImagePrompt)

Imagem do item da coleção.
openUriAction

object (OpenUrl)

Obrigatório. URI a ser aberto se o item for selecionado.

Sugestão

Representa um ícone de sugestão, um elemento de interface mostrado ao usuário por conveniência.

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

string

Obrigatório. Texto mostrado no ícone de sugestão. Quando tocado, esse texto é postado de volta na conversa como se o usuário o tivesse digitado. Cada título precisa ser exclusivo entre o conjunto de ícones de sugestão. Máximo de 25 caracteres

StaticCanvasPrompt

Representa uma resposta de tela interativa a ser enviada ao usuário. Isso pode ser usado com o campo firstSimple na solicitação para falar com o usuário, além de exibir uma resposta de tela interativa.

Representação JSON 
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "sendStateDataToCanvasApp": boolean,
  "enableFullScreen": boolean
}
Campos
url

string

Obrigatório. URL da visualização da Web a ser carregada.
data[]

value (Value format)

Opcional. Dados JSON a serem transmitidos para a página da Web da experiência imersiva como um evento. Se o campo override no comando tiver false, os valores de dados definidos neste comando da tela vão ser adicionados depois dos valores de dados definidos nos comandos anteriores.
suppressMic

boolean

Opcional. Um valor verdadeiro significa que o microfone não será aberto para capturar entradas depois que essa resposta imersiva for apresentada ao usuário.
sendStateDataToCanvasApp

boolean

Opcional. Se for true, os metadados relacionados à conversa serão incluídos e enviados de volta ao aplicativo de tela.
enableFullScreen

boolean

Opcional. Se true, o aplicativo de canvas ocupa a tela cheia e não tem um cabeçalho na parte de cima. Uma mensagem de aviso também vai aparecer na tela de carregamento com o nome de exibição da ação, o nome do desenvolvedor e instruções para sair dela. Valor padrão: false

Cenário

A cena é a unidade básica do fluxo de controle ao projetar uma conversa. Eles podem ser encadeados com outras cenas, gerar comandos para o usuário final e definir slots. O nome da cena é especificado no nome do arquivo.

Representação JSON 
{
  "onEnter": {
    object (EventHandler)
  },
  "intentEvents": [
    {
      object (IntentEvent)
    }
  ],
  "conditionalEvents": [
    {
      object (ConditionalEvent)
    }
  ],
  "slots": [
    {
      object (Slot)
    }
  ],
  "onSlotUpdated": {
    object (EventHandler)
  }
}
Campos
onEnter

object (EventHandler)

Gerenciador a ser invocado ao fazer a transição para essa cena.
intentEvents[]

object (IntentEvent)

A lista de eventos acionados com base em intents. Esses eventos podem ser acionados a qualquer momento depois que o manipulador on_load é chamado. Importante: esses eventos definem o conjunto de intents com escopo para essa cena e terão precedência sobre qualquer evento definido globalmente que tenha as mesmas intents ou frases de acionamento. Os nomes das intents precisam ser exclusivos dentro de uma cena.
conditionalEvents[]

object (ConditionalEvent)

A lista de eventos a serem acionados com base em instruções condicionais. Eles são avaliados após o preenchimento do formulário ou imediatamente após on_load se a cena não tiver um formulário. A avaliação é feita apenas uma vez. Somente o primeiro evento correspondente será acionado.
slots[]

object (Slot)

Lista ordenada de slots. Cada slot define o tipo de dados que ele vai resolver e a configuração para personalizar a experiência da resolução (por exemplo, comandos).
onSlotUpdated

object (EventHandler)

Gerenciador chamado quando há uma alteração no estado de um slot não causada por atualizações em outro gerenciador. Isso permite que slots sejam invalidados, a cena invalidada ou outras mudanças no estado da cena.

IntentEvent

Registra eventos que são acionados como resultado de uma correspondência de intent.

Representação JSON 
{
  "intent": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
Campos
intent

string

Obrigatório. Intent que aciona o evento.
transitionToScene

string

Opcional. Cena de destino para a qual a conversa deve pular. O estado da cena atual é destruído na transição.
handler

object (EventHandler)

Opcional. Manipulador de eventos, que é acionado quando a intent é correspondida. Precisa ser executado antes da transição para a cena de destino. Útil para gerar comandos em resposta a eventos.

ConditionalEvent

Registra eventos que são acionados como resultado de uma condição verdadeira.

Representação JSON 
{
  "condition": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
Campos
condition

string

Obrigatório. Condição de filtro para que este evento seja acionado. Se a condição for avaliada como verdadeira, o handler associado será acionado. As seguintes referências de variáveis são compatíveis: $session: para fazer referência a dados no armazenamento da sessão. $user: para referenciar dados no armazenamento do usuário. Os seguintes operadores booleanos são aceitos (com exemplos): && - session.params.counter > 0 && session.params.counter < 100 || - session.params.foo == "John" || session.params.counter == "Adam" ! - !(session.params.counter == 5) As seguintes comparações são compatíveis: ==, !=, <, >, <= e >= Os seguintes operadores de lista e string são aceitos (com exemplos): in - "Watermelon" em session.params.fruitList size - size(session.params.fruitList) > 2 substring - session.params.fullName.contains("John")
transitionToScene

string

Opcional. Cena de destino para onde a conversa precisa pular quando a condição associada é avaliada como verdadeira. O estado da cena atual é destruído na transição.
handler

object (EventHandler)

Opcional. Manipulador de eventos que é acionado quando a condição associada é avaliada como true. Precisa ser executado antes da transição para a cena de destino. Útil para gerar comandos em resposta a eventos.

Slot

Configuração para um slot. Os slots são unidades únicas de dados que podem ser preenchidas por linguagem natural (ou seja, parâmetros de intent), parâmetros de sessão e outras fontes.

Representação JSON 
{
  "name": string,
  "type": {
    object (ClassReference)
  },
  "required": boolean,
  "promptSettings": {
    object (PromptSettings)
  },
  "commitBehavior": {
    object (CommitBehavior)
  },
  "config": value,
  "defaultValue": {
    object (DefaultValue)
  }
}
Campos
name

string

Obrigatório. Nome do slot.
type

object (ClassReference)

Obrigatório. Declara o tipo de dados desse slot.
required

boolean

Opcional. Indica se o espaço precisa ser preenchido antes de avançar. Os espaços obrigatórios que não estiverem preenchidos acionarão um aviso personalizável ao usuário.
promptSettings

object (PromptSettings)

Opcional. Registra solicitações para diferentes estágios de preenchimento de slot.
commitBehavior

object (CommitBehavior)

Opcional. Comportamento de confirmação associado ao slot.
config

value (Value format)

Opcional. Configuração adicional associada ao slot que é usada para preencher o slot. O formato da configuração é específico para o tipo de slot. As referências de recursos ao parâmetro do usuário ou da sessão podem ser adicionadas a essa configuração. Essa configuração é necessária para preencher slots relacionados a transações e engajamento do usuário.

Exemplo: para um slot do tipo actions.type.CompletePurchaseValue, a configuração a seguir propõe um pedido de produto digital com uma referência a um parâmetro de sessão userSelectedSkuId definido pelo cliente:

{ &quot;@type&quot;: &quot;type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec&quot;, &quot;skuId&quot;: { &quot;skuType&quot;: &quot;SKU_TYPE_IN_APP&quot;, &quot;id&quot;: &quot;$session.params.userSelectedSkuId&quot;, &quot;packageName&quot;: &quot;com.example.company&quot; }
defaultValue

object (DefaultValue)

Opcional. Configuração para preencher um valor padrão para este slot.

PromptSettings

Um único local onde os comandos de slot são definidos.

Representação JSON 
{
  "initialPrompt": {
    object (EventHandler)
  },
  "noMatchPrompt1": {
    object (EventHandler)
  },
  "noMatchPrompt2": {
    object (EventHandler)
  },
  "noMatchFinalPrompt": {
    object (EventHandler)
  },
  "noInputPrompt1": {
    object (EventHandler)
  },
  "noInputPrompt2": {
    object (EventHandler)
  },
  "noInputFinalPrompt": {
    object (EventHandler)
  }
}
Campos
initialPrompt

object (EventHandler)

Prompt para o valor do slot propriamente dito. Exemplo: "Que tamanho você quer?"
noMatchPrompt1

object (EventHandler)

Prompt para fornecer quando a entrada do usuário não corresponder ao tipo de valor esperado para o slot pela primeira vez. Exemplo: "Desculpe, não entendi".
noMatchPrompt2

object (EventHandler)

Prompt para fornecer quando a entrada do usuário não corresponder ao tipo de valor esperado para o slot pela segunda vez. Exemplo: "Desculpe, não entendi".
noMatchFinalPrompt

object (EventHandler)

Prompt para fornecer quando a entrada do usuário não corresponder ao tipo de valor esperado para o slot pela última vez. Exemplo: "Desculpe, não entendi".
noInputPrompt1

object (EventHandler)

Prompt para fornecer quando o usuário não fornecer uma entrada pela primeira vez. Exemplo: "Desculpe, não entendi".
noInputPrompt2

object (EventHandler)

Prompt para fornecer quando o usuário não fornecer uma entrada pela segunda vez. Exemplo: "Desculpe, não entendi".
noInputFinalPrompt

object (EventHandler)

Prompt para fornecer quando o usuário não fornecer uma entrada pela última vez. Exemplo: "Desculpe, não entendi".

CommitBehavior

Mensagem que descreve o comportamento de confirmação associado ao slot depois que ele é preenchido.

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

string

O parâmetro da sessão para gravar o valor do slot depois que ele é preenchido. No momento, não é possível usar caminhos aninhados. "$$" é usado para gravar o valor do slot em um parâmetro de sessão com o mesmo nome do slot. Por exemplo: writeSessionParam = "fruit". corresponde a "$session.params.fruit". writeSessionParam = "tíquete" corresponde a "$session.params.ticket".

DefaultValue

Configuração para preencher um valor padrão para este slot.

Representação JSON 
{
  "sessionParam": string,
  "constant": value
}
Campos
sessionParam

string

Opcional. O parâmetro da sessão a ser usado para inicializar o valor do slot, se ele tiver um valor não vazio. O tipo de valor precisa corresponder ao tipo de espaço. No momento, não é possível usar caminhos aninhados. Por exemplo: sessionParam = "fruit" corresponde a $session.params.fruit. sessionParam = "ticket" corresponde a $session.params.ticket.
constant

value (Value format)

Opcional. Valor padrão constante para o slot. Só será usado se um valor para o espaço não tiver sido preenchido pelo sessionParam. O tipo desse valor precisa corresponder ao tipo de espaço.

DataFiles

Wrapper para o arquivo de dados repetidos. Não é possível haver campos repetidos em um oneof.

Representação JSON 
{
  "dataFiles": [
    {
      object (DataFile)
    }
  ]
}
Campos
dataFiles[]

object (DataFile)

Vários arquivos de dados.

DataFile

Representa um único arquivo que contém dados não estruturados. Os exemplos incluem arquivos de imagem, arquivos de áudio e código-fonte da função do Cloud.

Representação JSON 
{
  "filePath": string,
  "contentType": string,
  "payload": string
}
Campos
filePath

string

Caminho relativo do arquivo de dados da raiz do projeto na estrutura de arquivos do SDK. Caminhos de arquivo permitidos: - Imagens: resources/images/{multiple directories}?/{ImageName}.{extension} - Áudio: resources/audio/{multiple directories}?/{AudioFileName}.{extension} - Código da função inline do Cloud: webhooks/{WebhookName}.zip Extensões permitidas: - Imagens: png, jpg, jpeg - Áudio: mp3, mpeg - Funções do Cloud inline: zip
contentType

string

Obrigatório. O tipo de conteúdo desse recurso. Exemplo: text/html. O tipo de conteúdo precisa estar em conformidade com a especificação (http://www.w3.org/Protocols/rfc1341/4_Content-Type.html). O Cloud Functions precisa estar no formato ZIP e o tipo de conteúdo precisa ser application/zip;zip_type=cloud_function. O parâmetro zip_type indica que o zip é para uma função do Cloud.
payload

string (bytes format)

Conteúdo do arquivo de dados. Por exemplo, bytes brutos de imagens, arquivos de áudio ou formato ZIP da função do Cloud. Há um limite rígido de 10 MB para o tamanho do payload.

Uma string codificada em base64.