REST Resource: brands.agents

リソース: Agent

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

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

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

string

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

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

string

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

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

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

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

object (BusinessMessagesAgent)

ビジネス メッセージ用の詳細なエージェント情報。

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

（省略可）パートナーが指定したエージェント ID。この識別子は、エージェントに送信されるすべてのメッセージとともに渡されます。
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 ローカル以外のエントリ ポイントに対してビジネス メッセージを有効にします。

サポートされているエージェント インタラクション

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

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 人間による操作。

bot 担当者

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 日曜日

人間

人間の担当者の詳細。

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

object (MessagingAvailability)

必須。人間によるメッセージングの可用性。

電話

電話番号。

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

string

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

AuthorizationConfig

ビジネス メッセージでの OAuth サポートの構成の詳細。

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

string

ユーザーがログインしたエンドポイント URL。

非ローカル設定

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

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 のオプション。

アンケートの構成

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

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)

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

アンケートの質問

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

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 パートナーによるカスタマイズされたアンケートの質問

アンケートの回答

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

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

string

必須。アンケートに表示されるテキストのうち、ユーザーがアンケートをタップするとエージェントに送信されます。最大 35 文字。
postbackData

string

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

Methods

create

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

delete

 エージェントを削除します。

get

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

getLaunch

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

getVerification

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

list

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

patch

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

requestLaunch

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

requestVerification

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

updateLaunch

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

updateVerification

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