REST Resource: brands.agents

リソース: Agent

ブランドを表す会話エンティティ。

JSON 表現 
{
  "name": string,
  "displayName": string,

  // Union field detail_info can be only one of the following:
  "businessMessagesAgent": {
    object (BusinessMessagesAgent)
  },
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // End of list of possible types for union field detail_info.
}
フィールド
name

string

エージェントの一意の識別子。

読み取り専用。プラットフォームで定義されます。
displayName

string

必須。エージェントがユーザーに表示する名前。100 文字以内で指定します。

エージェントによる確認後は変更できません。

共用体フィールド detail_info。特定の商品に必要なフィールドが含まれます。

必須。detail_info は次のいずれかになります。
businessMessagesAgent

object (BusinessMessagesAgent)

ビジネス メッセージに関するエージェントの詳細情報です。
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

RCS ビジネス メッセージに対応しているエージェントの詳細情報です。

BusinessMessagesAgent

ビジネス メッセージに固有のエージェント情報。

JSON 表現 
{
  "logoUrl": string,
  "entryPointConfigs": [
    {
      object (BusinessMessagesEntryPointConfig)
    }
  ],
  "conversationalSettings": {
    string: {
      object (ConversationalSetting)
    },
    ...
  },
  "defaultLocale": string,
  "primaryAgentInteraction": {
    object (SupportedAgentInteraction)
  },
  "additionalAgentInteractions": [
    {
      object (SupportedAgentInteraction)
    }
  ],
  "customAgentId": string,
  "agentTestUrl": string,
  "testUrls": [
    {
      object (TestUrl)
    }
  ],
  "phone": {
    object (Phone)
  },
  "authorizationConfig": {
    object (AuthorizationConfig)
  },
  "nonLocalConfig": {
    object (NonLocalConfig)
  },
  "surveyConfig": {
    object (SurveyConfig)
  }
}
フィールド
logoUrl

string

省略可。エージェントのロゴの一般公開 URL。最大 50 KB。

エージェントによる確認後は変更できません。
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

省略可。エントリ ポイント構成のリスト。

エージェントによる確認後は変更できません。
conversationalSettings

map (key: string, value: object (ConversationalSetting))

必須。ロケールにマッピングされたエージェントの会話設定。ロケールは、整形式の IETF BCP 47 言語タグで表されます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }。
defaultLocale

string

必須。エージェントのデフォルトの言語 / 地域。conversationalSettings で定義されているロケールと一致する必要があります。
primaryAgentInteraction

object (SupportedAgentInteraction)

必須。メインのエージェント対応情報。ユーザーが会話を開始したときに使用されます。
additionalAgentInteractions[]

object (SupportedAgentInteraction)

省略可。エージェントとのやり取りに関する追加情報。エージェントが複数のインタラクション タイプをサポートできるようにします。
customAgentId

string

省略可。パートナーが指定するエージェントの識別子。この識別子は、エージェントに送信されるすべてのメッセージとともに渡されます。
agentTestUrl
(deprecated)

string

出力のみ。エージェントの会話エクスペリエンスをテストするための URL。

プラットフォームで定義されます。
testUrls[]

object (TestUrl)

出力のみ。エージェントの会話エクスペリエンスをテストするための URL。

プラットフォームで定義されます。
phone

object (Phone)

省略可。エージェントが表示する電話番号。指定しない場合、Google ナレッジグラフで見つかったブランドの電話番号があれば表示されます。
authorizationConfig

object (AuthorizationConfig)

省略可。OAuth サポートの認可構成。
nonLocalConfig

object (NonLocalConfig)

省略可。ローカル以外のエントリ ポイントの構成。
surveyConfig

object (SurveyConfig)

省略可。カスタム アンケートを有効にするための構成。

BusinessMessagesEntryPointConfig

エージェントのエントリ ポイントの構成。

JSON 表現 
{
  "allowedEntryPoint": enum (EntryPoint)
}
フィールド
allowedEntryPoint

enum (EntryPoint)

必須。エージェントの表示が有効になっている Google サーフェス。

EntryPoint

エージェントの表示が有効になっている Google サーフェス。

列挙型
ENTRY_POINT_UNSPECIFIED 未指定のエントリ ポイント。
LOCATION このエージェントのロケーションを有効にします。
NON_LOCAL ローカル以外のエントリ ポイントに対してビジネス メッセージを有効にします。

SupportedAgentInteraction

エージェントがサポートするやり取り。

JSON 表現 
{
  "interactionType": enum (InteractionType),

  // Union field representative can be only one of the following:
  "botRepresentative": {
    object (BotRepresentative)
  },
  "humanRepresentative": {
    object (HumanRepresentative)
  }
  // End of list of possible types for union field representative.
}
フィールド
interactionType

enum (InteractionType)

必須。エージェントがサポートするやり取りのタイプ。
共用体フィールド representative。構成タイプの詳細情報。必須。representative は次のいずれかになります。
botRepresentative

object (BotRepresentative)

bot 担当者の詳細。
humanRepresentative

object (HumanRepresentative)

人間の代表者の詳細。

InteractionType

エージェントがサポートするインタラクションのタイプ。

列挙型
INTERACTION_TYPE_UNSPECIFIED インタラクションが指定されていません。
BOT bot のインタラクション。
HUMAN ユーザーの操作。

BotRepresentative

bot 担当者の詳細。

JSON 表現 
{
  "botMessagingAvailability": {
    object (MessagingAvailability)
  }
}
フィールド
botMessagingAvailability

object (MessagingAvailability)

必須。bot メッセージングの対応状況。

MessagingAvailability

メッセージの送受信が可能な曜日の時間帯。複数の曜日の営業時間をグループ化できます。例: * 月曜～水曜の 08:00 ～ 16:00 時間 * 木曜～金曜の 10:00 ～ 14:00 時間（米国太平洋夏時間） * 木曜～金曜の 15:00 ～ 18:00 時間 * 土曜～土曜の 10:00 ～ 14:00 時間

空き状況に空きがある場合（日曜日に空き状況が明記されていない場合など）、その空き状況の間はメッセージを使用できません。

bot 時間は可用性に影響しません。bot のみのエージェントは常にウェルカム メッセージを表示しますが、人間の代表者と bot の代表者の両方を設定しているエージェントは、対応可否を定義する際に人間の代表者のみを考慮します。

JSON 表現 
{
  "hours": [
    {
      object (Hours)
    }
  ]
}
フィールド
hours[]

object (Hours)

必須。メッセージの対応時間

時間

メッセージの送受信が可能な時間帯。

JSON 表現 
{
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  },
  "timeZone": string,
  "startDay": enum (DayOfWeek),
  "endDay": enum (DayOfWeek)
}
フィールド
startTime

object (TimeOfDay)

必須。曜日の範囲内の各日の開始時間。
endTime

object (TimeOfDay)

必須。曜日の範囲内の各日の終了時間。
timeZone

string

必須。時間の IANA タイムゾーン。例: 「America/Los_Angeles」。
startDay

enum (DayOfWeek)

必須。開始日。
endDay

enum (DayOfWeek)

必須。終了日。指定した日が含まれます。

TimeOfDay

1 日のうちの時刻を表します。日付とタイムゾーンは意味を持たないか、他の場所で指定されています。API は、うるう秒を許可するようにできます。関連する型は、google.type.Date と google.protobuf.Timestamp です。

JSON 表現 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
フィールド
hours

integer

時間（24 時間形式）。0～23 である必要があります。API ではビジネスの終了時間などのシナリオにおいて、値 "24:00:00" を許可することもできます。
minutes

integer

分。0～59 である必要があります。
seconds

integer

秒。通常、0～59 である必要があります。API がうるう秒を許可する場合、値 60 が許可されます。
nanos

integer

秒の小数部分（ナノ秒単位）。0～999,999,999 である必要があります。

DayOfWeek

曜日を表します。

列挙型
DAY_OF_WEEK_UNSPECIFIED 曜日は指定されていません。
MONDAY 月曜日
TUESDAY 火曜日
WEDNESDAY 水曜日
THURSDAY 木曜日
FRIDAY Friday
SATURDAY Saturday
SUNDAY 日曜日

HumanRepresentative

担当者が対応する担当者の詳細。

JSON 表現 
{
  "humanMessagingAvailability": {
    object (MessagingAvailability)
  }
}
フィールド
humanMessagingAvailability

object (MessagingAvailability)

必須。人間によるメッセージの有無。

AuthorizationConfig

ビジネス メッセージで OAuth をサポートするための設定の詳細。

JSON 表現 
{
  "endpointUrl": string
}
フィールド
endpointUrl

string

ユーザーがログインするエンドポイント URL。

NonLocalConfig

ローカル以外のエントリ ポイントを有効にするための構成。

JSON 表現 
{
  "contactOption": {
    object (ContactOption)
  },
  "enabledDomains": [
    string
  ],
  "phoneNumber": {
    object (Phone)
  },
  "callDeflectionPhoneNumbers": [
    {
      object (Phone)
    }
  ],
  "regionCodes": [
    string
  ]
}
フィールド
contactOption

object (ContactOption)

必須。メッセージ ボタンと一緒に表示されるエージェントの連絡先情報です。
enabledDomains[]

string

必須。サイトリンクのエントリ ポイントで有効にするドメイン。
phoneNumber

object (Phone)

必須。エージェントの電話番号。ローカル以外のエントリ ポイントから開始された会話の phone フィールドをオーバーライドします。この電話番号は、設定したすべての地域で使用されます。
callDeflectionPhoneNumbers[]

object (Phone)

必須。通話の転送に使用する電話番号のリスト。
regionCodes[]

string

必須。エージェントが NON_LOCAL エントリ ポイントを起動できる国の CLDR リージョン コードのリスト。NON_LOCAL エントリ ポイントの場合は必須です。

ContactOption

メッセージ ボタンに加えて表示される連絡先情報。

JSON 表現 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
フィールド
url

string

必須。問い合わせオプションを利用できる URL です。
options[]

enum (Option)

必須。指定された URL で利用可能な連絡先オプションのリスト。

オプション

お問い合わせ方法

列挙型
OPTION_UNSPECIFIED 未指定
WEB_CHAT クリックします。
PHONE 電話オプション。
EMAIL メール オプション。
FAQS よくある質問のオプション。
TWITTER Twitter オプション。
WHATSAPP WhatsApp オプション。

SurveyConfig

カスタマイズされたアンケートの質問をサポートするための設定の詳細。

JSON 表現 
{
  "templateQuestionIds": [
    string
  ],
  "customSurveys": {
    string: {
      object (CustomSurveyConfig)
    },
    ...
  }
}
フィールド
templateQuestionIds[]

string

アンケートに含まれる質問のテンプレート ID のリスト。
customSurveys

map (key: string, value: object (CustomSurveyConfig))

ロケールにマッピングされた、エージェント向けのカスタム アンケートの質問。ロケールは、整形式の IETF BCP 47 言語タグで表されます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

CustomSurveyConfig

エージェントのカスタム アンケート構成。

JSON 表現 
{
  "customQuestions": [
    {
      object (SurveyQuestion)
    }
  ]
}
フィールド
customQuestions[]

object (SurveyQuestion)

カスタムの質問のリスト。

SurveyQuestion

アンケートの各質問の詳細な内容。

JSON 表現 
{
  "name": string,
  "questionType": enum (Type),
  "questionContent": string,
  "responseOptions": [
    {
      object (SurveyResponse)
    }
  ]
}
フィールド
name

string

必須。質問の一意の識別子。
questionType

enum (Type)

出力のみ。質問のタイプ。
questionContent

string

必須。質問内容。カスタムの質問に使用できるのは 200 文字です。
responseOptions[]

object (SurveyResponse)

必須。質問とともに表示される回答のリスト。最大 12 個。

タイプ

アンケートの質問の種類。

列挙型
TYPE_UNSPECIFIED 不明な質問形式です。
GOOGLE_STANDARD_QUESTION Google の標準的なアンケートの質問です。
GOOGLE_TEMPLATE_QUESTION Google 提供のアンケートの質問のテンプレート。
PARTNER_CUSTOM_QUESTION パートナー様がカスタマイズしたアンケートの質問です。

SurveyResponse

アンケートの質問に対する回答のコンテンツ。

JSON 表現 
{
  "content": string,
  "postbackData": string
}
フィールド
content

string

必須。アンケートに表示され、ユーザーがタップするとエージェントに返されるテキスト。最大半角 35 文字（全角 17 文字）です。
postbackData

string

ユーザーが質問の回答をタップしたときにエージェントが受け取る文字列。

RcsBusinessMessagingAgent

特に RCS ビジネス メッセージに関連するエージェント情報

JSON 表現 
{
  "description": string,
  "logoUri": string,
  "heroUri": string,
  "phoneNumbers": [
    {
      object (PhoneEntry)
    }
  ],
  "emails": [
    {
      object (EmailEntry)
    }
  ],
  "websites": [
    {
      object (WebEntry)
    }
  ],
  "privacy": {
    object (WebEntry)
  },
  "termsConditions": {
    object (WebEntry)
  },
  "color": string,
  "billingConfig": {
    object (RcsBusinessMessagingAgentBillingConfig)
  },
  "agentUseCase": enum (AgentUseCase),
  "hostingRegion": enum (HostingRegion)
}
フィールド
description

string

必須。ユーザーに表示されるエージェントの説明。100 文字以内で指定します。
logoUri

string

必須。エージェントのロゴの一般公開 URL。最大 50 KB。

エージェントによる確認後は変更できません。
heroUri

string

必須。エージェントのヒーロー画像の一般公開 URL。最大 200 KB。

エージェントによる確認後は変更できません。
phoneNumbers[]

object (PhoneEntry)

必須。エージェントに関連付けられている電話番号。
emails[]

object (EmailEntry)

省略可。エージェントに関連付けられているメールアドレス。
websites[]

object (WebEntry)

省略可。エージェントに関連付けられているウェブサイト。最大 3 個。
privacy

object (WebEntry)

必須。エージェントに関連付けられたプライバシー ポリシー。
termsConditions

object (WebEntry)

必須。エージェントに関連付けられた利用規約。
color

string

必須。ユーザーに表示されるエージェントのテーマカラー（16 進数形式）。例: #FF6347
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

必須。エージェントの課金構成。
agentUseCase

enum (AgentUseCase)

省略可。bot のユースケース。
hostingRegion

enum (HostingRegion)

必須。エージェントのホスティング リージョン。

PhoneEntry

エージェントに関連付けられている電話番号。

JSON 表現 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
フィールド
phoneNumber

object (Phone)

必須。E.164 形式の電話番号。例: +12223334444
label

string

必須。電話番号のラベル。

EmailEntry

エージェントに関連付けられたメールアドレス。

JSON 表現 
{
  "address": string,
  "label": string
}
フィールド
address

string

必須。メールアドレス。
label

string

必須。メールアドレスのラベル。

WebEntry

エージェントに関連付けられたウェブベースのリソース。

JSON 表現 
{
  "uri": string,
  "label": string
}
フィールド
uri

string

必須。エージェントに関連付けられた一般公開 URI。HTTP または HTTPS プロトコルを使用する必要があります。
label

string

省略可。URI のラベル。

RcsBusinessMessagingAgentBillingConfig

エージェントの課金構成。

JSON 表現 
{
  "billingCategory": enum (BillingCategory)
}
フィールド
billingCategory

enum (BillingCategory)

エージェントの請求カテゴリ。

BillingCategory

サポートされている請求カテゴリ。

列挙型
BILLING_CATEGORY_UNSPECIFIED カテゴリが指定されていません。
CONVERSATIONAL_LEGACY 既存のエージェントの課金設定をサポートする従来のカテゴリ。
CONVERSATIONAL ユーザーとブランドが一連のメッセージを交換する、より長く複雑なセッション向けに設計されています。
SINGLE_MESSAGE SMS に代わるより充実したメッセージ機能。CONVERSATIONAL として請求されることはありません。
BASIC_MESSAGE 課金モデルは SMS と同様です。CONVERSATIONAL として請求されることはありません。

AgentUseCase

ストレージで使用されるエージェントのユースケース タイプ。

列挙型
AGENT_USE_CASE_UNSPECIFIED ユースケースが指定されていません。
TRANSACTIONAL 一刻を争う重要かつ必要なメッセージのみを送信するエージェント。
PROMOTIONAL セールス、マーケティング、プロモーションに関するメッセージを送信するエージェント。デフォルトのタイプ。
OTP ワンタイム パスワードのみを送信するエージェント。
MULTI_USE 複数のユースケースがあるエージェント。

HostingRegion

エージェントがホストできる可能性のあるリージョン。P2A メッセージをリージョン化されたサーバーに正しくルーティングするために使用されます。

列挙型
HOSTING_REGION_UNSPECIFIED ホスティング リージョンが指定されていません。
NORTH_AMERICA 北米、
EUROPE 送信できるようにします。
ASIA_PACIFIC アジア太平洋。

Methods

create

 ブランドを表す新しいエージェントを作成します。

delete
(deprecated)

 非推奨: エージェントの削除は非推奨となりました。

get

 エージェントに関する情報を取得します。

getLaunch

 エージェントの起動情報を取得します。

getVerification

 エージェントの確認情報を取得します。

list

 ブランドに関連付けられているすべてのエージェントを一覧表示します。

patch

 エージェントに関する情報を更新します。

requestLaunch

 エージェントの起動プロセスを開始します。

requestVerification

 エージェントのビジネス情報の確認を開始します。

updateLaunch

 エージェントの起動情報を更新します。

updateVerification

 エージェントの確認ステータスを更新します。