ビジネス メッセージに登録する

ビジネス メッセージでパートナーとして登録すると、 会話形式でエージェントを作成することで、ユーザーとブランドの間の会話を ビジネス機能を表すエンティティ(ウェブサイトのサポート、ブランドなど) 提供します

Google 検索や Google マップで、あなたが管理しているブランドをユーザーが見つけたら、 検索結果に [チャット] オプションが表示されます。ユーザーが [チャット] をクリックすると、 ブランドのエージェントにメッセージを送信できますこのエージェントは、エージェントが 自動的に適用されます。

パートナーとして登録

ビジネス メッセージのパートナー登録、ブランドのエージェントの作成、 エージェントを強化する API を使用すると、 カスタマー サービス、販売、その他のビジネス アプリケーション向けに開発されました。

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

    フィールド
    名前 氏名
    パートナー名 組織名
    パートナー ウェブサイト 組織のウェブサイト
    地域 ビジネス メッセージ サービスをホストするリージョン
で確認できます。
  1. 次を確認して同意してください ビジネス メッセージの利用規約

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

ビジネス メッセージ パートナーとして登録され、Business Messages API と Business Communications API をご利用いただけるようになりました。Business Messages API はユーザーにメッセージを送信し、Business Communications API はエージェントを管理します。

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

Business Messages API と Business Communications API への API 呼び出しを安全に認証するには、サービス アカウント キーと oauth2l コマンドライン ツール。

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

    ブラウザにサービス アカウント キーがダウンロードされます。サービス アカウント キーを安全な非公開の場所に保存します。すべきでないこと 鍵を公開します。このキーは、後で Business Message API と Business Communication API にアクセスする際に必要になります。

で確認できます。

Webook を設定する

Business Messages API と Business Communications API が有効になったので、 開始するには Webhook URL を指定する必要があります メッセージを受信します

  1. Business Communications Developer Console で [アカウント設定] を開きます。
  2. 正しいパートナー アカウントが選択されていることを確認します。
  3. [Business Messages webhook URL] で [Configure] をクリックします。
  4. [Webhook endpoint URL] に、Webhook の URL( "https://"
  5. clientToken の値をメモします。これは、受信したメールが 受信の送信元が Google
  6. 指定された POST リクエストを受け入れるように Webhook を構成します。 clientToken パラメータを使用して書式なしテキストを含む 200 OK レスポンスを送信します レスポンス本文として secret パラメータの値を指定します。

    たとえば、Webhook が次の POST リクエストを受け取ったとします。 身体の内容

    {
      "clientToken":"SJENCPGJESMGUFPY",
      "secret":"0123456789"
    }
    

    Webhook が clientToken の値を確認します。clientToken の値が確認された場合は、 正しくない場合は、レスポンスの本文として 0123456789 を含む 200 OK レスポンスを返します。

  7. コンソールで [確認] をクリックします。

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

詳しくは、 例: Webhook URL を更新する をご覧ください。

パートナー情報を取得する

現在のパートナー情報を取得するには、Business Communications API をパートナー ID に置き換えます。

以下のコマンドを実行します。PARTNER_ID は、パートナー ID に置き換えます。

# This code gets the partner.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/partners/get

# Replace the __PARTNER_ID__
# Make sure a service account key file exists at ./service_account_key.json

curl -X GET \
"https://businesscommunications.googleapis.com/v1/partners/__PARTNER_ID__" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)"

パートナー情報を更新する

パートナー情報を更新するには、Business Communications Developer Console の [アカウント設定] ページを使用するか、次のコマンドを実行します。

置換 PARTNER_ID は、パートナー ID(パートナー ID は Business Communications Developer Console で確認できます)に置き換えます。また、 UPDATED_FIELDS は、更新するフィールド名に置き換えます。

# This code updates the partner entity.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/partners/patch

# Replace the __PARTNER_ID__, __UPDATED_FIELDS__, __FIELD_NAME__, __FIELD_VALUE__
# Make sure a service account key file exists at ./service_account_key.json

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/partners/__PARTNER_ID__?updateMask=__UPDATED_FIELDS__" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \
-d '{
  "__FIELD_NAME__": "__FIELD_VALUE__"
}'

書式設定と値のオプションについては、以下をご覧ください。 partners.patch

例: 表示名を更新する

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/12345/partners/67890?updateMask=displayName" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json /path/to/service/account/key businesscommunications)" \
-d "{
    'displayName': 'XYZ Messaging',
}"

例: Webhook URL を更新する

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/partners/12345?updateMask=productCapabilities" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json /path/to/service/account/key businesscommunications)" \
-d "{
  'productCapabilities': [
    {
      'product': 'BUSINESS_MESSAGES',
      'businessMessagesCapability': {
        'webhookUrl': 'https://xyz.messaging.com/webhook',
      },
    },
  ],
}"

次のステップ

パートナーとして登録され、API が有効になりました。 ビジネスメッセージを使って開発しますさっそく使い始めるには、 最初のエージェントを作成します

それ以外の場合は、 エージェントを作成する ブランドを会話で表現したり、Webhook を設定して メッセージを受信する 制限します。