REST Resource: projects.chatAppConfig

Recurso: ChatAppConfig

Representa a configuração de um app do Google Chat criado como um complemento do Google Workspace.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "interactiveFeatureConfig": {
    object (InteractiveFeatureConfig)
  },
  "avatarUri": string,
  "state": enum (AppState),
  "errorLoggingEnabled": boolean,
  "markupSyntax": enum (MarkupSyntax)
}
Campos
name

string

Obrigatório. Identificador. Nome do recurso da configuração do app do Chat.

Formato: projects/{project}/chatAppConfig, em que {project} é o número do projeto na nuvem do Google Cloud.
displayName

string

Obrigatório. O nome de exibição do app do Chat. O comprimento precisa ser de 3 a 25 caracteres.
description

string

Obrigatório. Uma breve descrição do app do Chat. Deve ter entre 1 e 40 caracteres.
interactiveFeatureConfig

object (InteractiveFeatureConfig)

Opcional. As configurações dos recursos interativos do app. Se isso não for informado, o app não será interativo, ou seja, poderá usar a API Chat, mas os usuários não poderão interagir com ele.
avatarUri

string

Opcional. O URL da imagem de avatar do app. Precisa ser um URL HTTPS que hospede uma imagem PNG quadrada (proporção de 1:1). Tamanho mínimo recomendado: 256 por 256 pixels. Um avatar padrão será usado se nenhum avatar for informado.
state

enum (AppState)

Opcional. O estado do app. O padrão será ACTIVE se não for especificado.
errorLoggingEnabled

boolean

Opcional. Se os erros devem ser registrados no Cloud Logging. Se não for especificado, o padrão false será usado.
markupSyntax

enum (MarkupSyntax)

Opcional. A sintaxe de marcação padrão para mensagens enviadas ou lidas por este app do Chat. O padrão será MARKUP_SYNTAX_MARKDOWN se não for especificado.

AppState

O estado atual do app do Chat.

Tipos enumerados
APP_STATE_UNSPECIFIED Valor padrão. Não especificado.
ACTIVE É mapeado para LIVE na página de configuração da API Chat. O app está ativo e pode ser encontrado e usado por pessoas com visibilidade.
DISABLED O app está desativado, não pode mais ser encontrado por ninguém e ninguém pode mais falar com ele.

InteractiveFeatureConfig

Configurações dos recursos interativos do app.

Representação JSON 
{
  "connectionConfig": {
    object (ConnectionConfig)
  },
  "appCommands": [
    {
      object (AppCommand)
    }
  ],
  "urlPatterns": [
    {
      object (UrlPattern)
    }
  ],
  "allowlistedTestingPrincipals": [
    string
  ],
  "supportsMultiuserSpaces": boolean
}
Campos
connectionConfig

object (ConnectionConfig)

Obrigatório. Como o app recebe eventos do Google Chat.
appCommands[]

object (AppCommand)

Opcional. Configuração para comandos de apps.
urlPatterns[]

object (UrlPattern)

Opcional. Configuração para prévias de links.
allowlistedTestingPrincipals[]

string

Opcional. Os endereços de e-mail dos usuários e grupos no seu domínio do Google Workspace que podem encontrar e usar o app.
supportsMultiuserSpaces

boolean

Opcional. Se o app pode ser adicionado a mensagens diretas individuais, grupos de chat e espaços. Se não for especificado, o padrão false será usado.

ConnectionConfig

Como o app recebe eventos.

Representação JSON 
{

  "httpEndpointConfig": {
    object (HttpEndpointConfig)
  },
  "appsScriptEndpointConfig": {
    object (AppsScriptEndpointConfig)
  },
  "cloudPubSubEndpointConfig": {
    object (CloudPubSubEndpointConfig)
  },
  "dialogflowEndpointConfig": {
    object (DialogflowEndpointConfig)
  }
}
Campos
O tipo de conexão. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
httpEndpointConfig

object (HttpEndpointConfig)

Configuração do endpoint HTTP.
appsScriptEndpointConfig

object (AppsScriptEndpointConfig)

Configuração de implantação do Apps Script.
cloudPubSubEndpointConfig

object (CloudPubSubEndpointConfig)

Configuração de tópico do Pub/Sub.
dialogflowEndpointConfig

object (DialogflowEndpointConfig)

Configuração do Dialogflow.
Fim dos campos mutuamente exclusivos.

HttpEndpointConfig

Configuração do endpoint HTTP.

Representação JSON 
{

  "commonUrl": string,
  "perEventEndpointConfig": {
    object (HttpPerEventEndpointConfig)
  }
}
Campos
A configuração do URL do endpoint HTTP. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
commonUrl

string

Opcional. O URL HTTPS para o qual o Google Chat envia todos os eventos interativos.
perEventEndpointConfig

object (HttpPerEventEndpointConfig)

Opcional. URLs HTTPS separados para os quais o Google Chat envia cada tipo de evento interativo.
Fim dos campos mutuamente exclusivos.

HttpPerEventEndpointConfig

Configuração de endpoint HTTP para tipos de evento específicos.

Representação JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Campos
appCommandEndpoint

string

Obrigatório. Endpoint de URL HTTPS para eventos de comando do app.
addedToSpaceEndpoint

string

Obrigatório. URL HTTPS do endpoint para eventos de adição ao espaço.
messageEndpoint

string

Obrigatório. Endpoint de URL HTTPS para eventos de mensagem.
removedFromSpaceEndpoint

string

Obrigatório. Endpoint de URL HTTPS para eventos de remoção de um espaço.

AppsScriptEndpointConfig

Configuração do endpoint do Apps Script.

Representação JSON 
{
  "deploymentId": string,
  "perEventEndpointConfig": {
    object (AppsScriptPerEventEndpointConfig)
  }
}
Campos
deploymentId

string

Obrigatório. O ID de implantação do Apps Script.
perEventEndpointConfig

object (AppsScriptPerEventEndpointConfig)

Opcional. Os nomes das funções do Apps Script que o Google Chat chama para cada tipo de evento interativo. Se não for especificado, o Chat vai chamar a função padrão para cada tipo de evento.

AppsScriptPerEventEndpointConfig

Configuração do endpoint do Apps Script para tipos de evento específicos.

Representação JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Campos
appCommandEndpoint

string

Opcional. Nome da função para eventos de comando do app. Se não for especificado, o nome padrão da função onAppCommand será usado.
addedToSpaceEndpoint

string

Opcional. Nome da função para eventos de adição ao espaço. Se não for especificado, o nome padrão da função onAddedToSpace será usado.
messageEndpoint

string

Opcional. Nome da função para eventos de mensagem. Se não for especificado, o nome padrão da função onMessage será usado.
removedFromSpaceEndpoint

string

Opcional. Nome da função para eventos de remoção do espaço. Se não for especificado, o nome padrão da função onRemovedFromSpace será usado.

CloudPubSubEndpointConfig

Configuração do endpoint do Pub/Sub.

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

string

Obrigatório. O tópico do Pub/Sub em que o Google Chat publica todos os eventos interativos. O tópico precisa estar no mesmo projeto na nuvem do Google Cloud que o app, e o Chat precisa ter permissão para publicar mensagens no tópico. Veja mais detalhes em Criar um app do Google Chat com o Pub/Sub.

Formato: projects/{project}/topics/{topic}

DialogflowEndpointConfig

Configuração do endpoint do Dialogflow.

Representação JSON 
{
  "dialogflowEdition": enum (DialogflowEdition),
  "agent": string
}
Campos
dialogflowEdition

enum (DialogflowEdition)

Obrigatório. A edição do Dialogflow.
agent

string

Opcional. O nome do agente de CX ou ambiente do Dialogflow CX. Obrigatório para o Dialogflow CX. Não defina para o Dialogflow ES.

Formato: projects/{project}/locations/{location}/agents/{agent} ou projects/{project}/locations/{location}/agents/{agent}/environments/{environment}.

DialogflowEdition

Tipo de edição do Dialogflow.

Tipos enumerados
DIALOGFLOW_EDITION_UNSPECIFIED Valor padrão. Não especificado.
ES Edição Dialogflow ES. Para usar essa edição, é necessário que um agente do Dialogflow ES exista no mesmo projeto do Google Cloud que o app. O Google Chat envia todos os eventos interativos para esse agente.
CX Edição do Dialogflow CX. Para usar essa edição, um agente de CX do Dialogflow CX precisa existir no mesmo projeto na nuvem do Google Cloud que o app e ser especificado no campo agent. O Google Chat envia todos os eventos interativos para esse agente.

AppCommand

Configuração de um comando de app.

Representação JSON 
{
  "commandType": enum (CommandType),
  "commandId": integer,
  "command": string,
  "displayName": string,
  "description": string,
  "dialogEnabled": boolean,
  "loadingNotificationMessage": string
}
Campos
commandType

enum (CommandType)

Obrigatório. O tipo do comando.
commandId

integer

Obrigatório. O ID do comando (1-1000). Precisa ser exclusivo no app.
command

string

Opcional. O nome do comando. Obrigatório para SLASH_COMMAND. Não defina para outros tipos de comando. Precisa começar com uma "/", por exemplo, "/comando".
displayName

string

Opcional. O nome de exibição fácil de usar do comando. Obrigatório para MESSAGE_ACTION e QUICK_COMMAND. Não defina para SLASH_COMMAND.
description

string

Obrigatório. Uma breve descrição do comando.
dialogEnabled

boolean

Opcional. Se este comando deve acionar uma caixa de diálogo. O padrão será false se nada for especificado.
loadingNotificationMessage

string

Opcional. Uma notificação a ser enviada ao usuário quando ele acionar a ação da mensagem. Compatível apenas com comandos MESSAGE_ACTION.

CommandType

O tipo do comando do app.

Tipos enumerados
COMMAND_TYPE_UNSPECIFIED Valor padrão. Não especificado.
SLASH_COMMAND Um comando invocado ao digitar "/" seguido do nome do comando. Ele pode aceitar outros argumentos no texto da mensagem.
QUICK_COMMAND Um comando rápido invocado no menu de contexto de criação de mensagens. Os comandos rápidos não aceitam argumentos adicionais.
MESSAGE_ACTION Um comando invocado de um menu de contexto de mensagem.

UrlPattern

Configuração de uma prévia de link.

Representação JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
Campos
hostPattern

string

Obrigatório. O domínio a ser correspondido. Para corresponder a um subdomínio específico, como "subdomain.example.com", ou a um domínio inteiro, inclua um asterisco (*) como caractere curinga inicial. Por exemplo, "*.example.com" corresponde a "https://subdomain.example.com" e "https://any.number.of.subdomains.example.com".
pathPrefix

string

Opcional. Prefixo do caminho anexado ao padrão do host. Se estiver em branco, corresponderá a todos os URLs no padrão de host. Por exemplo, quando combinado com o padrão de host "subdomain.example.com", especifique "path/" para corresponder aos URLs de página que começam com "https://subdomain.example.com/path/".

MarkupSyntax

A sintaxe de marcação usada para formatar o texto da mensagem para este app do Chat.

Tipos enumerados
MARKUP_SYNTAX_UNSPECIFIED Valor padrão. Não especificado. Os apps do Chat criados antes da introdução de markup_syntax têm esse valor e usam MARKUP_SYNTAX_CHAT até serem atualizados explicitamente.
MARKUP_SYNTAX_CHAT Usa a sintaxe de marcação do Google Chat. Consulte https://developers.google.com/workspace/chat/format-messages#format-texts para mais informações.
MARKUP_SYNTAX_MARKDOWN Usa a sintaxe de Markdown. Essa sintaxe é baseada na especificação CommonMark, com extensões adicionais. Consulte https://developers.google.com/workspace/chat/format-messages#format-texts para mais informações.

Métodos

get

 Recebe a configuração do app do Chat de um projeto.

patch

 Atualiza a configuração do app Chat de um projeto.