Kurzanleitung für Actions SDK und Builder

In diesem Leitfaden erfahren Sie, wie Sie Ihre Umgebung zum Erstellen von Aktionen mit Actions SDK und Actions Builder. Sie führen die folgenden Aufgaben aus:

  • Node.js installieren:Sie benötigen diese Laufzeitumgebung, um unser Node.js-Script zu verwenden. Fulfillment-Bibliothek.
  • Firebase CLI installieren:Mit diesem Befehlszeilentool können Sie Firebase-Abhängigkeiten wie Web-Apps für Interactive Canvas bereitstellen, Firebase Hosting.
  • gactions-Befehlszeilentool installieren:Bei der Entwicklung mit dem Actions-Tool SDK verwenden Sie dieses Tool zum Erstellen, Verwalten und Bereitstellen des Aktionspakets für deine Aktion.
  • Actions-Projekt erstellen:Ein Actions-Projekt ist der logische Container für Ihre Konversationsaktionen. Sie müssen ein Konto in der Actions Console erstellen, bevor Sie mit der Entwicklung beginnen können.
  • Beispiel initialisieren und bereitstellen:In diesem einfachen Beispiel wird gezeigt, wie Sie mit der Entwicklung von Aktionen auf Basis von Interactive Canvas begonnen.

Nachdem Sie diesen Schnellstart abgeschlossen haben, können Sie Ihr Actions-Projekt zwischen Ihre lokale Entwicklungsumgebung und die Weboberfläche von Actions Builder.

Node.js und Firebase CLI installieren

Laden Sie Node.js herunter und installieren Sie es gemäß Node.js. Dokumentation zur Verwendung unserer Fulfillment-Bibliothek. Ihre Installation von Node.js ermöglicht es Ihnen, die Firebase CLI mit npm zu installieren und später Ihre Implementierung der konversationellen Fulfillment-Lösung lokal.

Installieren und richten Sie die Firebase CLI gemäß zur Firebase-Dokumentation. Mit der Firebase CLI können Sie ein interaktives Canvas-Webanwendung in Firebase Hosting und bei Bedarf manuell bereitstellen Auftragsausführung in Cloud Functions for Firebase.

gactions-Befehlszeilentool installieren

Installieren Sie das gactions-Befehlszeilentool. Laden Sie dazu eine Installationspaket erstellen, es entpacken und den Ausführungspfad konfigurieren.

So installieren und konfigurieren Sie Gactions:

  1. Laden Sie das entsprechende Paket für Ihr Betriebssystem herunter:

    Plattform Paket Prüfsumme
    Windows Herunterladen SHA256
    Linux Herunterladen SHA256
    macOS Herunterladen SHA256

  2. Extrahieren Sie das Paket an einen Speicherort Ihrer Wahl und fügen Sie das Binärprogramm zu Ihrem die Variable PATH der Umgebung. Sie können das Paket auch Standort, der bereits in der Variablen PATH enthalten ist (z. B. /usr/local/bin).

  3. Aktivieren Sie unter Linux und Mac bei Bedarf Ausführungsberechtigungen:

    chmod +x PATH_TO/gactions

  4. Führen Sie den folgenden Befehl aus, um die Befehlszeile zu authentifizieren. Dieser Befehl startet einen Authentifizierungsvorgang und erfordert einen Webbrowser:

    gactions login

    Wenn der Vorgang abgeschlossen ist, authentifiziert sich die Befehlszeile automatisch.

Projekt erstellen und einrichten

Bevor Sie das gactions-Befehlszeilentool verwenden können, müssen Sie ein Projekt erstellen in die Actions Console aufrufen und gactions Zugriff auf das Projekt gewähren. So erstellen und legen Sie ein Projekt einrichten, gehen Sie so vor:

  1. Rufen Sie die Actions Console auf.
  2. Klicken Sie auf Neues Projekt, geben Sie einen Projektnamen ein und klicken Sie auf Projekt erstellen.
  3. Wählen Sie eine Kategorie aus und klicken Sie auf Weiter.
  4. Wählen Sie Leeres Projekt aus und klicken Sie auf Jetzt erstellen.
  5. Aktivieren Sie die Actions API in der Google Cloud Console, indem Sie die Anweisungen unter Aktivieren und Deaktivieren APIs Dies ermöglicht es Gactions, mit Ihrem Projekt zu interagieren.

Hello World-Beispiel abrufen

Das interaktive Beispiel „Hello World“ zeigt, wie eine einfache Aktion erstellt wird mit einer einzigen Aktion von Interactive Canvas.

  1. Erstellen Sie ein leeres Verzeichnis und initialisieren Sie das interaktive Canvas-Beispiel in dieses Verzeichnis. Mit dem folgenden Code wird beispielsweise das Beispiel in einem Verzeichnis interactive-canvas-sample/, das als Beispiel verwendet wird in diesem Dokument:

    gactions init interactive-canvas --dest interactive-canvas-sample
cd interactive-canvas-sample

  2. Öffnen Sie die Datei interactive-canvas-sample/sdk/settings/settings.yaml und Ändern Sie den Wert des Felds projectId in die ID Ihres Projekts.

Beispiel bereitstellen und testen

Nachdem Sie das Beispiel eingerichtet haben, können Sie die Interactive Canvas Web-App bereitstellen und Ihr Actions-Projekt. Durch diesen Prozess wird ein Entwurf deiner Aktionen erstellt das Sie im Actions-Simulator zur Vorschau und zum Testen bereitstellen können:

  1. Führen Sie im Verzeichnis interactive-canvas-sample/ den folgenden Befehl aus: zur Bereitstellung der Interactive Canvas Web-App (Inhalt der public/ -Verzeichnis).

    firebase deploy --project PROJECT_ID --only hosting

    Eine gerenderte Version der Web-App sehen Sie unter der URL, die vom Firebase CLI in einem Browser: https://PROJECT_ID.web.app

  2. Öffnen Sie die Datei interactive-canvas-sample/sdk/webhooks/ActionsOnGoogleFulfillment/index.js und Ändern Sie den Wert der Variablen CANVAS_URL in die Web-App-URL Ihres Projekts.

    const CANVAS_URL = 'https://PROJECT_ID.web.app';

  3. Führen Sie im Verzeichnis interactive-canvas-sample/sdk/ folgenden Befehl aus: , um die lokale Version Ihres Actions-Projekts per Push-Befehl an die Konsole zu übertragen, Entwurf:

    gactions push

  4. Führen Sie im Verzeichnis interactive-canvas-sample/sdk/ folgenden Befehl aus: verwenden, um Ihr Actions-Projekt im Simulator zu testen:

    gactions deploy preview

  5. Öffnen Sie den Link, den das Befehlszeilentool zurückgibt, um zum Simulator zu gelangen.

  6. Geben Sie im Simulator "Talk to Interactive canvas sample" ein, um die Aktion zu starten. Ich sollte ein sich drehendes Dreieck von der Web-App zu sehen sein, die unter https://PROJECT_ID.web.app

    <ph type="x-smartling-placeholder">
    </ph>
    Abbildung 1: Der Simulator mit der Vorschau des Actions-Projekts