本指南將逐步引導您設定環境,以使用 Actions SDK 和 Actions Builder 建構動作。您將會執行下列工作:
- 安裝 Node.js:您需要這個執行階段環境才能使用我們的 Node.js 執行要求程式庫。
- 安裝 Firebase CLI:這項指令列工具可讓您開發及部署 Firebase 依附元件 (例如互動式畫布的網頁應用程式),並將其部署至 Firebase 託管。
- 安裝 gactions 指令列工具:使用 Actions SDK 進行開發時,請使用這項工具為動作建立、管理及部署動作套件。
- 建立動作專案:動作專案是對話動作的邏輯容器。您必須先在 Actions 主控台建立一個資料表,才能開始建構。
- 初始化及部署範例:這個簡易範例說明如何開始使用互動式畫布技術建構動作。
完成這項快速入門導覽課程後,您就能在本機開發環境和 Actions Builder 網頁版服務之間同步處理 Actions 專案。
安裝 Node.js 和 Firebase CLI
請根據 Node.js 說明文件下載並安裝 Node.js,以便使用執行要求資料庫。安裝 Node.js 也可讓您使用 npm 安裝 Firebase CLI,並在本機執行對話執行要求實作。
根據 Firebase 說明文件安裝及設定 Firebase CLI。Firebase CLI 可讓您將互動式 Canvas 網頁應用程式部署至 Firebase 託管。如有需要,可手動將執行要求部署至 Cloud Functions for Firebase。
安裝 gactions 指令列工具
請安裝安裝套件、解壓縮套件,並設定執行路徑,以便安裝 gactions 指令列介面 (CLI) 工具。
如要安裝和設定動作,請按照下列步驟操作:
下載適用您作業系統適用的套件:
平台 套件 檢查碼 Windows 下載 SHA256 Linux 下載 SHA256 Mac 作業系統 下載 SHA256 將套件擷取至您選擇的位置,並將二進位檔新增至環境的
PATH
變數。或者,將套件擷取到PATH
變數中現有的位置 (例如/usr/local/bin
)。在 Linux 和 Mac 上,視需要啟用執行權限:
chmod +x PATH_TO/gactions
執行下列指令來驗證 CLI。這個指令會啟動驗證程序,必須使用網路瀏覽器:
gactions login
流程完成後,CLI 會自動進行驗證。
建立及設定專案
您必須先在 Actions 主控台建立專案,並授予 Fact 存取專案的權限,才能使用 gactions 指令列工具。如要建立及設定專案,請按照下列步驟操作:
- 前往動作控制台。
- 按一下「新增專案」,輸入專案名稱,然後按一下「建立專案」。
- 選取類別,然後點選「下一步」。
- 選取「Blank project」,然後按一下「Start Building」。
- 按照啟用及停用 API 中的操作說明,在 Google Cloud 控制台中啟用 Actions API。這樣即可指定懸浮動作與專案互動。
取得 Hello World 範例
Hello World 互動範例示範如何使用單一互動式 Canvas 提供的單一動作,建構簡單的操作專案。
建立空白目錄,並初始化該目錄中的互動式 Canvas 範例。舉例來說,以下程式碼會在
interactive-canvas-sample/
目錄中初始化範例,這會在這份文件中做為範例:gactions init interactive-canvas --dest interactive-canvas-sample
cd interactive-canvas-sample
開啟
interactive-canvas-sample/sdk/settings/settings.yaml
檔案,並將projectId
欄位的值變更為專案的 ID。
部署及測試範例
設定範例後,即可部署互動式 Canvas 網頁應用程式和動作專案。此程序會建立 Actions 專案的草稿版本,您可以將其部署至 Actions 模擬器,以便預覽及測試:
在
interactive-canvas-sample/
目錄中,執行下列指令來部署互動式 Canvas 網頁應用程式 (public/
目錄的內容)。firebase deploy --project PROJECT_ID --only hosting
透過 Firebase CLI 傳回的網址,即可看到網頁應用程式的轉譯版本:
https://PROJECT_ID.web.app
。開啟
interactive-canvas-sample/sdk/webhooks/ActionsOnGoogleFulfillment/index.js
檔案,並將CANVAS_URL
變數的值變更為專案的網頁應用程式網址。const CANVAS_URL = 'https://PROJECT_ID.web.app';
在
interactive-canvas-sample/sdk/
目錄中執行下列指令,將 Actions 專案的本機版本以草稿版本推送至主控台:gactions push
在
interactive-canvas-sample/sdk/
目錄中,在模擬器中測試 Actions 專案:gactions deploy preview
開啟指令列工具返回模擬器的連結。
在模擬工具中輸入 "Talk to Interactive canvas sample",開始執行動作。您應該會看到一個已旋轉的三角形,如是由
https://PROJECT_ID.web.app
所部署的網頁應用程式所建構圖 1. 模擬器預覽動作專案