Guida rapida all'SDK di Actions e a Builder

Questa guida illustra come configurare il tuo ambiente per creare azioni utilizzando sia l'SDK Actions che Actions Builder. Dovrai eseguire le seguenti attività:

  • Installa Node.js: devi avere questo ambiente di runtime per utilizzare la nostra libreria di fulfillment Node.js.
  • Installa l'interfaccia a riga di comando di Firebase: questo strumento a riga di comando consente di sviluppare ed eseguire il deployment di dipendenze di Firebase, come le app web per Interactive Canvas, in Firebase Hosting.
  • Installa lo strumento a riga di comando gactions: quando sviluppi con l'SDK Actions, utilizza questo strumento per creare, gestire ed eseguire il deployment del pacchetto Azione per l'Azione.
  • Crea un progetto Actions: un progetto Actions è il container logico per le tue azioni conversazionali. Devi crearne uno nella console di Actions prima di iniziare.
  • Inizializza ed esegui il deployment di un esempio: questo semplice esempio mostra come iniziare a creare azioni basate su Interactive Canvas.

Una volta completata questa guida rapida, puoi sincronizzare il tuo progetto Actions tra il tuo ambiente di sviluppo locale e l'esperienza web di Actions Builder.

Installa Node.js e l'interfaccia a riga di comando di Firebase

Scarica e installa Node.js in base alla documentazione di Node.js per utilizzare la nostra libreria di fulfillment. L'installazione di Node.js ti consente inoltre di installare l'interfaccia a riga di comando di Firebase con npm e, in seguito, di eseguire l'implementazione del fulfillment conversazionale localmente.

Installa e configura l'interfaccia a riga di comando di Firebase in base alla documentazione di Firebase. L'interfaccia a riga di comando di Firebase ti consente di eseguire il deployment di un'app web Interactive Canvas in Firebase Hosting e, se necessario, di eseguire manualmente il deployment del fulfillment in Cloud Functions for Firebase.

Installare lo strumento a riga di comando gactions

Installa lo strumento di interfaccia a riga di comando (CLI) gactions scaricando un pacchetto di installazione, decomprimendolo e configurando il percorso di esecuzione.

Per installare e configurare le azioni, procedi nel seguente modo:

  1. Scarica il pacchetto appropriato per il tuo sistema operativo:

    Piattaforma Package Checksum
    Windows Scarica SHA256
    Linux Scarica SHA256
    Sistema operativo Mac Scarica SHA256
  2. Estrai il pacchetto nella posizione che preferisci e aggiungi il programma binario alla variabile PATH del tuo ambiente. In alternativa, estrai il pacchetto in una posizione già presente nella variabile PATH (ad esempio, /usr/local/bin).

  3. Su Linux e Mac, abilita le autorizzazioni di esecuzione se necessario:

    chmod +x PATH_TO/gactions
  4. Esegui questo comando per autenticare l'interfaccia a riga di comando. Questo comando avvia un flusso di autenticazione e richiede un browser web:

    gactions login

    Al termine del flusso, l'interfaccia a riga di comando esegue automaticamente l'autenticazione.

Creare e configurare un progetto

Prima di poter utilizzare lo strumento a riga di comando gactions, devi creare un progetto nella console di Actions e concedere l'accesso alle azioni al progetto. Per creare e configurare un progetto, segui questi passaggi:

  1. Vai alla Console di Actions.
  2. Fai clic su Nuovo progetto, inserisci un nome per il progetto e fai clic su Crea progetto.
  3. Seleziona una categoria e fai clic su Avanti.
  4. Seleziona Progetto vuoto e fai clic su Inizia a creare.
  5. Abilita l'API Actions nella console Google Cloud seguendo le istruzioni riportate in Abilitare e disabilitare le API. In questo modo le gactions possono interagire con il tuo progetto.

Scaricare l'anteprima di Hello World

L'esempio interattivo di Hello World mostra come creare un semplice progetto Actions con un'unica azione basata su Interactive Canvas.

  1. Crea una directory vuota e inizializza l'esempio di Interactive Canvas nella directory. Ad esempio, il codice seguente inizializza l'esempio in una directory interactive-canvas-sample/, che viene utilizzata come esempio in questo documento:

    gactions init interactive-canvas --dest interactive-canvas-sample
    cd interactive-canvas-sample
    
  2. Apri il file interactive-canvas-sample/sdk/settings/settings.yaml e modifica il valore del campo projectId impostandolo sull'ID del progetto.

Esegui il deployment e testa l'esempio

Dopo aver configurato l'esempio, puoi eseguire il deployment dell'app web Interactive Canvas e del progetto Actions. Questo processo crea una bozza del progetto Actions che puoi distribuire nel simulatore di Actions per visualizzare in anteprima e testare:

  1. Dalla directory interactive-canvas-sample/, esegui questo comando per eseguire il deployment dell'app web Interactive Canvas (i contenuti della directory public/).

    firebase deploy --project PROJECT_ID --only hosting
    

    Puoi visualizzare una versione sottoposta a rendering dell'app web all'URL restituito dall'interfaccia a riga di comando di Firebase in un browser: https://PROJECT_ID.web.app.

  2. Apri il file interactive-canvas-sample/sdk/webhooks/ActionsOnGoogleFulfillment/index.js e modifica il valore della variabile CANVAS_URL impostando l'URL dell'app web del progetto.

    const CANVAS_URL = 'https://PROJECT_ID.web.app';
    
  3. Dalla directory interactive-canvas-sample/sdk/, esegui questo comando per eseguire il push della versione locale del progetto Actions nella console come versione bozza:

    gactions push
    
  4. Dalla directory interactive-canvas-sample/sdk/, esegui questo comando per testare il tuo progetto Actions nel simulatore:

    gactions deploy preview
    
  5. Apri il link restituito dallo strumento a riga di comando per passare al simulatore.

  6. Nel simulatore, inserisci "Parla con esempio di canvas interattivo" per avviare l'azione. Dovresti vedere un triangolo rotante basato sull'app web di cui è stato eseguito il deployment https://PROJECT_ID.web.app

    Figura 1. Il simulatore che visualizza l'anteprima del progetto Actions