前提条件
- 2022 年 3 月 7 日より前にパートナー アカウントを登録した場合は、Business Messages API を有効にする必要があります。Business Communications API と Business Messages API を有効にするをご覧ください。
エージェントを作成する
このガイドでは、サンプル アプリケーションを使用してエージェントを作成する方法について説明します。サンプルは、エージェントの機能をすばやく調べるための手段であり、エージェント開発の出発点として使用できます。既存のアプリケーションを変更してエージェントを含める場合、このサンプルはアプリケーション ロジックに適したモデルを提供します。
このクイックスタートでは、以下の内容を行います。
- パートナーとして登録
- ブランドとエージェントを作成する
- 必要に応じて、ビジネス メッセージの会話内でさまざまな機能を試すことができます ヘルパーボット
- メッセージを送受信するようにエージェントを設定する
サンプルを使用せずにエージェントを作成するには、エージェントを作成するをご覧ください。
パートナーとして登録
- アプリ Business Communications Developer Console。
- [ビジネス メッセージ] で [パートナー アカウントを作成] をクリックします。
パートナー情報を入力します。
フィールド 値 名前 氏名 パートナー名 組織名 パートナー ウェブサイト 組織のウェブサイト 地域 ビジネス メッセージ サービスをホストするリージョン 次を確認して同意してください ビジネス メッセージの利用規約
[作成] をクリックします。
ビジネス メッセージ パートナーとして登録されました。新しい Google Cloud プロジェクトが作成され、Business Messages API と Business Communications API が有効になっています。このプロジェクトにはアクセスできません。また、既存の Google Cloud プロジェクトに干渉することはありません。
これで、Business Messages API と Business Communications API にアクセスできるようになります。
サービス アカウントを作成する
- Business Communications Developer Console のホームページで、[パートナー アカウントの設定] をクリックします。
- 左側のナビゲーションで サービス アカウント。
[鍵を作成]、[作成] の順にクリックします。
ブラウザにサービス アカウント キーがダウンロードされます。安全な場所に保管してください。 あります。このキーは、後でウェブ アプリケーションのデプロイや 今後 Business Messages API と Business Communications API にアクセスする必要があります。
ブランドとエージェントを作成する
エージェントはブランドの会話表現 - 会話エンティティ ユーザーが操作するリソースの数です。ビジネスを表すブランドを作成し 消費者が会話形式で接続できるようにエージェントを作成する。
- Business Communications Developer を開きます。 コンソール ビジネス メッセージの Google アカウントでログインします。
- [Create Agent(エージェントを作成)] をクリックします。
- [Agent type](エージェントの種類)で、[Business Messages](ビジネス メッセージ)を選択します。
- [Brand name] と [Agent name] に値を入力します。
- 次のいずれかを行います。
- エージェントとの会話を体験するには、 [Enable Business Messages Helper Bot] を選択します。
- エージェントをカスタマイズしてメッセージ処理用に準備するには、 Business Messages Helper Bot を有効にします。
- [Create Agent(エージェントを作成)] をクリックします。
Business Messages Helper Bot を有効にしている場合は、すぐに会話を開始できます。それ以外の場合は メッセージ処理用のエージェントの設定に進みます。
Business Messaging Helper Bot の機能を確認する
Business Messages Helper Bot を使うと、メッセージ アプリを使って プラットフォームが提供する機能を体験できます。ヘルパーを有効にする bot は省略可能ですが、最初のエージェントを作成する場合は、使用することを強くおすすめします。
Helper Bot を使ってできること
- 豊富な機能を見る
- 機能の実装方法を学ぶ
- エージェントの設定に関するリソースを探す
Helper Bot が有効になると、エージェントに代わってメッセージを送受信します。 Webhook は不要です。Helper Bot を無効にする必要があります。 Webhook を設定したり Dialogflow を有効化したりする前に ユーザー メッセージを処理します。
Helper Bot と会話を始める
Business Messages Helper Bot を有効にすると、会話を開始できます。 エージェントの作成後すぐにダイアログが開き、使用を開始できます。
Helper Bot とやり取りするには、このダイアログで次の手順を行います。
エージェントのテスト URL にアクセスします。いくつかの方法があります。
- [Android] ボタンまたは [iOS] ボタンをクリックします。QR コードをスキャンしてください 対応するモバイル デバイスに接続して [公開] をクリックします。 または、[Android の URL をコピー] または [iOS の URL をコピー] をクリックしてコピーします。 エージェントのテスト URL です。
- [送信] をクリックすると、指定したメールアドレスに URL が送信されます。
モバイル デバイスで URL を開きます。(iOS デバイスの場合、 Google マップ app.)
Helper Bot を無効にする
エージェントをカスタマイズしてリリースに備える前に、以下を行う必要があります。 Business Messages Helper Bot を無効にします。
Helper Bot を無効にするには、
- Business Communications Developer を開きます。 コンソールで確認できます。
- エージェントを選択します。
- 画面左のナビゲーションで [Integrations] をクリックします。
- [Helper Bot] で [無効にする] をクリックします。
Helper Bot を無効にすると、 できます。次は、エージェントを設定して、 説明します。
メッセージ処理用にエージェントを設定する
このガイドでは、Google Cloud Platform(GCP)に Echo Bot を Webhook です。
Echo Bot は、ユーザーにメッセージをエコーバックするサンプル アプリケーションです。これは、 次のような豊富な機能を試すことができます。 推奨されるアクション および リッチカード 会話でやり取りできます。Echo Bot をスタート地点とし、 重要なポイントになります
次の手順を実施します。
- Echo Bot サンプルを GCP にデプロイする
- ビジネス メッセージ パートナー アカウントの Webhook URL を設定する
- エージェントに関する基本情報を入力します。
このガイドを終えると、エージェントがメッセージを送受信できるようになります。
ウェブ アプリケーションを GCP にデプロイする
ビジネス メッセージでユーザーからのメッセージが Webhook に転送されます。 必要があります。このガイドでは、Echo Bot サンプルを 事前構成済みの Webhook にマッピングできますウェブ インフラストラクチャをすでにご利用の場合は、 そのウェブで新しい Webhook を作成できます。 ただし、ロジックは自分で構成する必要があります。詳しくは、 パートナー レベルの Webhook を設定する をご覧ください。
クラウド環境を作成する
Echo Bot サンプルをデプロイするには、クラウド環境が必要です。
GCP プロジェクトをクラウド環境として作成する手順は次のとおりです。
アプリ Google Cloud コンソールのプロジェクト セレクタ。
Google Cloud プロジェクトを作成したことがない場合は、利用規約に同意する必要があります。
[プロジェクトの作成] をクリックします。
新しいプロジェクトの名前と場所を入力します
- プロジェクト ID は自動的に生成され、プロジェクト名の下に表示されます。
- [ロケーション] フィールドで [参照] をクリックして、プロジェクトの可能性のあるロケーションを表示します。Google Workspace の組織が見つからない場合は、Google Workspace アカウントにログインしていません。組織がなくてもプロジェクトを作成できますが、一部の機能が制限されます。詳細については、組織リソースのメリットをご覧ください。
[作成] をクリックします。
[メニュー] をクリックします。
[料金] をクリックします。
[請求先アカウントをリンク] をクリックします。
新しい請求先アカウントを作成するか、既存の請求先アカウントをプロジェクトに追加します。お支払い方法については、Google Cloud の無料プログラムの機能をご覧ください。
Echo Bot サンプルをデプロイする
- gcloud CLI をインストールします。これを使用して、サンプルコードを Google Cloud にデプロイします。
ダウンロードした JSON 認証情報ファイルを サンプルのリソース フォルダで、サービス アカウントを作成します。 認証情報の名前を「bm-agent-service-account-credentials.json」に変更します。 この認証情報ファイルのパスは、ダウンロードしたサンプルによって異なります。
./bm-nodejs-echo-bot/full_sample/resources/bm-agent-service-account-credentials.json
./bm-java-echo-bot/full_sample/src/main/resources/bm-agent-service-account-credentials.json
./bm-python-echo-bot/full_sample/resources/bm-agent-service-account-credentials.json
ターミナルで、サンプルの full_sample ディレクトリに移動します。
ターミナルで次のコマンドを実行して、サンプルをデプロイします。
gcloud config set project PROJECT_ID
gcloud app create
gcloud app deploy
PROJECT_ID は、作成したプロジェクトのプロジェクト ID です。 クラウド環境を作成します。プロジェクト ID は、Google Cloud のプロジェクト ダッシュボードに表示されます。
gcloud config set project PROJECT_ID
gcloud app create
mvn appengine:deploy
PROJECT_ID は、作成したプロジェクトのプロジェクト ID です。 クラウド環境を作成します。プロジェクト ID は、Google Cloud のプロジェクト ダッシュボードに表示されます。
gcloud config set project PROJECT_ID
gcloud app create
gcloud app deploy
PROJECT_ID は、作成したプロジェクトのプロジェクト ID です。 クラウド環境を作成します。プロジェクト ID は、Google Cloud のプロジェクト ダッシュボードに表示されます。
最後のコマンドの出力にある、デプロイされたアプリケーションの URL をメモします。 これが Webhook URL のベースとなります。
Deployed service [default] to [https://PROJECT_ID.appspot.com]
Webhook の設定
Echo Bot がデプロイされたので、Webhook URL( 起動して メッセージを受信します。
- アプリ アカウント設定 。
- 正しいパートナー アカウントが選択されていることを確認します。
- [Business Messages webhook URL] で [Configure] をクリックします。
[Webhook endpoint URL] に、アプリケーションの URL と「/callback」を入力します。
エンドポイントは次の形式になります。 "https://PROJECT_ID.appspot.com/callback".
このエンドポイントは、使用するサンプルのアプリケーション ロジックで事前定義されています。 GCP にデプロイされます。
Play Console で [確認] をクリックします。
ビジネス メッセージが Webhook の確認を完了すると、ダイアログが閉じます。
Business Communications API を使用して Webhook を構成するには、以下をご覧ください。 例: Webhook URL を更新する。
ビジネス メッセージ テスト フレームワークを使用できます。 を使用して、Webhook がビジネス メッセージのペイロードに正常に応答するかどうかをテストします。
エージェント情報を入力
エージェントの設定を完了するために、いくつかの基本情報を入力します。
- Business Communications Developer を開きます。 コンソールで確認できます。
- 左側のナビゲーションで [Agent information](エージェント情報)をクリックします。
必要に応じて値を更新するか、次の推奨事項を使用します。
フィールド 値 ウェルカム メッセージ Echo Bot の会話へようこそ! プライバシー ポリシー https://policies.google.com/privacy [保存] をクリックします。
会話を開始
Echo Bot を操作する手順は次のとおりです。
- Business Communications Developer を開きます。 コンソールで確認できます。
- 左側のナビゲーションで [Agent information](エージェント情報)をクリックします。
- [Agent test URLs] で、[Android] ボタンまたは [iOS] ボタンをクリックします。
対応するモバイル デバイスで QR コードをスキャンするか、[コピー] をクリックします [Android URL] または [iOS URL をコピー] をクリックして、エージェントのテスト URL をコピーします。
[送信] をクリックして、URL を自分のメールアドレスに送信することもできます。
モバイル デバイスで URL を開きます。(iOS デバイスの場合、 Google マップ アプリ)。
エージェントのウェルカム メッセージが表示されます。この時点で Echo Bot です。送信したメッセージがエコーされます。さらに、 「カルーセル」、「カード」、「チップ」などの特定の文字列を送信することで、リッチな機能を呼び出す。
次のステップ
これで最初のエージェントが作成されました。ビジネス メッセージの詳細をご覧ください プラットフォームでできること
詳しくは、ビジネス メッセージの仕組みをご覧ください。
ビジネス メッセージの要件とガイドラインを確認します。
Echo Bot を変更し、メッセージの受信方法を確認して、ビジネス ロジックで応答します。