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

Ce guide vous explique comment configurer votre environnement pour créer des actions à l'aide de le SDK Actions et le générateur d'actions. Vous allez effectuer les tâches suivantes:

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

Une fois ce démarrage rapide terminé, vous pourrez 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 en respectant la syntaxe pour utiliser notre bibliothèque de fulfillment. Votre installation de Node.js s'effectue également vous permet d'installer la CLI Firebase avec npm, puis une version ultérieure, pour exécuter votre l'implémentation locale du traitement conversationnel.

Installez et configurez la CLI Firebase en suivant les instructions à la documentation Firebase. La CLI Firebase vous permet de déployer Application Web Canvas à Firebase Hosting et, si nécessaire, déploiement manuel le fulfillment à 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 d’installation, de le décompresser et de configurer votre chemin d’exécution.

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

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

    Plate-forme Package 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 et ajoutez le binaire à votre la variable PATH de l'environnement. Vous pouvez aussi extraire le package emplacement figurant 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 démarre 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 donner accès au projet à gactions. Pour créer et définir 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 Projet vide, puis cliquez sur Commencer à créer.
  5. Activez l'API Actions dans la console Google Cloud en procédant comme suit : les instructions de la section Activer et désactiver API. Cela permet aux gactions d'interagir avec votre projet.

Obtenir l'exemple Hello World

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

  1. Créez un répertoire vide et initialisez l'exemple Interactive Canvas dans dans ce répertoire. Par exemple, le code suivant initialise l'exemple dans une Répertoire interactive-canvas-sample/, 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 vos actions projet que vous pouvez déployer dans le simulateur Actions pour les prévisualiser et les tester:

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

    firebase deploy --project PROJECT_ID --only hosting

    Vous pouvez voir une version affichée de l'application Web au niveau de 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. À partir du 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 version brouillon:

    gactions push

  4. À partir du 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 pour lancer l'action. Toi un triangle en rotation alimenté par l'application Web déployée https://PROJECT_ID.web.app

    <ph type="x-smartling-placeholder">
    </ph>
    Figure 1. Simulateur prévisualisant le projet Actions