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

前提条件

エージェントを作成する

このガイドでは、サンプル アプリケーションを使用してエージェントを作成する方法について説明します。サンプルは、エージェントの機能をすばやく調べるための手段であり、エージェント開発の出発点として使用できます。既存のアプリケーションを変更してエージェントを含める場合、このサンプルはアプリケーション ロジックに適したモデルを提供します。

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

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

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

パートナーとして登録

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

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

    項目 価値
    自分の名前 氏名
    パートナー名 組織名
    パートナー ウェブサイト 組織のウェブサイト
    リージョン ビジネス メッセージ サービスをホストするリージョン

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

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

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

これで、Business Messages API と Business Communications API にアクセスできるようになります。

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

  1. Business Communications Developer Console のホームページで、[パートナー アカウントの設定] をクリックします。
  2. 左側のナビゲーションで、[サービス アカウント] をクリックします。

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

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

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

エージェントは、ブランド（ユーザーがやり取りする会話エンティティ）の会話表現です。ビジネスを表すブランドを作成し、消費者が会話でブランドに接続できるようにエージェントを作成します。

  1. Business Communications Developer Console を開き、ビジネス メッセージの Google アカウントでログインします。
  2. [Create Agent（エージェントを作成）] をクリックします。
  3. [Agent type]（エージェントの種類）で、[Business Messages]（ビジネス メッセージ）を選択します。
  4. [Brand name] と [Agent name] に値を入力します。
  5. 次のいずれかを行います。
    • エージェントとの会話を体験して使用可能な機能を調べるには、[Enable Business Messages Helper Bot] を選択します。
    • エージェントをカスタマイズしてメッセージ処理用に準備するには、[Enable the Business Messages Helper Bot] の選択を解除します。
  6. [Create Agent（エージェントを作成）] をクリックします。

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

Business Messaging Helper Bot の機能を確認する

Business Messages Helper Bot を使用すると、エージェントとすぐに会話を開始し、プラットフォームが提供する機能を体験できます。Helper Bot を有効にするかどうかは任意ですが、最初のエージェントを作成する際には有効にすることを強くおすすめします。

Helper Bot を使ってできること

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

Helper Bot を有効にすると、エージェントに代わってメッセージを送受信します。Webhook は必要ありません。ユーザー メッセージを処理する Webhook を設定するか、Dialogflow を有効にする前に、Helper Bot を無効にする必要があります。

Helper Bot と会話を始める

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

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 を設定する
  • エージェントに関する基本情報を入力します。

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

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

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

クラウド環境を作成する

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 は、クラウド環境の作成で作成したプロジェクトのプロジェクト ID です。プロジェクト ID は、Google Cloud のプロジェクト ダッシュボードに表示されます。

    Java

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

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

    Python

    gcloud config set project PROJECT_ID
gcloud app create
gcloud app deploy

    PROJECT_ID は、クラウド環境の作成で作成したプロジェクトのプロジェクト 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 Developer Console で [アカウント設定] を開きます。
  2. 正しいパートナー アカウントが選択されていることを確認します。
  3. [Business Messages webhook URL] で [Configure] をクリックします。

  4. [Webhook endpoint URL] に、アプリケーションの URL と「/callback」を入力します。

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

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

  5. Play Console で [確認] をクリックします。

    ビジネス メッセージが Webhook の確認を完了すると、ダイアログが閉じます。

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

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

エージェント情報を入力

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

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

  3. 必要に応じて値を更新するか、次の推奨事項を使用します。

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

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

会話を開始

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

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

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

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

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

エージェントのウェルカム メッセージが表示されます。この時点で Echo Bot を操作できます。送信したメッセージがエコーされます。さらに、「カルーセル」、「カード」、「チップ」などの特定の文字列を送信することで、リッチ機能を呼び出すことができます。

次のステップ

最初のエージェントを作成したら、ビジネス メッセージの詳細と、このプラットフォームでできることを確認しましょう。