更新：查看版本说明，了解新功能和产品动态。

此页面由 Cloud Translation API 翻译。

REST Resource: brands.agents

资源：代理

代表品牌的对话实体。

JSON 表示法

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,

  // 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)` Business Messages 的详细代理信息。
`rcsBusinessMessagingAgent`	`object (RcsBusinessMessagingAgent)` RCS Business Messaging 的详细代理信息。

BusinessMessagesAgent

Business Messages 专用代理信息。

JSON 表示法

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,
  "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` 可选。代理的徽标的公开网址。大小上限为 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` 此项已弃用！仅供输出。用于测试代理对话体验的网址。由平台定义。
`testUrls[]`	`object (TestUrl)` 仅供输出。用于测试代理对话体验的网址。由平台定义。
`phone`	`object (Phone)` 可选。要显示的代理的电话号码。如果未指定，代理将显示在 Google 知识图谱中找到的品牌的电话号码（如果有）。
`authorizationConfig`	`object (AuthorizationConfig)` 可选。针对 OAuth 支持的授权配置。
`nonLocalConfig`	`object (NonLocalConfig)` 可选。非本地入口点配置。
`surveyConfig`	`object (SurveyConfig)` 可选。用于启用自定义调查问卷的配置。

BusinessMessagesEntryPointConfig

代理的入口点配置。

JSON 表示法
{ "allowedEntryPoint": enum (`EntryPoint`) }

字段

字段
`allowedEntryPoint`	`enum (EntryPoint)` 必需。支持显示代理的 Google 平台。

allowedEntryPoint

enum (EntryPoint)

必需。支持显示代理的 Google 平台。

EntryPoint

支持显示代理的 Google 平台。

枚举
`ENTRY_POINT_UNSPECIFIED`	未指定的入口点。
`LOCATION`	为此代理启用营业地点。
`NON_LOCAL`	为非本地入口点启用 Business Messages。

SupportedAgentInteraction

代理支持的交互。

JSON 表示法

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),

  // 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)` 聊天机器人代表的详细信息。
`humanRepresentative`	`object (HumanRepresentative)` 人工代表的详细信息。

InteractionType

代理支持的交互类型。

枚举
`INTERACTION_TYPE_UNSPECIFIED`	未指定的互动。
`BOT`	聊天机器人互动。
`HUMAN`	人际互动。

BotRepresentative

聊天机器人代表的详细信息。

JSON 表示法
{ "botMessagingAvailability": { object (`MessagingAvailability`) } }

字段

字段
`botMessagingAvailability`	`object (MessagingAvailability)` 必需。聊天机器人消息功能可用性。

botMessagingAvailability

object (MessagingAvailability)

必需。聊天机器人消息功能可用性。

MessagingAvailability

一周中每天可收发消息的时段。您可以将多天的营业时间归为一组。例如，* 太平洋夏令时间星期一至星期三 * 08:00–16:00 小时（太平洋夏令时间）* 10:00–14:00 小时（太平洋夏令时间）星期四至星期五 * 15:00–18:00 小时（太平洋夏季时间）* 星期六 10:00–14:00（美国太平洋夏令时间）

如果有空/忙碌信息有缺漏（例如没有在周日明确指定空档），则无法在这类时间之间发送消息。

聊天机器人的营业时间对空闲时段没有影响。仅聊天机器人的客服人员始终会显示欢迎辞，而同时采用人工代表和聊天机器人代表设置的客服人员在定义空闲情况时只会考虑人工代表。

JSON 表示法
{ "hours": [ { object (`Hours`) } ] }

字段

字段
`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

表示一天中的某个时间。日期和时区不重要，或在别处指定。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 允许闰秒，则 API 可以允许 60 一值。
`nanos`	`integer` 秒数的小数部分（以纳秒为单位）。值必须是介于 0 和 999999999 之间的数字。

DayOfWeek

表示星期几。

枚举
`DAY_OF_WEEK_UNSPECIFIED`	未指定星期几。
`MONDAY`	星期一
`TUESDAY`	星期二
`WEDNESDAY`	星期三
`THURSDAY`	星期四
`FRIDAY`	星期五
`SATURDAY`	星期六
`SUNDAY`	星期日

HumanRepresentative

人工代表的详细信息。

JSON 表示法
{ "humanMessagingAvailability": { object (`MessagingAvailability`) } }

字段

字段
`humanMessagingAvailability`	`object (MessagingAvailability)` 必需。人工消息功能可用性。

humanMessagingAvailability

object (MessagingAvailability)

必需。人工消息功能可用性。

AuthorizationConfig

有关在 Business Messages 中支持 OAuth 的配置详情。

JSON 表示法
{ "endpointUrl": string }

字段

字段
`endpointUrl`	`string` 用户登录的端点网址。

endpointUrl

string

用户登录的端点网址。

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` 必需。可使用联系选项的网址。
`options[]`	`enum (Option)` 必需。指定网址可用的联系选项列表。

url

string

必需。可使用联系选项的网址。

options[]

enum (Option)

必需。指定网址可用的联系选项列表。

选项

联系方式。

枚举
`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" }`。

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)` 自定义问题列表。

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 个字符。
`postbackData`	`string` 当用户点按问题回复时，代理收到的字符串。

content

string

必需。在调查问卷中显示的文字，当用户点按它时，该文字会发送回代理。不得超过 35 个字符。

postbackData

string

当用户点按问题回复时，代理收到的字符串。

RcsBusinessMessagingAgent

与 RCS Business Messaging 相关的代理信息。

JSON 表示法

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,
  "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` 必需。代理的徽标的公开网址。大小上限为 50 KB。代理验证后无法修改。
`heroUri`	`string` 必需。代理主打图片的公开网址。大小上限为 200 KB。代理验证后无法修改。
`phoneNumbers[]`	`object (PhoneEntry)` 必需。与客服人员相关联的电话号码。
`emails[]`	`object (EmailEntry)` 可选。与代理关联的电子邮件地址。
`websites[]`	`object (WebEntry)` 可选。与代理相关联的网站。最多 3 个。
`privacy`	`object (WebEntry)` 必需。与代理关联的隐私权政策。
`termsConditions`	`object (WebEntry)` 必需。与代理相关的条款及条件。
`color`	`string` 必需。对用户可见的代理的主题颜色，以十六进制格式表示。例如，#FF6347。
`billingConfig`	`object (RcsBusinessMessagingAgentBillingConfig)` 必需。代理的结算配置。
`agentUseCase`	`enum (AgentUseCase)` 可选。聊天机器人的使用场景。
`hostingRegion`	`enum (HostingRegion)` 必需。代理的托管区域。

PhoneEntry

与客服人员相关联的电话号码。

JSON 表示法
{ "phoneNumber": { object (`Phone`) }, "label": string }

字段

字段
`phoneNumber`	`object (Phone)` 必需。采用 E.164 格式的电话号码。例如 `+12223334444`。
`label`	`string` 必需。电话号码的标签。

phoneNumber

object (Phone)

必需。采用 E.164 格式的电话号码。例如 +12223334444。

label

string

必需。电话号码的标签。

EmailEntry

与代理关联的电子邮件地址。

JSON 表示法
{ "address": string, "label": string }

字段

字段
`address`	`string` 必需。电子邮件地址。
`label`	`string` 必需。电子邮件地址的标签。

address

string

必需。电子邮件地址。

label

string

必需。电子邮件地址的标签。

WebEntry

与代理关联的基于网络的资源。

JSON 表示法
{ "uri": string, "label": string }

字段

字段
`uri`	`string` 必需。与代理关联的可公开访问的 URI。必须使用 HTTP 或 HTTPS 协议。
`label`	`string` 可选。URI 的标签。

uri

string

必需。与代理关联的可公开访问的 URI。必须使用 HTTP 或 HTTPS 协议。

label

string

可选。URI 的标签。

RcsBusinessMessagingAgentBillingConfig

代理的结算配置。

JSON 表示法
{ "billingCategory": enum (`BillingCategory`) }

字段

字段
`billingCategory`	`enum (BillingCategory)` 代理的结算类别。

billingCategory

enum (BillingCategory)

代理的结算类别。

BillingCategory

支持的结算类别。

枚举
`BILLING_CATEGORY_UNSPECIFIED`	未指定类别。
`CONVERSATIONAL_LEGACY`	用于支持现有代理的结算配置的旧类别。
`CONVERSATIONAL`	这种会话适合更长、更复杂的会话，用户和品牌可以交换一系列消息。
`SINGLE_MESSAGE`	用更丰富的短信体验取代短信。从未以“CONVERSATIONAL”结算。
`BASIC_MESSAGE`	结算模式与短信类似。从未以“CONVERSATIONAL”结算。

AgentUseCase

存储空间中使用的代理使用场景类型。

枚举
`AGENT_USE_CASE_UNSPECIFIED`	未指定用例。
`TRANSACTIONAL`	仅发送重要、必要且时效性强的代理消息。
`PROMOTIONAL`	发送销售、营销和促销信息的代理。默认类型。
`OTP`	仅发送一次性密码的代理。
`MULTI_USE`	具有多个用例的代理。

HostingRegion

可能的代理托管区域，用于将 P2A 消息正确路由到区域化服务器。

枚举
`HOSTING_REGION_UNSPECIFIED`	未指定的托管区域。
`NORTH_AMERICA`	北美地区。
`EUROPE`	欧洲。
`ASIA_PACIFIC`	亚太地区。

方法
`create`	创建新的代理来代表品牌。
`delete (deprecated)`	已弃用：代理删除功能已弃用。
`get`	获取有关代理的信息。
`getLaunch`	获取代理的发布信息。
`getVerification`	获取代理的验证信息。
`list`	列出与品牌关联的所有代理。
`patch`	更新代理的相关信息。
`requestLaunch`	开始代理的发布流程。
`requestVerification`	开始为代理验证商家信息。
`updateLaunch`	更新代理的发布信息。
`updateVerification`	更新代理的验证状态。

REST Resource: brands.agents

资源：代理

BusinessMessagesAgent

BusinessMessagesEntryPointConfig

EntryPoint

SupportedAgentInteraction

InteractionType

BotRepresentative

MessagingAvailability

小时

TimeOfDay

DayOfWeek

HumanRepresentative

AuthorizationConfig

NonLocalConfig

ContactOption

选项

SurveyConfig

CustomSurveyConfig

SurveyQuestion

类型

SurveyResponse

RcsBusinessMessagingAgent

PhoneEntry

EmailEntry

WebEntry

RcsBusinessMessagingAgentBillingConfig

BillingCategory

AgentUseCase

HostingRegion

方法

delete (deprecated)

`delete (deprecated)`