REST Resource: projects.chatAppConfig

Recurso: ChatAppConfig

Representa la configuración de una app de Google Chat creada como complemento de Google Workspace.

Representación JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "interactiveFeatureConfig": {
    object (InteractiveFeatureConfig)
  },
  "avatarUri": string,
  "state": enum (AppState),
  "errorLoggingEnabled": boolean,
  "markupSyntax": enum (MarkupSyntax)
}
Campos
name

string

Obligatorio. Es el identificador. Es el nombre del recurso de la configuración de la app de Chat.

Formato: projects/{project}/chatAppConfig, en el que {project} es el número del proyecto de Google Cloud.
displayName

string

Obligatorio. Es el nombre visible de la app de Chat. La longitud debe ser de entre 3 y 25 caracteres.
description

string

Obligatorio. Una descripción breve de la app de Chat. Debe tener entre 1 y 40 caracteres.
interactiveFeatureConfig

object (InteractiveFeatureConfig)

Opcional. La configuración de las funciones interactivas de la app. Si no se proporciona, la app no será interactiva, lo que significa que puede usar la API de Chat, pero los usuarios no pueden interactuar con ella.
avatarUri

string

Opcional. Es la URL de la imagen de avatar de la app. Debe ser una URL HTTPS que aloje una imagen PNG cuadrada (con una relación de aspecto de 1:1). Tamaño mínimo recomendado: 256 por 256 píxeles. Si no se especifica un avatar de la app, se usará uno predeterminado.
state

enum (AppState)

Opcional. Es el estado de la app. El valor predeterminado es ACTIVE si no se especifica.
errorLoggingEnabled

boolean

Opcional. Indica si se deben registrar los errores en Cloud Logging. El valor predeterminado es false si no se especifica.
markupSyntax

enum (MarkupSyntax)

Opcional. Es la sintaxis de lenguaje de marcado predeterminada para los mensajes que envía o lee esta app de Chat. El valor predeterminado es MARKUP_SYNTAX_MARKDOWN si no se especifica.

AppState

Es el estado actual de la app de Chat.

Enums
APP_STATE_UNSPECIFIED Valor predeterminado Sin especificar.
ACTIVE Se asigna a EN VIVO en la página de configuración de la API de Chat. La app está activa, y las personas con visibilidad pueden encontrarla y usarla.
DISABLED La app está inhabilitada, nadie puede encontrarla ni hablar con ella.

InteractiveFeatureConfig

La configuración de las funciones interactivas de la app

Representación JSON 
{
  "connectionConfig": {
    object (ConnectionConfig)
  },
  "appCommands": [
    {
      object (AppCommand)
    }
  ],
  "urlPatterns": [
    {
      object (UrlPattern)
    }
  ],
  "allowlistedTestingPrincipals": [
    string
  ],
  "supportsMultiuserSpaces": boolean
}
Campos
connectionConfig

object (ConnectionConfig)

Obligatorio. Cómo la app recibe eventos de Google Chat
appCommands[]

object (AppCommand)

Opcional. Configuración de los comandos de la app.
urlPatterns[]

object (UrlPattern)

Opcional. Configuración de las vistas previas de vínculos.
allowlistedTestingPrincipals[]

string

Opcional. Son las direcciones de correo electrónico de los usuarios y grupos de tu dominio de Google Workspace que pueden encontrar y usar la app.
supportsMultiuserSpaces

boolean

Opcional. Indica si la app se puede agregar a MD individuales, chats en grupo y espacios. El valor predeterminado es false si no se especifica.

ConnectionConfig

Cómo la app recibe eventos

Representación JSON 
{

  "httpEndpointConfig": {
    object (HttpEndpointConfig)
  },
  "appsScriptEndpointConfig": {
    object (AppsScriptEndpointConfig)
  },
  "cloudPubSubEndpointConfig": {
    object (CloudPubSubEndpointConfig)
  },
  "dialogflowEndpointConfig": {
    object (DialogflowEndpointConfig)
  }
}
Campos
Es el tipo de conexión. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
httpEndpointConfig

object (HttpEndpointConfig)

Configuración del extremo HTTP.
appsScriptEndpointConfig

object (AppsScriptEndpointConfig)

Es la configuración de la implementación de Apps Script.
cloudPubSubEndpointConfig

object (CloudPubSubEndpointConfig)

Configuración del tema de Pub/Sub.
dialogflowEndpointConfig

object (DialogflowEndpointConfig)

Configuración de Dialogflow.
Fin de los campos mutuamente excluyentes.

HttpEndpointConfig

Configuración del extremo HTTP.

Representación JSON 
{

  "commonUrl": string,
  "perEventEndpointConfig": {
    object (HttpPerEventEndpointConfig)
  }
}
Campos
Es la configuración de la URL del extremo HTTP. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
commonUrl

string

Opcional. Es la URL HTTPS a la que Google Chat envía todos los eventos interactivos.
perEventEndpointConfig

object (HttpPerEventEndpointConfig)

Opcional. Son URLs HTTPS independientes a las que Google Chat envía cada tipo de evento interactivo.
Fin de los campos mutuamente excluyentes.

HttpPerEventEndpointConfig

Configuración de extremos HTTP para tipos de eventos específicos.

Representación JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Campos
appCommandEndpoint

string

Obligatorio. Es el extremo de la URL HTTPS para los eventos de comandos de la app.
addedToSpaceEndpoint

string

Obligatorio. Es el extremo de la URL HTTPS para los eventos de adición a un espacio.
messageEndpoint

string

Obligatorio. Es el extremo de la URL HTTPS para los eventos de mensajes.
removedFromSpaceEndpoint

string

Obligatorio. Es el extremo de la URL HTTPS para los eventos de eliminación de un espacio.

AppsScriptEndpointConfig

Configuración del extremo de Apps Script.

Representación JSON 
{
  "deploymentId": string,
  "perEventEndpointConfig": {
    object (AppsScriptPerEventEndpointConfig)
  }
}
Campos
deploymentId

string

Obligatorio. Es el ID de implementación de Apps Script.
perEventEndpointConfig

object (AppsScriptPerEventEndpointConfig)

Opcional. Son los nombres de las funciones de Apps Script a las que llama Google Chat para cada tipo de evento interactivo. Si no se especifica, Chat llama a la función predeterminada para cada tipo de evento.

AppsScriptPerEventEndpointConfig

Configuración del extremo de Apps Script para tipos de eventos específicos.

Representación JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Campos
appCommandEndpoint

string

Opcional. Es el nombre de la función para los eventos de comandos de la app. Si no se especifica, se usará el nombre de función predeterminado onAppCommand.
addedToSpaceEndpoint

string

Opcional. Es el nombre de la función para los eventos de adición a un espacio. Si no se especifica, se usará el nombre de función predeterminado onAddedToSpace.
messageEndpoint

string

Opcional. Es el nombre de la función para los eventos de mensajes. Si no se especifica, se usará el nombre de función predeterminado onMessage.
removedFromSpaceEndpoint

string

Opcional. Es el nombre de la función para los eventos de eliminación de un espacio. Si no se especifica, se usará el nombre de función predeterminado onRemovedFromSpace.

CloudPubSubEndpointConfig

Es la configuración del extremo de Pub/Sub.

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

string

Obligatorio. Es el tema de Pub/Sub en el que Google Chat publica todos los eventos interactivos. El tema debe estar en el mismo proyecto de Google Cloud que la app, y Chat debe tener permiso para publicar mensajes en el tema. Para obtener más detalles, consulta Cómo compilar una app de Google Chat con Pub/Sub.

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

DialogflowEndpointConfig

Es la configuración del extremo de Dialogflow.

Representación JSON 
{
  "dialogflowEdition": enum (DialogflowEdition),
  "agent": string
}
Campos
dialogflowEdition

enum (DialogflowEdition)

Obligatorio. La edición de Dialogflow.
agent

string

Opcional. Es el nombre del agente o entorno de Dialogflow CX. Es obligatorio para Dialogflow CX. No lo configures para Dialogflow ES.

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

DialogflowEdition

Es el tipo de edición de Dialogflow.

Enums
DIALOGFLOW_EDITION_UNSPECIFIED Valor predeterminado Sin especificar.
ES Edición de Dialogflow ES. Para usar esta edición, debe existir un agente de Dialogflow ES en el mismo proyecto de Google Cloud que la app. Google Chat envía todos los eventos interactivos a ese agente.
CX Edición de Dialogflow CX. Para usar esta edición, debe existir un agente de Dialogflow CX en el mismo proyecto de Google Cloud que la app y debe especificarse en el campo agent. Google Chat envía todos los eventos interactivos a ese agente.

AppCommand

Es la configuración de un comando de app.

Representación JSON 
{
  "commandType": enum (CommandType),
  "commandId": integer,
  "command": string,
  "displayName": string,
  "description": string,
  "dialogEnabled": boolean,
  "loadingNotificationMessage": string
}
Campos
commandType

enum (CommandType)

Obligatorio. Es el tipo de este comando.
commandId

integer

Obligatorio. Es el ID del comando (del 1 al 1000). Debe ser único dentro de la app.
command

string

Opcional. Es el nombre del comando. Es obligatorio para SLASH_COMMAND. No lo configures para otros tipos de comandos. Debe comenzar con una "/", p.ej., "/command".
displayName

string

Opcional. Es el nombre visible fácil de usar del comando. Es obligatorio para MESSAGE_ACTION y QUICK_COMMAND, no lo configures para SLASH_COMMAND.
description

string

Obligatorio. Una descripción breve del comando.
dialogEnabled

boolean

Opcional. Indica si este comando debe activar un diálogo. El valor predeterminado es false si no se especifica.
loadingNotificationMessage

string

Opcional. Es una notificación que se enviará al usuario cuando active la acción de mensaje. Solo se admite para los comandos MESSAGE_ACTION.

CommandType

Es el tipo de comando de la app.

Enums
COMMAND_TYPE_UNSPECIFIED Valor predeterminado Sin especificar.
SLASH_COMMAND Es un comando que se invoca escribiendo una "/" seguida del nombre del comando. Puede aceptar argumentos adicionales en el texto del mensaje.
QUICK_COMMAND Un comando rápido que se invoca desde el menú contextual de redacción de mensajes. Los comandos rápidos no aceptan argumentos adicionales.
MESSAGE_ACTION Un comando invocado desde un menú contextual de mensajes.

UrlPattern

Configuración de una vista previa de vínculo.

Representación JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
Campos
hostPattern

string

Obligatorio. Es el dominio con el que se buscarán coincidencias. Haz coincidir un subdominio específico, como "subdominio.example.com", o un dominio completo incluyendo un asterisco (*) como carácter comodín inicial. Por ejemplo, "*.example.com" coincide con "https://subdomain.example.com" y "https://any.number.of.subdomains.example.com".
pathPrefix

string

Opcional. Prefijo de ruta de acceso agregado al patrón de host. Si está en blanco, coincide con todas las URLs del patrón de host. Por ejemplo, cuando se vincula con el patrón de host "subdominio.example.com", especifica "ruta/" para que coincida con las URLs de página que comienzan con "https://subdominio.example.com/ruta/".

MarkupSyntax

Es la sintaxis de lenguaje de marcado que se usa para dar formato al texto de los mensajes de esta app de Chat.

Enums
MARKUP_SYNTAX_UNSPECIFIED Valor predeterminado Sin especificar. Las apps de Chat existentes creadas antes de que se introdujera markup_syntax tienen este valor y usan MARKUP_SYNTAX_CHAT hasta que se actualizan de forma explícita.
MARKUP_SYNTAX_CHAT Usa la sintaxis de lenguaje de marcado de Google Chat. Consulta https://developers.google.com/workspace/chat/format-messages#format-texts para obtener más información.
MARKUP_SYNTAX_MARKDOWN Usa la sintaxis de Markdown. Esta sintaxis se basa en la especificación de CommonMark, con extensiones adicionales. Consulta https://developers.google.com/workspace/chat/format-messages#format-texts para obtener más información.

Métodos

get

 Obtiene la configuración de la app de Chat de un proyecto.

patch

 Actualiza la configuración de la app de Chat de un proyecto.