AppRequest

AppRequest est une requête envoyée par l'Assistant Google à un traitement afin d'interagir avec une action. La version de l'API est spécifiée dans l'en-tête HTTP. Pour l'API version 1, l'en-tête contient: Google-Assistant-API-Version: v1. Pour l'API version 2, l'en-tête contient: Google-actions-API-Version: 2. Pour voir comment cela est utilisé dans les actions Google, consultez la page https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json .

Représentation JSON
{
  "user": {
    object (User)
  },
  "device": {
    object (Device)
  },
  "surface": {
    object (Surface)
  },
  "conversation": {
    object (Conversation)
  },
  "inputs": [
    {
      object (Input)
    }
  ],
  "isInSandbox": boolean,
  "availableSurfaces": [
    {
      object (Surface)
    }
  ]
}
Champs
user

object (User)

Utilisateur ayant initié la conversation.

device

object (Device)

Informations sur l'appareil dont se sert l'utilisateur pour interagir avec l'action.

surface

object (Surface)

Informations sur la surface avec laquelle l'utilisateur interagit (par exemple, s'il peut diffuser du contenu audio ou disposer d'un écran).

conversation

object (Conversation)

Contient des données de session telles que l'ID de conversation et le jeton de conversation.

inputs[]

object (Input)

Liste des entrées correspondant aux entrées attendues spécifiées par l'action. Pour le déclencheur de conversation initial, l'entrée contient des informations sur la manière dont l'utilisateur a déclenché la conversation.

isInSandbox

boolean

Indique si la requête doit être gérée en mode bac à sable.

availableSurfaces[]

object (Surface)

Surfaces disponibles pour le transfert entre plusieurs surfaces.

Utilisateur

Représentation JSON
{
  "idToken": string,
  "profile": {
    object (UserProfile)
  },
  "accessToken": string,
  "permissions": [
    enum (Permission)
  ],
  "locale": string,
  "lastSeen": string,
  "userStorage": string,
  "packageEntitlements": [
    {
      object (PackageEntitlement)
    }
  ],
  "userVerificationStatus": enum (UserVerificationStatus)
}
Champs
idToken

string

représentant l'identité de l'utilisateur. Il s'agit d'un jeton Web JSON comprenant un profil encodé. La définition est disponible sur la page https://developers.google.com/identity/protocols/OpenIDConnect#obtainuserinfo.

profile

object (UserProfile)

Informations sur l'utilisateur final. Certains champs ne sont disponibles que si l'utilisateur a donné l'autorisation de fournir ces informations à l'action.

accessToken

string

Un jeton OAuth2 qui identifie l'utilisateur dans votre système. Uniquement disponible si l'utilisateur associe son compte.

permissions[]

enum (Permission)

Contient les autorisations accordées par l'utilisateur pour cette action.

locale

string

Paramètre régional principal de l'utilisateur à l'origine de la requête. Suit le code de langue IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt, mais le sous-tag du script n'est pas inclus.

lastSeen

string (Timestamp format)

Code temporel de la dernière interaction avec cet utilisateur. Ce champ est omis si l'utilisateur n'a jamais interagi avec l'agent.

Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : "2014-10-02T15:01:23.045123456Z"

userStorage

string

Jeton opaque fourni par l'application et conservé dans toutes les conversations d'un utilisateur particulier. La taille maximale de la chaîne est de 10 000 caractères.

packageEntitlements[]

object (PackageEntitlement)

Liste des droits d'accès des utilisateurs pour chaque nom de package répertorié dans le package d'actions, le cas échéant.

userVerificationStatus

enum (UserVerificationStatus)

Indique l'état de validation de l'utilisateur.

UserProfile

Contient les informations personnelles de l'utilisateur. Ces champs ne sont renseignés que si l'utilisateur accorde l'autorisation à l'action pour un champ particulier.

Représentation JSON
{
  "displayName": string,
  "givenName": string,
  "familyName": string
}
Champs
displayName

string

Nom complet de l'utilisateur (tel qu'indiqué dans son compte Google) Nécessite l'autorisation NAME.

givenName

string

Prénom de l'utilisateur tel qu'indiqué dans son compte Google Nécessite l'autorisation NAME.

familyName

string

Nom de l'utilisateur tel qu'il est indiqué dans son compte Google Notez que ce champ peut être vide. Nécessite l'autorisation NAME.

PackageEntitlement

Liste des droits associés à un nom de package

Représentation JSON
{
  "packageName": string,
  "entitlements": [
    {
      object (Entitlement)
    }
  ]
}
Champs
packageName

string

Doit correspondre au nom du package dans le package d'actions

entitlements[]

object (Entitlement)

Liste des droits d'accès d'une application donnée

Droit d'accès

Définit les droits d'accès numériques d'un utilisateur. Types de droits possibles: achats via une application, abonnements via une application.

Représentation JSON
{
  "sku": string,
  "skuType": enum (SkuType),
  "inAppDetails": {
    object (SignedData)
  }
}
Champs
sku

string

Code SKU Nom de package pour l'application payante, suffixe de Finsky pour les achats et abonnements via l'application. Faites correspondre getSku() dans l'API Play InApp Billing.

skuType

enum (SkuType)

inAppDetails

object (SignedData)

Disponible uniquement pour les achats via une application et les abonnements via l'application.

SignedData

Représentation JSON
{
  "inAppPurchaseData": {
    object
  },
  "inAppDataSignature": string
}
Champs
inAppPurchaseData

object (Struct format)

Faire correspondre les données INAPP_PURCHASE_DATA de la méthode getPurchases(). Contient toutes les données d'achat via une application au format JSON. Consultez les détails du tableau 6 sur https://developer.android.com/google/play/billing/billing_reference.html.

inAppDataSignature

string

Correspond à IN_APP_DATA_SIGNATURE de la méthode getPurchases() de l'API Play InApp Billing.

Appareil

Informations sur l'appareil dont se sert l'utilisateur pour interagir avec l'action.

Représentation JSON
{
  "location": {
    object (Location)
  }
}
Champs
location

object (Location)

Représente la position réelle de l'appareil (latitude, longitude, adresse formatée, etc.). Nécessite l'autorisation DEVICE_COARSE_LOCATION ou DEVICE_PRECISE_LOCATION.

Surface

Informations spécifiques à la surface client Assistant Google avec laquelle l'utilisateur interagit. Il se distingue d'un appareil par le fait que plusieurs surfaces de l'Assistant peuvent résider sur le même appareil.

Représentation JSON
{
  "capabilities": [
    {
      object (Capability)
    }
  ]
}
Champs
capabilities[]

object (Capability)

Liste des fonctionnalités prises en charge par la surface au moment de la requête, par exemple actions.capability.AUDIO_OUTPUT.

Capacité

Représente une unité de fonctionnalité que la surface peut prendre en charge.

Représentation JSON
{
  "name": string
}
Champs
name

string

Nom de la capacité, par exemple actions.capability.AUDIO_OUTPUT.

Conversation

Représentation JSON
{
  "conversationId": string,
  "type": enum (ConversationType),
  "conversationToken": string
}
Champs
conversationId

string

Identifiant unique de la conversation multitours. Il est attribué pour le premier tour. Elle reste ensuite identique jusqu'à la fin de la conversation.

type

enum (ConversationType)

indique l'état de la conversation dans son cycle de vie.

conversationToken

string

Jeton opaque spécifié par l'action dans le dernier tour de conversation. Elle peut être utilisée par une action pour suivre la conversation ou pour stocker des données liées à la conversation.

Entrée

Représentation JSON
{
  "rawInputs": [
    {
      object (RawInput)
    }
  ],
  "intent": string,
  "arguments": [
    {
      object (Argument)
    }
  ]
}
Champs
rawInputs[]

object (RawInput)

Transcription d'entrée brute pour chaque tour de conversation. Plusieurs tours de conversation peuvent être nécessaires pour que les actions Google fournissent certains types d'entrées à l'action.

intent

string

Indique l'intention de l'utilisateur. Pour le premier tour de conversation, l'intent fait référence à l'intent de déclenchement de l'action. Pour les conversations ultérieures, l'intent sera une action courante sur l'intent Google (commence par "actions"). Par exemple, si l'entrée attendue est actions.intent.OPTION, l'intent spécifié ici sera actions.intent.OPTION si l'Assistant Google a pu satisfaire cet intent, ou actions.intent.TEXT si l'utilisateur a fourni d'autres informations. Consultez la page https://developers.google.com/assistant/df-asdk/reference/intents.

arguments[]

object (Argument)

Liste des valeurs d'argument fournies pour l'entrée demandée par l'action.

RawInput

Représentation 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.
}
Champs
inputType

enum (InputType)

Indique comment l'utilisateur a fourni cette entrée: réponse saisie, réponse vocale, réponse non spécifiée, etc.

Champ d'union input. La valeur d'entrée réelle input ne peut être que l'une des suivantes:
query

string

Entrée saisie ou prononcée par l'utilisateur final

url

string

URL de déclenchement.