Resource: Agent
A conversational entity that represents a brand.
JSON representation |
---|
{ "name" : string , "displayName" : string , // Union field |
name
string
The unique identifier of the agent.
Read-only. Defined by the platform.
displayName
string
Required. The name that the agent displays to users. Maximum 100 characters.
Not modifiable after agent verification.
Union field detail_info
. Contains the fields required for the particular product.
Required. detail_info
can be only one of the following:
businessMessagesAgent
object (
BusinessMessagesAgent
)
Detailed agent information for Business Messages.
BusinessMessagesAgent
Agent information specific to Business Messages.
JSON representation |
---|
{ "logoUrl" : string , "entryPointConfigs" : [ { object ( |
Fields | |
---|---|
logoUrl
|
Optional. Publicly available URL of the logo for the agent. Maximum 50 KB. Not modifiable after agent verification. |
entryPointConfigs[]
|
Optional. List of entry point configurations. Not modifiable after agent verification. |
conversationalSettings
|
Required. Conversational settings for an agent, mapped to a locale. Locale is represented by a well-formed IETF BCP 47 language tag. An object containing a list of |
defaultLocale
|
Required. The default locale for the agent. Must match a locale defined in |
primaryAgentInteraction
|
Required. Primary agent interaction information. Used when the user initiates a conversation. |
additionalAgentInteractions[]
|
Optional. Additional agent interaction information. Enables the agent to support multiple interaction types. |
customAgentId
|
Optional. A partner-specified identifier for the agent. The identifier is passed alongside all messages sent to the agent. |
agentTestUrl
|
Output only. The URL for testing the agent's conversational experience. Defined by the platform. |
testUrls[]
|
Output only. URLs for testing the agent's conversational experience. Defined by the platform. |
phone
|
Optional. The phone number for the agent to display. If not specified, the agent displays the phone number for the brand found in the Google Knowledge Graph , if any. |
authorizationConfig
|
Optional. Authorization configuration for OAuth support. |
nonLocalConfig
|
Optional. Configuration for non-local entry points. |
surveyConfig
|
Optional. Configuration to enable custom surveys. |
BusinessMessagesEntryPointConfig
The entry point configuration for an agent.
JSON representation |
---|
{
"allowedEntryPoint"
:
enum (
|
Fields | |
---|---|
allowedEntryPoint
|
Required. The Google surfaces the agent is enabled to appear on. |
EntryPoint
The Google surfaces the agent is enabled to appear on.
Enums | |
---|---|
ENTRY_POINT_UNSPECIFIED
|
Unspecified entry point. |
LOCATION
|
Enable locations for this agent. |
NON_LOCAL
|
Enable Business Messages for non-local entry points. |
SupportedAgentInteraction
Interactions supported by an agent.
JSON representation |
---|
{ "interactionType" : enum ( |
interactionType
enum (
InteractionType
)
Required. The type of interaction supported by the agent.
representative
. The detailed info for the config type. Required. representative
can be only one of the following:botRepresentative
object (
BotRepresentative
)
Bot representative details.
humanRepresentative
object (
HumanRepresentative
)
Human representative details.
InteractionType
Type of interaction supported for the agent.
Enums | |
---|---|
INTERACTION_TYPE_UNSPECIFIED
|
Unspecified interaction. |
BOT
|
Bot interaction. |
HUMAN
|
Human interaction. |
BotRepresentative
Details for bot representative.
JSON representation |
---|
{
"botMessagingAvailability"
:
{
object (
|
Fields | |
---|---|
botMessagingAvailability
|
Required. Bot messaging availability. |
MessagingAvailability
The hours of each day of the week that messaging is available. You can group hours for multiple days together. For example, * 08:00–16:00 hrs PDT Monday–Wednesday * 10:00–14:00 hrs PDT Thursday–Friday * 15:00–18:00 hrs PDT Thursday–Friday * 10:00–14:00 hrs PDT Saturday–Saturday
If there are gaps in availability, such as no specified availability on Sunday, messaging is unavailable during those gaps.
Bot hours have no effect on availability. Bot-only agents always display a welcome message, while agents with both human and bot representative settings only consider human representatives when defining availability.
JSON representation |
---|
{
"hours"
:
[
{
object (
|
Fields | |
---|---|
hours[]
|
Required. Hours of messaging availability. |
Hours
A range of hours that messaging is available.
JSON representation |
---|
{ "startTime" : { object ( |
Fields | |
---|---|
startTime
|
Required. Start time for each day within the day-of-week range. |
endTime
|
Required. End time for each day within the day-of-week range. |
timeZone
|
Required. The IANA time zone for the hours. For example, "America/Los_Angeles". |
startDay
|
Required. Start day. |
endDay
|
Required. End day. Includes the specified day. |
TimeOfDay
Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date
and google.protobuf.Timestamp
.
JSON representation |
---|
{ "hours" : integer , "minutes" : integer , "seconds" : integer , "nanos" : integer } |
Fields | |
---|---|
hours
|
Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
minutes
|
Minutes of hour of day. Must be from 0 to 59. |
seconds
|
Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
nanos
|
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
DayOfWeek
Represents a day of the week.
Enums | |
---|---|
DAY_OF_WEEK_UNSPECIFIED
|
The day of the week is unspecified. |
MONDAY
|
Monday |
TUESDAY
|
Tuesday |
WEDNESDAY
|
Wednesday |
THURSDAY
|
Thursday |
FRIDAY
|
Friday |
SATURDAY
|
Saturday |
SUNDAY
|
Sunday |
HumanRepresentative
Details for human representative.
JSON representation |
---|
{
"humanMessagingAvailability"
:
{
object (
|
Fields | |
---|---|
humanMessagingAvailability
|
Required. Human messaging availability. |
AuthorizationConfig
Configuration details for supporting OAuth on Business Messages.
JSON representation |
---|
{ "endpointUrl" : string } |
Fields | |
---|---|
endpointUrl
|
The endpoint URL where the user logs in. |
NonLocalConfig
Configuration to enable non-local entry points.
JSON representation |
---|
{ "contactOption" : { object ( |
Fields | |
---|---|
contactOption
|
Required. Contact information for the agent that displays with the messaging button. |
enabledDomains[]
|
Required. Domains to enable for the sitelinks entry point. |
phoneNumber
|
Required. Agent's phone number. Overrides the |
callDeflectionPhoneNumbers[]
|
Required. List of phone numbers for call deflection. |
regionCodes[]
|
Required. List of CLDR region codes
for countries where the agent is allowed to launch |
ContactOption
Contact details displayed in addition to the messaging button.
JSON representation |
---|
{
"url"
:
string
,
"options"
:
[
enum (
|
Fields | |
---|---|
url
|
Required. The URL that contact options are available for. |
options[]
|
Required. The list of contact options available for the specified URL. |
Option
Contact options.
Enums | |
---|---|
OPTION_UNSPECIFIED
|
Unspecified |
WEB_CHAT
|
Web Chat option. |
PHONE
|
Phone option. |
EMAIL
|
Email option. |
FAQS
|
FAQ option. |
TWITTER
|
Twitter option. |
WHATSAPP
|
Whatsapp option. |
SurveyConfig
Configuration details for supporting customized survey questions.
JSON representation |
---|
{
"templateQuestionIds"
:
[
string
]
,
"customSurveys"
:
{
string
:
{
object (
|
Fields | |
---|---|
templateQuestionIds[]
|
List of template question IDs for template questions included in a survey. |
customSurveys
|
Custom survey questions for an agent, mapped to a locale. Locale is represented by a well-formed IETF BCP 47 language tag. An object containing a list of |
CustomSurveyConfig
Custom survey configuration for an agent.
JSON representation |
---|
{
"customQuestions"
:
[
{
object (
|
Fields | |
---|---|
customQuestions[]
|
List of custom questions. |
SurveyQuestion
The detailed content of each survey question.
JSON representation |
---|
{ "name" : string , "questionType" : enum ( |
Fields | |
---|---|
name
|
Required. The unique identifier of the question. |
questionType
|
Output only. Type of the question. |
questionContent
|
Required. Question content. Limited to 200 characters for custom questions. |
responseOptions[]
|
Required. List of responses displayed with the question. Maximum 12. |
Type
The type of survey question.
Enums | |
---|---|
TYPE_UNSPECIFIED
|
Unknown survey question type. |
GOOGLE_STANDARD_QUESTION
|
Google standard survey question. |
GOOGLE_TEMPLATE_QUESTION
|
Google provided template survey question. |
PARTNER_CUSTOM_QUESTION
|
Partner customized survey question. |
SurveyResponse
The content for a survey question response.
JSON representation |
---|
{ "content" : string , "postbackData" : string } |
Fields | |
---|---|
content
|
Required. Text that is shown in the survey and sent back to the agent when the user taps it. Maximum 35 characters. |
postbackData
|
The string the agent receives when the user taps the question response. |
Methods |
|
---|---|
|
Creates a new agent to represent a brand. |
|
Deletes an agent. |
|
Get information about an agent. |
|
Gets the launch information for an agent. |
|
Gets the verification information for an agent. |
|
Lists all the agents associated with a brand. |
|
Updates information about an agent. |
|
Begins the launch process for an agent. |
|
Begins business information verification for an agent. |
|
Updates the launch information for an agent. |
|
Updates the verification state for an agent. |