Method: projects.sendInteraction

string

Obrigatório. O projeto que está sendo testado, indicado pelo ID. Formato: projects/{project}

{
  "query": string,
  "type": enum (InputType)
}

string

Conteúdo da entrada enviada pelo usuário.

enum (InputType)

Tipo de entrada.

{
  "surface": enum (Surface),
  "location": {
    object (Location)
  },
  "locale": string,
  "timeZone": string
}

enum (Surface)

Plataforma usada para interagir com a ação.

object (Location)

Localização do dispositivo, como latitude, longitude e endereço formatado.

string

Localidade definida no dispositivo. O formato precisa seguir o BCP 47: https://tools.ietf.org/html/bcp47 (link em inglês). Exemplos: en, en-US, es-419 (mais exemplos em https://tools.ietf.org/html/bcp47#appendix-A).

string

Fuso horário definido no dispositivo O formato precisa seguir o banco de dados de fuso horário da IANA, por exemplo, "America/New_York": https://www.iana.org/time-zones (em inglês).

{
  "coordinates": {
    object (LatLng)
  },
  "formattedAddress": string,
  "zipCode": string,
  "city": string
}

object (LatLng)

Coordenadas geográficas. Requer a permissão [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] [DEVICE_PRECISE_LOCATION].

string

Endereço de exibição, por exemplo, "1600 Amphitheatre Parkway, Mountain View, CA 94043". Requer a permissão [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] [DEVICE_PRECISE_LOCATION].

string

CEP Requer a permissão [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] ou [DEVICE_COARSE_LOCATION].

string

Cidade. Requer a permissão [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] ou [DEVICE_COARSE_LOCATION].

{
  "latitude": number,
  "longitude": number
}

number

A latitude em graus. Precisa estar no intervalo [-90,0, +90,0].

number

A longitude em graus. Precisa estar no intervalo [-180,0, +180,0].

{
  "text": string,
  "speech": [
    string
  ],
  "canvas": {
    object (Canvas)
  },
  "actionsBuilderPrompt": {
    object (Prompt)
  }
}

string

Resposta falada enviada ao usuário como uma string simples.

string

Conteúdo de fala produzido pela ação. Isso pode incluir elementos de marcação como SSML.

object (Canvas)

Conteúdo de tela interativa.

object (Prompt)

Estado do comando ao final da rodada de conversas. Mais informações sobre a solicitação: https://developers.google.com/assistant/conversational/prompts

{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "enableFullScreen": boolean
}

string

URL do app da Web de tela interativo que será carregado. Se não for definido, o URL da tela ativa atual será reutilizado.

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 "substituir" no comando for "falso", os valores de dados definidos neste comando do Canvas vão ser adicionados após os valores de dados definidos nas solicitações anteriores.

boolean

Opcional. Valor padrão: falso.

boolean

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

{
  "append": boolean,
  "override": boolean,
  "firstSimple": {
    object (Simple)
  },
  "content": {
    object (Content)
  },
  "lastSimple": {
    object (Simple)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (Link)
  },
  "canvas": {
    object (Canvas)
  }
}

boolean

Opcional. Modo de como estas mensagens devem ser mescladas com mensagens definidas anteriormente. "false" limpa todas as mensagens definidas anteriormente (primeira e última simples, conteúdo, link e tela de sugestões) e adiciona mensagens definidas no comando. "true" vai adicionar as mensagens definidas neste comando às mensagens definidas nas respostas anteriores. Definir este campo como "true" também ativa a anexação a alguns campos dentro de prompts simples, de sugestões e do Canvas (parte do prompt de conteúdo). As mensagens de conteúdo e link sempre serão substituídas, se definidas no prompt. O valor padrão é "falso".

boolean

Opcional. Modo de como estas mensagens devem ser mescladas com mensagens definidas anteriormente. "true" limpa todas as mensagens definidas anteriormente (primeira e última simples, conteúdo, link e tela de sugestões) e adiciona mensagens definidas no comando. "false" adiciona as mensagens definidas neste comando às definidas nas respostas anteriores. Deixar esse campo como "falso" também permite anexar a alguns campos dentro de prompts simples, de sugestões e do Canvas (parte do prompt de conteúdo). As mensagens de Conteúdo e Link são sempre substituídas se definidas no prompt. O valor padrão é "falso".

object (Simple)

Opcional. A primeira resposta de voz e somente texto.

object (Content)

Opcional. Um conteúdo como um card, lista ou mídia que será exibido ao usuário.

object (Simple)

Opcional. A última resposta de voz e somente texto.

object (Suggestion)

Opcional. Sugestões a serem exibidas ao usuário que sempre aparecerão no final da resposta. Se o campo "substituir" no comando for "falso", os títulos definidos nele serão adicionados aos títulos definidos nas solicitações de sugestões definidas anteriormente, e os valores duplicados serão removidos.

object (Link)

Opcional. Um chip de sugestão adicional que pode ser vinculado ao app ou site associado. O ícone será renderizado com o título "Abrir ". Máximo de 20 caracteres.

object (Canvas)

Opcional. Representa uma resposta de tela interativa a ser enviada ao usuário.

{
  "speech": string,
  "text": string
}

string

Opcional. Representa a fala a ser falada para o usuário. Pode ser SSML ou conversão de texto em voz. Se o campo "substituir" no comando que contém o comando for "true", a fala definida nesse campo vai substituir a fala da solicitação Simples anterior.

string

Texto opcional a ser exibido no balão do chat. Se não for fornecido, será usada uma renderização de exibição do campo de fala acima. Limitado a 640 caracteres. Se o campo "substituir" no comando que contém o comando for "true", o texto definido nesse campo vai substituir o texto do comando Simples anterior.

{

  // Union field content can be only one of the following:
  "card": {
    object (Card)
  },
  "image": {
    object (Image)
  },
  "table": {
    object (Table)
  },
  "media": {
    object (Media)
  },
  "canvas": {
    object (Canvas)
  },
  "collection": {
    object (Collection)
  },
  "list": {
    object (List)
  }
  // End of list of possible types for union field content.
}

object (Card)

Um cartão básico.

object (Image)

Uma imagem.

object (Table)

Card de tabela.

object (Media)

Resposta indicando um conjunto de mídias a serem reproduzidas.

object (Canvas)

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

object (Collection)

Um card que apresenta uma coleção de opções.

object (List)

Um card com uma lista de opções disponíveis.

{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (Image)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (Link)
  }
}

string

Título geral do card. Opcional.

string

Opcional.

string

É o texto do corpo do card. Oferece suporte a um conjunto limitado de sintaxe markdown para formatação. Obrigatório, a menos que haja imagem.

object (Image)

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

enum (ImageFill)

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

object (Link)

Botão. Opcional.

{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}

string

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

string

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

integer

A altura da imagem, em pixels. Opcional.

integer

A largura da imagem, em pixels. Opcional.

{
  "name": string,
  "open": {
    object (OpenUrl)
  }
}

string

Nome do link

object (OpenUrl)

O que acontece quando um usuário abre o link

{
  "url": string,
  "hint": enum (UrlHint)
}

string

O campo de URL, que pode ser qualquer uma das seguintes opções: - URLs http/https para abrir um app vinculado ao app ou uma página da Web

enum (UrlHint)

Indica uma dica para o tipo de URL.

{
  "title": string,
  "subtitle": string,
  "image": {
    object (Image)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (Link)
  }
}

string

Título geral da tabela. Opcional, mas precisa ser definido se o subtítulo estiver definido.

string

Subtítulo da tabela. Opcional.

object (Image)

Imagem associada à tabela. Opcional.

object (TableColumn)

Cabeçalhos e alinhamento de colunas.

object (TableRow)

Dados de linha da tabela. As três primeiras linhas certamente serão mostradas, mas as outras podem ser cortadas em determinadas superfícies. Teste com o simulador para saber quais linhas vão ser mostradas para uma determinada superfície. Nas plataformas compatíveis com o recurso WEB_BROWSER, é possível direcionar o usuário para uma página da Web com mais dados.

object (Link)

Botão.

{
  "header": string,
  "align": enum (HorizontalAlignment)
}

string

Texto do cabeçalho da coluna.

enum (HorizontalAlignment)

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

{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}

object (TableCell)

Células nesta linha. As três primeiras células vão aparecer, mas as outras podem ser cortadas em determinadas superfícies. Teste com o simulador para ver quais células vão ser mostradas para uma determinada superfície.

boolean

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

{
  "text": string
}

string

Conteúdo do texto da célula.

{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ]
}

enum (MediaType)

Tipo de mídia.

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".

enum (OptionalMediaControls)

Tipos de controle de mídia opcionais compatíveis com a 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 precisa lidar com dois tipos de controle padrão, FINISHED e FAILED.

object (MediaObject)

Lista de objetos de mídia

{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}

string

Nome desse objeto de mídia.

string

Descrição desse objeto de mídia.

string

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

object (MediaImage)

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

{

  // Union field image can be only one of the following:
  "large": {
    object (Image)
  },
  "icon": {
    object (Image)
  }
  // End of list of possible types for union field image.
}

object (Image)

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

object (Image)

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

{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}

string

Título da coleção. Opcional.

string

Subtítulo da coleção. Opcional.

object (CollectionItem)

mín: 2 máx: 10

enum (ImageFill)

Como os planos de fundo das imagens dos itens da coleção vão ser preenchidos. Opcional.

{
  "key": string
}

string

Obrigatório. A chave PLN que corresponde ao nome da chave de entrada no Tipo associado.

{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}

string

Título da lista. Opcional.

string

Subtítulo da lista. Opcional.

object (ListItem)

mín: 2 máx: 30

{
  "key": string
}

string

Obrigatório. A chave PLN que corresponde ao nome da chave de entrada no Tipo associado.

{
  "title": string
}

string

Obrigatório. O texto mostrado no ícone de sugestão. Quando tocado, esse texto será postado de volta na conversa literalmente, como se o usuário o tivesse digitado. Cada título precisa ser único no conjunto de ícones de sugestão. Até 25 caracteres

{
  "actionsBuilderEvents": [
    {
      object (ExecutionEvent)
    }
  ]
}

object (ExecutionEvent)

Lista de eventos com detalhes sobre o processamento da rodada de conversa ao longo dos estágios do modelo de interação do Actions Builder. Preenchido apenas para apps do Actions Builder e do SDK do Actions.

{
  "eventTime": string,
  "executionState": {
    object (ExecutionState)
  },
  "status": {
    object (Status)
  },
  "warningMessages": [
    string
  ],

  // Union field EventData can be only one of the following:
  "userInput": {
    object (UserConversationInput)
  },
  "intentMatch": {
    object (IntentMatch)
  },
  "conditionsEvaluated": {
    object (ConditionsEvaluated)
  },
  "onSceneEnter": {
    object (OnSceneEnter)
  },
  "webhookRequest": {
    object (WebhookRequest)
  },
  "webhookResponse": {
    object (WebhookResponse)
  },
  "webhookInitiatedTransition": {
    object (WebhookInitiatedTransition)
  },
  "slotMatch": {
    object (SlotMatch)
  },
  "slotRequested": {
    object (SlotRequested)
  },
  "slotValidated": {
    object (SlotValidated)
  },
  "formFilled": {
    object (FormFilled)
  },
  "waitingUserInput": {
    object (WaitingForUserInput)
  },
  "endConversation": {
    object (EndConversation)
  }
  // End of list of possible types for union field EventData.
}

string (Timestamp format)

Carimbo de data/hora de quando o evento aconteceu.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

object (ExecutionState)

Estado da execução durante o evento.

object (Status)

Status resultante de uma etapa de execução específica.

string

Lista de avisos gerados durante a execução deste evento. Avisos são dicas para o desenvolvedor descobertas durante a solicitação de conversa. Elas geralmente não são críticas e não interrompem a execução da solicitação. Por exemplo, um aviso pode ser gerado quando o webhook tenta substituir um tipo personalizado que não existe. Os erros são informados como um código de status com falha, mas os avisos podem estar presentes mesmo quando o status é OK.

object (UserConversationInput)

Evento de manipulação de entrada do usuário.

object (IntentMatch)

Evento de correspondência de intent.

object (ConditionsEvaluated)

Evento de avaliação da condição.

object (OnSceneEnter)

Evento de execução de OnSceneEnter.

object (WebhookRequest)

Evento de envio de solicitação de webhook.

object (WebhookResponse)

Evento de recebimento de resposta de webhook.

object (WebhookInitiatedTransition)

Evento de transição iniciado pelo webhook.

object (SlotMatch)

Evento de correspondência de espaço.

object (SlotRequested)

Evento de solicitação de espaço.

object (SlotValidated)

Evento de validação de slot.

object (FormFilled)

Evento de preenchimento de formulário.

object (WaitingForUserInput)

Aguardando evento de entrada do usuário.

object (EndConversation)

Evento de fim de conversa.

{
  "currentSceneId": string,
  "sessionStorage": {
    object
  },
  "slots": {
    object (Slots)
  },
  "promptQueue": [
    {
      object (Prompt)
    }
  ],
  "userStorage": {
    object
  },
  "householdStorage": {
    object
  }
}

string

ID do cenário que está ativo no momento.

object (Struct format)

Estado do armazenamento da sessão: https://developers.google.com/assistant/conversational/storage-session

object (Slots)

Estado do preenchimento de slots, se aplicável: https://developers.google.com/assistant/conversational/scenes#slot_filling

object (Prompt)

Fila de comandos: https://developers.google.com/assistant/conversational/prompts

object (Struct format)

Estado do armazenamento do usuário: https://developers.google.com/assistant/conversational/storage-user

object (Struct format)

Estado do armazenamento do Google Home: https://developers.google.com/assistant/conversational/storage-home

{
  "status": enum (SlotFillingStatus),
  "slots": {
    string: {
      object (Slot)
    },
    ...
  }
}

enum (SlotFillingStatus)

O status atual do preenchimento de slots.

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

Os slots associados à cena atual.

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

{
  "mode": enum (SlotMode),
  "status": enum (SlotStatus),
  "value": value,
  "updated": boolean,
  "prompt": {
    object (Prompt)
  }
}

enum (SlotMode)

O modo do slot (obrigatório ou opcional). Pode ser definido pelo desenvolvedor.

enum (SlotStatus)

O status do espaço.

value (Value format)

O valor do slot. Alterar esse valor na resposta modifica o valor no preenchimento de slots.

boolean

Indica se o valor do slot foi coletado na última curva. Este campo é somente leitura.

object (Prompt)

Opcional. Essa solicitação é enviada ao usuário quando necessário para preencher um slot necessário. Esse prompt substitui o comando existente definido no console. Este campo não está incluído na solicitação do webhook.

{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}

integer

O código de status, que precisa ser um valor de enumeração de google.rpc.Code.

string

Uma mensagem de erro em inglês para o desenvolvedor. Qualquer mensagem de erro para o usuário precisa ser localizada e enviada no campo google.rpc.Status.details, ou localizada pelo cliente.

object

Uma lista de mensagens com os detalhes do erro. Há um conjunto comum de tipos de mensagens para as APIs usarem.

Um objeto contendo campos de um tipo arbitrário. Um campo adicional "@type" contém uma URI que identifica o tipo. Exemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

{
  "type": string,
  "originalQuery": string
}

string

Tipo de entrada do usuário. Por exemplo, teclado, voz, toque etc.

string

Entrada de texto original do usuário.

{
  "intentId": string,
  "intentParameters": {
    string: {
      object (IntentParameterValue)
    },
    ...
  },
  "handler": string,
  "nextSceneId": string
}

string

ID da intent que acionou esta interação.

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

Parâmetros da intent que acionaram essa interação.

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

string

Nome do gerenciador anexado a esta interação.

string

Cena a que a interação leva.

{
  "failedConditions": [
    {
      object (Condition)
    }
  ],
  "successCondition": {
    object (Condition)
  }
}

object (Condition)

Lista de condições que foram avaliadas como "false".

object (Condition)

A primeira condição avaliada como "true", se houver.

{
  "expression": string,
  "handler": string,
  "nextSceneId": string
}

string

Expressão especificada nesta condição.

string

Nome do gerenciador especificado na condição avaliada.

string

Cena de destino especificada na condição avaliada.

{
  "handler": string
}

string

Nome do manipulador especificado no evento onSceneEnter.

{
  "requestJson": string
}

string

Payload da solicitação do webhook.

{
  "responseJson": string
}

string

Payload da resposta do webhook.

{
  "nextSceneId": string
}

string

ID do cenário ao qual a transição está levando.

{
  "nluParameters": {
    string: {
      object (IntentParameterValue)
    },
    ...
  }
}

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

Parâmetros extraídos por PLN da entrada do usuário.

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

{
  "slot": string,
  "prompt": {
    object (Prompt)
  }
}

string

Nome do espaço solicitado.

object (Prompt)

Solicitação de slot.