REST Resource: brands.agents

Recurso: Agente

Una entidad conversacional que representa una marca.

Representación 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.
}
Campos
name

string

El identificador único del agente.

Solo lectura. Definido por la plataforma
displayName

string

Obligatorio. El nombre que el agente muestra 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 detail_info. Contiene los campos obligatorios para un producto en particular.

Obligatorio. detail_info puede ser una de las siguientes opciones:
businessMessagesAgent

object (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 (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)
  }
}
Campos
logoUrl

string

Opcional. Es la URL disponible de forma pública del logotipo para el agente. 50 KB como máximo.

No se puede modificar después de la verificación del agente.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

Opcional. Lista de configuraciones de puntos de entrada.

No se puede modificar después de la verificación del agente.
conversationalSettings

map (key: string, value: object (ConversationalSetting))

Obligatorio. La configuración de conversación de un agente, asignada a una configuración regional. La configuración regional se representa con una etiqueta de idioma IETF BCP 47 bien formada.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
defaultLocale

string

Obligatorio. La configuración regional predeterminada del agente. Debe coincidir con una configuración regional definida en conversationalSettings.
primaryAgentInteraction

object (SupportedAgentInteraction)

Obligatorio. Información de interacción del agente principal. Se usa cuando el usuario inicia una conversación.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

Opcional. Información adicional sobre la interacción con los agentes. Permite que el agente admita varios tipos de interacciones.
customAgentId

string

Opcional. Un identificador especificado por el socio para el agente. El identificador se pasa junto con todos los mensajes que se envían al agente.
agentTestUrl
(deprecated)

string

Solo salida. La URL para probar la experiencia de conversación del agente.

Definido por la plataforma
testUrls[]

object (TestUrl)

Solo salida. Las URLs para probar la experiencia de conversación del agente.

Definido por la plataforma
phone

object (Phone)

Opcional. El número de teléfono que debe 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

object (AuthorizationConfig)

Opcional. Configuración de autorización para la compatibilidad con OAuth.
nonLocalConfig

object (NonLocalConfig)

Opcional. Configuración para puntos de entrada no locales.
surveyConfig

object (SurveyConfig)

Opcional. Configuración para habilitar las encuestas personalizadas.

BusinessMessagesEntryPointConfig

La configuración del punto de entrada para un agente.

Representación JSON 
{
  "allowedEntryPoint": enum (EntryPoint)
}
Campos
allowedEntryPoint

enum (EntryPoint)

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.

Enumeraciones
ENTRY_POINT_UNSPECIFIED Punto de entrada no especificado.
LOCATION Habilitar ubicaciones para este agente.
NON_LOCAL Habilitar Business Messages para los puntos de entrada no locales.

SupportedAgentInteraction

Interacciones admitidas por un agente.

Representación 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.
}
Campos
interactionType

enum (InteractionType)

Obligatorio. El tipo de interacción que admite el agente.
Campo de unión representative. La información detallada del tipo de configuración. Obligatorio. Las direcciones (representative) solo pueden ser una de las siguientes opciones:
botRepresentative

object (BotRepresentative)

Detalles del representante del bot.
humanRepresentative

object (HumanRepresentative)

Detalles del representante humano.

InteractionType

Tipo de interacción admitida para el agente.

Enumeraciones
INTERACTION_TYPE_UNSPECIFIED Interacción no especificada.
BOT Interacción con el bot.
HUMAN Interacción humana.

BotRepresentative

Detalles del representante del bot.

Representación JSON 
{
  "botMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Campos
botMessagingAvailability

object (MessagingAvailability)

Obligatorio. Disponibilidad de mensajes de bots.

MessagingAvailability

Las horas de cada día de la semana en que la mensajería está disponible. Puedes agrupar las horas para varios días. Por ejemplo, * De lunes a miércoles de 8:00 a.m. a 6:00 p.m. (PDT) * 10:00 a.m. a 14:00 h (de jueves a viernes) * De jueves a viernes de 15:00 a.m. a 6:00 p.m. (de jueves a viernes) * De 10:00 a.m. a 14:00 h (sábado y sábado)

Si hay brechas en la disponibilidad, como una no especificada para el domingo, la mensajería no estará disponible durante esos períodos.

Las horas de bot no afectan la disponibilidad. Los agentes que solo usan bots siempre muestran un mensaje de bienvenida, mientras que los agentes con una configuración de persona y de representante de bots solo tienen en cuenta a los representantes humanos cuando definen la disponibilidad.

Representación JSON 
{
  "hours": [
    {
      object (Hours)
    }
  ]
}
Campos
hours[]

object (Hours)

Obligatorio. Horas de disponibilidad de mensajes

Horas

Un rango de horarios en los que la mensajería está disponible.

Representación JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  },
  "timeZone": string,
  "startDay": enum (DayOfWeek),
  "endDay": enum (DayOfWeek)
}
Campos
startTime

object (TimeOfDay)

Obligatorio. Hora de inicio para cada día dentro del rango del día de la semana.
endTime

object (TimeOfDay)

Obligatorio. Hora de finalización para cada día dentro del rango del día de la semana.
timeZone

string

Obligatorio. La zona horaria de IANA para las horas. Por ejemplo, “America/Los_Angeles”.
startDay

enum (DayOfWeek)

Obligatorio. Día de inicio.
endDay

enum (DayOfWeek)

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

integer

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

integer

Minutos de horas del día. Debe ser un valor entre 0 y 59.
seconds

integer

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

integer

Fracciones de segundos en nanosegundos. Debe ser un valor entre 0 y 999,999,999.

DayOfWeek

Representa un día de la semana.

Enumeraciones
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 (MessagingAvailability)
  }
}
Campos
humanMessagingAvailability

object (MessagingAvailability)

Obligatorio. Disponibilidad de mensajería humana.

AuthorizationConfig

Detalles de la configuración para admitir OAuth en Business Messages.

Representación JSON 
{
  "endpointUrl": string
}
Campos
endpointUrl

string

Es la URL del extremo en la que el usuario accede.

NonLocalConfig

Configuración para habilitar puntos de entrada no locales.

Representación JSON 
{
  "contactOption": {
    object (ContactOption)
  },
  "enabledDomains": [
    string
  ],
  "phoneNumber": {
    object (Phone)
  },
  "callDeflectionPhoneNumbers": [
    {
      object (Phone)
    }
  ],
  "regionCodes": [
    string
  ]
}
Campos
contactOption

object (ContactOption)

Obligatorio. Información de contacto del agente que se muestra con el botón de mensajería.
enabledDomains[]

string

Obligatorio. Dominios para habilitar para el punto de entrada de vínculos a sitios.
phoneNumber

object (Phone)

Obligatorio. Número de teléfono del agente. Anula el campo phone para las conversaciones iniciadas desde puntos de entrada no locales. Este número de teléfono se usará para todas las regiones configuradas.
callDeflectionPhoneNumbers[]

object (Phone)

Obligatorio. Lista de números de teléfono para el desvío de llamadas.
regionCodes[]

string

Obligatorio. Lista de códigos regionales de CLDR para los países en los que el agente puede iniciar puntos de entrada NON_LOCAL. Se requiere para NON_LOCAL puntos de entrada.

ContactOption

Son los detalles de contacto que se muestran además del botón de mensajes.

Representación JSON 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
Campos
url

string

Obligatorio. La URL para la que están disponibles las opciones de contacto.
options[]

enum (Option)

Obligatorio. Es la lista de opciones de contacto disponibles para la URL especificada.

Opción

Opciones de contacto.

Enumeraciones
OPTION_UNSPECIFIED Sin especificar
WEB_CHAT Opción de chat web.
PHONE Opción de teléfono.
EMAIL Opción de correo electrónico.
FAQS 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 (CustomSurveyConfig)
    },
    ...
  }
}
Campos
templateQuestionIds[]

string

Lista de IDs de preguntas de plantilla para preguntas de plantilla incluidas en una encuesta.
customSurveys

map (key: string, value: object (CustomSurveyConfig))

Preguntas de encuesta personalizadas para un agente, asignadas a una configuración regional. La configuración regional se representa con una etiqueta de idioma IETF BCP 47 bien formada.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CustomSurveyConfig

Configuración de encuesta personalizada para un agente.

Representación JSON 
{
  "customQuestions": [
    {
      object (SurveyQuestion)
    }
  ]
}
Campos
customQuestions[]

object (SurveyQuestion)

Lista de preguntas personalizadas.

SurveyQuestion

El contenido detallado de cada pregunta de la encuesta

Representación JSON 
{
  "name": string,
  "questionType": enum (Type),
  "questionContent": string,
  "responseOptions": [
    {
      object (SurveyResponse)
    }
  ]
}
Campos
name

string

Obligatorio. Es el identificador único de la pregunta.
questionType

enum (Type)

Solo salida. Tipo de pregunta.
questionContent

string

Obligatorio. Contenido de la pregunta Límite de 200 caracteres para las preguntas personalizadas.
responseOptions[]

object (SurveyResponse)

Obligatorio. Es la lista de respuestas que se muestra con la pregunta. 12 como máximo.

Tipo

El tipo de pregunta de encuesta.

Enumeraciones
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 de encuesta proporcionada por Google.
PARTNER_CUSTOM_QUESTION Pregunta de la encuesta personalizada del socio.

SurveyResponse

Es el contenido de la respuesta de una pregunta de la encuesta.

Representación JSON 
{
  "content": string,
  "postbackData": string
}
Campos
content

string

Obligatorio. El texto que se muestra en la encuesta y que se envía de vuelta al agente cuando el usuario lo presiona. Se admiten hasta 35 caracteres.
postbackData

string

La cadena que recibe el agente cuando el usuario presiona la respuesta de la pregunta.

Métodos

create

 Crea un agente nuevo para representar a una marca.

delete

 Borra un agente.

get

 Obtén información sobre un agente.

getLaunch

 Obtiene la información de lanzamiento de un agente.

getVerification

 Obtiene la información de verificación de un agente.

list

 Enumera todos los agentes asociados con una marca.

patch

 Actualiza la información sobre un agente.

requestLaunch

 Inicia el proceso de inicio de un agente.

requestVerification

 Comienza la verificación de la información de la empresa para un agente.

updateLaunch

 Actualiza la información de lanzamiento de un agente.

updateVerification

 Actualiza el estado de verificación de un agente.