このページは Cloud Translation API によって翻訳されました。

エージェントを作成してブランドを管理する

パートナーとして登録すると、管理しているブランド向けにビジネスメッセージエージェントを作成することで、そのブランドとの会話を有効にできます。

エージェントは、ユーザーがやり取りする会話エンティティです。エージェントは、管理するブランドごとに 1 つのエージェントを作成します。エージェントの作成と管理は Business Communications API で行い、エージェントのメッセージングは Business Messages API で制御します。

エージェントには、オンラインサポートや実店舗（存在する場合）などのブランドのビジネス機能が含まれます。各メッセージには、ユーザーが会話を開始したコンテキストが含まれています。メッセージルーティングインフラストラクチャでは、ユーザーが特定のビジネス拠点を表示したか、一般的なサポートを検索したかを検出し、メッセージを正しい宛先にルーティングできます。

たとえば、ウェブサイトと 2 つのビジネス拠点を持つ Growing Tree Bank ブランドを管理する場合は、「Growing Tree Bank」エージェントを 1 つ作成します。ユーザーは一般的な検索または位置情報ベースの検索でエージェントを見つけることができ、エージェントが見つけたときのコンテキストは各メッセージとともに Webhook に渡されます。このコンテキストを使用して、特定の場所でスタッフ、またはウェブサイトサポートチームにメッセージを転送します。サポートチームが返信を作成してユーザーとの会話を継続します。

求められること

エージェントを作成する前に、ビジネスメッセージに対するエージェントに期待されていることを理解してください。

エージェントは、ビジネスメッセージの会話デザインに記載されている設計ガイダンスに従う必要があります。
自動化でリクエストを処理できない場合や、ユーザーからのリクエストがあった場合は、エージェントが質問に答えてくれる人間の担当者を用意する必要があります。

注: エージェントが人間の担当者をサポートしていない場合は、位置情報ベースのエントリポイントやローカル以外のエントリポイントから起動することはできません。エージェントに人間のインタラクションタイプを指定して、Google 管理のエントリポイントで表示できるようにします。
指標で説明されているように、エージェントは顧客満足度（CSAT）80% 以上、販売者返信率（MRR）95% 以上を維持する必要があります。

エージェントを作成する

エージェントを作成するには、ブランドに関する情報と、エージェントをユーザーに表示する方法に関する情報を収集して送信する必要があります。

複数のブランドを管理している場合は、ブランドごとにエージェントを作成する手順を繰り返します。

前提条件

管理するブランドのエージェントを作成する前に、いくつかの情報を収集する必要があります。

開発環境

開発環境に関する情報。

Business Communications API が有効になっている GCP プロジェクト

API を有効にするには、ビジネスメッセージに登録するをご覧ください。
開発マシン上の GCP プロジェクトのサービスアカウントキーのパス

ブランドの詳細

エージェントが表すブランドに関する情報。

ブランド名
ブランドのウェブサイト
ウェブサイトの連絡先オプション（OPTION で定義）
消費者向けの電話番号
通話の転送で電話番号を有効にしました

エージェントの外観とポリシー

エージェントがユーザーにどのように表示されるか、およびエージェントがどのように動作するかに関する情報。

エージェント名（ユーザーとの会話で使用する名前）
プライバシーポリシー（「https://」で始まる一般公開の URL）
（推奨）エージェントのロゴ（1024 x 1024 ピクセル）（公開 URL）

会話内では、ロゴは直径 1, 024 ピクセルの円で表示されます。ロゴが円でも正しく表示されることを確認してください。

ロゴをテストする
ロゴの URL を入力すると、ロゴがユーザーにどのように表示されるかを確認できます。

注: 画像をホストするウェブサーバーは、他のウェブサイトに画像を埋め込むことができるようにする必要があります。
（省略可）カスタムエージェント ID。Webhook が受け取るメッセージ内のブランドを識別します。

エージェントとのやり取り

エージェントがユーザーとやり取りする方法に関する情報。

エージェントが通常使用する言語 / 地域。2 文字の ISO 639-1 言語コードで指定します。
エージェントのウェルカムメッセージ

エージェントはユーザーにあいさつする際、何と言っていますか？
エージェントとの会話のきっかけ

ユーザーがエージェントとやり取りするための候補のリスト。これは、（SuggestedReply で定義されている）会話チップの形式です。
- チップでユーザーに表示されるテキスト
- ポストバックデータ。ユーザーがチップをタップしたときに、メッセージペイロードで Webhook に返される文字列です。
自動チャットとチャットの所要時間
- 毎日の開始時間（TimeOfDay オブジェクト形式）
  
  たとえば、午前 8 時 15 分は
```
{
  "hours": 8,
  "minutes": 15,
}
```
- 毎日の終了時間（TimeOfDay オブジェクト）
  
  たとえば、午後 7:30 は
```
{
  "hours": 19,
  "minutes": 30,
}
```
- 開始日。エージェントがチャットに対応できる最初の曜日（DayOfWeek で定義）
- 終了日、エージェントがチャットに対応可能な最終曜日（DayOfWeek で定義）
- エージェントが運用しているタイムゾーン（IANA タイムゾーンデータベースの定義に基づく。例: America/Los_Angeles）

エージェントのエントリポイント

ユーザーがエージェントとの会話を開始できる場所に関する情報。

許可されたエージェントのエントリポイント。ユーザーがエージェントとの会話を開始できる場所（NON_LOCAL または LOCATION）

注: 地域固有の会話を有効にするには、LOCATION エントリポイントが必要です。

NON_LOCAL のエントリポイントに関する情報（Google 広告のエントリポイントには適用されません）。

許可されたリージョン（CLDR リージョンコード）。NON_LOCAL エントリポイントへのリージョンアクセスを制限します。

リージョンに関係なく、1 つのエージェントに関連付けられる電話番号は 1 つのみです。地域ごとに異なる電話番号が必要な場合は、地域ごとに異なるエージェントを作成する必要があります。

使用可能なすべてのリージョンで NON_LOCAL エントリポイントを有効にするには、World リージョンコードに 001 を使用します。

oauth2l をインストールしてテストする

このサイトのドキュメントに記載されているすべての curl リクエストで、認証に oauth2l を使用します。コマンドラインを使用して Business Communications API と Business Messages API に接続する場合は、oauth2l をインストールします。

Python 3 で oauth2l をインストールするには、

oauth2l をダウンロードします。
「./oauth2l/python」ディレクトリに移動します。
次のコマンドを使用して oauth2l をインストールします。
```
sudo python setup.sh build && sudo python setup.py install
```

oauth2l で認証トークンを生成できるかどうかをテストします。

oauth2l header --json resources/bm-agent-service-account-credentials.json businesscommunications

出力で次の形式の認証トークンが作成されていることを確認します。
```
Authorization: Bearer AUTHORIZATION_BEARER_TOKEN
```

オペレーティングシステムに応じて oauth2l をインストールするには、他にも方法があります。どのインストール方法でも、先に進む前に、サービスアカウントの JSON 認証情報に基づいて認証トークンを生成できることを確認してください。

エージェントを作成する

情報を収集したら、エージェントを作成します。

エージェントが表すブランドを作成する。ブランドがすでに存在する場合は、ブランドの name を取得して次のステップに進みます。

ターミナルで次のコマンドを実行します。

cURL


# This code creates a brand.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/create

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

curl -X POST "https://businesscommunications.googleapis.com/v1/brands" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \
-d '{
  "displayName": "My first brand curl"
}'create-brand.sh

Node.js


/**
 * This code snippet creates a brand.
 * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/create
 *
 * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js
 * Business Communications client library.
 */

/**
 * Edit the values below:
 */
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY);

async function main() {
  const authClient = await initCredentials();

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      resource: {
        displayName: 'My first brand',
      },
    };

    bcApi.brands.create(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Brand created
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

/**
 * Initializes the Google credentials for calling the
 * Business Communcations API.
 */
 async function initCredentials() {
  // configure a JWT auth client
  const authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject('Failed to connect');
      } else {
        resolve(authClient);
      }
    });
  })
}

main();create-brand.js

Java

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.businesscommunications.v1.BusinessCommunications;
import com.google.api.services.businesscommunications.v1.model.Brand;
import java.io.FileInputStream;
import java.util.Arrays;
import java.util.UUID;

class Main {
  /**
   * Initializes credentials used by the Business Communications API.
   */
  private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
    BusinessCommunications.Builder builder = null;
    try {
      GoogleCredential credential = GoogleCredential
            .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));

      credential = credential.createScoped(Arrays.asList(
          "https://www.googleapis.com/auth/businesscommunications"));

      credential.refreshToken();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();

      // Create instance of the Business Communications API
      builder = new BusinessCommunications
          .Builder(httpTransport, jsonFactory, null)
          .setApplicationName(credential.getServiceAccountProjectId());

      // Set the API credentials and endpoint
      builder.setHttpRequestInitializer(credential);
    } catch (Exception e) {
      e.printStackTrace();
    }

    return builder;
  }

  public static void main(String args[]) {
    try {
      // Create client library reference
      BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();

      // Create a request to create a new brand
      BusinessCommunications.Brands.Create request = builder
          .build().brands().create(new Brand().setDisplayName("BRAND_NAME"));

      Brand brand = request.execute();

      // Print newly created brand object
      System.out.println(brand.toPrettyString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

このコードは、Java Business Communications クライアントライブラリに基づいています。

Python


"""This code creates a brand.

Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/create

This code is based on the https://github.com/google-business-communications/python-businessmessages
Python Business Messages client library.
"""

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1
from businesscommunications.businesscommunications_v1_messages import (
    Brand)

# Edit the values below:
SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = './service_account_key.json'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

brands_service = BusinesscommunicationsV1.BrandsService(client)

brand = brands_service.Create(Brand(displayName='My first brand'))

print(brand)create-brand.py

API から返される name の値を保存します。これは更新やエージェントの作成に必要になります

ブランドを更新または検索するには、brands をご覧ください。

エージェントを作成します。BRAND_ID は、ブランドの name 値で「brands/」に続く部分に置き換えます。たとえば、name が「brands/12345」の場合、ブランド ID は「12345」です。

ターミナルで次のコマンドを実行します。

cURL


# This code creates a Business Messages agent.
# Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/agents?method=api#create_the_agent

# Replace the __BRAND_ID__ with a brand id that you can create agents for
# Make sure a service account key file exists at ./service_account_key.json

curl -X POST "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \
-d '{
  "displayName": "My first agent",
  "businessMessagesAgent": {
    "logoUrl": "https://developers.google.com/identity/images/g-logo.png",
    "entryPointConfigs": [
      {
        "allowedEntryPoint": "NON_LOCAL"
      }
    ],
    "customAgentId": "'$(uuidgen)'",
    "nonLocalConfig": {
      "regionCodes": [
        "US",
        "CA"
      ],
      "contactOption": {
        "url": "https://www.your-company-website.com",
        "options": [
          "EMAIL",
          "PHONE"
        ]
      },
      "enabledDomains": [
        "your-company-website.com"
      ],
      "phoneNumber": {
        "number": "+10000000000"
      },
      "callDeflectionPhoneNumbers": [
        {
          "number": "+10000000000"
        },
        {
          "number": "+10000000000"
        }
      ]
    },
    "conversationalSettings": {
      "en": {
        "welcomeMessage": {
          "text": "This is a sample welcome message"
        },
        "privacyPolicy": {
          "url": "https://www.your-company-website.com/privacy"
        },
        "conversationStarters": [
          {
            "suggestion": {
              "reply": {
                "text": "Option 1",
                "postbackData": "postback_option_1"
              }
            }
          }
        ]
      }
    },
    "defaultLocale": "en",
    "primaryAgentInteraction": {
      "interactionType": "HUMAN",
      "humanRepresentative": {
        "humanMessagingAvailability": {
          "hours": [
            {
              "startTime": {
                "hours": 8,
                "minutes": 30
              },
              "endTime": {
                "hours": 20,
                "minutes": 0
              },
              "timeZone": "America/Los_Angeles",
              "startDay": "MONDAY",
              "endDay": "SATURDAY"
            }
          ]
        }
      }
    }
  }
}'create-agent-bm.sh

Node.js


/**
 * This code snippet creates a Business Messages agent.
 * Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/agents?method=api#create_the_agent
 *
 * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js
 * Business Communications client library.
 */

/**
 * Edit the values below:
 */
const BRAND_ID = 'EDIT_HERE';
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');
const uuidv4 = require('uuid').v4;

// Initialize the Business Communications API
const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY);

async function main() {
  const authClient = await initCredentials();
  const brandName = 'brands/' + BRAND_ID;

  if (authClient) {
    const agentObject = {
      displayName: 'My first agent',
      businessMessagesAgent: {
        customAgentId: uuidv4(), // Optional
        logoUrl: 'https://developers.google.com/identity/images/g-logo.png',
        entryPointConfigs: [
          {
            allowedEntryPoint: 'NON_LOCAL',
          }
        ],
        nonLocalConfig: { // Configuration options for launching on non-local entry points
          // List of phone numbers for call deflection, values must be globally unique
          callDeflectionPhoneNumbers: [
            { number: '+10000000000' },
            { number: '+10000000001' },
          ],
          // Contact information for the agent that displays with the messaging button
          contactOption: {
            options: [
              'EMAIL',
              'PHONE'
            ],
            url: 'https://www.your-company-website.com',
          },
          // Domains enabled for messaging within Search, values must be globally unique
          enabledDomains: [ 'your-company-website.com' ],
          // Agent's phone number. Overrides the `phone` field
          // for conversations started from non-local entry points
          phoneNumber: { number: '+10000000000' },
          // List of CLDR region codes for countries where the agent is allowed to launch `NON_LOCAL` entry points
          regionCodes: [ 'US', 'CA' ]
        },
        // Must match a conversational setting locale
        defaultLocale: 'en',
        conversationalSettings: {
          en: {
            privacyPolicy: { url: 'https://www.your-company-website.com/privacy' },
            welcomeMessage: { text: 'This is a sample welcome message' },
            conversationStarters: [
              {
                suggestion: {
                  reply: {
                    text: 'Option 1',
                    postbackData: 'postback_option_1',
                  },
                },
              },
            ],
          },
        },
        primaryAgentInteraction: {
          interactionType: 'HUMAN',
          humanRepresentative: {
            humanMessagingAvailability: {
              hours: [
                {
                  startTime: {
                    hours: 8,
                    minutes: 30
                  },
                  startDay: 'MONDAY',
                  endDay: 'SATURDAY',
                  endTime: {
                    hours: 20,
                    minutes: 0
                  },
                  timeZone: 'America/Los_Angeles',
                },
              ],
            },
          },
        },
      },
    };

    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      parent: brandName,
      resource: agentObject
    };

    bcApi.brands.agents.create(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent created
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
 async function initCredentials() {
  // Configure a JWT auth client
  const authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // Authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject(false);
      } else {
        resolve(authClient);
      }
    });
  });
}

main();create-agent-bm.js

Java

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.businesscommunications.v1.BusinessCommunications;
import com.google.api.services.businesscommunications.v1.model.Brand;
import com.google.common.collect.ImmutableMap;
import java.io.FileInputStream;
import java.util.Arrays;
import java.util.UUID;

class Main {
  /**
   * Initializes credentials used by the Business Communications API.
   */
  private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
    BusinessCommunications.Builder builder = null;
    try {
      GoogleCredential credential = GoogleCredential
            .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));

      credential = credential.createScoped(Arrays.asList(
          "https://www.googleapis.com/auth/businesscommunications"));

      credential.refreshToken();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();

      // Create instance of the Business Communications API
      builder = new BusinessCommunications
          .Builder(httpTransport, jsonFactory, null)
          .setApplicationName(credential.getServiceAccountProjectId());

      // Set the API credentials and endpoint
      builder.setHttpRequestInitializer(credential);
    } catch (Exception e) {
      e.printStackTrace();
    }

    return builder;
  }

  public static void main(String args[]) {
    try {
      // Create client library reference
      BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();

      String brandName = "BRAND_ID";

      BusinessCommunications.Brands.Agents.Create request = builder
          .build().brands().agents().create(brandName,
              new Agent()
                  .setDisplayName("AGENT_NAME")
                  .setBusinessMessagesAgent(new BusinessMessagesAgent()
                      .setCustomAgentId("CUSTOM_ID") // Optional
                      .setLogoUrl("LOGO_URL")
                      .setEntryPointConfigs(Arrays.asList(
                        new BusinessMessagesEntryPointConfig()
                            .setAllowedEntryPoint(
                                "ENTRY_POINT_1"),
                        new BusinessMessagesEntryPointConfig()
                            .setAllowedEntryPoint(
                                "ENTRY_POINT_2")
                      ))
                      // Configuration options for launching on non-local entry points
                      .setNonLocalConfig(new NonLocalConfig()
                        // List of phone numbers for call deflection, values must be globally unique
                        .setCallDeflectionPhoneNumbers(Arrays.asList(new Phone().setNumber("DEFLECTION_PHONE_NUMBER_1"),
                            new Phone().setNumber("DEFLECTION_PHONE_NUMBER_2")))
                        // Contact information for the agent that displays with the messaging button
                        .setContactOption(new ContactOption().setOptions(Arrays.asList(
                            "CONTACT_OPTION_1",
                            "CONTACT_OPTION_2")
                        ).setUrl("WEBSITE_URL"))
                        // Domains enabled for messaging within Search, values must be globally unique
                        .setEnabledDomains(Arrays.asList("ENABLED_DOMAIN_1", "ENABLED_DOMAIN_2"))
                        // Agent's phone number. Overrides the `phone` field for
                        // conversations started from non-local entry points
                        .setPhoneNumber(new Phone().setNumber("CONTACT_PHONE_NUMBER"))
                        // List of regions where this agent will be available
                        .setRegionCodes(Arrays.asList("REGION_CODE")))
                      .setDefaultLocale("LOCALE")
                      // Create a map between the language code and the initial conversation settings
                      .setConversationalSettings(ImmutableMap.of("LOCALE",
                        new ConversationalSetting()
                            .setPrivacyPolicy(new PrivacyPolicy().setUrl("PRIVACY_POLICY_URL"))
                            .setWelcomeMessage(new WelcomeMessage().setText("WELCOME_MESSAGE"))
                            .setConversationStarters(Arrays.asList(
                                new ConversationStarters().setSuggestion(new Suggestion()
                                    .setReply(new SuggestedReply().setText("SUGGESTION_TEXT").setPostbackData("SUGGESTION_POSTBACK_DATA")))
                            ))))
                      .setPrimaryAgentInteraction(new SupportedAgentInteraction()
                          .setInteractionType(InteractionType.HUMAN.toString())
                          .setHumanRepresentative(new HumanRepresentative()
                              .setHumanMessagingAvailability(new MessagingAvailability()
                                  // Create a list of available hours
                                  .setHours(Arrays.asList(new Hours()
                                    .setStartTime(new TimeOfDay().setHours(START_TIME_HOURS).setMinutes(START_TIME_MINUTES))
                                    .setStartDay("BEGINNING_DAY_OF_WEEK")
                                    .setEndDay("END_DAY_OF_WEEK")
                                    .setEndTime(new TimeOfDay().setHours(END_TIME_HOURS).setMinutes(END_TIME_MINUTES))
                                    .setTimeZone("TIME_ZONE"))))))

                  ));

      Agent agent = request.execute();

      System.out.println(agent.toPrettyString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

このコードは、Java Business Communications クライアントライブラリに基づいています。

Python


"""This code creates a Business Messages agent.

Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/agents?method=api#create_the_agent

This code is based on the https://github.com/google-business-communications/python-businessmessages
Python Business Messages client library.
"""

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1
from businesscommunications.businesscommunications_v1_messages import (
    Agent, BusinesscommunicationsBrandsAgentsCreateRequest,
    BusinessMessagesAgent, BusinessMessagesEntryPointConfig,
    ContactOption, ConversationalSetting, ConversationStarters,
    Hours, HumanRepresentative, MessagingAvailability,
    NonLocalConfig, Phone, PrivacyPolicy, Suggestion,
    SuggestedReply, SupportedAgentInteraction,
    TimeOfDay, WelcomeMessage
)

# Edit the values below:
BRAND_ID = 'EDIT_HERE'
SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = './service_account_key.json'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

brand_name = 'brands/ '+ BRAND_ID

agent = Agent(
    displayName='My first agent',
    businessMessagesAgent=BusinessMessagesAgent(
        customAgentId='CUSTOM_ID', # Optional
        logoUrl='https://developers.google.com/identity/images/g-logo.png',
        entryPointConfigs=[BusinessMessagesEntryPointConfig(
            allowedEntryPoint=BusinessMessagesEntryPointConfig.AllowedEntryPointValueValuesEnum.LOCATION
        ), BusinessMessagesEntryPointConfig(
            allowedEntryPoint=BusinessMessagesEntryPointConfig.AllowedEntryPointValueValuesEnum.NON_LOCAL
        )],
        nonLocalConfig=NonLocalConfig(
            # List of phone numbers for call deflection, values must be globally unique
            # Generating a random phone number for demonstration purposes
            # This should be replaced with a real brand phone number
            callDeflectionPhoneNumbers=[Phone(number='+10000000000'),
              Phone(number='+10000000001')],
            # Contact information for the agent that displays with the messaging button
            contactOption=ContactOption(
                    options=[ContactOption.OptionsValueListEntryValuesEnum.EMAIL,
                        ContactOption.OptionsValueListEntryValuesEnum.PHONE],
                    url='https://www.your-company-website.com'
                ),
            # Domains enabled for messaging within Search, values must be globally unique
            # Generating a random URL for demonstration purposes
            # This should be replaced with a real brand URL
            enabledDomains=['your-company-website.com'],
            # Agent's phone number. Overrides the `phone` field for conversations started from non-local entry points
            phoneNumber=Phone(number='+10000000000'),
            # List of CLDR region codes for countries where the agent is allowed to launch `NON_LOCAL` entry points.
            # Example is for launching in Canada and the USA
            regionCodes=['US', 'CA']
        ),
        defaultLocale='en',
        conversationalSettings=BusinessMessagesAgent.ConversationalSettingsValue(
            additionalProperties=[BusinessMessagesAgent.ConversationalSettingsValue.AdditionalProperty(
                key='en',
                value=ConversationalSetting(
                    privacyPolicy=PrivacyPolicy(url='https://www.your-company-website.com/privacy'),
                    welcomeMessage=WelcomeMessage(text='This is a sample welcome message'),
                    conversationStarters=[
                        ConversationStarters(
                            suggestion=Suggestion(
                                reply=SuggestedReply(text='Option 1',
                                                     postbackData='postback_option_1')
                            )
                        )
                    ]
                )
            )]
        ),
        primaryAgentInteraction=SupportedAgentInteraction(
            interactionType=SupportedAgentInteraction.InteractionTypeValueValuesEnum.HUMAN,
            humanRepresentative=HumanRepresentative(
                humanMessagingAvailability=MessagingAvailability(hours=[
                        Hours(
                            startTime=TimeOfDay(hours=8, minutes=30),
                            startDay=Hours.StartDayValueValuesEnum.MONDAY,
                            endDay=Hours.EndDayValueValuesEnum.SATURDAY,
                            endTime=TimeOfDay(hours=20, minutes=0),
                            timeZone='America/Los_Angeles'
                        )
                    ])
            )
        ),
    )
)

new_agent = agents_service.Create(
    BusinesscommunicationsBrandsAgentsCreateRequest(
        agent=agent,
        parent=brand_name
    )
)

print(new_agent)create-agent-bm.py

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

ブランドにエージェントに関連付けるビジネスがある場合は、ビジネスを追加するをご覧ください。

例: Growing Tree Bank のエージェントを作成する

curl -X POST "https://businesscommunications.googleapis.com/v1/brands" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json /path/to/service/account/key.json businesscommunications)" \
-d "{
    'displayName': 'Growing Tree Bank'
}"

# Fetch returned brand name value of "brands/12345"

curl -X POST "https://businesscommunications.googleapis.com/v1/brands/12345/agents" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json /path/to/service/account/key.json businesscommunications)" \
-d "{
    'displayName': 'Growing Tree Bank',
    'businessMessagesAgent': {
        'logoUrl': 'https://www.growingtreebank.com/images/logo.png',
        'entryPointConfigs': [
          {
            'allowedEntryPoint': 'NON_LOCAL',
          },
          {
            'allowedEntryPoint': 'LOCATION',
          },
        ],
        'customAgentId': 'growing-tree-bank',
        'nonLocalConfig': {
            'regionCodes': ['001'],
            'contactOption': {
                'url': 'https://www.growingtreebank.com',
                'options': [
                    'EMAIL',
                    'PHONE',
                ],
            },
            'enabledDomains': [
                'https://www.growingtreebank.com',
            ],
            'phoneNumber': {
                'number': '+12223334444',
            },
            'callDeflectionPhoneNumbers': [
                {
                    'number': '+12223334444',
                },
                {
                    'number': '+56667778888',
                },
            ],
        },
        'conversationalSettings': {
            'en': {
                'welcomeMessage': {
                    'text': 'Thanks for contacting Growing Tree Bank. What can I help with today?',
                },
                'privacyPolicy': {
                    'url': 'https://www.growingtreebank.com/privacy',
                },
                'conversationStarters': [
                    {
                        'suggestion': {
                            'reply': {
                                'text': 'Set up an account',
                                'postbackData': 'new-account',
                            },
                        },
                    },
                ],
            },
        },
        'defaultLocale': 'en',
        'primaryAgentInteraction': {
            'interactionType': 'BOT',
            'botRepresentative': {
                'botMessagingAvailability': {
                    'hours': [
                        {
                            'startTime': {
                                'hours': '8',
                                'minutes': '00',
                            },
                            'endTime': {
                                'hours': '17',
                                'minutes': '30',
                            },
                            'timeZone': 'America/Los_Angeles',
                            'startDay': 'MONDAY',
                            'endDay': 'FRIDAY',
                        },
                    ],
                },
            },
        },
    },
}"

重要な情報を保存する

エージェントを作成すると、Business Communications API はエージェントの値（name、testUrls など）を返します。

エージェントレベルの Webhook を設定する

Webhook でエージェントに送信されたメッセージを受信します。特定のエージェント宛てのメッセージが別の Webhook に送信されるようにするには、エージェントレベルの Webhook を設定します。

エージェントレベルの Webhook を設定するには、Play Console を使用します。

エージェントをテストする

各エージェントにはテスト URL があります。これにより、エージェントとの会話がユーザーにどのように表示されるかを確認し、メッセージングインフラストラクチャを検証できます。

TestUrl には url 属性と surface 属性があります。 iOS デバイスでテストするには、サーフェス値が SURFACE_IOS_MAPS のテスト URL を使用します。Google マップアプリがインストールされている iOS デバイスでこの URL を開くと、エージェントとの会話機能が完全に開始します。

Android デバイスには 2 つのテスト URL があります。surface 値が SURFACE_ANDROID_MAPS の URL は、Google マップで会話を開き、Google マップに表示される会話のエントリポイントを表します。surface 値が SURFACE_ANDROID_WEB の URL は、会話がオーバーレイの会話ビューで開き、他のすべてのエントリポイントを表します。

会話サーフェスが開くと、会話にはユーザーに表示されるすべてのブランディング情報が含まれます。エージェントにメッセージを送信すると、Webhook は、ユーザーとの通信時に想定される完全な JSON ペイロードを含むメッセージを受信します。

エージェントのテスト URL を開くには、リンクをタップするか、モバイルデバイスでビジネスメッセージエージェントランチャーを使用します。

エージェント情報を取得する

agentTestUrl などのエージェントに関する情報を取得するには、エージェントの name 値があれば、Business Communications API から情報を取得できます。

1 人のエージェントに関する情報を取得する

エージェント情報を取得するには、次のコマンドを実行します。BRAND_ID と AGENT_ID は、エージェントの name の一意の値に置き換えます。

cURL


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

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

curl -X GET \
"https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)"get-agent.sh

Node.js


/**
 * This code snippet gets an agent.
 * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/get
 *
 * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js
 * Business Communications client library.
 */

/**
 * Edit the values below:
 */
const BRAND_ID = 'EDIT_HERE';
const AGENT_ID = 'EDIT_HERE';
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY);

async function main() {
  const authClient = await initCredentials();

  const agentName = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID;

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: agentName,
    };

    bcApi.brands.agents.get(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent found
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
 async function initCredentials() {
  // Configure a JWT auth client
  const authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // Authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject(false);
      } else {
        resolve(authClient);
      }
    });
  });
}

main();get-agent.js

Java

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.businesscommunications.v1.BusinessCommunications;
import com.google.api.services.businesscommunications.v1.model.Agent;
import java.io.FileInputStream;
import java.util.Arrays;

class Main {
  /**
   * Initializes credentials used by the Business Communications API.
   */
  private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
    BusinessCommunications.Builder builder = null;
    try {
      GoogleCredential credential = GoogleCredential
            .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));

      credential = credential.createScoped(Arrays.asList(
          "https://www.googleapis.com/auth/businesscommunications"));

      credential.refreshToken();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();

      // Create instance of the Business Communications API
      builder = new BusinessCommunications
          .Builder(httpTransport, jsonFactory, null)
          .setApplicationName(credential.getServiceAccountProjectId());

      // Set the API credentials and endpoint
      builder.setHttpRequestInitializer(credential);
    } catch (Exception e) {
      e.printStackTrace();
    }

    return builder;
  }

  public static void main(String args[]) {
    try {
      // Create client library reference
      BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();

      String agentName = "brands/BRAND_ID/agents/AGENT_ID";

      BusinessCommunications.Brands.Agents.Get request = builder
        .build().brands().agents().get(agentName);

      Agent agent = request.execute();

      System.out.println(agent.toPrettyString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

このコードは、Java Business Communications クライアントライブラリに基づいています。

Python


"""This code gets the agent.

Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/get

This code is based on the https://github.com/google-business-communications/python-businessmessages
Python Business Messages client library.
"""

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1
from businesscommunications.businesscommunications_v1_messages import (
    Agent,
    BusinesscommunicationsBrandsAgentsGetRequest,
)

# Edit the values below:
BRAND_ID = 'EDIT_HERE'
AGENT_ID = 'EDIT_HERE'
SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = './service_account_key.json'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

agent_name = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID

agent = agents_service.Get(BusinesscommunicationsBrandsAgentsGetRequest(
        name=agent_name
    ))

print(agent)get-agent.py

ブランドのすべてのエージェントを一覧表示する

エージェントの name がわからない場合は、GET リクエスト URL から AGENT_ID 値を省略することで、ブランドに関連付けられているすべてのエージェントの情報を取得できます。

cURL


# This code lists all agents from a brand.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/list

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

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

Node.js


/**
 * This code snippet lists the agents of a brand.
 * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/list
 *
 * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js
 * Business Communications client library.
 */

/**
 * Edit the values below:
 */
const BRAND_ID = 'EDIT_HERE';
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY);

async function main() {
  const authClient = await initCredentials();

  const brandName = 'brands/' + BRAND_ID;

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      parent: brandName,
    };

    bcApi.brands.agents.list(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent found
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
 async function initCredentials() {
  // Configure a JWT auth client
  const authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // Authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject(false);
      } else {
        resolve(authClient);
      }
    });
  });
}

main();list-agents.js

Java

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.businesscommunications.v1.BusinessCommunications;
import com.google.api.services.businesscommunications.v1.model.Agent;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;

class Main {
  /**
   * Initializes credentials used by the Business Communications API.
   */
  private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
    BusinessCommunications.Builder builder = null;
    try {
      GoogleCredential credential = GoogleCredential
            .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));

      credential = credential.createScoped(Arrays.asList(
          "https://www.googleapis.com/auth/businesscommunications"));

      credential.refreshToken();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();

      // Create instance of the Business Communications API
      builder = new BusinessCommunications
          .Builder(httpTransport, jsonFactory, null)
          .setApplicationName(credential.getServiceAccountProjectId());

      // Set the API credentials and endpoint
      builder.setHttpRequestInitializer(credential);
    } catch (Exception e) {
      e.printStackTrace();
    }

    return builder;
  }

  public static void main(String args[]) {
    try {
      // Create client library reference
      BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();

      String brandName = "brands/BRAND_ID";

      BusinessCommunications.Brands.Agents.List request = builder
          .build().brands().agents().list(brandName);

      List agents = request.execute().getAgents();
      agents.stream().forEach(agent -> {
        try {
          System.out.println(agent.toPrettyString());
        } catch (IOException e) {
          e.printStackTrace();
        }
      });
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

このコードは、Java Business Communications クライアントライブラリに基づいています。

Python


"""This code lists all agents from a brand.

Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/list

This code is based on the https://github.com/google-business-communications/python-businessmessages
Python Business Messages client library.
"""

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1
from businesscommunications.businesscommunications_v1_messages import (
    Agent,
    BusinesscommunicationsBrandsAgentsGetRequest,
)

# Edit the values below:
BRAND_ID = 'EDIT_HERE'
SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = './service_account_key.json'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

brand_name = 'brands/' + BRAND_ID

agents = agents_service.List(BusinesscommunicationsBrandsAgentsListRequest(
        parent=brand_name
    ))

print(agents)list-agents.py

エージェント情報を更新する

エージェントを更新するには、Business Communications API を使用して PATCH リクエストを実行します。API 呼び出しを行うときに、編集するフィールドの名前を「updateMask」URL パラメータの値として指定します。

たとえば、displayName フィールドと customAgentId フィールドを更新した場合、URL パラメータは「updateMask=displayName,businessMessagesAgent.customAgentId」になります。

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

エージェントの name が不明な場合は、ブランドのすべてのエージェントを一覧表示するをご覧ください。

エージェントの確認後に更新できるのは、次のフィールドのみです。

conversationalSetting

注意: conversationalSettings 内のフィールドを更新する場合は、オブジェクト内のすべてのフィールドを更新し、設定のロケールを 2 文字の ISO 639-1 言語コードで指定する必要があります。
customAgentId
defaultLocale
primaryAgentInteraction
additionalAgentInteractions
phone

エージェントの確認後に他のフィールドを更新する必要がある場合は、お問い合わせください。（まず、ビジネスメッセージの Google アカウントでログインする必要があります。アカウントを登録するには、ビジネスメッセージに登録するをご覧ください）。

例: 表示名を更新する

cURL

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID?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': 'Growing Tree Bank',
}"

Node.js

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
let bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require('PATH_TO_SERVICE_ACCOUNT_KEY');

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
async function initCredentials() {
  // Configure a JWT auth client
  let authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // Authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject(false);
      } else {
        resolve(authClient);
      }
    });
  });
}

async function main() {
  let authClient = await initCredentials();

  let agentName = 'brands/BRAND_ID/agents/AGENT_ID';

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: agentName,
      updateMask: 'displayName',
      resource: {
        displayName: 'Growing Tree Bank',
      }
    };

    bcApi.brands.agents.patch(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent found
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

main();

このコードは、Node.js Business Communications クライアントライブラリに基づいています。

Java

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.businesscommunications.v1.BusinessCommunications;
import com.google.api.services.businesscommunications.v1.model.Agent;
import java.io.FileInputStream;
import java.util.Arrays;

class Main {
  /**
   * Initializes credentials used by the Business Communications API.
   */
  private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
    BusinessCommunications.Builder builder = null;
    try {
      GoogleCredential credential = GoogleCredential
            .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));

      credential = credential.createScoped(Arrays.asList(
          "https://www.googleapis.com/auth/businesscommunications"));

      credential.refreshToken();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();

      // Create instance of the Business Communications API
      builder = new BusinessCommunications
          .Builder(httpTransport, jsonFactory, null)
          .setApplicationName(credential.getServiceAccountProjectId());

      // Set the API credentials and endpoint
      builder.setHttpRequestInitializer(credential);
    } catch (Exception e) {
      e.printStackTrace();
    }

    return builder;
  }

  public static void main(String args[]) {
    try {
      // Create client library reference
      BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();

      String agentName = "brands/BRAND_ID/agents/AGENT_ID";

      Agent agent = new Agent().setDisplayName("Growing Tree Bank");

      BusinessCommunications.Brands.Agents.Patch request = builder
          .build().brands().agents().patch(agentName, agent);

      request.setUpdateMask("displayName");

      Agent updatedAgent = request.execute();
      System.out.println(updatedAgent.toPrettyString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

このコードは、Java Business Communications クライアントライブラリに基づいています。

Python

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import (
    BusinesscommunicationsV1
)
from businesscommunications.businesscommunications_v1_messages import (
    Agent,
    BusinesscommunicationsBrandsAgentsPatchRequest,
)

SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = 'PATH_TO_SERVICE_ACCOUNT_KEY'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

agent_name = 'brands/BRAND_ID/agents/AGENT_ID'

agent=Agent(
          displayName='Growing Tree Bank'
      )

updated_agent = agents_service.Patch(
        BusinesscommunicationsBrandsAgentsPatchRequest(
            agent=agent,
            name=agent_name,
            updateMask='displayName'
        )
    )

print(updated_agent)

このコードは、Python Business Communications クライアントライブラリに基づいています。

例: `NON_LOCAL` と `LOCATION` のエントリポイントグループを指定する

cURL

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID?updateMask=businessMessagesAgent.entryPointConfigs" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications)" \
-d "{
  'businessMessagesAgent': {
    'entryPointConfigs': [
      {
        'allowedEntryPoint': 'NON_LOCAL',
      },
      {
        'allowedEntryPoint': 'LOCATION',
      },
    ],
  },
}"

Node.js

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
let bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require('PATH_TO_SERVICE_ACCOUNT_KEY');

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
async function initCredentials() {
  // Configure a JWT auth client
  let authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // Authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject(false);
      } else {
        resolve(authClient);
      }
    });
  });
}

async function main() {
  let authClient = await initCredentials();

  let agentName = 'brands/BRAND_ID/agents/AGENT_ID';

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: agentName,
      updateMask: 'businessMessagesAgent.entryPointConfigs',
      resource: {
        businessMessagesAgent: {
          entryPointConfigs: [
            {
              allowedEntryPoint: 'LOCATION',
            },
            {
              allowedEntryPoint: 'NON_LOCAL',
            },
          ],
        }
      }
    };

    bcApi.brands.agents.patch(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent found
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

main();

このコードは、Node.js Business Communications クライアントライブラリに基づいています。

Java

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.businesscommunications.v1.BusinessCommunications;
import com.google.api.services.businesscommunications.v1.model.*;
import java.io.FileInputStream;
import java.util.Arrays;

class Main {
  /**
   * Initializes credentials used by the Business Communications API.
   */
  private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
    BusinessCommunications.Builder builder = null;
    try {
      GoogleCredential credential = GoogleCredential
            .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));

      credential = credential.createScoped(Arrays.asList(
          "https://www.googleapis.com/auth/businesscommunications"));

      credential.refreshToken();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();

      // Create instance of the Business Communications API
      builder = new BusinessCommunications
          .Builder(httpTransport, jsonFactory, null)
          .setApplicationName(credential.getServiceAccountProjectId());

      // Set the API credentials and endpoint
      builder.setHttpRequestInitializer(credential);
    } catch (Exception e) {
      e.printStackTrace();
    }

    return builder;
  }

  public static void main(String args[]) {
    try {
      // Create client library reference
      BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();

      String agentName = "brands/BRAND_ID/agents/AGENT_ID";

      Agent agent = new Agent().setBusinessMessagesAgent(
          new BusinessMessagesAgent().setEntryPointConfigs(Arrays.asList(
              new BusinessMessagesEntryPointConfig()
                  .setAllowedEntryPoint(
                      "NON_LOCAL"),
              new BusinessMessagesEntryPointConfig()
                  .setAllowedEntryPoint(
                      "LOCATION"))));

      BusinessCommunications.Brands.Agents.Patch request = builder
          .build().brands().agents().patch(agentName, agent);

      request.setUpdateMask("businessMessagesAgent.entryPointConfigs");

      Agent updatedAgent = request.execute();
      System.out.println(updatedAgent.toPrettyString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

このコードは、Java Business Communications クライアントライブラリに基づいています。

Python

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import (
    BusinesscommunicationsV1
)
from businesscommunications.businesscommunications_v1_messages import (
    Agent,
    BusinessMessagesAgent,
    BusinessMessagesEntryPointConfig,
    BusinesscommunicationsBrandsAgentsPatchRequest,
)

SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = 'PATH_TO_SERVICE_ACCOUNT_KEY'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

agent_name = 'brands/BRAND_ID/agents/AGENT_ID'

agent=Agent(
    businessMessagesAgent=BusinessMessagesAgent(
        entryPointConfigs=[BusinessMessagesEntryPointConfig(
            allowedEntryPoint=BusinessMessagesEntryPointConfig.AllowedEntryPointValueValuesEnum.NON_LOCAL
        ), BusinessMessagesEntryPointConfig(
            allowedEntryPoint=BusinessMessagesEntryPointConfig.AllowedEntryPointValueValuesEnum.LOCATION
        )]
    )
)

updated_agent = agents_service.Patch(
        BusinesscommunicationsBrandsAgentsPatchRequest(
            agent=agent,
            name=agent_name,
            updateMask='businessMessagesAgent.entryPointConfigs'
        )
    )

print(updated_agent)

このコードは、Python Business Communications クライアントライブラリに基づいています。

例: ウェルカムメッセージを更新する

conversationalSettings 内のフィールド（welcomeMessage など）を更新する場合は、オブジェクト内のすべてのフィールドを更新し、設定のロケール（2 文字の ISO 639-1 言語コード）を指定する必要があります。

cURL

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID?updateMask=businessMessagesAgent.conversationalSettings.en" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications)" \
-d "{
    'businessMessagesAgent': {
        'conversationalSettings': {
            'en': {
                'welcomeMessage': {
                    'text': 'Thanks for contacting Growing Tree Bank. What can I help with today?',
                },
                'offlineMessage': {
                    'text': 'We\'re closed for the night. Please reach out to us again tomorrow.',
                },
                'privacyPolicy': {
                    'url': 'https://www.growingtreebank.com/privacy',
                },
                'conversationStarters': [
                    {
                        'suggestion': {
                            'reply': {
                                'text': 'Set up an account',
                                'postbackData': 'new-account',
                            },
                        },
                    },
                    {
                        'suggestion': {
                            'reply': {
                                'text': 'Look up account information',
                                'postbackData': 'account-lookup',
                            },
                        },
                    },
                ],
            },
        },
    },
}"

Node.js

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
let bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require('PATH_TO_SERVICE_ACCOUNT_KEY');

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
async function initCredentials() {
  // Configure a JWT auth client
  let authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // Authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject(false);
      } else {
        resolve(authClient);
      }
    });
  });
}

async function main() {
  let authClient = await initCredentials();

  let agentName = 'brands/BRAND_ID/agents/AGENT_ID';

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: agentName,
      updateMask: 'businessMessagesAgent.conversationalSettings.en',
      resource: {
        businessMessagesAgent: {
          conversationalSettings: {
            en: {
              privacyPolicy: { url: 'https://www.growingtreebank.com/privacy' },
              welcomeMessage: { text: 'Thanks for contacting Growing Tree Bank. What can I help with today?' },
              offlineMessage: { text: 'We\'re closed for the night. Please reach out to us again tomorrow.' },
              conversationStarters: [
                {
                  suggestion: {
                    reply: {
                      text: 'Set up an account',
                      postbackData: 'new-account',
                    },
                  },
                },
                {
                  suggestion: {
                    reply: {
                      text: 'Look up account information',
                      postbackData: 'account-lookup',
                    },
                  },
                },
              ],
            },
          }
        }
      }
    };

    bcApi.brands.agents.patch(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent found
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

main();

このコードは、Node.js Business Communications クライアントライブラリに基づいています。

Java

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.businesscommunications.v1.BusinessCommunications;
import com.google.api.services.businesscommunications.v1.model.*;
import com.google.common.collect.ImmutableMap;
import java.io.FileInputStream;
import java.util.Arrays;

class Main {
  /**
   * Initializes credentials used by the Business Communications API.
   */
  private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
    BusinessCommunications.Builder builder = null;
    try {
      GoogleCredential credential = GoogleCredential
            .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));

      credential = credential.createScoped(Arrays.asList(
          "https://www.googleapis.com/auth/businesscommunications"));

      credential.refreshToken();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();

      // Create instance of the Business Communications API
      builder = new BusinessCommunications
          .Builder(httpTransport, jsonFactory, null)
          .setApplicationName(credential.getServiceAccountProjectId());

      // Set the API credentials and endpoint
      builder.setHttpRequestInitializer(credential);
    } catch (Exception e) {
      e.printStackTrace();
    }

    return builder;
  }

  public static void main(String args[]) {
    try {
      // Create client library reference
      BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();

      String agentName = "brands/BRAND_ID/agents/AGENT_ID";

      Agent agent = new Agent().setBusinessMessagesAgent(
          new BusinessMessagesAgent().setConversationalSettings(ImmutableMap.of("en",
              new ConversationalSetting()
                  .setPrivacyPolicy(new PrivacyPolicy().setUrl("https://www.growingtreebank.com/privacy"))
                  .setWelcomeMessage(new WelcomeMessage().setText("Thanks for contacting Growing Tree Bank. What can I help with today?"))
                  .setOfflineMessage(new OfflineMessage().setText("We're closed for the night. Please reach out to us again tomorrow."))
                  .setConversationStarters(Arrays.asList(
                      new ConversationStarters().setSuggestion(new Suggestion()
                          .setReply(new SuggestedReply()
                              .setText("Set up an account")
                              .setPostbackData("new-account"))),
                      new ConversationStarters().setSuggestion(new Suggestion()
                          .setReply(new SuggestedReply()
                              .setText("Look up account information")
                              .setPostbackData("account-lookup")))
                      )))));

      BusinessCommunications.Brands.Agents.Patch request = builder
          .build().brands().agents().patch(agentName, agent);

      request.setUpdateMask("businessMessagesAgent.conversationalSettings.en");

      Agent updatedAgent = request.execute();
      System.out.println(updatedAgent.toPrettyString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

このコードは、Java Business Communications クライアントライブラリに基づいています。

Python

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import (
    BusinesscommunicationsV1
)
from businesscommunications.businesscommunications_v1_messages import (
    Agent,
    BusinessMessagesAgent,
    ConversationStarters,
    ConversationalSetting,
    OfflineMessage,
    PrivacyPolicy,
    WelcomeMessage,
    BusinesscommunicationsBrandsAgentsPatchRequest,
)

SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = 'PATH_TO_SERVICE_ACCOUNT_KEY'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

agent_name = 'brands/BRAND_ID/agents/AGENT_ID'

agent=Agent(
		businessMessagesAgent=BusinessMessagesAgent(
		  	conversationalSettings=BusinessMessagesAgent.ConversationalSettingsValue(
		        additionalProperties=[BusinessMessagesAgent.ConversationalSettingsValue.AdditionalProperty(
		            key='en',
		            value=ConversationalSetting(
		                privacyPolicy=PrivacyPolicy(url='https://www.growingtreebank.com/privacy'),
		                welcomeMessage=WelcomeMessage(text='Thanks for contacting Growing Tree Bank. What can I help with today?'),
		                offlineMessage=OfflineMessage(text='We\'re closed for the night. Please reach out to us again tomorrow.'),
		                conversationStarters=[
		                    ConversationStarters(
		                        suggestion=Suggestion(
		                            reply=SuggestedReply(text='Set up an account',
		                                postbackData='new-account')
		                        )
		                    ),
		                    ConversationStarters(
		                        suggestion=Suggestion(
		                            reply=SuggestedReply(text='Look up account information',
		                                postbackData='account-lookup')
		                        )
		                    )]
		                )
		            )
		        ]
		    )
		)
)

updated_agent = agents_service.Patch(
        BusinesscommunicationsBrandsAgentsPatchRequest(
            agent=agent,
            name=agent_name,
            updateMask='businessMessagesAgent.conversationalSettings.en'
        )
    )

print(updated_agent)

このコードは、Python Business Communications クライアントライブラリに基づいています。

エージェントを削除する

エージェントを削除すると、ビジネスメッセージによってすべてのエージェントデータが削除されます。ビジネスメッセージは、エージェントが送信したメッセージのうち、ユーザーのデバイスに転送中またはデバイスに保存されているメッセージは削除されません。ユーザーへのメッセージはエージェントデータではありません。

エージェントにロケーションが関連付けられている場合、またはエージェントの確認を 1 回以上試みた場合、削除リクエストが失敗します。ビジネス情報を更新するには、ビジネス情報を追加するをご覧ください。

確認済みのエージェントは削除できません。確認または確認を試みたエージェントを削除するには、お問い合わせください。（まず、ビジネスメッセージの Google アカウントでログインする必要があります。アカウントを登録するには、ビジネスメッセージに登録するをご覧ください）。

エージェントを削除するには、次のコマンドを実行します。BRAND_ID と AGENT_ID は、エージェントの name の一意の値に置き換えます。

cURL


# This code deletes an agent.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/delete

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

curl -X DELETE "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)"delete-agent.sh

Node.js


/**
 * This code snippet deletes an agent.
 * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/delete
 *
 * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js
 * Business Communications client library.
 */

/**
 * Edit the values below:
 */
const BRAND_ID = 'EDIT_HERE';
const AGENT_ID = 'EDIT_HERE';
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY);

async function main() {
  const authClient = await initCredentials();

  const agentName = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID;

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: agentName,
    };

    bcApi.brands.agents.delete(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent removed
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
 async function initCredentials() {
  // Configure a JWT auth client
  const authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // Authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject(false);
      } else {
        resolve(authClient);
      }
    });
  });
}

main();delete-agent.js

Java

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.businesscommunications.v1.BusinessCommunications;
import com.google.api.services.businesscommunications.v1.model.*;
import java.io.FileInputStream;
import java.util.Arrays;

class Main {
  /**
   * Initializes credentials used by the Business Communications API.
   */
  private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
    BusinessCommunications.Builder builder = null;
    try {
      GoogleCredential credential = GoogleCredential
            .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));

      credential = credential.createScoped(Arrays.asList(
          "https://www.googleapis.com/auth/businesscommunications"));

      credential.refreshToken();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();

      // Create instance of the Business Communications API
      builder = new BusinessCommunications
          .Builder(httpTransport, jsonFactory, null)
          .setApplicationName(credential.getServiceAccountProjectId());

      // Set the API credentials and endpoint
      builder.setHttpRequestInitializer(credential);
    } catch (Exception e) {
      e.printStackTrace();
    }

    return builder;
  }

  public static void main(String args[]) {
    try {
      // Create client library reference
      BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();

      String agentName = "brands/BRAND_ID/agents/AGENT_ID";

      BusinessCommunications.Brands.Agents.Delete request
         = builder.build().brands().agents().delete(agentName);

      System.out.println(request.execute());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

このコードは、Java Business Communications クライアントライブラリに基づいています。

Python


"""This code deletes an agent.

Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/delete

This code is based on the https://github.com/google-business-communications/python-businessmessages
Python Business Messages client library.
"""

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1
from businesscommunications.businesscommunications_v1_messages import (
    Agent,
    BusinesscommunicationsBrandsAgentsDeleteRequest,
)

# Edit the values below:
BRAND_ID = 'EDIT_HERE'
AGENT_ID = 'EDIT_HERE'
SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = './service_account_key.json'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

agent_name = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID

agent = agents_service.Delete(BusinesscommunicationsBrandsAgentsDeleteRequest(
        name=agent_name
    ))

print(agent)delete-agent.py

書式設定と値のオプションについては、brands.agents.delete をご覧ください。

ブランドを削除する

ブランドを削除するときは、Business Communications API を使用して DELETE リクエストを実行します。ブランドに関連付けられているエージェントまたはロケーションが 1 つ以上ある場合、それらのエージェントが別のプロダクトに属している場合でも、削除リクエストは失敗します。

ブランドを削除するには、次のコマンドを実行します。BRAND_ID は、ブランドの name の一意の値に置き換えます。

cURL


# This code deletes a brand.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/delete

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

curl -X DELETE "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)"delete-brand.sh

Node.js


/**
 * This code snippet deletes a brand.
 * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/delete
 *
 * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js
 * Business Communications client library.
 */

/**
 * Edit the values below:
 */
const BRAND_ID = 'EDIT_HERE';
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY);

async function main() {
  const authClient = await initCredentials();

  const brandName = 'brands/' + BRAND_ID;

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: brandName,
    };

    bcApi.brands.delete(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Brand removed
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
 async function initCredentials() {
  // Configure a JWT auth client
  const authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // Authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject(false);
      } else {
        resolve(authClient);
      }
    });
  });
}

main();delete-brand.js

Java

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.businesscommunications.v1.BusinessCommunications;
import com.google.api.services.businesscommunications.v1.model.*;
import java.io.FileInputStream;
import java.util.Arrays;

class Main {
  /**
   * Initializes credentials used by the Business Communications API.
   */
  private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
    BusinessCommunications.Builder builder = null;
    try {
      GoogleCredential credential = GoogleCredential
            .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));

      credential = credential.createScoped(Arrays.asList(
          "https://www.googleapis.com/auth/businesscommunications"));

      credential.refreshToken();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();

      // Create instance of the Business Communications API
      builder = new BusinessCommunications
          .Builder(httpTransport, jsonFactory, null)
          .setApplicationName(credential.getServiceAccountProjectId());

      // Set the API credentials and endpoint
      builder.setHttpRequestInitializer(credential);
    } catch (Exception e) {
      e.printStackTrace();
    }

    return builder;
  }

  public static void main(String args[]) {
    try {
      // Create client library reference
      BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();

      String brandName = "brands/BRAND_ID";

      BusinessCommunications.Brands.Delete request = builder.build().brands().delete(brandName);

      System.out.println(request.execute());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

このコードは、Java Business Communications クライアントライブラリに基づいています。

Python


"""This code deletes a brand.

Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/delete

This code is based on the https://github.com/google-business-communications/python-businessmessages
Python Business Messages client library.
"""

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1
from businesscommunications.businesscommunications_v1_messages import (
    BusinesscommunicationsBrandsAgentsDeleteRequest
)

# Edit the values below:
BRAND_ID = 'EDIT_HERE'
SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = './service_account_key.json'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

brand_name = 'brands/' + BRAND_ID

agent = agents_service.Delete(BusinesscommunicationsBrandsAgentsDeleteRequest(
        name=brand_name
    ))

print(agent)delete-brand.py

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

次のステップ

エージェントを用意できたので、次の操作を行います。

エージェントを作成してブランドを管理する

求められること

エージェントを作成する

前提条件

開発環境

ブランドの詳細

エージェントの外観とポリシー

エージェントとのやり取り

エージェントのエントリ ポイント

oauth2l をインストールしてテストする

エージェントを作成する

cURL

Node.js

Java

Python

cURL

Node.js

Java

Python

例: Growing Tree Bank のエージェントを作成する

重要な情報を保存する

エージェント レベルの Webhook を設定する

エージェントをテストする

エージェント情報を取得する

1 人のエージェントに関する情報を取得する

cURL

Node.js

Java

Python

ブランドのすべてのエージェントを一覧表示する

cURL

Node.js

Java

Python

エージェント情報を更新する

例: 表示名を更新する

cURL

Node.js

Java

Python

例: NON_LOCAL と LOCATION のエントリ ポイント グループを指定する

cURL

Node.js

Java

Python

例: ウェルカム メッセージを更新する

cURL

Node.js

Java

Python

エージェントを削除する

cURL

Node.js

Java

Python

ブランドを削除する

cURL

Node.js

Java

Python

次のステップ

エージェントのエントリポイント

エージェントレベルの Webhook を設定する

例: `NON_LOCAL` と `LOCATION` のエントリポイントグループを指定する

例: ウェルカムメッセージを更新する