Guide de démarrage rapide pour les SDK Actions et Builder

Ce guide explique comment configurer votre environnement pour créer des actions à l'aide du SDK Actions et d'Actions Builder. Vous allez effectuer les tâches suivantes:

  • Installez Node.js:vous avez besoin de cet environnement d'exécution pour utiliser notre bibliothèque de traitement Node.js.
  • Installez la CLI Firebase:cet outil de ligne de commande vous permet de développer et de déployer des dépendances Firebase, telles que des applications Web pour Interactive Canvas, sur Firebase Hosting.
  • Installez l'outil de ligne de commande gactions:lors du développement avec le SDK Actions, vous pouvez utiliser cet outil pour créer, gérer et déployer le package d'actions correspondant à votre action.
  • Créer un projet Actions:un projet Actions est le conteneur logique de vos actions conversationnelles. Vous devez en créer un dans la console Actions avant de pouvoir commencer à en créer une.
  • Initialiser et déployer un exemple:cet exemple simple vous montre comment commencer à créer des actions avec Interactive Canvas.

Une fois ce démarrage rapide effectué, vous pouvez synchroniser votre projet Actions entre votre environnement de développement local et l'expérience Web d'Actions Builder.

Installer Node.js et la CLI Firebase

Téléchargez et installez Node.js conformément à la documentation Node.js pour utiliser notre bibliothèque de fulfillment. L'installation de Node.js vous permet également d'installer la CLI Firebase avec npm, puis d'exécuter votre mise en œuvre de traitement conversationnel localement.

Installez et configurez la CLI Firebase conformément à la documentation de Firebase. La CLI Firebase vous permet de déployer une application Web Interactive Canvas sur Firebase Hosting et, si nécessaire, de déployer manuellement le traitement dans Cloud Functions for Firebase.

Installer l'outil de ligne de commande gactions

Installez l'outil d'interface de ligne de commande (CLI) gactions en téléchargeant un package d'installation, en le décompressant et en configurant votre chemin d'exécution.

Pour installer et configurer les gactions, procédez comme suit:

  1. Téléchargez le package correspondant à votre système d'exploitation:

    Plate-forme Empaqueter Total
    Windows Télécharger SHA256
    Linux Télécharger SHA256
    macOS Télécharger SHA256
  2. Extrayez le package à l'emplacement de votre choix, puis ajoutez le binaire à la variable PATH de votre environnement. Vous pouvez également extraire le package vers un emplacement qui se trouve déjà dans votre variable PATH (par exemple, /usr/local/bin).

  3. Sous Linux et Mac, activez les autorisations d'exécution si nécessaire:

    chmod +x PATH_TO/gactions
  4. Exécutez la commande suivante pour authentifier la CLI. Cette commande lance un flux d'authentification et nécessite un navigateur Web:

    gactions login

    Une fois le flux terminé, la CLI s'authentifie automatiquement.

Créer et configurer un projet

Avant de pouvoir utiliser l'outil de ligne de commande gactions, vous devez créer un projet dans la console Actions et autoriser gactions à y accéder. Pour créer et configurer un projet, procédez comme suit:

  1. Accédez à la console Actions.
  2. Cliquez sur Nouveau projet, saisissez un nom de projet, puis cliquez sur Créer un projet.
  3. Sélectionnez une catégorie, puis cliquez sur Suivant.
  4. Sélectionnez Blank project (Projet vide), puis cliquez sur Start build (Commencer à créer).
  5. Activez l'API Actions dans la console Google Cloud en suivant les instructions de la section Activer et désactiver des API. Cela permet aux gactions d'interagir avec votre projet.

Télécharger l'exemple Hello World

L'exemple interactif Hello World vous montre comment créer un projet Actions simple avec une seule action optimisée par Interactive Canvas.

  1. Créez un répertoire vide et initialisez l'exemple Interactive Canvas dans ce répertoire. Par exemple, le code suivant initialise l'exemple dans un répertoire interactive-canvas-sample/, qui est utilisé comme exemple tout au long de ce document:

    gactions init interactive-canvas --dest interactive-canvas-sample
    cd interactive-canvas-sample
    
  2. Ouvrez le fichier interactive-canvas-sample/sdk/settings/settings.yaml et remplacez la valeur du champ projectId par l'ID de votre projet.

Déployer et tester l'exemple

Après avoir configuré l'exemple, vous pouvez déployer l'application Web Interactive Canvas et votre projet Actions. Ce processus crée une version brouillon de votre projet Actions que vous pouvez déployer dans le simulateur Actions pour la prévisualiser et le tester:

  1. À partir du répertoire interactive-canvas-sample/, exécutez la commande suivante pour déployer l'application Web Interactive Canvas (contenu du répertoire public/).

    firebase deploy --project PROJECT_ID --only hosting
    

    Vous pouvez afficher une version rendue de l'application Web à l'URL renvoyée par la CLI Firebase dans un navigateur : https://PROJECT_ID.web.app.

  2. Ouvrez le fichier interactive-canvas-sample/sdk/webhooks/ActionsOnGoogleFulfillment/index.js et remplacez la valeur de la variable CANVAS_URL par l'URL de l'application Web de votre projet.

    const CANVAS_URL = 'https://PROJECT_ID.web.app';
    
  3. Dans le répertoire interactive-canvas-sample/sdk/, exécutez la commande suivante pour transférer la version locale de votre projet Actions vers la console en tant que brouillon:

    gactions push
    
  4. Dans le répertoire interactive-canvas-sample/sdk/, exécutez la commande suivante pour tester votre projet Actions dans le simulateur:

    gactions deploy preview
    
  5. Ouvrez le lien renvoyé par l'outil de ligne de commande pour accéder au simulateur.

  6. Dans le simulateur, saisissez "Talk to Interactive canevas sample" (Parler à un exemple de canevas interactif) pour lancer l'action. Vous devriez voir un triangle en rotation optimisé par l'application Web déployée à https://PROJECT_ID.web.app.

    Figure 1 : Simulateur affichant un aperçu du projet Actions