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

パートナーとしてビジネス メッセージに登録すると、エージェントを作成して、ユーザーとブランド間の会話を有効にできます。エージェントとは、ウェブサイト サポートやブランド ロケーションなどのビジネス機能を表す会話エンティティです。

ユーザーが Google 検索または Google マップで管理しているブランドを検索すると、検索結果に [チャット] オプションが表示されます。ユーザーが [チャット] をクリックすると、ブランドのエージェントにメッセージを送信できます。エージェントでは、ユーザーのメッセージを受信して返信できます。

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

パートナーとしてビジネス メッセージに登録し、ブランドのエージェントを作成して、エージェントに対する API を使用することで、カスタマー サービス、販売、その他のビジネス アプリケーションに対するメッセージングのエクスペリエンスを実現できます。

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

    Field
    名前 氏名
    パートナー名 組織名
    パートナー ウェブサイト 組織のウェブサイト
    リージョン ビジネス メッセージ サービスをホストするリージョン
  1. ビジネス メッセージの利用規約を確認して同意します。

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

ビジネス メッセージ パートナーとして登録され、ビジネス メッセージと 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 と Business Communications API が有効になったので、メッセージを受信するには、Webhook URL を指定する必要があります。

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

    たとえば、Webhook が次の本文の POST リクエストを受け取った場合

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

    Webhook が clientToken 値を確認し、clientToken が正しい場合は、0123456789 をレスポンス本文として 200 OK レスポンスを返します。

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

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

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

パートナー情報を取得

現在のパートナー情報を取得するには、パートナー ID を使用して Business Communications API をクエリします。

以下のコマンドを実行します。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 を構成する方法を確認してください。