Actions SDK と Actions Builder のクイック スタートガイド

このガイドでは、Actions SDK と Actions Builder の両方を使用してアクションを構築するための環境をセットアップする手順について説明します。以下のタスクを行います。

  • Node.js をインストールする: Node.js フルフィルメント ライブラリを使用するには、このランタイム環境が必要です。
  • Firebase CLI をインストールする: このコマンドライン ツールを使用すると、インタラクティブ キャンバス用のウェブアプリなど、Firebase の依存関係を開発して Firebase Hosting にデプロイできます。
  • gactions コマンドライン ツールをインストールする: Actions SDK を使用して開発する場合、このツールを使用して、アクションのアクション パッケージを作成、管理、デプロイします。
  • アクション プロジェクトを作成する: アクション プロジェクトは会話型アクションの論理コンテナです。構築を開始する前に、Actions Console で作成する必要があります。
  • サンプルを初期化してデプロイする: このシンプルなサンプルは、Interactive Canvas を利用したアクションの作成を開始する方法を示しています。

このクイックスタートを完了すると、ローカル開発環境と Actions Builder のウェブ エクスペリエンスとの間で Actions プロジェクトを同期できます。

Node.js と Firebase CLI をインストールする

Google のフルフィルメント ライブラリを使用するには、Node.js のドキュメントに沿って Node.js をダウンロードしてインストールします。Node.js をインストールすると、npm を使用して Firebase CLI をインストールし、会話型フルフィルメントの実装をローカルで実行することもできます。

Firebase のドキュメントに従って Firebase CLI をインストールして設定します。Firebase CLI を使用すると、インタラクティブ キャンバス ウェブアプリを Firebase Hosting にデプロイできます。また、必要に応じて、フルフィルメントを Cloud Functions for Firebase に手動でデプロイできます。

gactions コマンドライン ツールをインストールする

インストール パッケージをダウンロードして展開し、実行パスを構成して、gactions コマンドライン インターフェース(CLI)ツールをインストールします。

gactions をインストールして構成する手順は次のとおりです。

  1. ご使用のオペレーティング システムに対応したパッケージをダウンロードします。

    プラットフォーム パッケージ チェックサム
    ウィンドウ ダウンロード SHA256
    Linux ダウンロード SHA256
    Mac OS ダウンロード SHA256
  2. パッケージを任意の場所に抽出し、バイナリを環境の PATH 変数に追加します。または、PATH 変数にすでに含まれている場所(例: /usr/local/bin)にパッケージを解凍します。

  3. Linux と Mac で、必要に応じて実行権限を有効にします。

    chmod +x PATH_TO/gactions
  4. 次のコマンドを実行して CLI を認証します。このコマンドは認証フローを開始します。その際、ウェブブラウザが必要になります。

    gactions login

    フローが完了すると、CLI が自動的に認証されます。

プロジェクトを作成して設定する

gactions コマンドライン ツールを使用する前に、Actions Console でプロジェクトを作成し、gactions にプロジェクトへのアクセス権を付与する必要があります。プロジェクトを作成して設定する手順は次のとおりです。

  1. Actions Console に移動します。
  2. [新しいプロジェクト] をクリックし、プロジェクト名を入力して、[プロジェクトを作成] をクリックします。
  3. カテゴリを選択し、[次へ] をクリックします。
  4. [Blank project] を選択し、[Start building](ビルドを開始)をクリックします。
  5. API を有効または無効にする手順に沿って、Google Cloud コンソールで Actions API を有効にします。これにより、Gactions がプロジェクトを操作できるようになります。

Hello World サンプルを取得する

Hello World のインタラクティブなサンプルは、Interactive Canvas を利用した 1 つのアクションでシンプルな Actions プロジェクトを作成する方法を示しています。

  1. 空のディレクトリを作成し、そのディレクトリで Interactive Canvas のサンプルを初期化します。たとえば次のコードは、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 に変更します。

サンプルをデプロイしてテストする

サンプルを設定したら、Interactive Canvas ウェブアプリと Actions プロジェクトをデプロイできます。このプロセスでは、プレビューとテストのために Actions シミュレータにデプロイできる Actions プロジェクトのドラフト バージョンが作成されます。

  1. interactive-canvas-sample/ ディレクトリから次のコマンドを実行して、Interactive Canvas ウェブアプリ(public/ ディレクトリの内容)をデプロイします。

    firebase deploy --project PROJECT_ID --only hosting
    

    ブラウザの Firebase CLI から返された URL(https://PROJECT_ID.web.app)で、ウェブアプリのレンダリング バージョンを確認できます。

  2. interactive-canvas-sample/sdk/webhooks/ActionsOnGoogleFulfillment/index.js ファイルを開き、CANVAS_URL 変数の値をプロジェクトのウェブアプリ URL に変更します。

    const CANVAS_URL = 'https://PROJECT_ID.web.app';
    
  3. interactive-canvas-sample/sdk/ ディレクトリから次のコマンドを実行して、Actions プロジェクトのローカル バージョンをドラフト バージョンとしてコンソールにプッシュします。

    gactions push
    
  4. interactive-canvas-sample/sdk/ ディレクトリから次のコマンドを実行して、シミュレータで Actions プロジェクトをテストします。

    gactions deploy preview
    
  5. コマンドライン ツールから返されたリンクを開いて、シミュレータに移動します。

  6. シミュレータで「Talk to Interactive canvas sample」と入力してアクションを開始します。https://PROJECT_ID.web.app にデプロイされたウェブアプリによって回転する三角形が表示されます。

    図 1. Actions プロジェクトをプレビューしているシミュレータ