AppRequest

AppRequest es una solicitud que envía Asistente de Google a una entrega para interactuar con una acción. La versión de la API se especifica en el encabezado HTTP. Para la versión 1 de la API, el encabezado contiene: Google-Assistant-API-Version: v1. Para la versión 2 de la API, el encabezado contiene: Google-actions-API-Version: 2. Para ver ejemplos de cómo se usa este método en Actions on Google, consulta https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json .

Representación 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)

El usuario que inició la conversación.

device

object (Device)

Es la información sobre el dispositivo que el usuario usa para interactuar con la acción.

surface

object (Surface)

Información sobre la superficie con la que interactúa el usuario, p.ej., si puede transmitir audio o tiene pantalla.

conversation

object (Conversation)

Contiene datos de sesión, como el ID y el token de la conversación.

inputs[]

object (Input)

Lista de entradas que corresponden a las entradas esperadas que especifica la acción. Para el activador inicial de la conversación, la entrada contiene información sobre cómo el usuario activó la conversación.

isInSandbox

boolean

Indica si la solicitud debe manejarse en el modo de zona de pruebas.

availableSurfaces[]

object (Surface)

Superficies disponibles para transferencia entre superficies.

Usuario

Representación 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 la identidad del usuario. Este es un token web JSON que incluye el perfil codificado. La definición está en https://developers.google.com/identity/protocols/OpenIDConnect#obtainuserinfo.

profile

object (UserProfile)

Información sobre el usuario final. Algunos campos solo están disponibles si el usuario otorgó permiso para proporcionar esta información a la acción.

accessToken

string

Un token de OAuth2 que identifica al usuario en tu sistema. Solo está disponible si el usuario vincula su cuenta.

permissions[]

enum (Permission)

Contiene los permisos otorgados por el usuario para esta acción.

locale

string

Es la configuración regional principal del usuario que realiza la solicitud. Sigue el código de idioma IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt Sin embargo, no se incluye la subetiqueta de la secuencia de comandos.

lastSeen

string (Timestamp format)

La marca de tiempo de la última interacción con este usuario. Este campo se omitirá si el usuario no interactuó antes con el agente.

Es una marca de tiempo en el formato RFC3339 UTC "Zulu", con precisión de nanosegundos. Ejemplo: "2014-10-02T15:01:23.045123456Z".

userStorage

string

Un token opaco proporcionado por la aplicación que se conserva en las conversaciones de un usuario en particular. El tamaño máximo de la cadena es de 10,000 caracteres.

packageEntitlements[]

object (PackageEntitlement)

Lista de derechos del usuario para cada nombre de paquete del paquete de acción, si corresponde.

userVerificationStatus

enum (UserVerificationStatus)

Indica el estado de verificación del usuario.

UserProfile

Contiene la información personal del usuario. Los campos solo se propagan si el usuario otorga permiso a la acción para un campo en particular.

Representación JSON
{
  "displayName": string,
  "givenName": string,
  "familyName": string
}
Campos
displayName

string

El nombre completo del usuario, como se especifica en su Cuenta de Google. Requiere el permiso NAME.

givenName

string

Indica el nombre del usuario, tal como se especifica en su Cuenta de Google. Requiere el permiso NAME.

familyName

string

El apellido del usuario, como se especifica en su Cuenta de Google. Ten en cuenta que este campo podría estar vacío. Requiere el permiso NAME.

PackageEntitlement

Lista de derechos relacionados con un nombre de paquete

Representación JSON
{
  "packageName": string,
  "entitlements": [
    {
      object (Entitlement)
    }
  ]
}
Campos
packageName

string

Debe coincidir con el nombre del paquete en el paquete de acción

entitlements[]

object (Entitlement)

Lista de derechos de una app determinada

Derecho

Define los derechos digitales de un usuario. Tipos de derechos posibles: aplicaciones pagadas, compras directas desde la aplicación y suscripciones integradas en las apps.

Representación JSON
{
  "sku": string,
  "skuType": enum (SkuType),
  "inAppDetails": {
    object (SignedData)
  }
}
Campos
sku

string

SKU del producto Nombre del paquete de la aplicación pagada, sufijo del dócid Finsky para las compras directas desde la aplicación y la suscripción integrada en la aplicación. Haz coincidir getSku() en la API de Facturación integrada de Play.

skuType

enum (SkuType)

inAppDetails

object (SignedData)

Solo está presente para compras directas desde la aplicación y suscripciones integradas en la aplicación.

SignedData

Representación JSON
{
  "inAppPurchaseData": {
    object
  },
  "inAppDataSignature": string
}
Campos
inAppPurchaseData

object (Struct format)

Hacer coincidir INAPP_PURCHASE_DATA con el método getPurchases(). Contiene todos los datos de compras directas desde la aplicación en formato JSON. Consulta los detalles en la tabla 6 de https://developer.android.com/google/play/billing/billing_reference.html.

inAppDataSignature

string

Coincide con IN_APP_DATA_SIGNATURE con el método getPurchases() en la API de Facturación integrada en Play.

Dispositivo

Es la información sobre el dispositivo que el usuario usa para interactuar con la acción.

Representación JSON
{
  "location": {
    object (Location)
  }
}
Campos
location

object (Location)

Representa la ubicación real del dispositivo, como la latitud, la longitud y la dirección con formato. Requiere el permiso DEVICE_COARSE_LOCATION o DEVICE_PRECISE_LOCATION.

Superficie

Información específica de la plataforma cliente de Asistente de Google con la que el usuario está interactuando. Las superficies se distinguen de los dispositivos por el hecho de que pueden existir varias superficies del Asistente en el mismo dispositivo.

Representación JSON
{
  "capabilities": [
    {
      object (Capability)
    }
  ]
}
Campos
capabilities[]

object (Capability)

Una lista de las capacidades que la plataforma admite en el momento de la solicitud, p.ej., actions.capability.AUDIO_OUTPUT

Función

Representa una unidad de funcionalidad que la superficie puede admitir.

Representación JSON
{
  "name": string
}
Campos
name

string

El nombre de la función, p.ej., actions.capability.AUDIO_OUTPUT

Conversación

Representación JSON
{
  "conversationId": string,
  "type": enum (ConversationType),
  "conversationToken": string
}
Campos
conversationId

string

ID único para la conversación de varios turnos. Se asigna para el primer turno. Después de eso, se mantiene igual para los turnos de conversación posteriores hasta que esta finalice.

type

enum (ConversationType)

type indica el estado de la conversación en su ciclo de vida.

conversationToken

string

Token opaco especificado por la acción en el último turno de la conversación. Una acción puede usarla para hacer un seguimiento de la conversación o para almacenar datos relacionados.

Entrada

Representación JSON
{
  "rawInputs": [
    {
      object (RawInput)
    }
  ],
  "intent": string,
  "arguments": [
    {
      object (Argument)
    }
  ]
}
Campos
rawInputs[]

object (RawInput)

Transcripción de entrada sin procesar de cada turno de conversación. Es posible que se requiera varios turnos de conversación para que Actions on Google proporcione algunos tipos de entradas a la acción.

intent

string

Indica la intención del usuario. En el primer turno de la conversación, el intent se referirá al intent activador de la acción. Para los turnos de conversación posteriores, el intent será una acción común en el intent de Google (comienza con "acciones"). Por ejemplo, si la entrada esperada es actions.intent.OPTION, el intent especificado aquí será actions.intent.OPTION si Asistente de Google pudo satisfacer ese intent o actions.intent.TEXT si el usuario proporcionó otra información. Consulta https://developers.google.com/assistant/df-asdk/reference/intents.

arguments[]

object (Argument)

Una lista de valores de argumento proporcionados para la entrada que solicita la acción.

RawInput

Representación 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 cómo el usuario proporcionó esta entrada: una respuesta escrita, una respuesta de voz, sin especificar, etcétera.

Campo de unión input. El valor de entrada real input puede ser solo uno de los siguientes:
query

string

Entrada de voz o escrita del usuario final.

url

string

La URL de activación.