Les actions de conversation seront abandonnées le 13 juin 2023. Pour en savoir plus, consultez Abandon de la fonctionnalité Conversation.

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 la version 1 de l'API, l'en-tête contient le code suivant: Google-Assistant-API-Version: v1. Pour la version 2 de l'API, l'en-tête contient: Google-actions-API-Version: 2. Pour consulter des exemples d'utilisation avec les actions sur 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 qui a initié la conversation.
device

object (Device)

Informations sur l'appareil que l'utilisateur utilise pour interagir avec l'action.
surface

object (Surface)

Informations sur la surface avec laquelle l'utilisateur interagit (par exemple, pour indiquer si l'audio peut être diffusé ou s'il est équipé d'un écran)
conversation

object (Conversation)

Contient les données de session, telles que l'ID et le jeton de la conversation.
inputs[]

object (Input)

Liste des entrées correspondant aux entrées 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 traitée en mode bac à sable.
availableSurfaces[]

object (Surface)

Surfaces disponibles pour le transfert transversal.

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

Jeton représentant l'identité de l'utilisateur Il s'agit d'un jeton Web JSON qui inclut le profil encodé. La définition se trouve sur 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 autorisé l'action à fournir ces informations.
accessToken

string

Un jeton OAuth2 qui identifie l'utilisateur dans votre système. Disponible uniquement si l'utilisateur associe son compte.
permissions[]

enum (Permission)

Contient les autorisations accordées par l'utilisateur à 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.websearch-editor.org/websearch/bcp/bcp47.txt. Cependant, le sous-tag de script n'est pas inclus.
lastSeen

string (Timestamp format)

Horodatage de la dernière interaction de 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é d'une conversation à l'autre pour 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'action, le cas échéant.
userVerificationStatus

enum (UserVerificationStatus)

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

Profil utilisateur

Contient les informations personnelles de l'utilisateur. Les 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 indiqué dans son compte Google Nécessite l'autorisation NAME.
givenName

string

Prénom de l'utilisateur (tel que spécifié dans son compte Google) Nécessite l'autorisation NAME.
familyName

string

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

Droits d'accès au package

Liste des droits d'accès 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'action
entitlements[]

object (Entitlement)

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

Droits

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

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

string

SKU du produit. Nom du package pour l'application payante, suffixe de Finsky docid pour l'achat via l'application et l'abonnement via l'application. Correspondance de getSku() dans l'API Play InApp Billing.
skuType

enum (SkuType)
inAppDetails

object (SignedData)

Uniquement disponible pour les achats et les abonnements via une application.

Données signées

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

object (Struct format)

Faites correspondre les INAPP_PURCHASE_DATA à la méthode getPurchases(). Contient toutes les données relatives aux achats via une application au format JSON. Pour en savoir plus, consultez le tableau 6 de la page https://developer.android.com/google/play/billing/billing_reference.html.
inAppDataSignature

string

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

Type d'appareil

Informations sur l'appareil que l'utilisateur utilise pour interagir avec l'action.

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

object (Location)

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

Surface

Informations spécifiques à la surface cliente de l'Assistant Google avec laquelle l'utilisateur interagit. La surface se distingue de l'autre 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 compatibles avec la surface au moment de la requête, par exemple actions.capability.AUDIO_OUTPUT

Capacité

Représente une unité de fonctionnalité compatible avec la surface.

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

string

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

Conversation

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

string

ID unique de la conversation multitour Elle est attribuée au premier tour. Par la suite, elle reste la même pour les conversations suivantes jusqu'à la fin de la conversation.
type

enum (ConversationType)

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

string

Jeton opaque spécifié par l'action lors du dernier tour de conversation. Elle permet à une action de suivre la conversation ou de stocker des données associées.

Entrée

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

object (RawInput)

Transcription brute de l'entrée de chaque conversation. Plusieurs actions de conversation peuvent être nécessaires pour que les actions sur Google fournissent certains types de donné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 suivantes, il s'agit d'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 réussi à le satisfaire, 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.

Entrée brute

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 saisi cette entrée: réponse saisie, vocale, non spécifiée, etc.
Champ d'union input. La valeur d'entrée réelle input ne peut être que l'un des éléments suivants:
query

string

Saisie saisie ou vocale de l'utilisateur final
url

string

URL de déclenchement.