ActionPackage

ActionPackage contient le contenu du brouillon d'une application ainsi que de chaque version déployée. Cela inclut les détails de l'annuaire, la configuration des conversations et l'association de comptes.

Représentation JSON
{
  "manifest": {
    object (Manifest)
  },
  "accountLinking": {
    object (AccountLinking)
  },
  "actions": [
    {
      object (Action)
    }
  ],
  "types": [
    {
      object (Type)
    }
  ],
  "conversations": {
    string: {
      object(ConversationFulfillment)
    },
    ...
  },
  "locale": string
}
Champs
manifest

object (Manifest)

Détails de l'application. C'est là que la liste du répertoire est conservée, ainsi que d'autres identifiants d'application tels que displayName.

accountLinking

object (AccountLinking)

Détails de l'association de comptes dans cette application.

actions[]

object (Action)

Liste des actions que l'application est capable de gérer.

types[]

object (Type)

Liste des types définis par le développeur.

conversations

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

Cartographiez les conversations qui peuvent être partagées dans actions. Par exemple, consultez conversationName dans Fulfillment.

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

locale

string

Paramètres régionaux de ce package d'actions. Il est représenté par des chaînes de langue BCP-47, telles que "en", "en-US", "fr", "fr-CA", "sr-Latn", "zh-Hans", "zh-Hans-CN", "zh-Hant", "zh-Hant-HK", etc. Ce paramètre est obligatoire lorsqu'une application prend en charge plusieurs langues. Chaque paramètre régional compatible possède son propre ActionPackage. Si aucune valeur n'est fournie, les paramètres régionaux par défaut de l'agent sont implicites.

Fichier manifeste

Ensemble des métadonnées de l'application. Le contenu de ce message est utilisé dans plusieurs contextes:

  1. actions sur la fiche de l'annuaire Google.
  2. Identification unique d'une application pour un appel explicite (displayName).
  3. Contenu d'autres parties d'un ActionPackage (shortDescription est utilisé pour l'affichage dans AccountLinking, displayName est utilisé dans actions pour présenter le nom de l'application aux utilisateurs).

Ce message est en lecture seule. Vous devez spécifier les champs de ce message via la console d'actions, et non directement dans le package d'actions.

Représentation JSON
{
  "displayName": string,
  "invocationName": string,
  "enabledRegions": [
    string
  ],
  "disabledRegions": [
    string
  ],
  "shortDescription": string,
  "longDescription": string,
  "category": string,
  "smallSquareLogoUrl": string,
  "largeLandscapeLogoUrl": string,
  "companyName": string,
  "contactEmail": string,
  "termsOfServiceUrl": string,
  "privacyUrl": string,
  "sampleInvocation": [
    string
  ],
  "introduction": string,
  "testingInstructions": string,
  "voiceName": string,
  "externalVoiceName": string,
  "voiceLocale": string,
  "surfaceRequirements": {
    object (SurfaceRequirements)
  }
}
Champs
displayName

string

Le nom à afficher par défaut de cette application (si aucune traduction n'est disponible), par exemple "Starbucks". Cela permet également aux utilisateurs d'appeler cette application (en plus de invocationName). Le nom à afficher doit être unique et phonétiquement très semblable à invocationName.

invocationName

string

Nom unique de l'application permettant de l'appeler directement dans un contexte vocal (parlé). Les règles exigent que le nom d'appel soit très semblable phonétiquement au champ displayName.

enabledRegions[]

string (int64 format)

ID de critère AdWords pour les régions dans lesquelles l'application est autorisée en fonction du lieu de présence de l'utilisateur. Consultez la page https://developers.google.com/adwords/api/docs/appendix/geotargeting

disabledRegions[]

string (int64 format)

ID de critère AdWords pour les régions où l'application est bloquée en fonction de la zone géographique de l'utilisateur. Consultez la page https://developers.google.com/adwords/api/docs/appendix/geotargeting

shortDescription

string

Brève description par défaut de l'application (si aucune traduction n'est disponible). (80 caractères maximum).

longDescription

string

Description longue par défaut de l'application (si aucune traduction n'est disponible). Ce texte est limité à 4 000 caractères.

category

string

Catégorie de l'application. La valeur doit correspondre à l'une des catégories autorisées pour les applications. Consultez les actions disponibles dans la console Google pour obtenir la liste des catégories autorisées.

smallSquareLogoUrl

string

Petite image carrée. Les dimensions doivent être de 192 x 192 pixels.

largeLandscapeLogoUrl

string

Grande image en mode paysage. Les dimensions doivent être de 2 208 x 1 242 pixels.

companyName

string

Nom de l'entreprise à laquelle l'application est associée.

contactEmail

string

Adresse e-mail permettant aux utilisateurs de vous contacter à propos de l'application.

termsOfServiceUrl

string

URL des conditions d'utilisation de l'application.

privacyUrl

string

URL des règles de confidentialité de l'application.

sampleInvocation[]

string

Exemple d'expression d'appel affichée dans la description de l'application dans le répertoire de toutes les applications. Vous ne pouvez indiquer que cinq valeurs.

introduction

string

Résumé des fonctionnalités d'une application. Utilisé pour présenter l'application aux utilisateurs. Il doit s'agir d'un syntagme verbal qui complète une phrase telle que "You can use this App to..." (Vous pouvez utiliser cette application pour...)

testingInstructions

string

Instructions de test au format libre pour l'examinateur de l'application.

voiceName

string

Nom de la voix à utiliser. Exemples de valeurs acceptées: male_1, male_2, female_1, female_2.

externalVoiceName

string

Nom de la voix externe de cet agent. Ne contient pas d'informations régionales.

voiceLocale

string

Paramètres régionaux de la voix pour cet agent. S'il est défini sur une chaîne vide, il sera résolu dans les paramètres régionaux de l'utilisateur au moment de l'exécution.

surfaceRequirements

object (SurfaceRequirements)

Ensemble de conditions requises pour la surface client de l'Assistant Google, qui doivent être remplies pour que l'application soit déclenchée.

SurfaceRequirements

Contient un ensemble d'exigences pour la surface client qui doivent être remplies pour que l'agent soit déclenché. Si l'une des conditions indiquées ici n'est pas remplie, l'agent ne sera pas déclenché.

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

object (Capability)

Ensemble minimal de fonctionnalités nécessaires au fonctionnement de l'agent. Si la surface ne contient pas l'un de ces éléments, l'agent n'est pas déclenché.

Capacité

Représente une exigence concernant la disponibilité d'une capacité donnée

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

string

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

Type

Type qui peut être référencé dans une action. Il peut s'agir de types personnalisés propres à l'action ou de types courants définis par Google et référencés dans l'action.

Représentation JSON
{
  "name": string,
  "entities": [
    {
      object (Entity)
    }
  ],
  "isUserDefined": boolean
}
Champs
name

string

Nom du type personnalisé, au format type.

entities[]
(deprecated)

object (Entity)

Liste des entités pour ce type. Chacun d'eux comprend une clé et une liste de synonymes.

isUserDefined

boolean

Indique si les entités sont définies par l'utilisateur (différentes pour chaque utilisateur).

Entité

Chaque entité correspondant est unique pour ce type. La clé doit être unique et la liste de synonymes est utilisée pour le déclenchement.

Représentation JSON
{
  "key": string,
  "synonyms": [
    string
  ]
}
Champs
key

string

Clé unique pour cet élément.

synonyms[]

string

Liste des synonymes qui peuvent être utilisés pour faire référence à cet élément.