REST Resource: brands.agents

Recurso: agente

Uma entidade de conversa 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)
  }
  // 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 modificável 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.

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 disponível publicamente para o agente. Máximo de 50 KB.

Não modificável após a verificação do agente.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

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

Não modificável 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. Outras informações sobre interação com o agente. Permite que o agente seja compatível com 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 a ser exibido pelo agente. Se não for especificado, o agente exibirá 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 a 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 Ative locais para este agente.
NON_LOCAL Ative 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 aceito pelo 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 do representante do bot.

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

object (MessagingAvailability)

Obrigatório. Disponibilidade de mensagens de bots.

MessagingAvailability

Os horários de cada dia da semana em que as mensagens estão disponíveis. Você pode agrupar os horários de vários dias. Por exemplo, * das 8h às 16h (horário do Pacífico), 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), aos sábados e às 14h (horário do Pacífico).

Se houver lacunas na disponibilidade, como quando não houver disponibilidade especificada no domingo, o envio de mensagens ficará indisponível durante esses intervalos.

As horas de uso do bot não afetam a disponibilidade. Os agentes exclusivos de bots sempre exibem uma mensagem de boas-vindas, enquanto os agentes com configurações de representatividade humana e de bot só consideram representantes humanos ao definir a disponibilidade.

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

object (Hours)

Obrigatório. Horário de disponibilidade das mensagens.

Horas

Um intervalo de horários em que as mensagens estão disponíveis.

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 de dias da semana.
endTime

object (TimeOfDay)

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

string

Obrigatório. O fuso horário IANA para as 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 representante humano.

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

object (MessagingAvailability)

Obrigatório. Disponibilidade de mensagens humanas.

AuthorizationConfig

Detalhes da configuração para oferecer suporte ao 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. Os domínios a serem ativados para o ponto de entrada dos 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 de telefone será usado em 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 regionais CLDR para países em que o agente tem permissão para lançar pontos de entrada do NON_LOCAL. Obrigatório para pontos de entrada 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 Opção de telefone.
EMAIL Opção de e-mail.
FAQS Perguntas frequentes.
TWITTER opção para o Twitter.
WHATSAPP Opção WhatsApp.

SurveyConfig

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

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

string

Lista de IDs de perguntas para modelos incluídos 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 de 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. Máximo de 12.

Tipo

O tipo de pergunta da pesquisa.

Enums
TYPE_UNSPECIFIED Tipo de pergunta da pesquisa desconhecido.
GOOGLE_STANDARD_QUESTION pergunta de pesquisa padrão do Google.
GOOGLE_TEMPLATE_QUESTION Modelo de pergunta de pesquisa fornecido pelo Google.
PARTNER_CUSTOM_QUESTION Pergunta da pesquisa personalizada do parceiro.

SurveyResponse

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

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

string

Obrigatório. Texto mostrado na pesquisa e enviado 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 à pergunta.

Métodos

create

 Cria um novo agente para representar uma marca.

delete

 Exclui um agente.

get

 Receber 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 de um agente.

updateLaunch

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

updateVerification

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