REST Resource: brands.agents

Recurso: agente

Uma entidade conversacional que representa uma marca.

Representação 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.
}
Campos
name

string

O identificador exclusivo do agente.

Somente leitura. Definido pela plataforma.
displayName

string

Obrigatório. O nome que o agente exibe aos usuários. Máximo de 100 caracteres.

Não pode ser modificado após a verificação do agente.

Campo de união detail_info. Contém os campos obrigatórios para o produto específico.

Obrigatório. detail_info pode ser apenas de um dos tipos a seguir:
businessMessagesAgent

object (BusinessMessagesAgent)

Informações detalhadas do agente para o Business Messages.
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

Informações detalhadas do agente para o RCS Business Messaging.

BusinessMessagesAgent

Informações do agente específicas para o Business Messages.

Representação 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. URL do logotipo do agente disponível publicamente. Máximo de 50 KB.

Não pode ser modificado após a verificação do agente.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

Opcional. Lista de configurações de ponto de entrada.

Não pode ser modificado após a verificação do agente.
conversationalSettings

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

Obrigatório. Configurações de conversa de um agente, mapeadas para uma localidade. A localidade é representada por uma tag de idioma IETF BCP 47 bem formada.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
defaultLocale

string

Obrigatório. A localidade padrão do agente. Precisa corresponder a uma localidade definida em conversationalSettings.
primaryAgentInteraction

object (SupportedAgentInteraction)

Obrigatório. Informações de interação com o agente principal. Usado quando o usuário inicia uma conversa.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

Opcional. Informações adicionais sobre a interação com o agente. Permite que o agente aceite vários tipos de interação.
customAgentId

string

Opcional. Um identificador especificado pelo parceiro para o agente. O identificador é transmitido com todas as mensagens enviadas ao agente.
agentTestUrl
(deprecated)

string

Apenas saída. O URL para testar a experiência de conversa do agente.

Definido pela plataforma.
testUrls[]

object (TestUrl)

Apenas saída. URLs para testar a experiência de conversa do agente.

Definido pela plataforma.
phone

object (Phone)

Opcional. O número de telefone do agente a ser exibido. Se não for especificado, o agente vai mostrar o número de telefone da marca encontrada no Mapa de informações do Google, se houver.
authorizationConfig

object (AuthorizationConfig)

Opcional. Configuração de autorização para suporte do OAuth.
nonLocalConfig

object (NonLocalConfig)

Opcional. Configuração para pontos de entrada não locais.
surveyConfig

object (SurveyConfig)

Opcional. Configuração para ativar pesquisas personalizadas.

BusinessMessagesEntryPointConfig

A configuração do ponto de entrada de um agente.

Representação JSON 
{
  "allowedEntryPoint": enum (EntryPoint)
}
Campos
allowedEntryPoint

enum (EntryPoint)

Obrigatório. As plataformas do Google em que o agente está ativado.

EntryPoint

As plataformas do Google em que o agente está ativado.

Enums
ENTRY_POINT_UNSPECIFIED Ponto de entrada não especificado.
LOCATION Ativar locais para este agente.
NON_LOCAL Ativar o Business Messages para pontos de entrada não locais.

SupportedAgentInteraction

Interações compatíveis com um agente.

Representação 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)

Obrigatório. O tipo de interação compatível com o agente.
Campo de união representative. As informações detalhadas do tipo de configuração. Obrigatório. representative pode ser apenas de um dos tipos a seguir:
botRepresentative

object (BotRepresentative)

Detalhes do representante do bot.
humanRepresentative

object (HumanRepresentative)

Detalhes do representante humano.

InteractionType

Tipo de interação compatível com o agente.

Enums
INTERACTION_TYPE_UNSPECIFIED Interação não especificada.
BOT Interação com o bot.
HUMAN Interação humana.

BotRepresentative

Detalhes para o representante do bot.

Representação JSON 
{
  "botMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Campos
botMessagingAvailability

object (MessagingAvailability)

Obrigatório. Disponibilidade de mensagens do bot.

MessagingAvailability

O horário de funcionamento de cada dia da semana em que o recurso de mensagens está disponível. Você pode agrupar horários de funcionamento para vários dias. Por exemplo, * das 8h às 16h PDT, de segunda a quarta-feira * das 10h às 14h PDT de quinta a sexta-feira * das 15h às 18h PDT de quinta a sexta-feira * das 10h às 14h PDT, de quinta-feira a sexta-feira

Se houver lacunas na disponibilidade, como uma disponibilidade especificada no domingo, o recurso de mensagens ficará indisponível durante esses intervalos.

O horário do bot não afeta a disponibilidade. Os agentes apenas de bots sempre exibem uma mensagem de boas-vindas, enquanto os agentes com configurações de representante humano e bot só consideram representantes humanos ao definir a disponibilidade.

Representação JSON 
{
  "hours": [
    {
      object (Hours)
    }
  ]
}
Campos
hours[]

object (Hours)

Obrigatório. O horário de funcionamento para enviar mensagens.

Horas

Um intervalo de horários em que o recurso de mensagens fica disponível.

Representação JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  },
  "timeZone": string,
  "startDay": enum (DayOfWeek),
  "endDay": enum (DayOfWeek)
}
Campos
startTime

object (TimeOfDay)

Obrigatório. Horário de início de cada dia no intervalo do dia da semana.
endTime

object (TimeOfDay)

Obrigatório. Horário de término de cada dia no intervalo do dia da semana.
timeZone

string

Obrigatório. O fuso horário da IANA das horas. Por exemplo, "América/Los_Angeles".
startDay

enum (DayOfWeek)

Obrigatório. Data de início.
endDay

enum (DayOfWeek)

Obrigatório. Data de término. Inclui o dia especificado.

TimeOfDay

Representa um horário do dia. A data e o fuso horário não são relevantes ou são especificados em outro lugar. Uma API pode permitir segundos bissextos. Os tipos relacionados são google.type.Date e google.protobuf.Timestamp.

Representação JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Campos
hours

integer

Horas do dia no formato de 24 horas. Precisa ser de 0 a 23. Uma API pode permitir o valor "24:00:00" para o horário de fechamento da empresa, por exemplo.
minutes

integer

Minutos da hora do dia. Precisa ser de 0 a 59.
seconds

integer

Segundos do minutos do horário. Normalmente precisa ser de 0 a 59. Uma API pode permitir o valor 60 se permitir segundos bissextos.
nanos

integer

Frações de segundos em nanossegundos. Precisa ser de 0 a 999.999.999.

DayOfWeek

Representa um dia da semana.

Enums
DAY_OF_WEEK_UNSPECIFIED O dia da semana não é especificado.
MONDAY Segunda-feira
TUESDAY Terça-feira
WEDNESDAY Quarta-feira
THURSDAY Quinta-feira
FRIDAY Sexta-feira
SATURDAY Sábado
SUNDAY Domingo

HumanRepresentative

Detalhes para o representante humano.

Representação JSON 
{
  "humanMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Campos
humanMessagingAvailability

object (MessagingAvailability)

Obrigatório. Disponibilidade de mensagens humanas.

AuthorizationConfig

Detalhes de configuração para compatibilidade com o OAuth no Business Messages.

Representação JSON 
{
  "endpointUrl": string
}
Campos
endpointUrl

string

O URL do endpoint em que o usuário faz login.

NonLocalConfig

Configuração para ativar pontos de entrada não locais.

Representação JSON 
{
  "contactOption": {
    object (ContactOption)
  },
  "enabledDomains": [
    string
  ],
  "phoneNumber": {
    object (Phone)
  },
  "callDeflectionPhoneNumbers": [
    {
      object (Phone)
    }
  ],
  "regionCodes": [
    string
  ]
}
Campos
contactOption

object (ContactOption)

Obrigatório. Os dados de contato do agente que aparecem com o botão para enviar mensagens.
enabledDomains[]

string

Obrigatório. Domínios a serem ativados para o ponto de entrada de sitelinks.
phoneNumber

object (Phone)

Obrigatório. Número de telefone do agente. Modifica o campo phone para conversas iniciadas em pontos de entrada não locais. Esse número será usado para todas as regiões configuradas.
callDeflectionPhoneNumbers[]

object (Phone)

Obrigatório. Lista de números de telefone para desvio de chamada.
regionCodes[]

string

Obrigatório. Lista de códigos de região CLDR para países em que o agente tem permissão para lançar pontos de entrada NON_LOCAL. Obrigatório para pontos de entrada de NON_LOCAL.

ContactOption

Detalhes de contato exibidos além do botão de mensagens.

Representação JSON 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
Campos
url

string

Obrigatório. O URL para o qual as opções de contato estão disponíveis.
options[]

enum (Option)

Obrigatório. A lista de opções de contato disponíveis para o URL especificado.

Opção

Opções de contato.

Enums
OPTION_UNSPECIFIED Não especificado
WEB_CHAT Opção de chat na Web.
PHONE Telefone.
EMAIL Opção de e-mail.
FAQS opção de perguntas frequentes.
TWITTER Opção do Twitter.
WHATSAPP Opção do WhatsApp.

SurveyConfig

Detalhes da configuração para responder a perguntas de pesquisa personalizadas.

Representação JSON 
{
  "templateQuestionIds": [
    string
  ],
  "customSurveys": {
    string: {
      object (CustomSurveyConfig)
    },
    ...
  }
}
Campos
templateQuestionIds[]

string

Lista de IDs de perguntas de modelo para perguntas de modelo incluídas em uma pesquisa.
customSurveys

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

Perguntas de pesquisa personalizadas para um agente, mapeadas para uma localidade. A localidade é representada por uma tag de idioma IETF BCP 47 bem formada.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CustomSurveyConfig

Configuração de pesquisa personalizada para um agente.

Representação JSON 
{
  "customQuestions": [
    {
      object (SurveyQuestion)
    }
  ]
}
Campos
customQuestions[]

object (SurveyQuestion)

Lista de perguntas personalizadas.

SurveyQuestion

O conteúdo detalhado de cada pergunta da pesquisa.

Representação JSON 
{
  "name": string,
  "questionType": enum (Type),
  "questionContent": string,
  "responseOptions": [
    {
      object (SurveyResponse)
    }
  ]
}
Campos
name

string

Obrigatório. O identificador exclusivo da pergunta.
questionType

enum (Type)

Apenas saída. Tipo da pergunta.
questionContent

string

Obrigatório. Conteúdo da pergunta. Limitado a 200 caracteres para perguntas personalizadas.
responseOptions[]

object (SurveyResponse)

Obrigatório. Lista de respostas exibidas com a pergunta. No máximo 12.

Tipo

O tipo de pergunta da pesquisa.

Enums
TYPE_UNSPECIFIED Tipo de pergunta de pesquisa desconhecido.
GOOGLE_STANDARD_QUESTION pergunta padrão de pesquisa do Google.
GOOGLE_TEMPLATE_QUESTION O Google forneceu um modelo de pergunta de pesquisa.
PARTNER_CUSTOM_QUESTION Pergunta de pesquisa personalizada para parceiros.

SurveyResponse

O conteúdo de uma resposta à pergunta da pesquisa.

Representação JSON 
{
  "content": string,
  "postbackData": string
}
Campos
content

string

Obrigatório. Texto que é mostrado na pesquisa e enviado de volta ao agente quando o usuário toca nele. Máximo de 35 caracteres.
postbackData

string

É a string que o agente recebe quando o usuário toca na resposta da pergunta.

RcsBusinessMessagingAgent

Informações do agente relacionadas especificamente ao RCS Business Messaging.

Representação 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)
}
Campos
description

string

Obrigatório. Descrição do agente que fica visível para os usuários. Máximo de 100 caracteres.
logoUri

string

Obrigatório. URL do logotipo do agente disponível publicamente. Máximo de 50 KB.

Não pode ser modificado após a verificação do agente.
heroUri

string

Obrigatório. URL disponível publicamente da imagem principal do agente. Máximo de 200 KB.

Não pode ser modificado após a verificação do agente.
phoneNumbers[]

object (PhoneEntry)

Obrigatório. Números de telefone associados ao agente.
emails[]

object (EmailEntry)

Opcional. Endereços de e-mail associados ao agente.
websites[]

object (WebEntry)

Opcional. Sites associados ao agente. Máximo de 3.
privacy

object (WebEntry)

Obrigatório. Política de Privacidade associada ao agente.
termsConditions

object (WebEntry)

Obrigatório. Termos e condições associados ao agente.
color

string

Obrigatório. Cor do tema do agente que fica visível para os usuários em formato hexadecimal. Por exemplo: #FF6347.
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

Obrigatório. Configuração de faturamento para o agente.
agentUseCase

enum (AgentUseCase)

Opcional. Caso de uso do bot.
hostingRegion

enum (HostingRegion)

Obrigatório. Região de hospedagem de um agente.

PhoneEntry

Um número de telefone associado ao agente.

Representação JSON 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
Campos
phoneNumber

object (Phone)

Obrigatório. Número de telefone no formato E.164. Por exemplo, +12223334444.
label

string

Obrigatório. Marcador do número de telefone.

EmailEntry

Um e-mail associado ao agente.

Representação JSON 
{
  "address": string,
  "label": string
}
Campos
address

string

Obrigatório. Um endereço de e-mail.
label

string

Obrigatório. Marcador do endereço de e-mail.

WebEntry

Um recurso baseado na Web associado ao agente.

Representação JSON 
{
  "uri": string,
  "label": string
}
Campos
uri

string

Obrigatório. Um URI de acesso público associado ao agente. É necessário usar o protocolo HTTP ou HTTPS.
label

string

Opcional. Identificador do URI.

RcsBusinessMessagingAgentBillingConfig

Configuração de faturamento para o agente.

Representação JSON 
{
  "billingCategory": enum (BillingCategory)
}
Campos
billingCategory

enum (BillingCategory)

Categoria de faturamento do agente.

BillingCategory

Categorias de faturamento compatíveis.

Enums
BILLING_CATEGORY_UNSPECIFIED Categoria não especificada.
CONVERSATIONAL_LEGACY Categoria legada para dar suporte à configuração de faturamento dos agentes atuais.
CONVERSATIONAL Desenvolvido para sessões mais longas e complexas em que o usuário e a marca trocam uma série de mensagens.
SINGLE_MESSAGE Substitui o SMS por uma experiência de mensagens mais avançada. Nunca faturado como CONVERSATIONAL.
BASIC_MESSAGE O modelo de faturamento é semelhante ao SMS. Nunca faturado como CONVERSATIONAL.

AgentUseCase

Tipos de caso de uso do agente usados no armazenamento.

Enums
AGENT_USE_CASE_UNSPECIFIED Caso de uso não especificado.
TRANSACTIONAL Agentes que enviam apenas mensagens essenciais, necessárias e urgentes.
PROMOTIONAL Agentes que enviam mensagens de vendas, marketing e promoções. Tipo padrão.
OTP Agentes que enviam apenas senhas únicas.
MULTI_USE Agentes que têm vários casos de uso.

HostingRegion

Possíveis regiões de hospedagem para um agente, usadas para rotear mensagens P2A para o servidor regionalizado corretamente.

Enums
HOSTING_REGION_UNSPECIFIED Região de hospedagem não especificada.
NORTH_AMERICA América do Norte.
EUROPE Europa.
ASIA_PACIFIC Ásia-Pacífico.

Métodos

create

 Cria um novo agente para representar uma marca.

delete
(deprecated)

 Obsoleto: a exclusão do agente foi descontinuada.

get

 Receba informações sobre um agente.

getLaunch

 Recebe as informações de lançamento de um agente.

getVerification

 Recebe as informações de verificação de um agente.

list

 Lista todos os agentes associados a uma marca.

patch

 Atualiza informações sobre um agente.

requestLaunch

 Inicia o processo de lançamento de um agente.

requestVerification

 Inicia a verificação das informações comerciais do agente.

updateLaunch

 Atualiza as informações de lançamento de um agente.

updateVerification

 Atualiza o estado de verificação de um agente.