Recurso: Agente
Es una entidad conversacional que representa una marca.
Representación JSON |
---|
{ "name": string, "displayName": string, // Union field |
Campos | |
---|---|
name |
El identificador único del agente. Solo lectura. Lo define la plataforma. |
displayName |
Obligatorio. El nombre que el agente les mostrará a los usuarios. Se admiten 100 caracteres como máximo. No se puede modificar después de la verificación del agente. |
Campo de unión Obligatorio. |
|
businessMessagesAgent |
Información detallada del agente para Business Messages. |
BusinessMessagesAgent
Información del agente específica de Business Messages.
Representación JSON |
---|
{ "logoUrl": string, "entryPointConfigs": [ { object ( |
Campos | |
---|---|
logoUrl |
Opcional. URL del logotipo disponible públicamente para el agente. 50 KB como máximo No se puede modificar después de la verificación del agente. |
entryPointConfigs[] |
Opcional. Lista de configuraciones de puntos de entrada. No se puede modificar después de la verificación del agente. |
conversationalSettings |
Obligatorio. Configuración de conversación para un agente, asignada a una configuración regional. La configuración regional se representa con una etiqueta de idioma IETF BCP 47 con el formato correcto. Es un objeto que contiene una lista de pares |
defaultLocale |
Obligatorio. La configuración regional predeterminada para el agente. Debe coincidir con una configuración regional definida en |
primaryAgentInteraction |
Obligatorio. Información sobre la interacción con el agente principal. Se usa cuando el usuario inicia una conversación. |
additionalAgentInteractions[] |
Opcional. Información adicional sobre la interacción con el agente. Permite que el agente admita varios tipos de interacción. |
customAgentId |
Opcional. Un identificador especificado por el socio para el agente. El identificador se pasa junto con todos los mensajes enviados al agente. |
agentTestUrl |
Solo salida. La URL para probar la experiencia conversacional del agente. Lo define la plataforma. |
testUrls[] |
Solo salida. URLs para probar la experiencia conversacional del agente. Lo define la plataforma. |
phone |
Opcional. El número de teléfono que mostrará el agente. Si no se especifica, el agente muestra el número de teléfono de la marca que se encuentra en el Gráfico de conocimiento de Google, si corresponde. |
authorizationConfig |
Opcional. Configuración de autorización para la asistencia de OAuth. |
nonLocalConfig |
Opcional. Configuración de puntos de entrada no locales. |
surveyConfig |
Opcional. Configuración para habilitar encuestas personalizadas. |
BusinessMessagesEntryPointConfig
La configuración del punto de entrada para un agente.
Representación JSON |
---|
{
"allowedEntryPoint": enum ( |
Campos | |
---|---|
allowedEntryPoint |
Obligatorio. La plataforma de Google en la que el agente está habilitado para aparecer |
EntryPoint
La plataforma de Google en la que el agente está habilitado para aparecer
Enumeradores | |
---|---|
ENTRY_POINT_UNSPECIFIED |
Punto de entrada no especificado. |
LOCATION |
Habilita las ubicaciones para este agente. |
NON_LOCAL |
Habilita Business Messages para puntos de entrada no locales. |
SupportedAgentInteraction
Interacciones respaldadas por un agente.
Representación JSON |
---|
{ "interactionType": enum ( |
Campos | |
---|---|
interactionType |
Obligatorio. El tipo de interacción que admite el agente. |
Campo de unión representative . La información detallada para el tipo de configuración. Obligatorio. Las direcciones (representative ) solo pueden ser una de las siguientes opciones: |
|
botRepresentative |
Detalles del representante del bot. |
humanRepresentative |
Detalles del representante humano. |
InteractionType
Tipo de interacción admitida para el agente.
Enumeradores | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
Interacción no especificada. |
BOT |
Interacción con el bot. |
HUMAN |
Interacción humana. |
BotRepresentative
Detalles para el representante de bots.
Representación JSON |
---|
{
"botMessagingAvailability": {
object ( |
Campos | |
---|---|
botMessagingAvailability |
Obligatorio. Disponibilidad de mensajes de bots. |
MessagingAvailability
Las horas de cada día de la semana en las que están disponibles los mensajes. Puedes agrupar las horas para varios días. Por ejemplo: * De lunes a miércoles de 08:00 a 16:00 h PDT * 10:00–14:00 h PDT jueves-viernes * 15:00–18:00 h PDT Thursday– Friday * 10:00–14:00 h PDT Sábado y sábado
Si hay brechas en la disponibilidad (por ejemplo, si no se especifica una disponibilidad el domingo), no se podrán enviar mensajes durante esos intervalos.
Las horas del bot no tienen efecto en la disponibilidad. Los agentes que solo tienen bots siempre muestran un mensaje de bienvenida, mientras que los agentes con parámetros de configuración tanto humanos como representativos de bots solo tienen en cuenta a los representantes humanos cuando definen la disponibilidad.
Representación JSON |
---|
{
"hours": [
{
object ( |
Campos | |
---|---|
hours[] |
Obligatorio. Horarios de disponibilidad de mensajes. |
Horas
Un rango de horas durante las cuales el servicio de mensajería está disponible.
Representación JSON |
---|
{ "startTime": { object ( |
Campos | |
---|---|
startTime |
Obligatorio. Hora de inicio de cada día dentro del rango de días de la semana. |
endTime |
Obligatorio. Hora de finalización de cada día dentro del rango de días de la semana. |
timeZone |
Obligatorio. La zona horaria de IANA para las horas. Por ejemplo, “America/Los_Angeles”. |
startDay |
Obligatorio. Día de inicio. |
endDay |
Obligatorio. Día de finalización. Incluye el día especificado. |
TimeOfDay
Representa una hora del día. La fecha y la zona horaria no son significativas o se especifican en otro lugar. Una API puede optar por permitir segundos bisiestos. Los tipos relacionados son google.type.Date
y google.protobuf.Timestamp
.
Representación JSON |
---|
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer } |
Campos | |
---|---|
hours |
Horas del día en formato de 24 horas. Debe ser del 0 al 23. Una API puede permitir el valor “24:00:00” para casos como el horario de cierre de empresas. |
minutes |
Minutos de horas del día. Debe ser un valor entre 0 y 59. |
seconds |
Segundos de minutos de la hora. Por lo general, debe ser un valor entre 0 y 59. Una API puede permitir el valor 60 si permite segundos bisiestos. |
nanos |
Fracciones de segundos en nanosegundos. Debe ser un valor entre 0 y 999,999,999. |
DayOfWeek
Representa un día de la semana.
Enumeradores | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
No se especifica el día de la semana. |
MONDAY |
Lunes |
TUESDAY |
Martes |
WEDNESDAY |
miércoles". |
THURSDAY |
Jueves |
FRIDAY |
Viernes |
SATURDAY |
Sábado |
SUNDAY |
Domingo |
HumanRepresentative
Detalles para el representante humano.
Representación JSON |
---|
{
"humanMessagingAvailability": {
object ( |
Campos | |
---|---|
humanMessagingAvailability |
Obligatorio. Disponibilidad de mensajería humana |
AuthorizationConfig
Detalles de configuración para admitir OAuth en Business Messages.
Representación JSON |
---|
{ "endpointUrl": string } |
Campos | |
---|---|
endpointUrl |
La URL de extremo al que accede el usuario. |
NonLocalConfig
Configuración para habilitar puntos de entrada no locales.
Representación JSON |
---|
{ "contactOption": { object ( |
Campos | |
---|---|
contactOption |
Obligatorio. Información de contacto del agente que se muestra con el botón de mensajería. |
enabledDomains[] |
Obligatorio. Dominios que se habilitarán para el punto de entrada de vínculos a sitios. |
phoneNumber |
Obligatorio. Número de teléfono del agente Anula el campo |
callDeflectionPhoneNumbers[] |
Obligatorio. Lista de números de teléfono para el desvío de llamadas. |
regionCodes[] |
Obligatorio. Lista de códigos regionales de CLDR para los países en los que el agente puede iniciar puntos de entrada |
ContactOption
Se muestran los detalles de contacto además del botón de mensajes.
Representación JSON |
---|
{
"url": string,
"options": [
enum ( |
Campos | |
---|---|
url |
Obligatorio. Las URL para las que están disponibles las opciones de contacto. |
options[] |
Obligatorio. Es la lista de opciones de contacto disponibles para la URL especificada. |
Opción
Opciones de contacto.
Enumeradores | |
---|---|
OPTION_UNSPECIFIED |
Sin especificar |
WEB_CHAT |
Chat web. |
PHONE |
Opción de teléfono. |
EMAIL |
Opción de correo electrónico. |
FAQS |
Opción de preguntas frecuentes. |
TWITTER |
Opción de Twitter. |
WHATSAPP |
Opción de WhatsApp. |
SurveyConfig
Detalles de configuración para admitir preguntas de encuesta personalizadas.
Representación JSON |
---|
{
"templateQuestionIds": [
string
],
"customSurveys": {
string: {
object ( |
Campos | |
---|---|
templateQuestionIds[] |
Es la lista de los IDs de las preguntas de plantilla incluidas en una encuesta. |
customSurveys |
Preguntas de encuestas personalizadas para un agente, asignadas a una configuración regional. La configuración regional se representa con una etiqueta de idioma IETF BCP 47 con el formato correcto. Es un objeto que contiene una lista de pares |
CustomSurveyConfig
Configuración de encuesta personalizada para un agente.
Representación JSON |
---|
{
"customQuestions": [
{
object ( |
Campos | |
---|---|
customQuestions[] |
Lista de preguntas personalizadas. |
SurveyQuestion
El contenido detallado de cada pregunta de la encuesta
Representación JSON |
---|
{ "name": string, "questionType": enum ( |
Campos | |
---|---|
name |
Obligatorio. Es el identificador único de la pregunta. |
questionType |
Solo salida. Tipo de la pregunta. |
questionContent |
Obligatorio. Contenido de la pregunta. Las preguntas personalizadas tienen un límite de 200 caracteres. |
responseOptions[] |
Obligatorio. Lista de respuestas que se muestran con la pregunta. Máximo 12. |
Tipo
Es el tipo de pregunta de encuesta.
Enumeradores | |
---|---|
TYPE_UNSPECIFIED |
El tipo de pregunta de la encuesta es desconocido. |
GOOGLE_STANDARD_QUESTION |
Pregunta de encuesta estándar de Google. |
GOOGLE_TEMPLATE_QUESTION |
Plantilla de pregunta que proporcionó Google |
PARTNER_CUSTOM_QUESTION |
Pregunta de encuesta personalizada del socio. |
SurveyResponse
El contenido de la respuesta a una pregunta de una encuesta
Representación JSON |
---|
{ "content": string, "postbackData": string } |
Campos | |
---|---|
content |
Obligatorio. Texto que se muestra en la encuesta y se envía al agente cuando el usuario lo presiona. Se admiten hasta 35 caracteres. |
postbackData |
La cadena que recibe el agente cuando el usuario presiona la respuesta a la pregunta. |
Métodos |
|
---|---|
|
Crea un agente nuevo para representar una marca. |
|
Borra un agente. |
|
Obtén información sobre un agente. |
|
Obtiene la información de lanzamiento de un agente. |
|
Obtiene la información de verificación de un agente. |
|
Muestra una lista de todos los agentes asociados con una marca. |
|
Actualiza la información sobre un agente. |
|
Inicia el proceso de lanzamiento de un agente. |
|
Inicia la verificación de la información de la empresa de un agente. |
|
Actualiza la información de lanzamiento de un agente. |
|
Actualiza el estado de verificación de un agente. |