Kurzanleitung für Actions SDK und Builder

In dieser Anleitung wird beschrieben, wie Sie Ihre Umgebung einrichten, um Aktionen mit dem Actions SDK und Actions Builder zu erstellen. Sie führen die folgenden Aufgaben aus:

  • Node.js installieren:Sie benötigen diese Laufzeitumgebung, um unsere Node.js-Auftragsausführungsbibliothek verwenden zu können.
  • Firebase CLI installieren: Mit diesem Befehlszeilentool können Sie Firebase-Abhängigkeiten entwickeln und in Firebase Hosting bereitstellen, z. B. Webanwendungen für Interactive Canvas.
  • Befehlszeilentool gactions installieren:Beim Entwickeln mit dem Actions SDK kannst du dieses Tool verwenden, um das Aktionspaket für deine Aktion zu erstellen, zu verwalten und bereitzustellen.
  • Actions-Projekt erstellen:Ein Actions-Projekt ist der logische Container für Ihre Konversationsaktionen. Sie müssen in der Actions Console eine Aktion erstellen, bevor Sie mit dem Erstellen beginnen können.
  • Beispiel initialisieren und bereitstellen:Dieses einfache Beispiel zeigt Ihnen die ersten Schritte zum Erstellen von Aktionen auf Basis von Interactive Canvas.

Nachdem Sie diesen Schnellstart abgeschlossen haben, können Sie Ihr Actions-Projekt zwischen Ihrer lokalen Entwicklungsumgebung und der Weboberfläche von Actions Builder synchronisieren.

Node.js und Firebase CLI installieren

Laden Sie Node.js gemäß der Node.js-Dokumentation herunter und installieren Sie es, um unsere Auftragsausführungsbibliothek zu verwenden. Mit der Installation von Node.js können Sie auch die Firebase CLI mit npm und höher installieren, um die Implementierung der dialogorientierten Auftragsausführung lokal auszuführen.

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

gactions-Befehlszeilentool installieren

Installieren Sie das Befehlszeilen-Tool gactions. Laden Sie dazu ein Installationspaket herunter, entpacken Sie es und konfigurieren Sie den Ausführungspfad.

So installieren und konfigurieren Sie Sitelinks:

  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 die Binärdatei in die PATH-Variable Ihrer Umgebung ein. Alternativ können Sie das Paket an einen Speicherort extrahieren, der sich bereits in der PATH-Variable befindet (z. B. /usr/local/bin).

  3. Aktivieren Sie unter Linux und Mac bei Bedarf die 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, wird die Befehlszeile automatisch authentifiziert.

Projekt erstellen und einrichten

Bevor Sie das gactions-Befehlszeilentool verwenden können, müssen Sie ein Projekt in der Actions Console erstellen und gactions Zugriff darauf gewähren. So erstellen und richten Sie ein Projekt ein:

  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 Mit der Erstellung beginnen.
  5. Aktivieren Sie die Actions API in der Google Cloud Console. Folgen Sie dazu der Anleitung unter APIs aktivieren und deaktivieren. Dies ermöglicht es gactions, mit deinem Projekt zu interagieren.

Hello World-Beispiel abrufen

Das interaktive „Hello World“-Beispiel zeigt Ihnen, wie Sie ein einfaches Actions-Projekt mit einer einzigen Aktion auf Grundlage von Interactive Canvas erstellen.

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

    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 Feldes projectId in Ihre Projekt-ID.

Beispiel bereitstellen und testen

Nachdem Sie das Beispiel eingerichtet haben, können Sie die Interactive Canvas-Webanwendung und Ihr Actions-Projekt bereitstellen. Dabei wird ein Entwurf Ihres Actions-Projekts erstellt, den Sie im Actions-Simulator für die Vorschau und zum Testen bereitstellen können:

  1. Führen Sie im Verzeichnis interactive-canvas-sample/ den folgenden Befehl aus, um die Interactive Canvas-Webanwendung (den Inhalt des Verzeichnisses public/) bereitzustellen.

    firebase deploy --project PROJECT_ID --only hosting
    

    Sie können eine gerenderte Version der Webanwendung unter der URL sehen, die von der Firebase CLI in einem Browser zurückgegeben wird: 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/ den folgenden Befehl aus, um die lokale Version Ihres Actions-Projekts als Entwurfsversion an die Console zu übertragen:

    gactions push
    
  4. Führen Sie im Verzeichnis interactive-canvas-sample/sdk/ den folgenden Befehl aus, 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. Es sollte ein sich drehendes Dreieck zu sehen sein, das von der unter https://PROJECT_ID.web.app bereitgestellten Web-App bereitgestellt wird.

    Abbildung 1: Der Simulator, der eine Vorschau des Actions-Projekts anzeigt