最初のエージェントを作成する

Prerequisites

エージェントを作成する

このガイドでは、サンプル アプリケーションを使用してエージェントを作成する方法について説明します。このサンプルは、エージェントの機能を簡単に調査でき、エージェント開発の出発点として活用できます。既存のアプリケーションを修正してエージェントを含める場合は、アプリケーション ロジックに適したモデルのサンプルを使用します。

このクイックスタートでは、次のことを行います。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1. Business Communications Developer Console を開き、ビジネス メッセージ Google アカウントでログインします。
  2. [Create Agent（エージェントを作成）] をクリックします。
  3. [エージェントの種類] で [ビジネス メッセージ] を選択します。
  4. [ブランド名] と [エージェント名] に値を入力します。
  5. 次のいずれかを行います。
    • エージェントと会話して利用可能な機能を調べるには、[Enable 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 を使用すると、次のことができます。

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

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

Helper Bot と会話を始める

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

Helper Bot を操作するには、このダイアログで次の手順を行います。

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

    • [Android] ボタンまたは [iOS] ボタンをクリックします。次に、対応するモバイル デバイスで QR コードをスキャンし、[Launch] をクリックします。 または、[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 に転送します。このガイドでは、事前構成された Webhook に Echo Bot ソースコードをデプロイします。メッセージを受信するためのウェブ インフラストラクチャがすでにある場合は、そのウェブサービスで新しい Webhook を作成できますが、ロジックを自分で構成する必要があります。詳しくは、パートナー レベルの Webhook の設定をご覧ください。

クラウド環境を作成する

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

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

  1. Google Cloud Console プロジェクト セレクタを開きます。

    これまでに 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 を指定します（その 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. Google Play Console で、[確認] をクリックします。

    ビジネス メッセージによって Webhook の確認が完了すると、ダイアログが終了します。

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

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

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

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

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

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

    Field 値
    ウェルカム メッセージ 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 を操作できます。あなた宛てに送信したメッセージがエコーされます。また、「カルーセル」、「カード」、「チップ」などの特定の文字列を送信することで、リッチ機能を呼び出すこともできます。

次のステップ

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