Guía de inicio rápido del SDK de Actions y el Builder

En esta guía, se explica cómo configurar tu entorno para crear acciones con el SDK de Actions y con Actions Builder. Realizarás las siguientes tareas:

  • Instala Node.js: Necesitas este entorno de ejecución para usar nuestra biblioteca de entregas de Node.js.
  • Instala Firebase CLI: Esta herramienta de línea de comandos te permite desarrollar e implementar dependencias de Firebase, como las apps web para Interactive Canvas, en Firebase Hosting.
  • Instala la herramienta de línea de comandos de gactions: Cuando desarrollas con el SDK de Actions, usas esta herramienta para crear, administrar y también implementar el paquete de acciones para tu Acción.
  • Crea un proyecto de Acciones: Un proyecto de Actions es el contenedor lógico de tus acciones de conversación. Debes crear una en la Consola de Actions antes de comenzar a compilar.
  • Inicializa e implementa una muestra: En este ejemplo simple, se muestra cómo comenzar a compilar acciones con la tecnología de Interactive Canvas.

Una vez que completes esta guía de inicio rápido, podrás sincronizar tu proyecto de Actions entre tu entorno de desarrollo local y la experiencia web de Actions Builder.

Instala Node.js y Firebase CLI

Descarga y, luego, instala Node.js de acuerdo con la documentación de Node.js para usar nuestra biblioteca de entregas. La instalación de Node.js también te permite instalar Firebase CLI con npm y, luego, ejecutar la implementación de entrega conversacional de forma local.

Instala y configura Firebase CLI de acuerdo con la documentación de Firebase. Firebase CLI te permite implementar una app web de Interactive Canvas en Firebase Hosting y, si es necesario, implementar manualmente las entregas en Cloud Functions para Firebase.

Cómo instalar la herramienta de línea de comandos de gactions

Para instalar la herramienta de la interfaz de línea de comandos (CLI) de gactions, descarga un paquete de instalación, descomprímelo y configura la ruta de ejecución.

Para instalar y configurar gactions, sigue estos pasos:

  1. Descarga el paquete adecuado para tu sistema operativo:

    Plataforma Paquete Suma de comprobación
    Windows Descargar SHA256
    Linux Descargar SHA256
    macOS Descargar SHA256
  2. Extrae el paquete en la ubicación que desees y agrega el objeto binario a la variable PATH de tu entorno. Como alternativa, extrae el paquete en una ubicación que ya esté en tu variable PATH (por ejemplo, /usr/local/bin).

  3. En Linux y Mac, habilita los permisos de ejecución si es necesario:

    chmod +x PATH_TO/gactions
  4. Ejecuta el siguiente comando para autenticar la CLI. Este comando inicia un flujo de autenticación y requiere un navegador web:

    gactions login

    Cuando se completa el flujo, la CLI se autentica automáticamente.

Crea y configura un proyecto

Para poder usar la herramienta de línea de comandos de gactions, debes crear un proyecto en la Consola de Actions y otorgarle a gactions acceso al proyecto. Para crear y configurar un proyecto, haz lo siguiente:

  1. Ve a la Consola de Actions.
  2. Haz clic en Proyecto nuevo, ingresa un nombre y haz clic en Crear proyecto.
  3. Selecciona una categoría y haz clic en Siguiente.
  4. Selecciona Blank project y haz clic en Start building.
  5. Para habilitar la API de Actions en la consola de Google Cloud, sigue las instrucciones que se indican en Inhabilita y habilita las APIs. Esto permite que las gactions interactúen con tu proyecto.

Obtén la muestra de Hello World

En el ejemplo interactivo de Hello World, se muestra cómo compilar un proyecto de acciones simple con una sola acción con la tecnología de Interactive Canvas.

  1. Crea un directorio vacío y, luego, inicializa la muestra de Interactive Canvas en ese directorio. Por ejemplo, el siguiente código inicializa la muestra en un directorio interactive-canvas-sample/, que se usa como ejemplo en todo este documento:

    gactions init interactive-canvas --dest interactive-canvas-sample
    cd interactive-canvas-sample
    
  2. Abre el archivo interactive-canvas-sample/sdk/settings/settings.yaml y cambia el valor del campo projectId por el ID de tu proyecto.

Implementa y prueba la muestra

Después de configurar la muestra, puedes implementar la app web de Interactive Canvas y tu proyecto de Acciones. Este proceso crea una versión de borrador de tu proyecto de Acciones que puedes implementar en el simulador de Actions para obtener una vista previa y realizar pruebas:

  1. Desde el directorio interactive-canvas-sample/, ejecuta el siguiente comando para implementar la aplicación web de Interactive Canvas (el contenido del directorio public/).

    firebase deploy --project PROJECT_ID --only hosting
    

    Puedes ver una versión renderizada de la aplicación web en la URL que muestra Firebase CLI en un navegador: https://PROJECT_ID.web.app.

  2. Abre el archivo interactive-canvas-sample/sdk/webhooks/ActionsOnGoogleFulfillment/index.js y cambia el valor de la variable CANVAS_URL por la URL de la app web de tu proyecto.

    const CANVAS_URL = 'https://PROJECT_ID.web.app';
    
  3. Desde el directorio interactive-canvas-sample/sdk/, ejecuta el siguiente comando para enviar la versión local de tu proyecto de acciones a la consola como una versión de borrador:

    gactions push
    
  4. Desde el directorio interactive-canvas-sample/sdk/, ejecuta el siguiente comando para probar tu proyecto de acciones en el simulador:

    gactions deploy preview
    
  5. Abre el vínculo que devuelve la herramienta de línea de comandos para ir al simulador.

  6. En el simulador, ingresa "Talk to Interactive canvas sample" para iniciar la acción. Deberías ver un triángulo giratorio con tecnología de la app web implementada en https://PROJECT_ID.web.app

    Figura 1: Vista previa del simulador del proyecto de Actions