Method: fulfill

RPC, qui représente l'API de fulfillment

Requête HTTP

POST https://webhook_handler_service.googleapis.com/fulfill

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON
{
  "handler": {
    object (Handler)
  },
  "intent": {
    object (Intent)
  },
  "scene": {
    object (Scene)
  },
  "session": {
    object (Session)
  },
  "user": {
    object (User)
  },
  "home": {
    object (Home)
  },
  "device": {
    object (Device)
  },
  "context": {
    object (Context)
  }
}
Champs
handler

object (Handler)

Obligatoire. Informations au traitement sur la façon de traiter la requête. Par exemple, une requête destinée à obtenir un fait peut avoir un gestionnaire nommé "getFact".

intent

object (Intent)

Obligatoire. Représente le dernier intent mis en correspondance. Consultez la page https://developers.google.com/assistant/conversational/intents.

scene

object (Scene)

Facultatif. Informations sur la scène actuelle et la scène suivante lorsque la fonction a été appelée. Sera renseigné lorsque l'appel de fulfillment est effectué dans le cadre d'une scène. Consultez la page https://developers.google.com/assistant/conversational/scenes.

session

object (Session)

Obligatoire. Contient des données de session telles que l'identifiant et les paramètres de session.

user

object (User)

Obligatoire. Utilisateur ayant initié la conversation.

home

object (Home)

Facultatif. Informations liées à la structure HomeGraph à laquelle appartient l'appareil cible. Consultez la page https://developers.google.com/actions/smarthome/concepts/homegraph.

device

object (Device)

Obligatoire. Informations sur l'appareil avec lequel l'utilisateur interagit avec l'action.

context

object (Context)

Facultatif. Informations sur le contexte actuel de la demande. Inclut, mais sans s'y limiter, les informations de session multimédia active ou les informations de canevas.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représente une réponse envoyée à Actions on Google depuis le traitement d'un développeur.

Représentation JSON
{
  "prompt": {
    object (Prompt)
  },
  "scene": {
    object (Scene)
  },
  "session": {
    object (Session)
  },
  "user": {
    object (User)
  },
  "home": {
    object (Home)
  },
  "device": {
    object (Device)
  },
  "expected": {
    object (Expected)
  }
}
Champs
prompt

object (Prompt)

Facultatif. Représente les invites à envoyer à l'utilisateur. Ces invites seront ajoutées aux messages précédemment ajoutés, sauf si elles sont explicitement remplacées.

scene

object (Scene)

Facultatif. Représente la scène actuelle et la scène suivante. Si Scene.next est défini, l'environnement d'exécution passe immédiatement à la scène spécifiée.

session

object (Session)

Facultatif. Décrit les données de la session en cours. Les paramètres de session peuvent être créés, mis à jour ou supprimés par le fulfillment.

user

object (User)

Facultatif. Permet de spécifier les paramètres utilisateur à renvoyer.

home

object (Home)

Facultatif. Permet de spécifier les paramètres liés à la structure HomeGraph à laquelle appartient l'appareil cible. Consultez la page https://developers.google.com/actions/smarthome/concepts/homegraph.

device

object (Device)

Facultatif. Permet de se déplacer entre les appareils dotés de l'Assistant auxquels l'utilisateur a accès.

expected

object (Expected)

Facultatif. Décrit les attentes pour le prochain tour de dialogue.

Handler

Représente un gestionnaire de fulfillment qui mappe les informations d'événement d'Actions on Google au fulfillment. Utilisez le nom du gestionnaire pour déterminer le code à exécuter dans le fulfillment. Par exemple, un gestionnaire peut être utilisé pour obtenir des informations sur les commandes d'un utilisateur avec un nom de gestionnaire tel que "OrderLookup", tandis qu'un autre peut obtenir des informations produit à partir d'une base de données, avec un nom de gestionnaire comme "GetProductInfo".

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

string

Facultatif. Nom du gestionnaire.

Intention

Représente un intent. Consultez la page https://developers.google.com/assistant/conversational/intents.

Représentation JSON
{
  "name": string,
  "params": {
    string: {
      object (IntentParameterValue)
    },
    ...
  },
  "query": string
}
Champs
name

string

Obligatoire. Nom du dernier intent mis en correspondance.

params

map (key: string, value: object (IntentParameterValue))

Obligatoire. Représente les paramètres identifiés dans le cadre de la mise en correspondance des intents. Il s'agit d'un mappage du nom du paramètre identifié avec la valeur du paramètre identifié à partir de l'entrée utilisateur. Tous les paramètres définis dans l'intent correspondant qui sont identifiés sont affichés ici.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

query

string

Facultatif. Entrée saisie ou prononcée par l'utilisateur final correspondant à cet intent. Ce champ est renseigné lorsqu'un intent est mis en correspondance, en fonction de l'entrée utilisateur.

IntentParameterValue

Représente une valeur pour le paramètre d'intent. Consultez la page https://developers.google.com/assistant/conversational/types.

Représentation JSON
{
  "original": string,
  "resolved": value
}
Champs
original

string

Obligatoire. Valeur textuelle d'origine extraite de l'énoncé de l'utilisateur.

resolved

value (Value format)

Obligatoire. Valeur structurée du paramètre extrait de l'entrée utilisateur. Ce champ n'est renseigné que si le paramètre est défini dans l'intent correspondant et que sa valeur a pu être identifiée lors de la mise en correspondance de l'intent.

Scene

Représente une scène. Les scènes peuvent appeler le fulfillment, ajouter des invites et collecter des valeurs d'emplacement auprès de l'utilisateur. Les scènes sont déclenchées par des événements ou des intents, et peuvent déclencher des événements et faire correspondre des intents pour passer à d'autres scènes.

Représentation JSON
{
  "name": string,
  "slotFillingStatus": enum (SlotFillingStatus),
  "slots": {
    string: {
      object (Slot)
    },
    ...
  },
  "next": {
    object (NextScene)
  }
}
Champs
name

string

Obligatoire. Nom de la scène actuelle.

slotFillingStatus

enum (SlotFillingStatus)

Obligatoire. État actuel du remplissage d'emplacements. Ce champ est en lecture seule.

slots

map (key: string, value: object (Slot))

Emplacements associés à la scène actuelle. Les réponses du gestionnaire ne peuvent pas renvoyer d'emplacements qui n'ont pas été envoyés dans la requête.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

next

object (NextScene)

Facultatif. Informations sur la scène à exécuter ensuite.

SlotFillingStatus

Représente l'état actuel du remplissage d'emplacements.

Enums
UNSPECIFIED Valeur de remplacement lorsque le champ d'utilisation n'est pas renseigné.
INITIALIZED Les emplacements ont été initialisés, mais le remplissage d'emplacements n'a pas commencé.
COLLECTING Les valeurs des emplacements sont en cours de collecte.
FINAL Toutes les valeurs des emplacements sont définitives et ne peuvent pas être modifiées.

Encoche

Représente un emplacement.

Représentation JSON
{
  "mode": enum (SlotMode),
  "status": enum (SlotStatus),
  "value": value,
  "updated": boolean,
  "prompt": {
    object (Prompt)
  }
}
Champs
mode

enum (SlotMode)

Mode de l'emplacement (obligatoire ou facultatif). Peut être défini par le développeur.

status

enum (SlotStatus)

État de l'emplacement.

value

value (Value format)

Valeur de l'emplacement. La modification de cette valeur dans la réponse modifiera la valeur du remplissage d'emplacements.

updated

boolean

Indique si la valeur de la position a été collectée lors du dernier virage. Ce champ est en lecture seule.

prompt

object (Prompt)

Facultatif. Cette invite est envoyée à l'utilisateur si nécessaire pour remplir un emplacement requis. Cette invite remplace celle définie dans la console. Ce champ n'est pas inclus dans la requête de webhook.

SlotMode

Représente le mode d'un emplacement, c'est-à-dire s'il est obligatoire ou non.

Enums
MODE_UNSPECIFIED Valeur de remplacement lorsque le champ d'utilisation n'est pas renseigné.
OPTIONAL Indique que l'emplacement n'est pas nécessaire pour terminer le remplissage d'emplacements.
REQUIRED Indique que l'emplacement est requis pour terminer le remplissage d'emplacements.

SlotStatus

Représente l'état d'un emplacement.

Enums
SLOT_UNSPECIFIED Valeur de remplacement lorsque le champ d'utilisation n'est pas renseigné.
EMPTY Indique qu'aucune valeur n'est définie pour l'emplacement. Cet état ne peut pas être modifié via la réponse.
INVALID Indique que la valeur de l'emplacement n'est pas valide. Cet état peut être défini via la réponse.
FILLED Indique que l'emplacement a une valeur. Cet état ne peut pas être modifié via la réponse.

Requête

Représente une réponse à un utilisateur. Consultez la page https://developers.google.com/assistant/conversational/prompts.

Représentation JSON
{
  "override": boolean,
  "firstSimple": {
    object (Simple)
  },
  "content": {
    object (Content)
  },
  "lastSimple": {
    object (Simple)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (Link)
  },
  "canvas": {
    object (Canvas)
  },
  "orderUpdate": {
    object (OrderUpdate)
  }
}
Champs
override

boolean

Facultatif. Mode de fusion de ces messages avec les messages précédemment définis. "true" efface tous les messages précédemment définis (premier et dernier élément simple, contenu, lien et canevas de suggestions) et ajoute les messages définis dans cette invite. "false" ajoute les messages définis dans cette invite à ceux définis dans les réponses précédentes. Si vous laissez ce champ sur "false", vous pouvez également ajouter certains champs dans les invites simples, les invites de suggestions et l'invite Canvas (qui fait partie de l'invite de contenu). Les messages de contenu et de lien sont toujours remplacés s'ils sont définis dans l'invite. La valeur par défaut est "false".

firstSimple

object (Simple)

Facultatif. Première réponse vocale et textuelle.

content

object (Content)

Facultatif. Contenus (par exemple, une carte, une liste ou un contenu multimédia) à présenter à l'utilisateur.

lastSimple

object (Simple)

Facultatif. Dernière réponse vocale et textuelle.

suggestions[]

object (Suggestion)

Facultatif. Suggestions à présenter à l'utilisateur, qui apparaîtront toujours à la fin de la réponse. Si le champ "remplacer" est défini sur "false" dans la requête associée, les titres définis dans ce champ seront ajoutés à ceux définis dans les requêtes de suggestion précédemment définies, et les valeurs en double seront supprimées.

canvas

object (Canvas)

Facultatif. Représente une réponse Interactive Canvas à envoyer à l'utilisateur.

orderUpdate

object (OrderUpdate)

L'action facultative répond par un "OrderUpdate" après réception de la commande lors du flux de transactions. À réception de la commande, Google l'enregistre et, en cas de succès, affiche un reçu ainsi que la synthèse vocale envoyée sur les appareils d'affichage.

Simple

Représente une invite simple à envoyer à un utilisateur. Consultez la page https://developers.google.com/assistant/conversational/prompts-simple.

Représentation JSON
{
  "speech": string,
  "text": string
}
Champs
speech

string

Facultatif. Représente la voix à énoncer. Il peut s'agir d'un balisage SSML ou d'une synthèse vocale. Si le champ "remplacer" est défini sur "true" dans la requête associée, les voix définies dans ce champ remplacent celles de la requête simple précédente. Consultez la page https://developers.google.com/assistant/conversational/ssml.

text

string

Texte facultatif à afficher dans la bulle de chat. Si ce champ n'est pas spécifié, le rendu du champ de saisie vocale ci-dessus sera utilisé à l'écran. Limité à 640 caractères. Si le champ "remplacer" de la requête associée est défini sur "true", le texte défini dans ce champ remplace le texte de l'invite simple précédente.

Contenu

Objet conteneur pour les invites enrichies ou les invites de sélection.

Représentation JSON
{

  // Union field content can be only one of the following:
  "card": {
    object (Card)
  },
  "image": {
    object (Image)
  },
  "table": {
    object (Table)
  },
  "media": {
    object (Media)
  },
  "collection": {
    object (Collection)
  },
  "list": {
    object (List)
  },
  "collectionBrowse": {
    object (CollectionBrowse)
  }
  // End of list of possible types for union field content.
}
Champs

Champ d'union content.

content ne peut être qu'un des éléments suivants :

card

object (Card)

Une carte basique

image

object (Image)

Image.

table

object (Table)

Fiche tableau.

media

object (Media)

Réponse indiquant un ensemble de contenus multimédias à lire.

collection

object (Collection)

Fiche présentant un ensemble d'options à sélectionner.

list

object (List)

Fiche présentant une liste d'options à sélectionner.

collectionBrowse

object (CollectionBrowse)

Fiche présentant un ensemble de pages Web à ouvrir.

Fiche

Fiche de base permettant d'afficher certaines informations, par exemple une image et/ou du texte. Consultez la page https://developers.google.com/assistant/conversational/prompts-rich#basic_card.

Représentation JSON
{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (Image)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (Link)
  }
}
Champs
title

string

Titre général de la fiche. Facultatif.

subtitle

string

Facultatif.

text

string

Corps du texte de la fiche. Accepte un ensemble limité de syntaxes Markdown pour la mise en forme. Obligatoire, sauf si une image est présente.

image

object (Image)

Une hero image pour la fiche. La hauteur est fixée à 192 dp. Facultatif.

imageFill

enum (ImageFill)

Façon dont l'arrière-plan de l'image sera rempli. Facultatif.

button

object (Link)

Bouton avec un lien sortant. Facultatif.

Image

Image affichée dans la fiche. Consultez la page https://developers.google.com/assistant/conversational/prompts-rich#image-cards.

Représentation JSON
{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}
Champs
url

string

URL source de l'image. Les images peuvent être au format JPG, PNG et GIF (avec ou sans animation). Exemple : https://www.agentx.com/logo.png. Obligatoire.

alt

string

Description textuelle de l'image à utiliser pour l'accessibilité, par exemple les lecteurs d'écran. Obligatoire.

height

integer

Hauteur de l'image en pixels. Facultatif.

width

integer

Largeur de l'image en pixels. Facultatif.

ImageFill

Options d'affichage des images permettant d'affecter la présentation de l'image. Utilisez cette option lorsque le format de l'image ne correspond pas à celui du conteneur de l'image.

Enums
UNSPECIFIED
GRAY Complétez les intervalles entre l'image et son conteneur à l'aide de barres grises.
WHITE Remplissez les intervalles entre l'image et son conteneur à l'aide de barres blanches.
CROPPED L'image est mise à l'échelle de sorte que sa largeur et sa hauteur correspondent ou dépassent les dimensions du conteneur. Cette opération peut recadrer le haut et le bas de l'image si la hauteur de l'image mise à l'échelle est supérieure à la hauteur du conteneur, ou recadrer l'image à gauche et à droite si la largeur de l'image mise à l'échelle est supérieure à la largeur du conteneur. Ce mode est semblable au mode zoom sur un téléviseur grand écran lors de la lecture d'une vidéo 4:3.

OpenUrl

Représentation JSON
{
  "url": string,
  "hint": enum (UrlHint)
}
Champs
url

string

Champ d'URL, qui peut correspondre à: - URL http/https pour ouvrir une page Web ou une application associée à une application

hint

enum (UrlHint)

Indique une indication concernant le type d'URL.

UrlHint

Différents types de indications d'URL

Enums
AMP URL qui redirige directement vers le contenu AMP, ou vers une URL canonique qui renvoie à du contenu AMP via . Consultez https://amp.dev/.

Table

Fiche de tableau permettant d'afficher un tableau de texte. Consultez la page https://developers.google.com/assistant/conversational/prompts-rich#table_cards.

Représentation JSON
{
  "title": string,
  "subtitle": string,
  "image": {
    object (Image)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (Link)
  }
}
Champs
title

string

Titre général du tableau. Facultatif, mais doit être défini si "sous-titre" est défini.

subtitle

string

Sous-titre de la table. Facultatif.

image

object (Image)

Image associée au tableau. Facultatif.

columns[]

object (TableColumn)

En-têtes et alignement des colonnes.

rows[]

object (TableRow)

Données de ligne de la table. L'affichage des trois premières lignes est garanti, mais d'autres peuvent être coupées sur certaines surfaces. Effectuez un test avec le simulateur afin d'identifier les lignes qui seront affichées pour une surface donnée. Sur les surfaces compatibles avec la fonctionnalité WEB_browser, vous pouvez rediriger l'utilisateur vers une page Web contenant plus de données.

button

object (Link)

Bouton.

TableColumn

Représentation JSON
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
Champs
header

string

Texte de l'en-tête de la colonne.

align

enum (HorizontalAlignment)

Alignement horizontal du contenu par rapport à la colonne. Si aucune valeur n'est spécifiée, le contenu sera aligné sur le bord avant.

HorizontalAlignment

L'alignement du contenu dans la cellule.

Enums
UNSPECIFIED
LEADING Bord de début de la cellule. Il s'agit de la valeur par défaut.
CENTER Le contenu est aligné au centre de la colonne.
TRAILING Le contenu est aligné par rapport au bord de fin de la colonne.

TableRow

Décrit une ligne de la table.

Représentation JSON
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
Champs
cells[]

object (TableCell)

Cellules sur cette ligne. L'affichage des trois premières cellules est garanti, mais d'autres peuvent être coupées sur certaines surfaces. Effectuez un test avec le simulateur pour identifier les cellules qui seront affichées pour une surface donnée.

divider

boolean

Indique si un séparateur doit être présent après chaque ligne.

TableCell

Décrit une cellule dans une ligne.

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

string

Contenu textuel de la cellule.

Multimédia

Représente un objet multimédia. Contient des informations sur le contenu multimédia, telles que le nom, la description, l'URL, etc. Consultez la page https://developers.google.com/assistant/conversational/prompts-media.

Représentation JSON
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ],
  "repeatMode": enum (RepeatMode),
  "firstMediaObjectIndex": integer
}
Champs
mediaType

enum (MediaType)

startOffset

string (Duration format)

Décalage de début du premier objet multimédia.

Durée en secondes avec neuf chiffres au maximum après la virgule. Se termine par "s". Example : "3.5s".

optionalMediaControls[]

enum (OptionalMediaControls)

Types de commandes multimédias facultatifs compatibles avec cette session de réponse multimédia. Si cette règle est définie, la demande sera envoyée aux 3p lorsqu'un événement multimédia spécifique se produit. Si cette règle n'est pas configurée, 3p doit tout de même gérer deux types de contrôle par défaut : FINISHED (Terminé) et FAILED (ÉCHEC).

mediaObjects[]

object (MediaObject)

Liste des objets Media

repeatMode

enum (RepeatMode)

Mode de répétition pour la liste des objets Media.

firstMediaObjectIndex

integer

Index de base 0 du premier objet Media à lire dans mediaObjects. Si aucune valeur n'est spécifiée, si elle est nulle ou hors limites, la lecture commence au niveau du premier objet multimédia dans mediaObjects.

MediaType

Type de contenu de cette réponse.

Enums
MEDIA_TYPE_UNSPECIFIED
AUDIO Fichier audio.
MEDIA_STATUS_ACK Réponse pour confirmer la réception d'un rapport sur l'état du média

OptionalMediaControls

Types de commandes multimédias facultatifs compatibles avec la réponse multimédia

Enums
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED Valeur non spécifiée
PAUSED Événement mis en pause. Déclenchement lorsque l'utilisateur met le contenu multimédia en pause.
STOPPED Événement arrêté. Déclenché lorsque l'utilisateur quitte la session tierce pendant la lecture d'un contenu multimédia.

MediaObject

Représente un seul objet multimédia

Représentation JSON
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
Champs
name

string

Nom de cet objet multimédia.

description

string

Description de cet objet multimédia.

url

string

URL pointant vers le contenu multimédia. Les fichiers MP3 doivent être hébergés sur un serveur Web et être accessibles au public via une URL HTTPS. La diffusion en direct n'est compatible qu'avec le format MP3.

image

object (MediaImage)

Image à afficher avec la fiche multimédia.

MediaImage

Représentation JSON
{

  // Union field image can be only one of the following:
  "large": {
    object (Image)
  },
  "icon": {
    object (Image)
  }
  // End of list of possible types for union field image.
}
Champs

Champ d'union image.

image ne peut être qu'un des éléments suivants :

large

object (Image)

Une grande image, comme la couverture de l'album, etc.

icon

object (Image)

Une petite icône d'image affichée à droite du titre Elle est redimensionnée au format 36 x 36 dp.

RepeatMode

Types de mode de répétition pour une liste d'objets multimédias.

Enums
REPEAT_MODE_UNSPECIFIED Équivaut à l'état "Désactivé".
OFF Terminer la session multimédia à la fin du dernier objet multimédia.
ALL Lire en boucle le début du premier objet multimédia lorsque la fin du dernier objet multimédia est atteinte.

Collection

Fiche présentant un ensemble d'options à sélectionner. Consultez la page https://developers.google.com/assistant/conversational/prompts-selection#collection.

Représentation JSON
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
Champs
title

string

Titre de la collection. Facultatif.

subtitle

string

Sous-titre de la collection. Facultatif.

items[]

object (CollectionItem)

Une liste d'éléments La valeur peut être de 2 (minimum) et de 10 (maximum).

imageFill

enum (ImageFill)

Mode de remplissage des arrière-plans des images des éléments de la collection. Facultatif.

CollectionItem

Un élément de la collection

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

string

Obligatoire. Clé NLU correspondant au nom de clé d'entrée dans le type associé.

Liste

Fiche présentant une liste d'options à sélectionner. Consultez la page https://developers.google.com/assistant/conversational/prompts-selection#list.

Représentation JSON
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
Champs
title

string

Titre de la liste. Facultatif.

subtitle

string

Sous-titre de la liste. Facultatif.

items[]

object (ListItem)

Une liste d'éléments La valeur peut être de 2 (minimum) et de 30 (maximum).

ListItem

Un élément de la liste

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

string

Obligatoire. Clé NLU correspondant au nom de clé d'entrée dans le type associé.

CollectionBrowse

Présente un ensemble de documents Web sous la forme d'une collection d'éléments de grande taille. Vous pouvez sélectionner des éléments pour lancer leur document Web associé dans un lecteur Web. Consultez la page https://developers.google.com/assistant/conversational/prompts-selection#collectionBrowse.

Représentation JSON
{
  "items": [
    {
      object (Item)
    }
  ],
  "imageFill": enum (ImageFill)
}
Champs
items[]

object (Item)

Une liste d'éléments La valeur peut être de 2 (minimum) et de 10 (maximum).

imageFill

enum (ImageFill)

Type d'option d'affichage d'image.

Article

Élément de la collection.

Représentation JSON
{
  "title": string,
  "description": string,
  "footer": string,
  "image": {
    object (Image)
  },
  "openUriAction": {
    object (OpenUrl)
  }
}
Champs
title

string

Obligatoire. Titre de l'élément de la collection.

description

string

Description de l'élément de la collection.

footer

string

Texte de pied de page de l'article de collection affiché sous la description. Une seule ligne de texte, tronquée par des points de suspension

image

object (Image)

Image de l'élément de la collection.

openUriAction

object (OpenUrl)

Obligatoire. URI à ouvrir si l'élément est sélectionné.

Suggestion

Les suggestions fournissent des chips de suggestion aux utilisateurs d'appareils compatibles avec l'affichage lorsque l'Assistant affiche l'invite. Utilisez les chips de suggestion pour donner des indications aux réponses des utilisateurs afin de poursuivre la conversation ou de la faire pivoter. Lorsque l'utilisateur appuie dessus, un chip de suggestion renvoie le texte affiché dans la conversation telle quelle, comme si l'utilisateur l'avait saisi. Consultez la page https://developers.google.com/assistant/conversational/prompts#suggestions.

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

string

Obligatoire. Texte affiché dans le chip de suggestion. Lorsque l'utilisateur appuie dessus, ce texte est republié dans la conversation, comme si l'utilisateur l'avait saisi. Chaque titre doit être unique parmi les chips de suggestion. 25 caractères max.

Canevas

Représente une réponse Interactive Canvas à envoyer à l'utilisateur. Vous pouvez l'utiliser avec le champ "firstSimple" de l'invite associée pour communiquer avec l'utilisateur en plus d'afficher une réponse de canevas interactive. La taille maximale de la réponse est de 50 000 octets. Consultez la page https://developers.google.com/assistant/interactivecanvas.

Représentation JSON
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "continuousMatchConfig": {
    object (ContinuousMatchConfig)
  }
}
Champs
url

string

URL de l'application Web de canevas interactif à charger. Si cette règle n'est pas configurée, l'URL du canevas actif actuel sera réutilisée.

data[]

value (Value format)

Facultatif. Données JSON à transmettre à la page Web de l'expérience immersive en tant qu'événement. Si le champ "remplacer" dans l'invite associée est défini sur "false", les valeurs de données définies dans cette invite Canvas seront ajoutées après les valeurs de données définies dans les invites Canvas précédentes.

suppressMic

boolean

Facultatif. Valeur par défaut : "false".

continuousMatchConfig

object (ContinuousMatchConfig)

Configuration utilisée pour lancer le mode de correspondance continue.

ContinuousMatchConfig

Configuration utilisée pour lancer le mode de correspondance continue.

Représentation JSON
{
  "expectedPhrases": [
    {
      object (ExpectedPhrase)
    }
  ],
  "durationSeconds": integer
}
Champs
expectedPhrases[]

object (ExpectedPhrase)

Toutes les expressions attendues possibles pendant cette session en mode correspondance continue.

durationSeconds

integer

Durée d'activation du mode Correspondance continue. Si spécifié, le micro sera désactivé une fois le temps écoulé. La valeur maximale autorisée est de 180.

ExpectedPhrase

Représentation JSON
{
  "phrase": string,
  "alternativePhrases": [
    string
  ]
}
Champs
phrase

string

Expression à rechercher lors de la session en mode correspondance continue.

alternativePhrases[]

string

Certaines expressions peuvent être mal reconnues par le modèle de reconnaissance vocale, même avec la pondération de la voix. Cela permet aux développeurs de spécifier d'autres déclencheurs pour les homophones.

OrderUpdate

Mettre à jour une commande

Représentation JSON
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
Champs
type
(deprecated)

enum (Type)

Obsolète. Utilisez plutôt OrderUpdate.update_mask. Si le type est = SNAPSHOT, OrderUpdate.order doit correspondre à l'intégralité de la commande. Si le type est = ORDER_STATUS, il s'agit de la modification de l'état au niveau de la commande. Seuls order.last_update_time et cet état de secteur sont récupérés. Remarque: type.ORDER_STATUS n'est compatible qu'avec les mises à jour de l'état de PurcahaseOrderExtension et il n'est pas prévu d'étendre cette compatibilité. Nous vous recommandons plutôt d'utiliser updateMask, car il est plus générique, extensible et peut être utilisé pour tous les secteurs.

order

object (Order)

updateMask

string (FieldMask format)

Remarque: Nous tenons compte des éléments suivants (et recommandations) concernant les champs spéciaux suivants: 1. La valeur order.last_update_time sera toujours mise à jour dans le cadre de la demande de mise à jour. 2. Les champs order.create_time, order.google_order_id et order.merchant_order_id seront ignorés si vous les renseignez dans le champ updateMask.

Il s'agit d'une liste de noms complets de champs séparés par une virgule. Exemple : "user.displayName,photo"

userNotification

object (UserNotification)

Si spécifié, affiche une notification à l'utilisateur avec le titre et le texte spécifiés. La spécification d'une notification est une suggestion d'envoi de notification. Il n'est pas garanti qu'une notification aboutisse.

reason

string

Motif de la modification/mise à jour.

Type

Obsolète. Utilisez plutôt OrderUpdate.update_mask. A autorisé les mises à jour d'une commande.

Enums
TYPE_UNSPECIFIED Type non spécifié, ne doit pas être défini explicitement.
ORDER_STATUS Ne met à jour que l'état de la commande.
SNAPSHOT Mettre à jour l'instantané de la commande.

Commande

Entité Order. Remarque: 1. Sauf indication contraire, toutes les chaînes, à tous les niveaux, doivent comporter moins de 1 000 caractères. 2. Sauf indication contraire, le nombre de champs répétés, quel que soit le niveau, doit être inférieur à 50. 3. S'ils sont spécifiés, tous les codes temporels de tous les niveaux doivent être valides.

Représentation JSON
{
  "googleOrderId": string,
  "merchantOrderId": string,
  "userVisibleOrderId": string,
  "userVisibleStateLabel": string,
  "buyerInfo": {
    object (UserInfo)
  },
  "image": {
    object (Image)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "transactionMerchant": {
    object (Merchant)
  },
  "contents": {
    object (Contents)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "paymentData": {
    object (PaymentData)
  },
  "termsOfServiceUrl": string,
  "note": string,
  "promotions": [
    {
      object (Promotion)
    }
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseOrderExtension)
  },
  "ticket": {
    object (TicketOrderExtension)
  }
  // End of list of possible types for union field verticals.
}
Champs
googleOrderId

string

ID de commande attribué par Google.

merchantOrderId

string

Obligatoire: ID de commande interne attribué au marchand. Cet identifiant doit être unique et est obligatoire pour toute opération ultérieure de mise à jour des commandes. Cet ID peut être défini sur la valeur googleOrderId fournie ou sur toute autre valeur unique. Notez que l'ID présenté aux utilisateurs correspond à userVisibleOrderId, qui peut être une valeur différente et plus conviviale. La longueur maximale autorisée est de 128 caractères.

userVisibleOrderId

string

Identifiant visible par l'utilisateur faisant référence à la commande en cours. Cet identifiant doit correspondre à celui affiché pour cette commande dans d'autres contextes, y compris sur les sites Web, les applications et les e-mails.

userVisibleStateLabel
(deprecated)

string

Obsolète: utilisez plutôt l'état OrderExtensions. Libellé visible par l'utilisateur pour l'état de cette commande.

buyerInfo

object (UserInfo)

Des informations sur l'acheteur.

image

object (Image)

Image associée à la commande.

createTime

string (Timestamp format)

Obligatoire: date et heure de création de la commande.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

lastUpdateTime

string (Timestamp format)

Date et heure de la dernière mise à jour de la commande. Obligatoire pour OrderUpdate.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

transactionMerchant

object (Merchant)

Marchand ayant facilité le règlement. Il peut s'agir d'un fournisseur au niveau de l'élément de campagne. Exemple: Commande Expedia avec un élément de campagne d'ANA.

contents

object (Contents)

Obligatoire: contenu de la commande, qui correspond à un groupe d'articles.

priceAttributes[]

object (PriceAttribute)

Prix, remises, taxes, etc.

followUpActions[]

object (Action)

Actions de suivi au niveau de la commande

paymentData

object (PaymentData)

Données de paiement pour la commande.

termsOfServiceUrl

string

Lien vers les conditions d'utilisation qui s'appliquent à la commande/commande proposée.

note

string

Notes associées à une commande.

promotions[]

object (Promotion)

Toutes les promotions associées à cette commande.

disclosures[]

object (Disclosure)

Divulgations associées à cette ordonnance.

vertical
(deprecated)

object

Obsolète: utilisez plutôt des secteurs. Ces propriétés s'appliqueront à tous les éléments de campagne, sauf si vous les remplacez dans certains d'entre eux. Ce secteur doit correspondre au type de secteur au niveau de l'élément de campagne. Valeurs possibles: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

Champ d'union verticals. Ces propriétés s'appliqueront à tous les éléments de campagne, sauf si vous les remplacez dans certains d'entre eux. Ce secteur doit correspondre au type de secteur au niveau de l'élément de campagne. verticals ne peut être qu'un des éléments suivants :
purchase

object (PurchaseOrderExtension)

Bon de commande

ticket

object (TicketOrderExtension)

Commande de billets

UserInfo

Informations sur l'utilisateur. Il est utilisé pour représenter les informations de l'utilisateur associé à une commande.

Représentation JSON
{
  "email": string,
  "firstName": string,
  "lastName": string,
  "displayName": string,
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ]
}
Champs
email

string

Adresse e-mail de l'utilisateur. Par exemple: janedoe@gmail.com.

firstName

string

Prénom de l'utilisateur.

lastName

string

Nom de l'utilisateur.

displayName

string

Le nom à afficher de l'utilisateur peut être différent du prénom ou du nom.

phoneNumbers[]

object (PhoneNumber)

Numéros de téléphone de l'utilisateur.

PhoneNumber

Représentation standard du numéro de téléphone.

Représentation JSON
{
  "e164PhoneNumber": string,
  "extension": string,
  "preferredDomesticCarrierCode": string
}
Champs
e164PhoneNumber

string

Numéro de téléphone au format E.164, tel que défini dans la recommandation E.164 de l'Union internationale des télécommunications (UIT). Lien wiki: https://en.wikipedia.org/wiki/E.164

extension

string

L'extension n'est pas standardisée dans les recommandations de l'UIT, sauf qu'elle est définie comme une série de numéros d'une longueur maximale de 40 chiffres. Il est défini ici comme une chaîne pour permettre l'utilisation possible d'un zéro devant dans l'extension (les organisations sont libres de le faire, car il n'y a pas de norme définie). À l'exception des chiffres, d'autres caractères de numérotation tels que "," (indiquant une attente) peuvent être stockés ici. Par exemple, au poste 123 xxx-xxx-xxxx, "123" correspond au numéro de poste.

preferredDomesticCarrierCode

string

Code de sélection de l'opérateur à privilégier pour appeler ce numéro de téléphone dans votre pays Cela comprend également les indicatifs qui doivent être composés dans certains pays pour les appels depuis une ligne fixe vers un mobile, et inversement. Par exemple, en Colombie, un "3" doit être composé avant le numéro de téléphone lui-même lorsque vous passez un appel d'un mobile vers un téléphone fixe national, et inversement. https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia https://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code

Notez qu'il s'agit du code "préféré", ce qui signifie que d'autres codes peuvent également fonctionner.

Image

Image affichée dans la fiche.

Représentation JSON
{
  "url": string,
  "accessibilityText": string,
  "height": integer,
  "width": integer
}
Champs
url

string

URL source de l'image. Les images peuvent être au format JPG, PNG et GIF (avec ou sans animation). Exemple : https://www.agentx.com/logo.png. Obligatoire.

accessibilityText

string

Description textuelle de l'image à utiliser pour l'accessibilité, par exemple les lecteurs d'écran. Obligatoire.

height

integer

Hauteur de l'image en pixels. Facultatif.

width

integer

Largeur de l'image en pixels. Facultatif.

Marchand

Marchand pour le panier/la commande/l'article.

Représentation JSON
{
  "id": string,
  "name": string,
  "image": {
    object (Image)
  },
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "address": {
    object (Location)
  }
}
Champs
id

string

Identifiant facultatif attribué au marchand, le cas échéant.

name

string

Nom du marchand, par exemple "Pain Panera".

image

object (Image)

Image associée au marchand.

phoneNumbers[]

object (PhoneNumber)

Numéros de téléphone du marchand.

address

object (Location)

Adresse du marchand.

Emplacement

Conteneur représentant un emplacement.

Représentation JSON
{
  "coordinates": {
    object (LatLng)
  },
  "formattedAddress": string,
  "zipCode": string,
  "city": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "name": string,
  "phoneNumber": string,
  "notes": string,
  "placeId": string
}
Champs
coordinates

object (LatLng)

Coordonnées géographiques. Nécessite l'autorisation [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

formattedAddress

string

Adresse à afficher, par exemple "1600 Amphitheatre Pkwy, Mountain View, CA 94043". Nécessite l'autorisation [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

zipCode

string

Code postal. Nécessite l'autorisation [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] ou [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

city

string

Ville. Nécessite l'autorisation [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] ou [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

postalAddress

object (PostalAddress)

Adresse postale. Nécessite l'autorisation [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] ou [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

name

string

Nom du lieu.

phoneNumber

string

Numéro de téléphone de l'établissement (par exemple, le numéro de téléphone de l'établissement ou du lieu de livraison).

notes

string

Notes sur le lieu.

placeId

string

placeId est utilisé avec l'API Places pour récupérer les détails d'un lieu. Consultez la page https://developers.google.com/places/web-service/place-id.

LatLng

Objet représentant une paire latitude/longitude. Cette valeur est exprimée par deux valeurs doubles représentant les degrés de latitude et de longitude. Sauf indication contraire, cet objet doit être conforme à la norme WGS84. Les valeurs doivent se situer dans les limites normalisées.

Représentation JSON
{
  "latitude": number,
  "longitude": number
}
Champs
latitude

number

Latitude en degrés. Elle doit être comprise dans la plage [-90.0, +90.0].

longitude

number

Longitude en degrés. Elle doit être comprise dans la plage [-180.0, +180.0].

PostalAddress

Représente une adresse postale, telles que des adresses de livraison ou de paiement. Les services postaux peuvent effectuer une livraison à cette adresse, boîte postale ou autre. Ce champ n'a pas vocation à modéliser des emplacements géographiques (routes, villes ou montagnes).

Généralement, une adresse est créée via une saisie utilisateur ou lors de l'importation de données existantes, en fonction du type de processus.

Conseils pour la saisie / modification d'adresse : utilisez un widget d'adresse compatible i18n tel que https://github.com/google/libaddressinput. Les utilisateurs ne doivent pas voir les éléments d'interface utilisateur permettant de saisir ou de modifier des champs en dehors des pays où ce champ est utilisé.

Pour en savoir plus sur l'utilisation de ce schéma, consultez la page https://support.google.com/business/answer/6397478.

Représentation JSON
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Champs
revision

integer

Révision du schéma de PostalAddress. Il doit être défini sur 0, à savoir la dernière révision.

Toutes les nouvelles révisions doivent être rétrocompatibles avec les anciennes révisions.

regionCode

string

Obligatoire. Code pays/région CLDR de l'adresse. Il n'est jamais déduit, et il revient à l'utilisateur de s'assurer que la valeur est correcte. Pour en savoir plus, consultez les pages http://cldr.unicode.org/ et http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Exemple : "CH" pour la Suisse.

languageCode

string

Facultatif. Code de langue BCP-47 du contenu de cette adresse (s'il est connu). Il s'agit souvent de la langue d'UI du formulaire de saisie. Sinon, il doit correspondre à l'une des langues utilisées dans le pays/la région mentionnés dans l'adresse ou leurs équivalents translittérés. Ce champ peut modifier la mise en forme dans certains pays, mais cela ne risque pas de nuire à l'exactitude des données et n'affectera jamais aucune validation ni aucune opération ne concernant pas la mise en forme.

Si cette valeur est inconnue, vous devez l'omettre (plutôt que de spécifier une valeur par défaut éventuellement incorrecte).

Exemples : "zh-Hant", "ja", "ja-Latn" et "en".

postalCode

string

Facultatif. Code postal de l'adresse. Tous les pays n'utilisent pas ou n'exigent pas de codes postaux, mais lorsqu'ils s'en servent, ils peuvent déclencher une validation supplémentaire avec d'autres parties de l'adresse (par exemple, validation par État/code postal aux États-Unis).

sortingCode

string

Facultatif. Code de tri supplémentaire, spécifique à chaque pays. La plupart des régions ne s'en servent pas. Lorsqu'il est utilisé, sa valeur comprend une chaîne de type CEDEX, éventuellement suivie d'un numéro (par exemple CEDEX 7), ou tout simplement un nombre représentant un "code de secteur" (Jamaïque), un "indicateur de zone de livraison" (Malawi) ou un "indicateur postal" (Côte d'Ivoire, par exemple).

administrativeArea

string

Facultatif. Plus haute subdivision administrative utilisée pour les adresses postales d'un pays ou d'une région. Par exemple, il peut s'agir d'un État, d'une province, d'un oblast ou d'une préfecture. Plus précisément, pour l'Espagne, il s'agit de la province et non de la communauté autonome (par exemple, "Barcelone" et non "Catalogne"). De nombreux pays n'utilisent pas de région administrative dans leurs adresses postales. Par exemple, ce champ doit rester vide en Suisse.

locality

string

Facultatif. Fait généralement référence à la ville de l'adresse. Exemples : une "city" aux États-Unis, une "comune" en Italie, une "post town" au Royaume-Uni. Dans les régions du monde où les localités ne sont pas bien définies ou ne s'intègrent pas bien dans cette structure, laissez le champ de localité vide et utilisez addressLines.

sublocality

string

Facultatif. Sous-localité de l'adresse. Il peut s'agir, par exemple, de quartiers, d'arrondissements ou de districts.

addressLines[]

string

Lignes d'adresse non structurées décrivant les niveaux inférieurs d'une adresse.

Étant donné que les valeurs dans "addressLines" ne contiennent pas d'informations de type et peuvent parfois comprendre plusieurs valeurs dans un seul champ (par exemple, "Austin, TX"), il est important que l'ordre des lignes soit bien clair. L'ordre des lignes d'adresse doit correspondre à l'ordre suivi sur les enveloppes pour le pays/la région de l'adresse. Dans les pays où cet ordre peut varier (par exemple, au Japon), "address_language" est utilisé pour le rendre explicite (par exemple, "ja" pour un ordre décroissant et "ja-Latn" ou "en" pour un ordre croissant). De cette façon, la ligne la plus spécifique d'une adresse peut être sélectionnée en fonction de la langue.

La représentation structurelle minimale autorisée d'une adresse consiste en un code "regionCode" avec toutes les informations restantes placées dans les lignes "adresseLines". Il serait possible de mettre en forme une telle adresse de manière très approximative sans géocodage, mais aucun raisonnement sémantique ne pourrait être réalisé quant à l'un des composants d'adresse avant qu'il n'ait été au moins partiellement résolu.

La création d'une adresse contenant uniquement un code "regionCode" et des lignes "addressLines" suivi d'un géocodage est la méthode recommandée pour gérer les adresses complètement déstructurées (plutôt que de deviner quelles parties de l'adresse sont des localités ou des régions administratives).

recipients[]

string

Facultatif. Destinataire. Ce champ peut, dans certaines circonstances, contenir des informations multilignes. Par exemple, il peut comporter la ligne "chez".

organization

string

Facultatif. Nom de l'entreprise.

Sommaire

Enveloppe pour les éléments de campagne.

Représentation JSON
{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}
Champs
lineItems[]

object (LineItem)

Liste des éléments de campagne. Vous devez spécifier au moins un élément (50 au maximum). Tous les éléments de campagne doivent appartenir au même secteur.

LineItem

Un élément de campagne contient un secteur. Une commande ou un panier peut comporter plusieurs articles associés au même secteur. Les éléments de sous-ligne, les modules complémentaires, etc. doivent être définis dans des fichiers proto verticaux en fonction de leurs cas d'utilisation. Remarque: 1. Sauf indication contraire, toutes les chaînes, à tous les niveaux, doivent comporter moins de 1 000 caractères. 2. Sauf indication contraire, le nombre de champs répétés, quel que soit le niveau, doit être inférieur à 50. 3. S'ils sont spécifiés, tous les codes temporels de tous les niveaux doivent être valides.

Représentation JSON
{
  "id": string,
  "name": string,
  "userVisibleStateLabel": string,
  "provider": {
    object (Merchant)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "recipients": [
    {
      object (UserInfo)
    }
  ],
  "image": {
    object (Image)
  },
  "description": string,
  "notes": [
    string
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseItemExtension)
  },
  "reservation": {
    object (ReservationItemExtension)
  }
  // End of list of possible types for union field verticals.
}
Champs
id

string

Obligatoire: identifiant attribué par le marchand pour l'article. Permet d'identifier un élément de campagne existant dans les mises à jour partielles. La longueur maximale autorisée est de 64 caractères.

name

string

Nom de l'élément de ligne, tel qu'il apparaît sur le reçu. La longueur maximale autorisée est de 100 caractères.

userVisibleStateLabel
(deprecated)

string

Obsolète. Utilisez plutôt l'état au niveau du secteur. Par exemple, pour les achats, utilisez purchaseOrderExtension.status. Libellé visible par l'utilisateur pour l'état de cet élément de campagne.

provider

object (Merchant)

Fournisseur de l'élément de campagne concerné, s'il est différent de la campagne globale. Exemple: Commande Expedia avec le fournisseur d'éléments de campagne ANA.

priceAttributes[]

object (PriceAttribute)

Prix et ajustements au niveau de l'élément de campagne.

followUpActions[]

object (Action)

Actions de suivi au niveau de l'élément de campagne.

recipients[]

object (UserInfo)

Clients au niveau de l'élément de campagne. Ce champ peut être différent de celui de l'acheteur au niveau de la commande. Exemple: L'utilisateur X a réservé un restaurant sous le nom de l'utilisateur Y.

image

object (Image)

Petite image associée à cet élément, le cas échéant.

description

string

Description de l'élément de campagne.

notes[]

string

Remarques supplémentaires applicables à cet article particulier, par exemple les modalités d'annulation.

disclosures[]

object (Disclosure)

Divulgations associées à cet élément de campagne.

vertical
(deprecated)

object

Obsolète: utilisez plutôt des secteurs. Obligatoire: contenu sémantique de l'élément de campagne en fonction de son type/secteur. Chaque secteur doit inclure ses propres informations de traitement. Doit correspondre à l'une des valeurs suivantes: google.actions.orders.v3.verticals.purchase.PurchaseItemExtension google.actions.orders.v3.verticals.reservation.ReservationItemExtension google.actions.orders.v3.verticals.ticket.TicketItemExtension

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

Champ d'union verticals. Obligatoire: contenu sémantique de l'élément de campagne en fonction de son type/secteur. Chaque secteur doit inclure ses propres informations de traitement. verticals ne peut être qu'un des éléments suivants :
purchase

object (PurchaseItemExtension)

Bons de commande, tels que des marchandises, de la nourriture, etc.

reservation

object (ReservationItemExtension)

Commandes de réservation (restaurant, salon de coiffure, etc.)

PriceAttribute

Attribut prix d'une commande ou d'un article.

Représentation JSON
{
  "type": enum (Type),
  "name": string,
  "id": string,
  "state": enum (State),
  "taxIncluded": boolean,

  // Union field spec can be only one of the following:
  "amount": {
    object (Money)
  },
  "amountMillipercentage": integer
  // End of list of possible types for union field spec.
}
Champs
type

enum (Type)

Obligatoire: attribut de type d'argent.

name

string

Obligatoire: l'utilisateur a affiché la chaîne de l'attribut prix. Ce nom est envoyé et localisé par le marchand.

id

string

Facultatif: identifiant de la ligne à laquelle ce prix correspond.

state

enum (State)

Obligatoire: état des prix: estimation ou valeur réelle.

taxIncluded

boolean

Indique si les taxes sont incluses dans le prix.

Champ d'union spec. Représente la valeur monétaire ou le pourcentage en millièmes. spec ne peut être qu'un des éléments suivants :
amount

object (Money)

Montant monétaire.

amountMillipercentage
(deprecated)

integer

Spécification du pourcentage, jusqu'à 1/1 000e de pourcentage. Exemple : "8, 750 %" correspond à 8 750.Les pourcentages négatifs représentent les pourcentages de remise. Abandon de ce champ. Envisagez de l'ajouter à nouveau lorsqu'un cas d'utilisation solide est requis.

Type

Représente le type de valeur monétaire.

Enums
TYPE_UNSPECIFIED Le type n'est pas spécifié. Les clients ne devraient pas avoir à le définir explicitement.
REGULAR Prix d'affichage standard, avant application des éventuelles remises, etc.
DISCOUNT À soustraire du sous-total.
TAX À ajouter au sous-total.
DELIVERY À ajouter au sous-total.
SUBTOTAL Sous-total avant l'ajout de frais.
FEE Tous les Frais supplémentaires.
GRATUITY À ajouter au sous-total.
TOTAL Prix affiché de la commande ou de l'élément de campagne.

État

Représente l'état du prix.

Enums
STATE_UNSPECIFIED Non spécifié.
ESTIMATE Il ne s'agit que d'une estimation, mais le montant final se rapproche de ce montant. Exemple: Si la taxe n'est pas connue avec précision au moment de la transaction, le montant total est d'ESTIMATION.
ACTUAL Prix réel qui sera facturé pour l'utilisateur.

Monnaie

Représente un montant associé à un type de devise.

Représentation JSON
{
  "currencyCode": string,
  "amountInMicros": string
}
Champs
currencyCode

string

Code de devise à trois lettres défini par la norme ISO 4217.

amountInMicros

string (int64 format)

Montant en micros. Par exemple, ce champ doit être défini sur 1990000 pour 1,99 $.

Action

Action de suivi associée à la campagne ou à l'élément de campagne.

Représentation JSON
{
  "type": enum (Type),
  "title": string,
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "actionMetadata": {
    object (ActionMetadata)
  }
}
Champs
type

enum (Type)

Obligatoire: type d'action.

title

string

Titre ou libellé de l'action, présenté à l'utilisateur. La longueur maximale autorisée est de 100 caractères.

openUrlAction

object (OpenUrlAction)

Action à effectuer.

actionMetadata

object (ActionMetadata)

Métadonnées associées à une action.

Type

Actions de suivi possibles

Enums
TYPE_UNSPECIFIED Action non spécifiée.
VIEW_DETAILS Afficher les détails de la commande.
MODIFY Modifier l'action de commande.
CANCEL Annuler l'action de commande.
RETURN Action de retour de la commande.
EXCHANGE Action de commande sur une place de marché.
EMAIL

Action d'e-mail. Les types EMAIL et CALL sont obsolètes. openUrlAction.url peut être utilisé comme numéro de téléphone ou adresse e-mail.

CALL

Action d'appel.

REORDER Action de réorganisation.
REVIEW Examinez l'action liée à la commande.
CUSTOMER_SERVICE Contactez le service client.
FIX_ISSUE Redirigez les utilisateurs vers le site ou l'application du marchand pour résoudre le problème.
DIRECTION Lien d'itinéraire.

OpenUrlAction

Ouvre l'URL donnée.

Représentation JSON
{
  "url": string,
  "androidApp": {
    object (AndroidApp)
  },
  "urlTypeHint": enum (UrlTypeHint)
}
Champs
url

string

Champ d'URL, qui peut correspondre à: - URL http/https pour ouvrir une page Web ou une application associée à une application

androidApp

object (AndroidApp)

Informations sur l'application Android, si l'URL est censée être traitée par une application Android.

urlTypeHint

enum (UrlTypeHint)

Indique une indication concernant le type d'URL.

AndroidApp

Spécification de l'application Android pour les restrictions de traitement

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

string

Nom de package Le nom de package doit être spécifié lorsque vous spécifiez un Fulfillment Android.

versions[]

object (VersionFilter)

Lorsque plusieurs filtres sont spécifiés, toute correspondance de filtre déclenche l'application.

VersionFilter

VersionFilter doit être inclus si des versions spécifiques de l'application sont requises.

Représentation JSON
{
  "minVersion": integer,
  "maxVersion": integer
}
Champs
minVersion

integer

Code de version min. ou 0 (inclus).

maxVersion

integer

Code de version maximal, inclus. La plage prise en compte est la suivante : [minVersion:maxVersion]. Une plage nulle implique n'importe quelle version. Exemples : pour spécifier une seule version, utilisez [target_version:target_version]. Pour spécifier une version, laissez les propriétés minVersion et maxVersion non spécifiées. Pour spécifier toutes les versions jusqu'à maxVersion, laissez la valeur minVersion non spécifiée. Pour spécifier toutes les versions à partir de minVersion, laissez maxVersion non spécifié.

UrlTypeHint

Différents types de indications d'URL

Enums
URL_TYPE_HINT_UNSPECIFIED Non spécifié
AMP_CONTENT URL qui redirige directement vers le contenu AMP, ou vers une URL canonique qui renvoie à un contenu AMP via <link rel="amphtml">.

ActionMetadata

Métadonnées associées par action.

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

string (Timestamp format)

Heure d'expiration de cette action.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

Divulgation

Un communiqué sur un produit, un service ou une règle qui peut être présenté à l'utilisateur.

Représentation JSON
{
  "title": string,
  "disclosureText": {
    object (DisclosureText)
  },
  "presentationOptions": {
    object (DisclosurePresentationOptions)
  }
}
Champs
title

string

Titre du communiqué. Exemple: "Informations relatives à la sécurité".

disclosureText

object (DisclosureText)

Contenu du communiqué. Les liens Web sont autorisés.

presentationOptions

object (DisclosurePresentationOptions)

Options de présentation de la divulgation

DisclosureText

Représente un texte brut avec des liens Web.

Représentation JSON
{
  "template": string,
  "textLinks": [
    {
      object (TextLink)
    }
  ]
}
Champs
template

string

Texte à afficher, contenant des espaces réservés tels que "{0}" et "{1}" pour chaque lien textuel à insérer. Exemple: "AVERTISSEMENT: Ce produit peut vous exposer à des produits chimiques connus de l'État de Californie comme provoquant le cancer. Pour plus d'informations, accédez à la page <ph type="x-smartling-placeholder">{0}</ph>." Ce texte de divulgation ne doit pas contenir de contenu promotionnel ni ressemblant à des annonces.

DisclosurePresentationOptions

Options de présentation d'un communiqué.

Représentation JSON
{
  "presentationRequirement": enum (PresentationRequirement),
  "initiallyExpanded": boolean
}
Champs
presentationRequirement

enum (PresentationRequirement)

Exigence de présentation du communiqué.

initiallyExpanded

boolean

Indique si le contenu de la mention spéciale doit être initialement développé. Par défaut, il est initialement réduit.

PresentationRequirement

Exigence de présentation du communiqué.

Enums
REQUIREMENT_UNSPECIFIED Exigence non spécifiée. Ne doit pas définir ce champ explicitement.
REQUIREMENT_OPTIONAL Cette divulgation est facultative. Vous pouvez l'ignorer si l'appareil ne permet pas d'afficher de communiqués.
REQUIREMENT_REQUIRED Cette divulgation est obligatoire. Si l'appareil n'est pas compatible avec l'affichage des communiqués, la conversation sera envoyée au téléphone.

PurchaseItemExtension

Contenu de l'élément de campagne du secteur "Achat".

Représentation JSON
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "productId": string,
  "quantity": integer,
  "unitMeasure": {
    object (MerchantUnitMeasure)
  },
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "itemOptions": [
    {
      object (ItemOption)
    }
  ],
  "productDetails": {
    object (ProductDetails)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
Champs
status

enum (PurchaseStatus)

Obligatoire: état au niveau de l'élément de campagne.

userVisibleStatusLabel

string

Obligatoire: chaîne/libellé visible par l'utilisateur pour l'état. La longueur maximale autorisée est de 50 caractères.

type

enum (PurchaseType)

Obligatoire: type d'achat.

productId
(deprecated)

string

ID du produit ou de l'offre associé à cet élément de campagne.

quantity

integer

Quantité de l'article.

unitMeasure

object (MerchantUnitMeasure)

Mesure unitaire. Spécifie la taille de l'article dans les unités choisies. La taille et le prix en vigueur sont utilisés pour déterminer le prix unitaire.

returnsInfo

object (PurchaseReturnsInfo)

Affiche des informations sur cet élément de campagne. Si cette règle n'est pas configurée, cet élément de campagne hérite des informations sur les retours au niveau de la campagne.

fulfillmentInfo

object (PurchaseFulfillmentInfo)

Informations de traitement pour cet élément de campagne. Si cette règle n'est pas configurée, cet élément de campagne hérite des informations de traitement au niveau de la campagne.

itemOptions[]

object (ItemOption)

Modules complémentaires ou sous-éléments supplémentaires.

productDetails

object (ProductDetails)

Informations sur le produit.

extension
(deprecated)

object

Tous les champs supplémentaires échangés entre le marchand et Google. Remarque: Nous vous déconseillons vivement d'utiliser cette extension. Selon le cas d'utilisation/les circonstances, envisagez l'une des options suivantes: 1. Définissez des champs dans l'extension "PurchaseItemExtension" si elle peut être utilisée pour d'autres cas d'utilisation (par exemple, des fonctionnalités génériques). 2. Utilisez "vertical_extension" si elle est spécifique à une fonctionnalité ou un cas d'utilisation personnalisés et non génériques.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

PurchaseStatus

État de l'achat associé à un bon de commande ou à un élément de ligne particulier.

Enums
PURCHASE_STATUS_UNSPECIFIED État non spécifié.
READY_FOR_PICKUP Prêt pour le retrait.
SHIPPED Expédiée.
DELIVERED Distribué.
OUT_OF_STOCK Non disponible.
IN_PREPARATION "IN_PREPARATION" peut avoir différentes significations selon le contexte. Pour la commande ALIMENTATION, il peut s'agir de plats en cours de préparation. Pour la vente au détail, il peut s'agir d'un article en cours d'emballage.
CREATED La commande est créée.
CONFIRMED Le marchand a confirmé la commande.
REJECTED Le marchand a refusé la commande ou l'article.
RETURNED L'article a été renvoyé par l'utilisateur.
CANCELLED La campagne ou l'élément de campagne a été annulé par l'utilisateur.
CHANGE_REQUESTED L'utilisateur a demandé à modifier la commande, et l'intégrateur traite actuellement cette modification. La commande doit être déplacée vers un autre état une fois la requête traitée.

PurchaseType

Catégorie d'achat

Enums
PURCHASE_TYPE_UNSPECIFIED Valeur inconnue.
RETAIL Cela inclut les achats tels que les biens matériels.
FOOD Cela inclut l'achat d'une commande de repas.
GROCERY Achat de courses.
MOBILE_RECHARGE Achat d'une recharge mobile prépayée.

MerchantUnitMeasure

Mesure de prix unitaire du marchand.

Représentation JSON
{
  "measure": number,
  "unit": enum (Unit)
}
Champs
measure

number

Valeur: exemple 1.2.

unit

enum (Unit)

Unité: exemple POUND, GRAM.

Unité

Enums
UNIT_UNSPECIFIED Unité non spécifiée.
MILLIGRAM Milligramme.
GRAM Gramme.
KILOGRAM Kilogramme.
OUNCE Une goutte d'eau.
POUND Livre.

PurchaseReturnsInfo

Affiche les informations associées à une commande ou à un élément de campagne particulier.

Représentation JSON
{
  "isReturnable": boolean,
  "daysToReturn": integer,
  "policyUrl": string
}
Champs
isReturnable

boolean

Si la valeur est "true", le retour est autorisé.

daysToReturn

integer

Le retour est autorisé dans un délai de ce nombre de jours.

policyUrl

string

Lien vers les conditions de retour.

PurchaseFulfillmentInfo

Informations de traitement associées à un bon de commande ou à un article particulier.

Représentation JSON
{
  "id": string,
  "fulfillmentType": enum (Type),
  "expectedFulfillmentTime": {
    object (Time)
  },
  "expectedPreparationTime": {
    object (Time)
  },
  "location": {
    object (Location)
  },
  "expireTime": string,
  "price": {
    object (PriceAttribute)
  },
  "fulfillmentContact": {
    object (UserInfo)
  },
  "shippingMethodName": string,
  "storeCode": string,
  "pickupInfo": {
    object (PickupInfo)
  }
}
Champs
id

string

Identifiant unique de cette option de service.

fulfillmentType

enum (Type)

Obligatoire: type de traitement.

expectedFulfillmentTime

object (Time)

Fenêtre si une période est spécifiée ou heure d'arrivée prévue si une seule heure est spécifiée. Heure de livraison ou de retrait prévue.

expectedPreparationTime

object (Time)

Fenêtre si une période est spécifiée ou heure d'arrivée prévue si une seule heure est spécifiée. Temps prévu pour préparer les aliments. Une seule fois de préférence.

location

object (Location)

Lieu de retrait ou de livraison.

expireTime

string (Timestamp format)

Heure à laquelle cette option de traitement expire.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

price

object (PriceAttribute)

Coût de cette option.

fulfillmentContact

object (UserInfo)

Contact de l'utilisateur pour ce traitement.

shippingMethodName

string

Nom du mode de livraison sélectionné par l'utilisateur.

storeCode

string

StoreCode de l'établissement. Exemple: Walmart est le marchand et storeCode est le magasin walmart dans lequel le traitement a eu lieu. https://support.google.com/business/answer/3370250?ref_topic=4596653.

pickupInfo

object (PickupInfo)

Informations supplémentaires sur la façon dont la commande sera sélectionnée. Ce champ n'est applicable que si le type de traitement est "RETRAIT".

Type

Type de traitement.

Enums
TYPE_UNSPECIFIED Type non spécifié
DELIVERY Cette commande sera livrée.
PICKUP Cette commande doit être retirée.

Heure

Construction de temps pour représenter l'heure d'un événement à utiliser lors de l'affichage d'une commande à l'utilisateur.

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

string

Représente l'heure d'un événement de commande, telle que l'heure de réservation, l'heure de livraison, etc. Il peut s'agir d'une durée (heure de début et d'une heure de fin), mais uniquement de la date, de la date et de l'heure. Pour connaître tous les formats acceptés, consultez la page https://en.wikipedia.org/wiki/ISO_8601.

PickupInfo

Informations sur le mode de retrait d'une commande Vous y trouverez des détails comme le type de retrait et des métadonnées supplémentaires pour chaque type, le cas échéant.

Représentation JSON
{
  "pickupType": enum (PickupType),
  "curbsideInfo": {
    object (CurbsideInfo)
  },
  "checkInInfo": [
    {
      object (CheckInInfo)
    }
  ]
}
Champs
pickupType

enum (PickupType)

Méthode de retrait en magasin, telle que INSTORE, CURBSIDE, etc.

curbsideInfo

object (CurbsideInfo)

Détails spécifiques aux informations sur le drive. Si "pickupType" n'est pas "CURBSIDE", ce champ est ignoré.

checkInInfo[]

object (CheckInInfo)

Liste des différentes méthodes acceptées par le partenaire pour l'enregistrement.

PickupType

Liste des types de retrait acceptés.

Enums
UNSPECIFIED Type de retrait non spécifié.
INSTORE Aller chercher de la nourriture à l'intérieur du restaurant.
CURBSIDE Garez le véhicule à l'emplacement prévu à l'extérieur du restaurant, où quelqu'un y livrerait la nourriture.

CurbsideInfo

Détails sur la façon dont la commande au drive serait facilitée.

Représentation JSON
{
  "curbsideFulfillmentType": enum (CurbsideFulfillmentType),
  "userVehicle": {
    object (Vehicle)
  }
}
Champs
curbsideFulfillmentType

enum (CurbsideFulfillmentType)

Les partenaires ont besoin d'informations supplémentaires pour faciliter les commandes à emporter. Selon le type de traitement choisi, les informations correspondantes sont collectées auprès de l'utilisateur.

userVehicle

object (Vehicle)

Informations sur le véhicule de l'utilisateur qui a passé la commande.

CurbsideFulfillmentType

Valeurs possibles des types de traitement au drive.

Enums
UNSPECIFIED Type de traitement drive non spécifié.
VEHICLE_DETAIL Informations sur le véhicule requises pour faciliter le retrait au drive.

Véhicule

Informations sur un véhicule

Représentation JSON
{
  "make": string,
  "model": string,
  "licensePlate": string,
  "colorName": string,
  "image": {
    object (Image)
  }
}
Champs
make

string

Marque du véhicule (par exemple, "Honda"). Ce nom est visible par l'utilisateur et doit être localisé. Obligatoire.

model

string

Modèle du véhicule (par exemple, "Grom"). Ce nom est visible par l'utilisateur et doit être localisé. Obligatoire.

licensePlate

string

Numéro de plaque d'immatriculation du véhicule (par exemple, "1ABC234"). Obligatoire.

colorName

string

Nom de la couleur du véhicule (par exemple, noir) Facultatif.

image

object (Image)

URL d'une photo du véhicule La photo s'affiche au format environ 256 x 256 pixels. Il doit s'agir d'un fichier jpg ou png. Facultatif.

CheckInInfo

Métadonnées requises par le partenaire pour indiquer une méthode d'enregistrement.

Représentation JSON
{
  "checkInType": enum (CheckInType)
}
Champs
checkInType

enum (CheckInType)

Méthode utilisée pour envoyer les instructions concernant l'arrivée.

CheckInType

Différentes méthodes utilisées pour envoyer des instructions relatives à l'enregistrement.

Enums
CHECK_IN_TYPE_UNSPECIFIED Valeur inconnue.
EMAIL Les informations d'arrivée sont envoyées par e-mail.
SMS Les informations d'arrivée sont envoyées par SMS.

ItemOption

Représente des modules complémentaires ou des sous-éléments.

Représentation JSON
{
  "id": string,
  "name": string,
  "prices": [
    {
      object (PriceAttribute)
    }
  ],
  "note": string,
  "quantity": integer,
  "productId": string,
  "subOptions": [
    {
      object (ItemOption)
    }
  ]
}
Champs
id

string

Pour les options qui correspondent à des articles, saisissez un identifiant d'article unique.

name

string

Nom de l'option.

prices[]

object (PriceAttribute)

Prix total de l'option.

note

string

Remarque concernant l'option.

quantity

integer

Pour les options qui incluent des articles, quantité.

productId

string

Identifiant du produit ou de l'offre associé à cette option.

subOptions[]

object (ItemOption)

Pour définir d'autres sous-options imbriquées.

ProductDetails

Informations sur le produit.

Représentation JSON
{
  "productId": string,
  "gtin": string,
  "plu": string,
  "productType": string,
  "productAttributes": {
    string: string,
    ...
  }
}
Champs
productId

string

ID du produit ou de l'offre associé à cet élément de campagne.

gtin

string

Code article international du produit. Utile si l'identifiant de l'offre n'est pas présent dans Merchant Center. Facultatif.

plu

string

Les codes de recherche de prix, communément appelés codes PLU, PLU, PLU, produits ou étiquettes de produits, sont un système de numéros qui identifient de manière unique les produits vendus en gros vendus dans les épiceries et les supermarchés.

productType

string

Catégorie de produits définie par le marchand. Par exemple, "Accueil > Épicerie > Produits laitiers et œufs > Lait > Lait entier"

productAttributes

map (key: string, value: string)

Informations fournies par le marchand sur le produit, par exemple { "allergen": "peanut" }. Utile si l'identifiant de l'offre n'est pas présent dans Merchant Center. Facultatif.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ReservationItemExtension

Contenu des éléments de campagne pour les commandes de réservation (restaurant, salon de coiffure, etc.)

Représentation JSON
{
  "status": enum (ReservationStatus),
  "userVisibleStatusLabel": string,
  "type": enum (ReservationType),
  "reservationTime": {
    object (Time)
  },
  "userAcceptableTimeRange": {
    object (Time)
  },
  "confirmationCode": string,
  "partySize": integer,
  "staffFacilitators": [
    {
      object (StaffFacilitator)
    }
  ],
  "location": {
    object (Location)
  }
}
Champs
status

enum (ReservationStatus)

Obligatoire: état de la réservation.

userVisibleStatusLabel

string

Obligatoire: chaîne/libellé visible par l'utilisateur pour l'état. La longueur maximale autorisée est de 50 caractères.

type

enum (ReservationType)

Type de réservation. Peut être désactivé si aucune des options de type n'est applicable.

reservationTime

object (Time)

Heure à laquelle le service/événement est programmé. Il peut s'agir d'une période, d'une date ou d'une date et d'une heure exactes.

userAcceptableTimeRange

object (Time)

Période acceptable pour l'utilisateur.

confirmationCode

string

Code de confirmation pour cette réservation.

partySize

integer

Nombre de personnes.

staffFacilitators[]

object (StaffFacilitator)

Les animateurs de personnel qui se chargeront de la réservation. Ex. : Le coiffeur.

location

object (Location)

Emplacement du service/événement.

ReservationStatus

État de la réservation.

Enums
RESERVATION_STATUS_UNSPECIFIED État non spécifié.
PENDING La réservation est en attente.
CONFIRMED La réservation est confirmée.
CANCELLED La réservation est annulée par l'utilisateur.
FULFILLED La réservation est effectuée.
CHANGE_REQUESTED Un changement de réservation est demandé
REJECTED La réservation a expiré ou a été refusée par l'intégrateur.

ReservationType

Type de réservation.

Enums
RESERVATION_TYPE_UNSPECIFIED Type non spécifié.
RESTAURANT Réservation au restaurant.
HAIRDRESSER Réservation pour le coiffeur.

StaffFacilitator

Informations sur la personne d'assistance.

Représentation JSON
{
  "name": string,
  "image": {
    object (Image)
  }
}
Champs
name

string

Nom de l'animateur du personnel. Ex. : "Jean Dupont"

image

object (Image)

Images de l'artiste.

PaymentData

Données de paiement associées à une commande.

Représentation JSON
{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
Champs
paymentResult

object (PaymentResult)

Résultat de paiement utilisé par l'intégrateur pour effectuer une transaction. Ce champ sera renseigné par Actions on Google si l'expérience de paiement est gérée par Actions-on-Google.

paymentInfo

object (PaymentInfo)

Informations de paiement concernant la commande qui sont utiles pour interagir avec l'utilisateur.

PaymentResult

Résultat de paiement utilisé par l'intégrateur pour effectuer une transaction.

Représentation JSON
{

  // Union field result can be only one of the following:
  "googlePaymentData": string,
  "merchantPaymentMethodId": string
  // End of list of possible types for union field result.
}
Champs
Champ d'union result. Les données de paiement Google ou le mode de paiement du marchand sont fournis. result ne peut être qu'un des éléments suivants :
googlePaymentData

string

Données fournies par Google sur les modes de paiement Si votre société de traitement des paiements est listée comme société de traitement des paiements acceptée par Google sur la page https://developers.google.com/pay/api/, accédez à cette société via ce lien pour en savoir plus. Sinon, reportez-vous à la documentation suivante pour en savoir plus sur la charge utile. https://developers.google.com/pay/api/payment-data-cryptography

merchantPaymentMethodId

string

Mode de paiement fourni par le marchand/l'action et choisi par l'utilisateur.

PaymentInfo

Informations de paiement concernant la commande en cours. Ce proto capture des informations utiles pour les interactions avec l'utilisateur.

Représentation JSON
{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
Champs
paymentMethodDisplayInfo

object (PaymentMethodDisplayInfo)

Les informations concernant le mode de paiement utilisé pour la transaction

paymentMethodProvenance

enum (PaymentMethodProvenance)

Provenance du mode de paiement utilisé pour la transaction. L'utilisateur peut avoir enregistré le même mode de paiement auprès de Google et du marchand.

PaymentMethodDisplayInfo

Résultat de paiement utilisé par l'intégrateur pour effectuer une transaction.

Représentation JSON
{
  "paymentType": enum (PaymentType),
  "paymentMethodDisplayName": string,
  "paymentMethodVoiceName": string
}
Champs
paymentType

enum (PaymentType)

Type de paiement.

paymentMethodDisplayName

string

Nom du mode de paiement visible par l'utilisateur. Par exemple, VISA **** 1234 Compte courant **** 5678

paymentMethodVoiceName

string

Nom du mode de paiement à énoncer à l'attention de l'utilisateur pour les appareils dotés de l'assistant vocal. Par exemple, "visa se terminant par 1234" ou "compte courant se terminant par 5678". Remarque: Il s'agit de la chaîne optimisée pour la voix à utiliser à la place de paymentMethodDisplayName pour les appareils dotés de l'assistant vocal uniquement. Si cette chaîne n'est pas définie, paymentMethodDisplayName est adressée à l'utilisateur.

PaymentType

PaymentType indique le mode de paiement utilisé par le marchand. L'action doit également fournir un nom à afficher pour le mode de paiement.

Enums
PAYMENT_TYPE_UNSPECIFIED Type de paiement non spécifié.
PAYMENT_CARD Une carte de crédit, de débit ou prépayée
BANK Le mode de paiement est un compte bancaire.
LOYALTY_PROGRAM Le mode de paiement est un programme de fidélité.
CASH Le mode de paiement est le paiement en espèces.
GIFT_CARD Le mode de paiement est une carte cadeau.
WALLET Portefeuille tiers, par exemple PayPal

PaymentMethodProvenance

Représente la provenance du mode de paiement utilisée pour la transaction.

Enums
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED La provenance n'est pas spécifiée.
PAYMENT_METHOD_PROVENANCE_GOOGLE La provenance est Google.
PAYMENT_METHOD_PROVENANCE_MERCHANT La provenance est le marchand.

Promotion

Promotions/offres ajoutées au panier.

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

string

Obligatoire: code promotionnel appliqué à cette offre.

PurchaseOrderExtension

Extension de commande pour le secteur des achats. Ces propriétés s'appliquent à tous les éléments de campagne, sauf si vous les remplacez dans un élément de campagne.

Représentation JSON
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "purchaseLocationType": enum (PurchaseLocationType),
  "errors": [
    {
      object (PurchaseError)
    }
  ],
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
Champs
status

enum (PurchaseStatus)

Obligatoire: état général de la commande.

userVisibleStatusLabel

string

Libellé/chaîne visible par l'utilisateur pour l'état. La longueur maximale autorisée est de 50 caractères.

type

enum (PurchaseType)

Obligatoire: type d'achat.

returnsInfo

object (PurchaseReturnsInfo)

Informations sur le retour de la commande.

fulfillmentInfo

object (PurchaseFulfillmentInfo)

Informations de traitement pour la commande.

purchaseLocationType

enum (PurchaseLocationType)

Lieu de l'achat (en magasin / en ligne)

errors[]

object (PurchaseError)

Facultatif: erreurs en raison desquelles cette commande a été refusée.

extension
(deprecated)

object

Tous les champs supplémentaires échangés entre le marchand et Google. Remarque: Nous vous déconseillons vivement d'utiliser cette extension. Selon le cas d'utilisation/les circonstances, envisagez l'une des options suivantes: 1. Définissez les champs de l'extension "PurchaseOrderExtension" si elle peut être utilisée pour d'autres cas d'utilisation (par exemple, des fonctionnalités génériques). 2. Utilisez "vertical_extension" si elle est spécifique à une fonctionnalité ou un cas d'utilisation personnalisés et non génériques.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

PurchaseLocationType

Type d'emplacement de l'achat.

Enums
UNSPECIFIED_LOCATION Valeur inconnue.
ONLINE_PURCHASE Tous les achats effectués en ligne.
INSTORE_PURCHASE Tous les achats en magasin.

PurchaseError

Erreurs pour lesquelles un bon de commande peut être refusé.

Représentation JSON
{
  "type": enum (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": integer
}
Champs
type

enum (ErrorType)

Obligatoire: cet attribut indique précisément pourquoi une commande est refusée par le marchand.

description

string

Description supplémentaire de l'erreur.

entityId

string

ID d'entité correspondant à l'erreur. Par exemple, il peut correspondre à "LineItemId"/"ItemOptionId".

updatedPrice

object (PriceAttribute)

Pertinent en cas d'erreur de type PRICE_CHANGED / INCORRECT_PRICE.

availableQuantity

integer

Quantité disponible maintenant. Applicable en cas de AVAILABILITY_CHANGED.

ErrorType

Types d'erreurs possibles.

Enums
ERROR_TYPE_UNSPECIFIED Erreur inconnue
NOT_FOUND Entité introuvable. Exemples : Item, FulfillmentOption, Promotion. Veuillez indiquer un ID d'entité.
INVALID Les données d'entité ne sont pas valides. pourraient être Item, FulfillmentOption, Promotion. Veuillez indiquer un ID d'entité.
AVAILABILITY_CHANGED Article indisponible ou nombre d'articles insuffisant pour traiter la demande. Veuillez indiquer un ID d'entité.
PRICE_CHANGED Prix de l'article différent de celui indiqué dans l'entité de l'article. Veuillez indiquer un ID d'entité et un prix mis à jour.
INCORRECT_PRICE Erreurs de prix dans "Frais" et "Total". Veuillez indiquer un ID d'entité et un prix mis à jour.
REQUIREMENTS_NOT_MET Contraintes d'acceptation de la commande non respectées - taille minimale du panier, etc.
TOO_LATE FulfillmentOption expirée.
NO_CAPACITY Aucune capacité de service disponible. Utilisez ce code d'erreur si aucun des types d'erreur plus précis n'est applicable.
NO_COURIER_AVAILABLE Aucun coursier n'a été trouvé. Type d'erreur détaillé pouvant être classé dans la catégorie NO_CAPACITY.
INELIGIBLE L'utilisateur ne peut pas passer commande (il figure sur la liste noire).
OUT_OF_SERVICE_AREA Impossible de livrer à l'adresse demandée en raison de règles frontalières, etc.
CLOSED Le restaurant est fermé au moment de la commande.
PROMO_NOT_APPLICABLE Code d'erreur générique permettant d'identifier tous les cas de non-application du code promotionnel, si aucun des problèmes ci-dessous ne convient. Ajoutez un code promotionnel comme ID d'entité.
PROMO_NOT_RECOGNIZED Le partenaire n'a pas reconnu le code promotionnel. Ajoutez un code promotionnel comme ID d'entité.
PROMO_EXPIRED Impossible d'appliquer la promotion, car elle a expiré. Ajoutez un code promotionnel comme ID d'entité.
PROMO_USER_INELIGIBLE L'utilisateur actuel n'est pas éligible pour ce bon de réduction. Ajoutez un code promotionnel comme ID d'entité.
PROMO_ORDER_INELIGIBLE La commande en cours ne permet pas de bénéficier de ce bon de réduction. Ajoutez un code promotionnel comme ID d'entité.
UNAVAILABLE_SLOT Le créneau de commande à l'avance n'est pas disponible.
FAILED_PRECONDITION Contraintes d'acceptation de commande non respectées : taille minimale du panier, etc.
PAYMENT_DECLINED Paiement non valide.
MERCHANT_UNREACHABLE Le marchand n'est pas joignable. Cela peut être utile lorsqu'un partenaire est un agrégateur et n'a pas pu contacter le marchand.
ACCOUNT_LINKING_FAILED Le marchand a essayé d'associer le compte Google de l'utilisateur à un compte de son système, mais une erreur s'est produite.

TicketOrderExtension

Contenu des commandes de billets (films, sports, etc.)

Représentation JSON
{
  "ticketEvent": {
    object (TicketEvent)
  }
}
Champs
ticketEvent

object (TicketEvent)

L'événement a été appliqué à tous les billets d'élément de campagne.

TicketEvent

Représente un seul événement.

Représentation JSON
{
  "type": enum (Type),
  "name": string,
  "description": string,
  "url": string,
  "location": {
    object (Location)
  },
  "eventCharacters": [
    {
      object (EventCharacter)
    }
  ],
  "startDate": {
    object (Time)
  },
  "endDate": {
    object (Time)
  },
  "doorTime": {
    object (Time)
  }
}
Champs
type

enum (Type)

Obligatoire: type d'événement associé à votre billet (par exemple, un film ou un concert).

name

string

Obligatoire: nom de l'événement. Par exemple, si l'événement est un film, il doit s'agir du nom du film.

description

string

Description de l'événement.

url

string

URL des informations sur l'événement.

location

object (Location)

Lieu où se déroule l'événement ou où se trouve une organisation.

eventCharacters[]

object (EventCharacter)

Personnages associés à cet événement. Il peut s'agir de réalisateurs ou d'acteurs d'un film, d'acteurs d'un concert, etc.

startDate

object (Time)

Heure de début

endDate

object (Time)

Heure de fin

doorTime

object (Time)

L'heure d'entrée, qui peut être différente de l'heure de début de l'événement (par exemple, l'événement commence à 9h et l'heure d'entrée à 8h30).

Type

Le type d'événement.

Enums
EVENT_TYPE_UNKNOWN Type d'événement inconnu.
MOVIE Film.
CONCERT Un concert.
SPORTS Sport

EventCharacter

Un caractère d'événement (organisateur, interprète, etc.)

Représentation JSON
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
Champs
type

enum (Type)

Type de personnage de l'événement (par exemple, acteur ou réalisateur).

name

string

Nom du personnage.

image

object (Image)

Images de personnages.

Type

Type de caractère

Enums
TYPE_UNKNOWN Type inconnu.
ACTOR Acteur.
PERFORMER Interprète.
DIRECTOR Un réalisateur.
ORGANIZER Organisateur.

UserNotification

Notification utilisateur facultative à afficher dans le cadre de la mise à jour de la commande.

Représentation JSON
{
  "title": string,
  "text": string
}
Champs
title

string

Titre de la notification utilisateur. La longueur maximale autorisée est de 30 caractères.

text

string

Contenu de la notification. La longueur maximale autorisée est de 100 caractères.

NextScene

Représente la scène à exécuter ensuite.

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

string

Nom de la scène à exécuter ensuite.

Session

Contient des informations sur la session de conversation en cours

Représentation JSON
{
  "id": string,
  "params": {
    string: value,
    ...
  },
  "typeOverrides": [
    {
      object (TypeOverride)
    }
  ],
  "languageCode": string
}
Champs
id

string

Obligatoire. ID unique global de la session de conversation en cours. Ce champ est en lecture seule.

params

map (key: string, value: value (Value format))

Obligatoire. Liste de tous les paramètres collectés à partir des formulaires et des intents pendant la session. "key" correspond au nom du paramètre. Les paramètres définis ici seront fusionnés avec ceux déjà définis dans la session. Les paramètres ayant une valeur nulle seront supprimés de la session. Consultez la documentation sur le stockage des sessions: https://developers.google.com/assistant/conversational/storage-session.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

typeOverrides[]

object (TypeOverride)

Facultatif. Types limités à la session. Les définitions de type de session peuvent compléter ou remplacer les types existants. Les noms de type doivent être uniques.

languageCode

string

Langue de la session de conversation en cours. Suit le code de langue IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt. Elle peut être différente de la langue locale de l'utilisateur si l'action utilise des fonctionnalités multilingues. Par exemple, une fois que le paramètre "Handler_response.expected.language_code" est défini, la langue de la conversation est modifiée pour tous les changements de direction suivants, ce qui est reflété dans ce champ.

TypeOverride

Représente un remplacement pour un type.

Représentation JSON
{
  "name": string,
  "mode": enum (TypeOverrideMode),
  "synonym": {
    object (SynonymType)
  }
}
Champs
name

string

Obligatoire. Nom du type à compléter ou à remplacer.

mode

enum (TypeOverrideMode)

Obligatoire. Méthode de fusion de ce type avec d'autres valeurs de type

synonym

object (SynonymType)

TypeOverrideMode

Types de modifications d'un type d'entité de session.

Enums
TYPE_UNSPECIFIED Non spécifié. Cette valeur ne doit jamais être utilisée.
TYPE_REPLACE Les définitions de type de cette réponse remplaceront les définitions de type définies précédemment.
TYPE_MERGE Les définitions de type de cette réponse seront fusionnées avec les définitions de type définies précédemment. Les nouvelles définitions de type écraseront les définitions de type existantes.

SynonymType

Représente un type avec des synonymes.

Représentation JSON
{
  "entries": [
    {
      object (Entry)
    }
  ]
}
Champs
entries[]

object (Entry)

Obligatoire. Liste des entrées pour le type de synonymes.

Entrée

Représente une entrée pour un type de synonyme.

Représentation JSON
{
  "name": string,
  "synonyms": [
    string
  ],
  "display": {
    object (EntryDisplay)
  }
}
Champs
name

string

Obligatoire. Nom de l'entrée (par exemple, "vélo"). L'entrée de ce champ doit être incluse dans le champ des synonymes répétés pour être reconnue en tant que valeur de type valide.

synonyms[]

string

Obligatoire. Liste de synonymes pour l'entrée (par exemple, "bike", "cycle").

display

object (EntryDisplay)

Facultatif. L'élément affiche des informations.

EntryDisplay

Représentation JSON
{
  "title": string,
  "description": string,
  "image": {
    object (Image)
  },
  "footer": string,
  "openUrl": {
    object (OpenUrl)
  }
}
Champs
title

string

Obligatoire. Titre de l'article. Lorsque l'utilisateur appuie dessus, ce texte est republié dans la conversation, comme si l'utilisateur l'avait saisi. Chaque titre doit être unique parmi les éléments de la collection.

description

string

Facultatif. Corps du texte de la fiche.

image

object (Image)

Facultatif. Image à afficher.

footer

string

Facultatif. Texte de pied de page de l'élément de la collection permettant de parcourir la collection, affiché sous la description. Une seule ligne de texte, tronquée par des points de suspension

openUrl

object (OpenUrl)

URL du document associé à la navigation dans l'élément du carrousel. Requis pour parcourir le carrousel.

Utilisateur

Représente l'utilisateur envoyant une requête à l'action.

Représentation JSON
{
  "locale": string,
  "params": {
    string: value,
    ...
  },
  "accountLinkingStatus": enum (AccountLinkingStatus),
  "verificationStatus": enum (UserVerificationStatus),
  "lastSeenTime": string,
  "engagement": {
    object (Engagement)
  },
  "packageEntitlements": [
    {
      object (PackageEntitlements)
    }
  ],
  "permissions": [
    enum (Permission)
  ]
}
Champs
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. Toutefois, le sous-tag du script n'est pas inclus.

params

map (key: string, value: value (Value format))

Facultatif. Liste de tous les paramètres associés à l'utilisateur actuel. Consultez la documentation sur le stockage utilisateur: https://developers.google.com/assistant/conversational/storage-user.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

accountLinkingStatus

enum (AccountLinkingStatus)

Indique si le compte utilisateur est associé à l'application.

verificationStatus

enum (UserVerificationStatus)

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

lastSeenTime

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.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

engagement

object (Engagement)

Engagement de l'utilisateur actuel, y compris les abonnements à des intents.

packageEntitlements[]

object (PackageEntitlements)

Droits de l'utilisateur liés au package Android associé à l'action en cours.

permissions[]

enum (Permission)

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

AccountLinkingStatus

Indique si l'utilisateur final a associé son compte à cette application. Consultez la documentation sur l'association de comptes: https://developers.google.com/assistant/identity.

Enums
ACCOUNT_LINKING_STATUS_UNSPECIFIED Inconnu.
NOT_LINKED L'utilisateur n'a pas associé son compte à cette application.
LINKED L'utilisateur a associé son compte à cette application.

UserVerificationStatus

Indique si l'utilisateur a été validé par Google. L'état "VALIDÉ" indique que vous pouvez enregistrer des données de conversations à l'aide du champ "Paramètres" ou avec l'association de comptes.

Enums
USER_VERIFICATION_STATUS_UNSPECIFIED Inconnu.
GUEST Utilisateur invité.
VERIFIED Utilisateur validé.

Engagement

Fournit des informations supplémentaires en lecture seule sur les mécanismes d'engagement auxquels l'utilisateur actuel s'est inscrit. Par exemple, il peut être utile de connaître les intents auxquels l'utilisateur est déjà abonné afin d'éviter de lui demander de s'abonner à nouveau au même intent. Ces informations peuvent être utilisées pour acheminer des requêtes de manière conditionnelle vers une scène afin de configurer des mises à jour quotidiennes ou des notifications push uniquement si l'utilisateur ne s'est pas déjà abonné. Consultez la documentation sur l'engagement utilisateur: https://developers.google.com/assistant/engagement.

Représentation JSON
{
  "pushNotificationIntents": [
    {
      object (IntentSubscription)
    }
  ],
  "dailyUpdateIntents": [
    {
      object (IntentSubscription)
    }
  ]
}
Champs
pushNotificationIntents[]

object (IntentSubscription)

Contient une liste des intents pour lesquels l'utilisateur a activé les notifications push.

dailyUpdateIntents[]

object (IntentSubscription)

Contient une liste des intents pour lesquels l'utilisateur a activé la mise à jour quotidienne.

IntentSubscription

Décrit un IntentSubscription existant.

Représentation JSON
{
  "intent": string,
  "contentTitle": string
}
Champs
intent

string

Nom de l'intent auquel est abonné.

contentTitle

string

Brève description de l'abonnement. Il est utilisé comme libellé de la notification et lorsque l'Assistant demande l'autorisation à l'utilisateur.

PackageEntitlements

Liste des droits d'accès de l'utilisateur liés à un nom de package. Consultez la documentation sur les transactions d'articles numériques: https://developers.google.com/assistant/transactions/digital/dev-guide-digital-non-consumables.

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

string

Nom du package Android spécifié dans le package d'actions.

entitlements[]

object (Entitlement)

Droits d'accès de l'utilisateur pour le package donné.

Droit d'accès

Définit les droits d'accès numériques d'un utilisateur.

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. Consultez la documentation sur la facturation des achats in-app sur Google Play: https://developer.android.com/google/play/billing.

skuType

enum (SkuType)

Type de SKU.

inAppDetails

object (SignedData)

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

SkuType

Enums
SKU_TYPE_UNSPECIFIED
IN_APP Achat via l'application
SUBSCRIPTION Abonnements
APP Les applications payantes

SignedData

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

object (Struct format)

Contient toutes les données d'achat via une application au format JSON. Pour en savoir plus, reportez-vous au tableau 6 de 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.

Autorisation

Valeurs possibles pour l'autorisation.

Enums
PERMISSION_UNSPECIFIED Autorisation non spécifiée.
DEVICE_PRECISE_LOCATION Demandez la position exacte de l'utilisateur, sa latitude/longitude et son adresse formatée.
DEVICE_COARSE_LOCATION Demandez à l'utilisateur la position approximative, le code postal, la ville et le code du pays.
UPDATE Demandez l'autorisation d'envoyer des mises à jour. Consultez la page https://developers.google.com/assistant/engagement/daily.

Accueil

Représente la structure HomeGraph à laquelle appartient l'appareil cible de l'utilisateur.

Représentation JSON
{
  "params": {
    string: value,
    ...
  }
}
Champs
params

map (key: string, value: value (Value format))

Facultatif. Liste des paramètres associés à la structure HomeGraph à laquelle appartient l'appareil cible. Consultez la documentation sur le stockage de votre maison: https://developers.google.com/assistant/conversational/storage-home.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Appareil

Représente l'appareil dont l'utilisateur se sert pour envoyer une requête à l'action.

Représentation JSON
{
  "capabilities": [
    enum (Capability)
  ],
  "currentLocation": {
    object (Location)
  },
  "timeZone": {
    object (TimeZone)
  }
}
Champs
capabilities[]

enum (Capability)

Obligatoire. Capacités de l'appareil qui envoie une requête à l'action.

currentLocation

object (Location)

Facultatif. Position de l'appareil de l'utilisateur. Notez que ce champ n'est renseigné qu'une fois que l'utilisateur final a accordé l'autorisation d'accéder à la position. Consultez le message de position pour en savoir plus sur les champs définis en fonction de l'autorisation d'accès à la position approximative ou précise. Consultez la documentation sur les autorisations: https://developers.google.com/assistant/conversational/permissions.

timeZone

object (TimeZone)

Facultatif. Fuseau horaire associé à l'appareil client. Elle peut être utilisée pour résoudre les valeurs de date et d'heure.

Capacité

Fonctionnalités compatibles avec la surface de l'appareil au moment de la requête.

Enums
UNSPECIFIED Capacité de l'appareil non spécifiée.
SPEECH L'appareil peut communiquer avec l'utilisateur via la synthèse vocale ou SSML.
RICH_RESPONSE L'appareil peut afficher des réponses enrichies telles que des fiches, des listes et des tableaux.
LONG_FORM_AUDIO L'appareil peut lire des contenus audio longs, comme de la musique et des podcasts.
INTERACTIVE_CANVAS L'appareil peut afficher une réponse de canevas interactif.
HOME_STORAGE L'appareil permet d'enregistrer et de récupérer l'espace de stockage de la maison.

Emplacement

Conteneur représentant un emplacement.

Représentation JSON
{
  "coordinates": {
    object (LatLng)
  },
  "postalAddress": {
    object (PostalAddress)
  }
}
Champs
coordinates

object (LatLng)

Coordonnées géographiques. Nécessite l'autorisation [DEVICE_PRECISE_LOCATION].

postalAddress

object (PostalAddress)

Adresse postale. Nécessite l'autorisation [DEVICE_PRECISE_LOCATION] ou [DEVICE_COARSE_LOCATION]. Lorsque l'autorisation d'accéder à la position approximative est accordée, seuls les champs "postalCode" et "Localité" doivent être renseignés. L'autorisation d'accéder à la position exacte remplira des champs supplémentaires tels que "administrativeArea" et "addressLines".

TimeZone

Représente un fuseau horaire de la base de données des fuseaux horaires IANA.

Représentation JSON
{
  "id": string,
  "version": string
}
Champs
id

string

Fuseau horaire de la base de données des fuseaux horaires IANA, par exemple "America/New_York".

version

string

Facultatif. Numéro de version de la base de données des fuseaux horaires IANA, par exemple "2019a".

Contexte

Contient des informations contextuelles lorsque l'utilisateur effectue une requête. Ce contexte inclut, sans s'y limiter, les informations sur la session multimédia active, l'état de l'application Web de canevas, etc.

Représentation JSON
{
  "media": {
    object (MediaContext)
  },
  "canvas": {
    object (CanvasContext)
  }
}
Champs
media

object (MediaContext)

Contient des informations contextuelles sur la session multimédia active en cours.

canvas

object (CanvasContext)

Contient des informations contextuelles sur le canevas actuel.

MediaContext

Contient des informations contextuelles sur la session multimédia active en cours.

Représentation JSON
{
  "progress": string,
  "index": integer
}
Champs
progress

string (Duration format)

Progression du fichier multimédia actif actuel.

Durée en secondes avec neuf chiffres au maximum après la virgule. Se termine par "s". Example : "3.5s".

index

integer

Index de base 0 du fichier multimédia actif actuel dans la liste de fichiers multimédias de la réponse multimédia.

CanvasContext

Contient des informations contextuelles sur le canevas actuel.

Représentation JSON
{
  "state": value
}
Champs
state

value (Value format)

Facultatif. État défini par l'application interactive Canvas tierce. Défini uniquement pour la requête, et non pour la réponse. Par exemple, pour une application de recette, l'état peut être une valeur de struct : { "current_page" : 5, "last_page" : 3, } La taille maximale est de 50 Ko.

Heure attendue

Décrit les attentes pour le prochain tour de dialogue.

Représentation JSON
{
  "speech": [
    string
  ]
}
Champs
speech[]

string

Liste des expressions que l'action attend de l'énoncé de l'utilisateur pour la pondération de la voix. Vous pouvez ajouter jusqu'à 1 000 expressions. Remarque: Ce champ a la même signification que ExpectInput.Speech_biasing_hints dans la version 2 de l'API.