Krótki przewodnik po pakiecie Actions SDK i Kreatorze
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Z tego przewodnika dowiesz się, jak skonfigurować środowisko do tworzenia akcji za pomocą
SDK Actions i Actions Builder. Wykonasz te zadania:
Zainstaluj Node.js: aby korzystać ze środowiska Node.js, musisz mieć to środowisko wykonawcze.
w bibliotece realizacji zamówień.
Zainstaluj interfejs wiersza poleceń Firebase: to narzędzie wiersza poleceń pozwala tworzyć
wdrażanie zależności Firebase, takich jak aplikacje internetowe, na potrzeby interaktywnego obszaru roboczego,
Hosting Firebase.
Instalowanie narzędzia wiersza poleceń gactions: podczas programowania za pomocą polecenia Actions
SDK, za pomocą tego narzędzia możesz tworzyć i wdrażać pakiet akcji dla
akcję.
Tworzenie projektu w Actions:projekt w Actions jest kontenerem logicznym.
dotyczące akcji konwersacyjnych. Musisz je utworzyć w Konsoli Actions, zanim
mogą zacząć tworzyć.
Zainicjuj i wdróż przykład: ten prosty przykład pokazuje, jak
rozpoczął tworzenie akcji opartych na Interaktywnej Canvas.
Gdy wykonasz ten krótki przewodnik, możesz zsynchronizować swój projekt w Actions między
lokalnego środowiska programistycznego i środowiska internetowego Actions Builder.
Instalowanie Node.js i interfejsu wiersza poleceń Firebase
Pobierz i zainstaluj Node.js zgodnie z Node.js
dokumentacji do korzystania z naszej biblioteki realizacji zamówień. Również Twoja instalacja środowiska Node.js
pozwala zainstalować interfejs wiersza poleceń Firebase za pomocą npm, a później uruchamiać
lokalnej implementacji realizacji konwersacyjnej.
Zainstaluj i skonfiguruj interfejs wiersza poleceń Firebase zgodnie z wymaganiami
do dokumentacji Firebase. Interfejs wiersza poleceń Firebase pozwala wdrożyć
aplikację internetową Canvas w Hostingu Firebase i w razie potrzeby wdrożyć ją ręcznie;
do Cloud Functions dla Firebase.
Instalowanie narzędzia wiersza poleceń Gactions
Zainstaluj narzędzie interfejsu wiersza poleceń Gactions, pobierając
pakietu instalacyjnego, rozpakowania go i skonfigurowania ścieżki wykonywania.
Aby zainstalować i skonfigurować interakcje, wykonaj te czynności:
Pobierz pakiet odpowiedni dla swojego systemu operacyjnego:
Rozpakuj pakiet do wybranej lokalizacji i dodaj plik binarny do
w zmiennej PATH środowiska. Możesz też rozpakować pakiet do
lokalizacja, która znajduje się już w zmiennej PATH (np. /usr/local/bin).
W systemach Linux i Mac włącz uprawnienia do uruchamiania, jeśli to konieczne:
chmod +x PATH_TO/gactions
Uruchom to polecenie, aby uwierzytelnić interfejs wiersza poleceń. To polecenie
uruchamia proces uwierzytelniania i wymaga przeglądarki:
gactions login
Po zakończeniu procesu interfejs wiersza poleceń uwierzytelnia się automatycznie.
Tworzenie i konfigurowanie projektu
Zanim zaczniesz korzystać z narzędzia wiersza poleceń frakcji, musisz utworzyć projekt w
w Konsoli Actions i przyznaj gakcjom dostęp do projektu. Aby utworzyć i ustawić
utwórz projekt, wykonaj te czynności:
Kliknij New project (Nowy projekt), wpisz nazwę projektu i kliknij Create project (Utwórz projekt).
Wybierz kategorię i kliknij Dalej.
Wybierz Pusty projekt i kliknij Rozpocznij tworzenie.
Włącz Actions API w konsoli Google Cloud przez wykonanie tych czynności
instrukcje znajdziesz w sekcji Włączanie i wyłączanie
interfejsów API.
Dzięki temu ułamki mogą wchodzić w interakcję z Twoim projektem.
Pobierz próbkę ze świata Hello World
Interaktywny przykład gry Hello World pokazuje, jak utworzyć proste akcje
za pomocą jednej akcji korzystającej z platformy Interactive Canvas.
Utwórz pusty katalog i zainicjuj przykładowy obszar interaktywny
do tego katalogu. Na przykład ten kod inicjuje przykład w pliku
interactive-canvas-sample/, używany jako przykład
w tym dokumencie:
Otwórz plik interactive-canvas-sample/sdk/settings/settings.yaml i
zmień wartość pola projectId na identyfikator Twojego projektu.
Wdrażanie i testowanie przykładu
Po skonfigurowaniu przykładu możesz wdrożyć aplikację internetową Interactive Canvas
w projekcie Actions. Ten proces spowoduje utworzenie wersji roboczej działań.
projekt, który możesz wdrożyć w Actions Simulator (Symulatorze Actions) na potrzeby wyświetlania podglądu i testowania:
W katalogu interactive-canvas-sample/ uruchom to polecenie
aby wdrożyć aplikację internetową Interactive Canvas (zawartość public/
).
Możesz zobaczyć wyrenderowaną wersję aplikacji internetowej pod adresem URL zwróconym przez funkcję
Interfejs wiersza poleceń Firebase w przeglądarce:
https://PROJECT_ID.web.app
Otwórz plik interactive-canvas-sample/sdk/webhooks/ActionsOnGoogleFulfillment/index.js i
zmień wartość zmiennej CANVAS_URL na adres URL aplikacji internetowej Twojego projektu.
const CANVAS_URL = 'https://PROJECT_ID.web.app';
W katalogu interactive-canvas-sample/sdk/ uruchom następujące polecenie
aby przekazać lokalną wersję projektu Actions do konsoli jako
wersja robocza:
gactions push
W katalogu interactive-canvas-sample/sdk/ uruchom następujące polecenie
aby przetestować projekt Actions w symulatorze:
gactions deploy preview
Otwórz link zwrócony przez narzędzie wiersza poleceń, by przejść do symulatora.
W symulatorze wpisz "Talk to Interactive Canvas sample", aby uruchomić działanie. Ty
zobaczysz obracający się trójkąt zasilany przez aplikację internetową
https://PROJECT_ID.web.app
Rysunek 1. Symulator wyświetlający podgląd projektu Actions.
[null,null,["Ostatnia aktualizacja: 2025-07-26 UTC."],[[["\u003cp\u003eThis guide helps you set up your environment for building Google Actions using the Actions SDK and Actions Builder.\u003c/p\u003e\n"],["\u003cp\u003eYou'll install necessary tools like Node.js, Firebase CLI, and the \u003ccode\u003egactions\u003c/code\u003e command-line tool.\u003c/p\u003e\n"],["\u003cp\u003eThe guide includes steps to create an Actions project, initialize a sample, and deploy it for testing in the Actions simulator.\u003c/p\u003e\n"],["\u003cp\u003eYou'll learn to deploy the Interactive Canvas web app to Firebase Hosting and push your local Actions project to the console.\u003c/p\u003e\n"],["\u003cp\u003eAfter completing the setup, you can preview and test your Action in the Actions simulator by invoking it with a specific phrase.\u003c/p\u003e\n"]]],["To set up for building Actions, install Node.js and the Firebase CLI for fulfillment and web app deployment. Install the `gactions` CLI by downloading and configuring the appropriate package, then authenticate using `gactions login`. In the Actions console, create a new project, enable the Actions API, and use `gactions init` to set up the Interactive Canvas sample. Deploy the web app with `firebase deploy`, update the `CANVAS_URL` and push the Action using `gactions push`. Finally, preview and test the action in the simulator using `gactions deploy preview`.\n"],null,["# Actions SDK and Builder quick start guide\n\nThis guide walks you through setting up your environment to build Actions using\nboth the Actions SDK and Actions Builder. You'll carry out the following tasks:\n\n- **Install Node.js:** You need this runtime environment to use our Node.js fulfillment library.\n- **Install the Firebase CLI:** This command-line tool lets you develop and deploy Firebase dependencies, such as web apps for [Interactive Canvas](/assistant/interactivecanvas), to Firebase Hosting.\n- **Install the gactions command-line tool:** When developing with the Actions SDK, you use this tool to create, manage, and deploy the Action package for your Action.\n- **Create an Actions project:** An [Actions project](/assistant/conversational/build/projects) is the logical container for your Conversational Actions. You have to create one in the Actions console before you can start building.\n- **Initialize and deploy a sample:** This simple sample shows you how to get started building Actions powered by Interactive Canvas.\n\nOnce you complete this quick start, you can sync your Actions project between\nyour local development environment and the web experience of Actions Builder.\n\nInstall Node.js and the Firebase CLI\n------------------------------------\n\nDownload and install [Node.js](https://nodejs.org/) according to the Node.js\ndocumentation to use our fulfillment library. Your installation of Node.js also\nallows you to install the Firebase CLI with [npm](https://www.npmjs.com/), and later, to run your\nconversational fulfillment implementation locally.\n\nInstall and set up the [Firebase CLI](https://firebase.google.com/docs/cli#setup_update_cli) according\nto the Firebase documentation. The Firebase CLI lets you deploy an Interactive\nCanvas web app to Firebase Hosting and, if necessary, manually deploy\nfulfillment to Cloud Functions for Firebase.\n\nInstall the gactions command-line tool\n--------------------------------------\n\nInstall the gactions command line interface (CLI) tool by downloading an\ninstallation package, unpacking it, and configuring your execution path.\n\nTo install and configure gactions, follow these steps:\n\n1. Download the appropriate package for your operating system:\n\n | Platform | Package | Checksum |\n |----------|----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|\n | Windows | [Download](https://dl.google.com/gactions/v3/release/gactions-sdk_windows.zip) | [SHA256](https://dl.google.com/gactions/v3/release/gactions-sdk_windows.zip.sha256) |\n | Linux | [Download](https://dl.google.com/gactions/v3/release/gactions-sdk_linux.tar.gz) | [SHA256](https://dl.google.com/gactions/v3/release/gactions-sdk_linux.tar.gz.sha256) |\n | Mac OS | [Download](https://dl.google.com/gactions/v3/release/gactions-sdk_darwin.tar.gz) | [SHA256](https://dl.google.com/gactions/v3/release/gactions-sdk_darwin.tar.gz.sha256) |\n\n2. Extract the package to a location of your choice and add the binary to your\n environment's `PATH` variable. Alternatively, extract the package to a\n location that's already in your `PATH` variable (for example, `/usr/local/bin`).\n\n3. On Linux and Mac, enable execute permissions if necessary:\n\n ```scdoc\n chmod +x PATH_TO/gactions\n ```\n4. Run the following command to authenticate the CLI. This command\n starts an authentication flow and requires a web browser:\n\n ```text\n gactions login\n ```\n\n When the flow is complete, the CLI automatically authenticates.\n\nCreate and set up a project\n---------------------------\n\n| **Note:** Actions project creation is not supported in the gactions CLI.\n\nBefore you can use the gactions command-line tool, you must create a project in\nthe Actions console and give gactions access to the project. To create and set\nup a project, do the following:\n\n1. Go to the [Actions console](https://console.actions.google.com).\n2. Click **New project** , enter a project name, and click **Create project**.\n3. Select a category and click **Next**.\n4. Select **Blank project** and click **Start building**.\n5. Enable the **Actions API** in the Google Cloud console by following the instructions in [Enable and disable\n APIs](https://support.google.com/googleapi/answer/6158841). This allows gactions to interact with your project.\n\nGet the hello world sample\n--------------------------\n\nThe hello world interactive sample shows you how to build a simple Actions\nproject with a single Action powered by Interactive Canvas.\n\n1. Create an empty directory and initialize the Interactive Canvas sample in\n that directory. For example, the following code initializes the sample in an\n `interactive-canvas-sample/` directory, which is used as an example\n throughout this document:\n\n gactions init interactive-canvas --dest interactive-canvas-sample\n cd interactive-canvas-sample\n\n2. Open the `interactive-canvas-sample/sdk/settings/settings.yaml` file and\n change the value of the `projectId` field to your project's ID.\n\n | **Note:** To get your project's ID, first open your project in the Actions console and click the more *more_vert* icon. Then, select **Project settings** and copy the string in the **Project ID** field.\n\nDeploy and test the sample\n--------------------------\n\nAfter you set up the sample, you can deploy the Interactive Canvas web app and\nyour Actions project. This process creates a draft version of your Actions\nproject that you can deploy to the Actions simulator for previewing and testing:\n\n1. From the `interactive-canvas-sample/` directory, run the following command\n to deploy the Interactive Canvas web app (the contents of the `public/`\n directory).\n\n firebase deploy --project \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e --only hosting\n\n You can see a rendered version of the web app at the URL returned by the\n Firebase CLI in a browser:\n `https://`\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`.web.app`.\n2. Open the `interactive-canvas-sample/sdk/webhooks/ActionsOnGoogleFulfillment/index.js` file and\n change the value of the `CANVAS_URL` variable to your project's web app URL.\n\n const CANVAS_URL = 'https://\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e.web.app';\n\n3. From the `interactive-canvas-sample/sdk/` directory, run the following\n command to push the local version of your Actions project to the console as a\n draft version:\n\n gactions push\n\n | **Note:** You'll see some warnings related to not having some project settings and resources defined. You can safely ignore them or now.\n4. From the `interactive-canvas-sample/sdk/` directory, run the following\n command to test your Actions project in the simulator:\n\n gactions deploy preview\n\n | **Note:** If you are using a new project, you need to enable the [Cloud Functions\n | API](https://console.cloud.google.com/apis/library/cloudfunctions.googleapis.com) and associate a billing account with your project in Google Cloud. You can enable the Cloud Functions API by visiting the [Cloud Console](https://console.cloud.google.com/billing).\n5. Open the link that the command-line tool returns to go to the simulator.\n\n6. In the simulator, enter *\"Talk to Interactive canvas sample\"* to start the Action. You\n should see a spinning triangle powered by the web app deployed at\n `https://`\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`.web.app`\n\n **Figure 1**. The simulator previewing the Actions project"]]
