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 ローカル以外のエントリ ポイントに対してビジネス メッセージを有効にする。

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 PDT、木曜日～金曜日の 15:00 ～ 18:00 PDT、木曜日～金曜日 * 土曜日～土曜日の 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 文字（全角 100 文字）以内にしてください。
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 文字。
postbackData

string

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

Methods

create

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

delete

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

get

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

getLaunch

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

getVerification

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

list

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

patch

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

requestLaunch

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

requestVerification

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

updateLaunch

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

updateVerification

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