最初のエージェントの作成

前提条件

• 2022 年 3 月 7 日より前にパートナー アカウントに登録した場合は、ビジネス メッセージ API を有効にする必要があります。Business Communications API とビジネス メッセージ API を有効にするをご覧ください。

エージェントを作成

このガイドでは、サンプル アプリケーションを使用してエージェントを作成する方法について説明します。このサンプルは、エージェントの機能を簡単に確認できる方法を提供し、エージェント開発の出発点として使用できます。既存のアプリケーションを変更してエージェントを含める場合は、このサンプルがアプリケーション ロジックの優れたモデルとなります。

このクイックスタートでは、以下の内容を行います。

• パートナーとして登録する
• ブランドとエージェントを作成する
• 必要に応じて、Business Messages Helper Bot との会話で機能を確認する
• メッセージを送受信するようにエージェントを設定する

サンプルを使用せずにエージェントを作成するには、エージェントを作成するをご覧ください。

パートナーとして登録する

1. Business Communications デベロッパー コンソールを開きます。
2. [ビジネス メッセージ] で [パートナー アカウントを作成] をクリックします。

3. パートナー情報を入力します。

   フィールド	値
   名前	氏名
   パートナー名	組織名
   パートナー ウェブサイト	組織のウェブサイト
   地域	Business Messages サービスをホストするリージョン

4. ビジネス メッセージの利用規約を確認して同意します。

5. [作成] をクリックします。

ビジネス メッセージ パートナーとして登録されました。Business Messages API と Business Communications API が有効になった新しい Google Cloud プロジェクトが作成されました。このプロジェクトにはアクセスできません。また、既存の Google Cloud プロジェクトに影響することもありません。

ビジネス メッセージ API と Business Communications API をご利用いただけるようになりました。

サービス アカウントを作成する

1. ビジネス コミュニケーション デベロッパー コンソールのホームページで、[パートナー アカウントの設定] をクリックします。
2. 左側のナビゲーションで、[サービス アカウント] をクリックします。

3. [鍵を作成]、[作成] の順にクリックします。

   ブラウザでサービス アカウント キーがダウンロードされます。安全な場所に保管してください。このキーは、後でウェブ アプリケーションをデプロイし、今後ビジネス メッセージ API と Business Communication API にアクセスするために必要になります。

ブランドとエージェントを作成する

エージェントは、ブランドの情報を会話形式で提供するものです。ユーザーがやり取りする会話エンティティです。ビジネスを表すブランドを作成し、消費者が会話形式でブランドとつながることができるようにエージェントを作成します。

1. ビジネス コミュニケーション デベロッパー コンソールを開き、ビジネス メッセージの Google アカウントでログインします。
2. [Create agent] をクリックします。
3. [エージェント タイプ] で [ビジネス メッセージ] を選択します。
4. [ブランド名] と [エージェント名] に値を入力します。
5. 次のいずれかを行います。
   • エージェントとの会話で利用できる機能を確認するには、[Business Messages Helper Bot を有効にする] を選択します。
   • エージェントをカスタマイズしてメッセージ処理の準備を行うには、[Business Messages Helper Bot を有効にする] の選択を解除します。
6. [Create agent] をクリックします。

Business Messages Helper Bot を有効にしている場合は、すぐに会話を開始できます。それ以外の場合は、メッセージ処理用にエージェントを設定するに進みます。

Business Messages Helper Bot で機能を確認する

Business Messages Helper Bot を使うと、エージェントとの会話をすばやく開始して、プラットフォームの機能を体験することができます。ヘルパーボットの有効化は必須ではありませんが、最初のエージェントを作成する際は有効にすることを強くおすすめします。

Helper Bot を使用すると、次のことができます。

• 豊富な機能を活用する
• 機能を実装する方法
• エージェントの設定に関するリソースを探す

Helper Bot が有効になっていると、エージェントに代わってメッセージの送受信が行われるため、Webhook を設定する必要がありません。ユーザー メッセージを処理するためにウェブフックを設定したり、Dialogflow を有効にしたりするには、事前にHelper Bot を無効にする必要があります。

Helper Bot との会話を開始する

Business Messages Helper Bot を有効にすると、会話を開始できます。エージェントの作成直後にダイアログが開き、利用を開始する際に役立ちます。

ヘルパーボットとやり取りするには、このダイアログで次の操作を行います。

1. エージェントのテスト URL にアクセスします。アクセスする方法はいくつかあります。

   • [Android] ボタンまたは [iOS] ボタンをクリックします。次に、対応するモバイル デバイスで QR コードをスキャンし、[起動] をクリックします。または、[Android URL をコピー] または [iOS URL をコピー] をクリックして、エージェントのテスト URL をコピーします。
   • [送信] をクリックして、URL をメールアドレスに送信します。

2. モバイル デバイスで URL を開きます。（iOS デバイスでは Google マップ アプリが必要です）。

Helper Bot を無効にする

エージェントをカスタマイズして起動の準備を行う前に、Business Messages Helper Bot を無効にする必要があります。

Helper Bot を無効にするには、

1. Business Communications Developer Console を開きます。
2. エージェントを選択します。
3. 画面左のナビゲーションで [Integrations] をクリックします。
4. [Helper Bot] で [無効にする] をクリックします。

Helper Bot が無効になると、エージェントに代わってメッセージの送受信を行うことはなくなります。これで、メッセージ フローを処理するようにエージェントを設定できます。

メッセージ処理用のエージェントを設定する

このガイドでは、ユーザー メッセージを処理するように設計された Webhook を使用して、Echo Bot を Google Cloud Platform（GCP）にデプロイします。

Echo Bot は、メッセージをユーザーにエコーバックするサンプル アプリケーションです。エージェントとの会話で、提案されたアクションやリッチカードなどのリッチ機能を試すことができます。Echo Bot をエージェントの開発の出発点として使用することもできます。

次の手順を行います。

• Echo Bot サンプルを GCP にデプロイする
• ビジネス メッセージのパートナー アカウントの Webhook URL を構成する
• エージェントに関する基本情報を入力する

このガイドを最後まで読むと、エージェントがメッセージの送受信を行えるようになります。

注: Business Messages Helper Bot を有効にしている場合は、エージェントをカスタマイズして Webhook でメッセージを受信できるようにする前に、無効にする必要があります。

ウェブ アプリケーションを GCP にデプロイする

ビジネス メッセージは、ユーザーからのメッセージをインフラストラクチャ内の Webhook に転送します。このガイドでは、Echo Bot サンプルのソースコードを事前構成済みの Webhook にデプロイします。メッセージの受信に利用できるウェブ インフラストラクチャがすでに存在する場合は、そのウェブ サービスで新しい Webhook を作成できますが、ロジックを自分で構成する必要があります。詳しくは、パートナー レベルの Webhook を設定するをご覧ください。

注: 独自のアプリケーションを作成する際に、Echo bot の事前構成されたロジックをモデルとして使用できます。受信したメッセージが Google から送信されたものであることを確認するために、clientToken のロジックを必ず含めてください。

クラウド環境を作成する

Echo Bot サンプルをデプロイするには、クラウド環境が必要です。

注: Cloud 環境を作成するときに、Cloud 請求先アカウントをプロジェクトに追加する必要があります。無料アカウントまたは有料アカウントを選択できます。Echo Bot を独自のサーバーにデプロイすることもできます。

クラウド環境として GCP プロジェクトを作成する手順は次のとおりです。

1. Google Cloud コンソールのプロジェクト セレクタを開きます。

   Google Cloud プロジェクトをまだ作成したことがない場合は、利用規約に同意する必要があります。

2. [プロジェクトを作成] をクリックします。

3. 新しいプロジェクトの名前と場所を入力します

   • プロジェクト ID は自動的に生成され、プロジェクト名の下に表示されます。
   • [ロケーション] フィールドで、[参照] をクリックして、プロジェクトの候補となるロケーションを表示します。Google Workspace 組織が見つからない場合は、Google Workspace アカウントにログインしていません。組織なしでプロジェクトを作成できますが、一部の機能は制限されます。詳細については、組織リソースのメリットをご覧ください。

4. [作成] をクリックします。

5. メニューをクリックします。

6. [料金] をクリックします。

7. [請求先アカウントをリンク] をクリックします。

8. 新しい請求先アカウントを作成するか、既存の請求先アカウントをプロジェクトに追加します。お支払い方法については、Google Cloud 無料プログラムの機能をご覧ください。

Echo Bot のサンプルをデプロイする

1. gcloud CLI をインストールします。これは、サンプルコードを Google Cloud にデプロイするために使用します。

2. Echo Bot サンプル（Node.js、Java、Python）をダウンロードして抽出します。

3. サービス アカウントを作成するでダウンロードした JSON 認証情報ファイルをサンプルのリソース フォルダにコピーし、認証情報の名前を「bm-agent-service-account-credentials.json」に変更します。この認証情報ファイルのパスは、ダウンロードしたサンプルによって異なります。

   Node.js

   ./bm-nodejs-echo-bot/full_sample/resources/bm-agent-service-account-credentials.json

   Java

   ./bm-java-echo-bot/full_sample/src/main/resources/bm-agent-service-account-credentials.json

   Python

   ./bm-python-echo-bot/full_sample/resources/bm-agent-service-account-credentials.json

4. ターミナルで、サンプルの full_sample ディレクトリに移動します。

5. ターミナルで次のコマンドを実行して、サンプルをデプロイします。

   Node.js

   gcloud config set project PROJECT_ID
   gcloud app create
   gcloud app deploy

   PROJECT_ID は、Cloud 環境を作成するで作成したプロジェクトのプロジェクト ID です。プロジェクト ID は、Google Cloud のプロジェクト ダッシュボードに表示されます。

   Java

   gcloud config set project PROJECT_ID
   gcloud app create
   mvn appengine:deploy

   PROJECT_ID は、Cloud 環境を作成するで作成したプロジェクトのプロジェクト ID です。プロジェクト ID は、Google Cloud のプロジェクト ダッシュボードに表示されます。

   Python

   gcloud config set project PROJECT_ID
   gcloud app create
   gcloud app deploy

   PROJECT_ID は、Cloud 環境を作成するで作成したプロジェクトのプロジェクト ID です。プロジェクト ID は、Google Cloud のプロジェクト ダッシュボードに表示されます。

6. 最後のコマンドの出力に記載されている、デプロイしたアプリケーションの URL をメモします。これは Webhook URL のベースです。

   Deployed service [default] to [https://PROJECT_ID.appspot.com]

Webhook を設定する

Echo Bot がデプロイされたので、メッセージの受信を開始するには、Webhook URL（ユーザーが運用する）を指定する必要があります。

1. Business Communications デベロッパー コンソールで [アカウント設定] を開きます。
2. 正しいパートナー アカウントが選択されていることを確認します。
3. [ビジネス メッセージの Webhook URL] で、[構成] をクリックします。

4. [Webhook エンドポイント URL] に、アプリケーションの URL + 「/callback」を入力します。

   エンドポイントは「https://PROJECT_ID.appspot.com/callback」という形式になります。

   このエンドポイントは、GCP にデプロイしたサンプルのアプリケーション ロジックで事前定義されています。

5. デベロッパー コンソールで、[確認] をクリックします。

   ビジネス メッセージで webhook の検証が完了すると、ダイアログが閉じます。

Business Communications API を使用して Webhook を構成するには、例: Webhook URL を更新するをご覧ください。

ビジネス メッセージ テスト フレームワークを使用すると、Webhook がビジネス メッセージ ペイロードに正常に応答するかどうかをテストできます。

エージェント情報を入力する

エージェントの設定を完了するために、基本情報を入力します。

1. Business Communications Developer Console を開きます。
2. 左側のナビゲーションで [エージェント情報] をクリックします。

3. 値を自由に更新するか、次の提案を使用します。

   フィールド	値
   ウェルカム メッセージ	Echo Bot との会話へようこそ。
   プライバシー ポリシー	https://policies.google.com/privacy

4. [保存] をクリックします。

会話を開始

Echo Bot を操作する手順は次のとおりです。

1. Business Communications Developer Console を開きます。
2. 左側のナビゲーションで [エージェント情報] をクリックします。
3. [エージェント テスト URL] で、[Android] ボタンまたは [iOS] ボタンをクリックします。

4. 対応するモバイル デバイスで QR コードをスキャンするか、[Android URL をコピー] または [iOS URL をコピー] をクリックして、エージェントのテスト URL をコピーします。

   [送信] をクリックして、URL をメールアドレスに送信することもできます。

5. モバイル デバイスで URL を開きます。（iOS デバイスでは Google マップ アプリが必要です）。

エージェントのウェルカム メッセージが表示されます。この時点で、Echo Bot とやり取りできます。送信したメッセージがエコーバックされます。また、特定の文字列（「carousel」、「card」、「chips」）を送信して、リッチ機能を呼び出すこともできます。

次のステップ

これで最初のエージェントを作成しました。ビジネス メッセージの詳細と、プラットフォームでできることについてご確認ください。

• 詳しくは、ビジネス メッセージの仕組みをご覧ください。

• ビジネス メッセージの要件とガイドラインを確認します。

• メッセージの受信方法を確認して、Echo Bot を変更し、ビジネス ロジックで応答します。

• インフラストラクチャを確認する。

• エージェントとロケーションをさらにリリースします。