- Representação JSON
- Usuário
- UserProfile
- PackageEntitlement
- Direito
- SignedData
- Dispositivo
- Superfície
- Capacidade
- Conversa
- Entrada
- RawInput
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 nas ações do Google, consulte https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json .
Representação JSON | |
---|---|
{ "user": { object ( |
Campos | |
---|---|
user |
Usuário que iniciou a conversa. |
device |
Informações sobre o dispositivo que o usuário está usando para interagir com a ação. |
surface |
Informações sobre a superfície com que o usuário está interagindo, por exemplo, se ela pode gerar áudio ou ter uma tela. |
conversation |
Mantém os dados da sessão, como o ID e o token da conversa. |
inputs[] |
Lista de entradas correspondentes às entradas esperadas especificadas pela ação. Para o gatilho de conversa inicial, a entrada contém informações sobre como o usuário acionou a conversa. |
isInSandbox |
Indica se a solicitação deve ser tratada no modo sandbox. |
availableSurfaces[] |
Superfícies disponíveis para transferência de superfície. |
Usuário
Representação JSON | |
---|---|
{ "idToken": string, "profile": { object ( |
Campos | |
---|---|
idToken |
token que representa a identidade do usuário. Este é um token da Web Json incluindo um perfil codificado. A definição está em https://developers.google.com/identity/protocols/OpenIDConnect#obtainuserinfo. |
profile |
Informações sobre o usuário final. Alguns campos só estarão disponíveis se o usuário tiver dado permissão para disponibilizar essas informações na ação. |
accessToken |
Um token OAuth2 que identifica o usuário no sistema. Disponível apenas se o usuário vincular a conta. |
permissions[] |
Contém permissões concedidas pelo usuário para esta Ação. |
locale |
Configuração de localidade principal do usuário que fez 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 |
O carimbo de data/hora da última interação com esse usuário. Este 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: |
userStorage |
Um token opaco fornecido pelo aplicativo que é mantido nas conversas de um usuário específico. O tamanho máximo da string é de 10 mil caracteres. |
packageEntitlements[] |
Lista de direitos do usuário para cada nome de pacote listado no pacote de ações, se houver. |
userVerificationStatus |
Indica o status da verificação do usuário. |
UserProfile
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 |
O nome completo do usuário, conforme especificado na Conta do Google. Requer a permissão |
givenName |
O nome do usuário, conforme especificado na Conta do Google. Requer a permissão |
familyName |
O sobrenome do usuário, conforme especificado na Conta do Google. Esse campo pode ficar vazio. Requer a permissão |
PackageEntitlement
Lista de direitos relacionados a um nome de pacote
Representação JSON | |
---|---|
{
"packageName": string,
"entitlements": [
{
object ( |
Campos | |
---|---|
packageName |
Precisa corresponder ao nome do pacote no pacote de ações |
entitlements[] |
Lista de direitos de um determinado app |
Direito
Define os direitos digitais de um usuário. Tipos de direitos possíveis: app pago, compras no app e assinaturas no app.
Representação JSON | |
---|---|
{ "sku": string, "skuType": enum ( |
Campos | |
---|---|
sku |
SKU do produto Nome do pacote do app pago, sufixo de docid do Finsky para compra no app e assinatura no app. Corresponde a getSku() na API do Faturamento em apps do Google Play. |
skuType |
|
inAppDetails |
Presente somente para compras e assinaturas no app. |
SignedData
Representação JSON | |
---|---|
{ "inAppPurchaseData": { object }, "inAppDataSignature": string } |
Campos | |
---|---|
inAppPurchaseData |
Corresponde ao método INAPP_PURCHASE_DATA do método getPurchases(). Contém todos os dados de compra no app no formato JSON. Consulte os detalhes na Tabela 6 de https://developer.android.com/google/play/billing/billing_reference.html. |
inAppDataSignature |
Corresponde a IN_APP_DATA_SIGNATURE do método getPurchases() na API Play InApp Billing. |
Dispositivo
Informações sobre o dispositivo que o usuário está usando para interagir com a ação.
Representação JSON | |
---|---|
{
"location": {
object ( |
Campos | |
---|---|
location |
Representa a localização real do dispositivo, como latitude, longitude e endereço formatado. Requer a permissão |
Superfície
Informações específicas sobre a plataforma do cliente do Google Assistente com que o usuário está interagindo. A plataforma se distingue do dispositivo pelo fato de que várias plataformas do Google Assistente podem existir no mesmo dispositivo.
Representação JSON | |
---|---|
{
"capabilities": [
{
object ( |
Campos | |
---|---|
capabilities[] |
Uma lista de recursos compatíveis com a plataforma no momento da solicitação, por exemplo, |
Capacidade
Representa uma unidade de funcionalidade compatível com a superfície.
Representação JSON | |
---|---|
{ "name": string } |
Campos | |
---|---|
name |
O nome da capacidade, por exemplo, |
Conversa
Representação JSON | |
---|---|
{
"conversationId": string,
"type": enum ( |
Campos | |
---|---|
conversationId |
ID exclusivo da conversa de várias interações. Ela é atribuída para a primeira curva. Depois disso, permanece o mesmo para as conversas subsequentes até que a conversa seja encerrada. |
type |
type indica o estado da conversa no ciclo de vida. |
conversationToken |
Token opaco especificado pela ação na última conversa. Ele pode ser usado por uma ação para rastrear a conversa ou armazenar dados relacionados à conversa. |
Entrada
Representação JSON | |
---|---|
{ "rawInputs": [ { object ( |
Campos | |
---|---|
rawInputs[] |
Transcrição de entrada bruta de cada turno da conversa. Várias rodadas de conversa podem ser necessárias para que as ações no Google forneçam alguns tipos de entrada para a ação. |
intent |
Indica a intenção do usuário. Para a primeira conversa, a intent vai se referir à intent de acionamento da ação. Para rodadas de conversas subsequentes, a intent será uma ação comum na intent do Google (começa com "actions".). Por exemplo, se a entrada esperada for |
arguments[] |
Uma lista de valores de argumento fornecidos para a entrada solicitada pela ação. |
RawInput
Representação JSON | |
---|---|
{ "inputType": enum ( |
Campos | ||
---|---|---|
inputType |
Indica como o usuário forneceu essa entrada: uma resposta digitada, uma resposta de voz, não especificada etc. |
|
Campo de união input . O valor real de entrada input só pode ser de uma das seguintes formas: |
||
query |
Entrada digitada ou falada pelo usuário final. |
|
url |
O URL de acionamento. |