Actions SDK 和建構工具快速入門指南

本指南將逐步引導您使用 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) 工具。

如要安裝及設定回應,請按照下列步驟操作:

  1. 下載適用於您作業系統的套件:

    平台 套件 檢查碼
    Windows 下載 SHA256
    Linux 下載 SHA256
    Mac 作業系統 下載 SHA256
  2. 將套件擷取至您選擇的位置,並將二進位檔新增至環境的 PATH 變數。或者,您也可以將套件擷取至 PATH 變數中的現有位置 (例如 /usr/local/bin)。

  3. 在 Linux 和 Mac 上,視需要啟用執行權限:

    chmod +x PATH_TO/gactions
  4. 執行下列指令來驗證 CLI。這個指令會啟動驗證流程,且需要網路瀏覽器:

    gactions login

    流程完成後,CLI 會自動進行驗證。

建立及設定專案

您必須先在「Actions」(動作) 控制台中建立專案,並授予專案回應存取權,才能使用 gactions 指令列工具。如要建立並設定專案,請按照下列步驟操作:

  1. 前往動作控制台
  2. 按一下「新專案」並輸入專案名稱,然後按一下「建立專案」
  3. 選取類別,然後點選「下一步」
  4. 選取「空白專案」,然後按一下「開始建構」
  5. 按照啟用及停用 API 中的操作說明,在 Google Cloud 控制台中啟用 Actions API。這樣一來,回應就會與您的專案互動。

取得「Hello World」範例

hello world 互動式範例說明如何透過以互動式畫布技術為基礎的單一動作建構簡單的動作專案。

  1. 建立空白目錄,並初始化該目錄中的互動式畫布範例。舉例來說,以下程式碼會初始化 interactive-canvas-sample/ 目錄中的範例,做為本文件中的範例:

    gactions init interactive-canvas --dest interactive-canvas-sample
    cd interactive-canvas-sample
    
  2. 開啟 interactive-canvas-sample/sdk/settings/settings.yaml 檔案,並將 projectId 欄位的值變更為專案 ID。

部署及測試範例

設定範例後,您可以部署互動式畫布網頁應用程式和動作專案。這項程序會建立動作專案的草稿版本,以便部署至動作模擬工具,以便預覽和測試:

  1. interactive-canvas-sample/ 目錄中執行下列指令,部署互動式畫布網頁應用程式 (public/ 目錄的內容)。

    firebase deploy --project PROJECT_ID --only hosting
    

    在瀏覽器中,您可以透過 Firebase CLI 傳回的網址查看轉譯版網頁應用程式:https://PROJECT_ID.web.app

  2. 開啟 interactive-canvas-sample/sdk/webhooks/ActionsOnGoogleFulfillment/index.js 檔案,並將 CANVAS_URL 變數的值變更為專案的網頁應用程式網址。

    const CANVAS_URL = 'https://PROJECT_ID.web.app';
    
  3. interactive-canvas-sample/sdk/ 目錄中執行下列指令,以草稿版本將動作專案的本機版本推送至主控台:

    gactions push
    
  4. interactive-canvas-sample/sdk/ 目錄中執行下列指令,在模擬器中測試 Actions 專案:

    gactions deploy preview
    
  5. 開啟指令列工具後傳回的連結,點選模擬工具。

  6. 在模擬工具中輸入 "Talk to Interactive canvas sample",開始執行動作。您應該會看到一個旋轉的三角形,其技術為部署於 https://PROJECT_ID.web.app 的網頁應用程式

    圖 1. 模擬工具預覽動作專案