REST Resource: brands.agents.integrations

Recurso: integração

Informações sobre a integração.

Representação JSON 
{
  "name": string,
  "status": enum (IntegrationStatus),

  // Union field integration_info can be only one of the following:
  "dialogflowEsIntegration": {
    object (DialogflowEsIntegration)
  },
  "dialogflowCxIntegration": {
    object (DialogflowCxIntegration)
  },
  "agentWebhookIntegration": {
    object (AgentWebhookIntegration)
  }
  // End of list of possible types for union field integration_info.
}
Campos
name

string

Apenas saída. O identificador exclusivo da integração. Somente leitura. Definido pela plataforma.
status

enum (IntegrationStatus)

Apenas saída. Status da integração.
Campo de união integration_info. Informações detalhadas sobre a integração. integration_info pode ser apenas de um dos tipos a seguir:
dialogflowEsIntegration

object (DialogflowEsIntegration)

Informações sobre um projeto associado do Dialogflow ES. https://cloud.google.com/dialogflow/es/docs
dialogflowCxIntegration

object (DialogflowCxIntegration)

Informações sobre um projeto associado do Dialogflow CX. https://cloud.google.com/dialogflow/cx/docs/basics
agentWebhookIntegration

object (AgentWebhookIntegration)

Informações sobre o webhook de um agente. Se um webhook for configurado no nível do agente, ele será substituído no nível do parceiro.

IntegrationStatus

Status da integração.

Enums
INTEGRATION_STATUS_UNSPECIFIED O status da integração não foi especificado.
ENABLED Ativo.
DISABLED Desativada.

DialogflowEsIntegration

Informações sobre um agente do Business Messages e uma associação de projetos do Dialogflow ES.

Representação JSON 
{
  "dialogflowProjectId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  },
  "dialogflowKnowledgeBases": [
    {
      object (DialogflowKnowledgebase)
    }
  ]
}
Campos
dialogflowProjectId

string

Obrigatório. O ID do projeto do Dialogflow.

Não editável. Para alterar esse valor, exclua o projeto do Dialogflow desse agente e crie uma nova integração.
autoResponseStatus

enum (AutoResponseStatus)

Obrigatório. Se for ENABLED, o Business Messages enviará automaticamente as respostas do Dialogflow para os usuários.
dialogflowServiceAccountEmail

string

Apenas saída. A conta de serviço que precisa ser configurada no projeto do Dialogflow com os papéis "Editor do agente do Console do Dialogflow" e "Cliente da API Dialogflow". Isso é necessário para fornecer acesso à API Dialogflow.
operationInfo

object (OperationInfo)

Apenas saída. Informações sobre o estado operacional da integração do Dialogflow.
dialogflowKnowledgeBases[]

object (DialogflowKnowledgebase)

Bases de conhecimento associadas ao projeto do Dialogflow.

Opcional

AutoResponseStatus

Status da resposta automática do Dialogflow.

Enums
AUTO_RESPONSE_STATUS_UNSPECIFIED A resposta automática não foi especificada.
ENABLED A resposta automática está ativada.
DISABLED A resposta automática está desativada.

OperationInfo

As informações da operação do Dialogflow.

Representação JSON 
{
  "operationName": string,
  "operationType": enum (OperationType),
  "operationState": enum (OperationState),
  "error": {
    object (Status)
  }
}
Campos
operationName

string

Apenas saída. O nome atribuído pelo servidor (ID da operação), que é exclusivo apenas no mesmo serviço que o retorna originalmente.
operationType

enum (OperationType)

Apenas saída. Tipo de operação do Dialogflow.
operationState

enum (OperationState)

Apenas saída. Estado da operação do Dialogflow.
error

object (Status)

Apenas saída. Resultado do erro, se houver.

OperationType

Tipos de operação do Dialogflow.

Enums
OPERATION_TYPE_UNSPECIFIED Tipo não especificado.
ASSOCIATE_DIALOGFLOW Associar ao Dialogflow.
DISSOCIATE_DIALOGFLOW Dissociar o Dialogflow.
ADD_DOCUMENT_TO_KNOWLEDGEBASE Adicionar documento à base de conhecimento.
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE Excluir documento da base de conhecimento.

OperationState

Status da operação no Dialogflow.

Enums
OPERATION_STATE_UNSPECIFIED Estado não especificado.
PROCESSING Processando.
COMPLETED Concluído.
FAILED Ocorreu uma falha.

Status

O tipo Status define um modelo de erro lógico que é adequado a diferentes ambientes de programação, incluindo APIs REST e RPC. É usado por gRPC (em inglês). Cada mensagem Status contém três partes de dados: código do erro, mensagem de erro e detalhes do erro.

É possível descobrir mais sobre esse modelo de erro e como trabalhar com ele no Guia de design de API.

Representação JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Campos
code

integer

O código de status, que precisa ser um valor de enumeração de google.rpc.Code.
message

string

Uma mensagem de erro em inglês para o desenvolvedor. Qualquer mensagem de erro para o usuário precisa ser localizada e enviada no campo google.rpc.Status.details, ou localizada pelo cliente.
details[]

object

Uma lista de mensagens com os detalhes do erro. Há um conjunto comum de tipos de mensagens para as APIs usarem.

Um objeto contendo campos de um tipo arbitrário. Um campo adicional "@type" contém uma URI que identifica o tipo. Exemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

DialogflowKnowledgebase

Informações da base de conhecimento. Uma base de conhecimento pode ter vários URLs de perguntas frequentes.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "documents": [
    {
      object (DialogflowDocument)
    }
  ],
  "updateTime": string
}
Campos
name

string

Apenas saída. ID da base de conhecimento.

Identificador exclusivo retornado pelo serviço do Dialogflow após a criação de uma base de conhecimento. Se o identificador de marca for "1234", o identificador do agente será "5678", o identificador de integração será "9092" e o identificador da base de conhecimento for "1111", esse parâmetro será resolvido como "brands/1234/agents/5678/integrations/9092/knowledgebases/1111".
displayName

string

Obrigatório. Nome de exibição da base de conhecimento.
documents[]

object (DialogflowDocument)

Documentos da base de conhecimento.

Opcional
updateTime

string (Timestamp format)

Apenas saída. Hora em que a base de conhecimento foi criada ou atualizada.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

DialogflowDocument

Um documento da base de conhecimento. Um documento pode ser o URL de um site ou de um arquivo CSV. Os URLs precisam estar disponíveis publicamente. Os arquivos CSV precisam conter um ou mais pares de perguntas/respostas, com uma linha para cada par.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "updateTime": string,
  "operationInfo": {
    object (OperationInfo)
  },

  // Union field content can be only one of the following:
  "faqUrl": string,
  "rawContent": string
  // End of list of possible types for union field content.
}
Campos
name

string

ID do documento gerado pelo sistema.

Se o identificador de marca for "1234", o identificador do agente será "5678", o identificador de integração será "9092", o identificador da base de conhecimento será "1111" e o identificador do documento for "2222". Esse parâmetro será resolvido como "brands/1234/agents/5678/integrations/9092/knowledgebases/1112/documents/222".
displayName

string

Obrigatório. Nome de exibição de um documento de perguntas frequentes.
updateTime

string (Timestamp format)

Apenas saída. Hora em que o documento foi criado/atualizado.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
operationInfo

object (OperationInfo)

Apenas saída. As informações de operação são preenchidas somente quando um documento é adicionado a uma base de conhecimento existente.
Campo de união content. Conteúdo do documento. content pode ser apenas de um dos tipos a seguir:
faqUrl

string

URL de um documento de perguntas frequentes.
rawContent

string (bytes format)

O conteúdo bruto do documento.

Uma string codificada em base64.

DialogflowCxIntegration

Informações sobre um agente do Business Messages e uma associação de projetos do Dialogflow CX.

Representação JSON 
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
Campos
dialogflowProjectId

string

Obrigatório. O ID do projeto do Dialogflow.

Não editável. Para alterar esse valor, exclua o projeto do Dialogflow desse agente e crie uma nova integração.
dialogflowAgentId

string

Obrigatório. O ID do agente do Dialogflow.
autoResponseStatus

enum (AutoResponseStatus)

Obrigatório. Se for ENABLED, o Business Messages enviará automaticamente as respostas do Dialogflow para os usuários.
dialogflowServiceAccountEmail

string

Apenas saída. A conta de serviço que precisa ser configurada no projeto do Dialogflow com os papéis "Editor do agente do Console do Dialogflow" e "Cliente da API Dialogflow". Isso é necessário para fornecer acesso à API Dialogflow.
operationInfo

object (OperationInfo)

Apenas saída. Informações sobre o estado operacional da integração do Dialogflow.

AgentWebhookIntegration

Informações sobre o webhook de um agente do Business Messages.

Representação JSON 
{
  "webhookUri": string,
  "verificationToken": string
}
Campos
webhookUri

string

Obrigatório. O URL do webhook em que as mensagens são entregues.
verificationToken

string

Apenas entrada. O token de verificação.

Métodos

create

 Criar uma integração.

delete

 Excluir uma integração.

get

 Receba uma integração.

list

 Listar integrações.

patch

 Atualizar uma integração.