AppRequest

AppRequest é uma solicitação enviada pelo Google Assistente a um fulfillment para interagir com uma ação. A versão da API é especificada no cabeçalho HTTP. Para a versão 1 da API, o cabeçalho contém: Google-Assistant-API-Version: v1. Para a versão 2 da API, o cabeçalho contém: Google-actions-API-Version: 2. Para ver exemplos de como isso é usado em ações no Google, consulte https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json .

Representação JSON 
{
  "user": {
    object (User)
  },
  "device": {
    object (Device)
  },
  "surface": {
    object (Surface)
  },
  "conversation": {
    object (Conversation)
  },
  "inputs": [
    {
      object (Input)
    }
  ],
  "isInSandbox": boolean,
  "availableSurfaces": [
    {
      object (Surface)
    }
  ]
}
Campos
user

object (User)

Usuário que iniciou a conversa.
device

object (Device)

São informações sobre o dispositivo que o usuário está usando para interagir com a ação.
surface

object (Surface)

Informações sobre a superfície com que o usuário está interagindo, por exemplo, se pode gerar áudio ou se tem uma tela.
conversation

object (Conversation)

Contém dados da sessão, como o código e o token da conversa.
inputs[]

object (Input)

Lista de entradas correspondentes às entradas especificadas pela ação. Para o acionador de conversa inicial, a entrada contém informações sobre como o usuário acionou a conversa.
isInSandbox

boolean

Indica se a solicitação deve ser processada no modo sandbox.
availableSurfaces[]

object (Surface)

Superfícies disponíveis para transferência entre superfícies.

Usuário

Representação JSON 
{
  "idToken": string,
  "profile": {
    object (UserProfile)
  },
  "accessToken": string,
  "permissions": [
    enum (Permission)
  ],
  "locale": string,
  "lastSeen": string,
  "userStorage": string,
  "packageEntitlements": [
    {
      object (PackageEntitlement)
    }
  ],
  "userVerificationStatus": enum (UserVerificationStatus)
}
Campos
idToken

string

token que representa a identidade do usuário. Este é um token da web Json que inclui um perfil codificado. A definição está em https://developers.google.com/identity/protocols/OpenIDConnect#obtainuserinfo.
profile

object (UserProfile)

Informações sobre o usuário final. Alguns campos só estarão disponíveis se o usuário tiver dado permissão para fornecer essas informações à ação.
accessToken

string

Um token OAuth2 que identifica o usuário no seu sistema. Disponível apenas se o usuário vincular a conta.
permissions[]

enum (Permission)

Contém permissões concedidas pelo usuário para esta ação.
locale

string

Configuração de localidade principal do usuário que faz a solicitação. Segue o código de idioma IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt. No entanto, a subtag de script não está incluída.
lastSeen

string (Timestamp format)

O carimbo de data/hora da última interação com esse usuário. Esse campo será omitido se o usuário não tiver interagido com o agente antes.

Um carimbo de data/hora no formato UTC “Zulu” RFC3339, medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".
userStorage

string

Um token opaco fornecido pelo aplicativo que é persistente em conversas de um usuário específico. O tamanho máximo da string é de 10.000 caracteres.
packageEntitlements[]

object (PackageEntitlement)

Lista de direitos do usuário para cada nome de pacote listado no pacote de ação, se houver.
userVerificationStatus

enum (UserVerificationStatus)

Indica o status de verificação do usuário.

Perfil do usuário

Contém as informações pessoais do usuário. Os campos só serão preenchidos se o usuário conceder permissão para a ação em um determinado campo.

Representação JSON 
{
  "displayName": string,
  "givenName": string,
  "familyName": string
}
Campos
displayName

string

O nome completo do usuário, conforme especificado na Conta do Google. Requer a permissão NAME.
givenName

string

O nome do usuário, conforme especificado na Conta do Google. Requer a permissão NAME.
familyName

string

O sobrenome do usuário, conforme especificado na Conta do Google. Esse campo pode estar vazio. Requer a permissão NAME.

Pacote Entitlement

Lista de direitos relacionados a um nome de pacote

Representação JSON 
{
  "packageName": string,
  "entitlements": [
    {
      object (Entitlement)
    }
  ]
}
Campos
packageName

string

Deve corresponder ao nome do pacote no pacote de ações
entitlements[]

object (Entitlement)

Lista de direitos de um determinado app

Direito

Define o direito digital de um usuário. Tipos de possíveis direitos: apps pagos, compras no app e assinaturas no app.

Representação JSON 
{
  "sku": string,
  "skuType": enum (SkuType),
  "inAppDetails": {
    object (SignedData)
  }
}
Campos
sku

string

SKU do produto. Nome do pacote de app pago, sufixo do Finsky docid para compras e assinatura no app. Corresponder getSku() à API Play InApp Billing.
skuType

enum (SkuType)
inAppDetails

object (SignedData)

Presente apenas para compras no app e assinaturas no app.

Dados assinados

Representação JSON 
{
  "inAppPurchaseData": {
    object
  },
  "inAppDataSignature": string
}
Campos
inAppPurchaseData

object (Struct format)

Corresponde a INAPP_PURCHASE_DATA do método getPurchases(). Contém todos os dados de compras no aplicativo no formato JSON. Veja detalhes na tabela 6 de https://developer.android.com/google/play/billing/billing_reference.html.
inAppDataSignature

string

Corresponde a IN_APP_DATA_SIGNATURE do método getPurchases() na API Play InApp Billing.

Dispositivo

São informações sobre o dispositivo que o usuário está usando para interagir com a ação.

Representação JSON 
{
  "location": {
    object (Location)
  }
}
Campos
location

object (Location)

Representa o local real do dispositivo, como latitude, longitude e endereço formatado. Requer a permissão DEVICE_COARSE_LOCATION ou DEVICE_PRECISE_LOCATION.

Superfície

As informações específicas da superfície do cliente do Google Assistente com que o usuário está interagindo. A superfície é diferente do dispositivo porque várias superfícies do Assistente podem estar no mesmo dispositivo.

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

object (Capability)

Uma lista de recursos compatíveis com a superfície no momento da solicitação, por exemplo, actions.capability.AUDIO_OUTPUT

Capacidade

Representa uma unidade de funcionalidade compatível com a superfície.

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

string

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

Conversa

Representação JSON 
{
  "conversationId": string,
  "type": enum (ConversationType),
  "conversationToken": string
}
Campos
conversationId

string

ID exclusivo da conversa com várias rodadas. Ela é atribuída na primeira rodada. Depois disso, a conversa é a mesma para conversas subsequentes até o encerramento.
type

enum (ConversationType)

type indica o estado da conversa em seu ciclo de vida.
conversationToken

string

Token opaco especificado pela ação na última conversa. Ele pode ser usado por uma ação para acompanhar a conversa ou armazenar dados relacionados a ela.

Entrada

Representação JSON 
{
  "rawInputs": [
    {
      object (RawInput)
    }
  ],
  "intent": string,
  "arguments": [
    {
      object (Argument)
    }
  ]
}
Campos
rawInputs[]

object (RawInput)

Transcrição bruta de entrada de cada turno de conversa. Pode ser necessário ativar várias rodadas de conversa para que ações no Google forneçam alguns tipos de entrada para a ação.
intent

string

Indica a intenção do usuário. Na primeira rodada de conversas, a intent vai se referir à intent de acionamento da ação. Para rodadas de conversa subsequentes, a intent será uma ação comum na intent do Google (começa com "ações"). Por exemplo, se a entrada esperada for actions.intent.OPTION, a intent especificada aqui será actions.intent.OPTION se o Google Assistente conseguir satisfazer essa intent ou actions.intent.TEXT se o usuário fornecer outras informações. Consulte https://developers.google.com/assistant/df-asdk/reference/intents.
arguments[]

object (Argument)

Uma lista de valores de argumentos fornecidos para a entrada solicitada pela ação.

Entrada bruta

Representação JSON 
{
  "inputType": enum (InputType),

  // Union field input can be only one of the following:
  "query": string,
  "url": string
  // End of list of possible types for union field input.
}
Campos
inputType

enum (InputType)

Indica como o usuário forneceu esta entrada: uma resposta digitada, uma voz, não especificada etc.
Campo de união input. O valor de entrada real input pode ser apenas um dos seguintes:
query

string

Entrada digitada ou falada do usuário final.
url

string

O URL de acionamento.