Guia de início rápido do SDK do Actions e do Builder

Veja neste guia como configurar seu ambiente para criar ações usando o SDK do Actions e o Actions Builder. Você realizará as seguintes tarefas:

  • Instalar o Node.js: você precisa desse ambiente de execução para usar nossa biblioteca de fulfillment do Node.js.
  • Instalar a Firebase CLI: essa ferramenta de linha de comando permite desenvolver e implantar dependências do Firebase, como apps da Web para Tela interativa, no Firebase Hosting.
  • Instalar a ferramenta de linha de comando gactions:ao desenvolver com o SDK do Actions, você usa essa ferramenta para criar, gerenciar e implantar o pacote de ações para sua ação.
  • Criar um projeto do Actions:um projeto do Actions é o contêiner lógico das ações de conversa. É necessário criar uma no Console do Actions antes de começar a criar.
  • Inicializar e implantar uma amostra: esta amostra simples mostra como começar a criar ações com tecnologia de tela interativa.

Depois de concluir este início rápido, sincronize seu projeto do Actions entre o ambiente de desenvolvimento local e a experiência na Web do Actions Builder.

Instalar o Node.js e a Firebase CLI

Faça o download e instale o Node.js de acordo com a documentação do Node.js para usar nossa biblioteca de fulfillment. A instalação do Node.js também permite que você instale a Firebase CLI com npm e depois para executar a implementação do fulfillment de conversa localmente.

Instale e configure a Firebase CLI de acordo com a documentação do Firebase. A CLI do Firebase permite implantar um app da Web de tela interativa no Firebase Hosting e, se necessário, implantar manualmente o fulfillment no Cloud Functions para Firebase.

Instalar a ferramenta de linha de comando gactions

Para instalar a ferramenta de interface de linha de comando (CLI) gactions, faça o download de um pacote de instalação, descompacte-o e configure o caminho de execução.

Para instalar e configurar gactions, siga estas etapas:

  1. Faça o download do pacote apropriado para seu sistema operacional:

    Plataforma Pacote Soma de verificação
    Windows Fazer download SHA256 (link em inglês)
    Linux Fazer download SHA256 (link em inglês)
    Mac OS Fazer download SHA256 (link em inglês)

  2. Extraia o pacote em um local de sua escolha e adicione o binário à variável PATH do ambiente. Como alternativa, extraia o pacote para um local que já esteja na variável PATH (por exemplo, /usr/local/bin).

  3. No Linux e no Mac, ative as permissões de execução, se necessário:

    chmod +x PATH_TO/gactions

  4. Execute o seguinte comando para autenticar a CLI. Este comando inicia um fluxo de autenticação e requer um navegador da Web:

    gactions login

    Quando o fluxo é concluído, a CLI é autenticada automaticamente.

Criar e configurar um projeto

Antes de usar a ferramenta de linha de comando gactions, crie um projeto no Console do Actions e conceda a ele o acesso para ele. Para criar e configurar um projeto, faça o seguinte:

  1. Acesse o console do Actions.
  2. Clique em Novo projeto, insira um nome e clique em Criar projeto.
  3. Selecione uma categoria e clique em Próxima.
  4. Selecione Projeto em branco e clique em Começar a criar.
  5. Ative a API Actions no Console do Google Cloud seguindo as instruções em Ativar e desativar APIs. Isso permite que os gactions interajam com seu projeto.

Veja a amostra "Hello World"

A amostra interativa "Hello World" mostra como criar um projeto simples do Actions com uma única ação com a tecnologia da tela interativa.

  1. Crie um diretório vazio e inicialize o exemplo da tela interativa nesse diretório. Por exemplo, o código a seguir inicializa a amostra em um diretório interactive-canvas-sample/, que é usado como exemplo em todo este documento:

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

  2. Abra o arquivo interactive-canvas-sample/sdk/settings/settings.yaml e altere o valor do campo projectId para o ID do projeto.

Implantar e testar a amostra

Depois de configurar a amostra, implante o app da Web da tela interativa e o projeto do Actions. Esse processo cria uma versão de rascunho do projeto que pode ser implantada no simulador do Actions para visualização e teste:

  1. No diretório interactive-canvas-sample/, execute o seguinte comando para implantar o app da Web de tela interativa (o conteúdo do diretório public/).

    firebase deploy --project PROJECT_ID --only hosting

    É possível ver uma versão renderizada do app da Web no URL retornado pela CLI do Firebase em um navegador: https://PROJECT_ID.web.app.

  2. Abra o arquivo interactive-canvas-sample/sdk/webhooks/ActionsOnGoogleFulfillment/index.js e altere o valor da variável CANVAS_URL para o URL do app da Web do projeto.

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

  3. No diretório interactive-canvas-sample/sdk/, execute o seguinte comando para enviar a versão local do seu projeto do Actions para o console como uma versão de rascunho:

    gactions push

  4. No diretório interactive-canvas-sample/sdk/, execute o seguinte comando para testar seu projeto do Actions no simulador:

    gactions deploy preview

  5. Abra o link que a ferramenta de linha de comando retorna para acessar o simulador.

  6. No simulador, digite Talk to Interactive Canvas sample para iniciar a ação. Você verá um triângulo giratório com a tecnologia do app da Web implantado em https://PROJECT_ID.web.app

    Figura 1. O simulador do projeto do Actions