REST Resource: projects.chatAppConfig

Ressource : ChatAppConfig

Représente la configuration d'une application Google Chat créée en tant que module complémentaire Google Workspace.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "interactiveFeatureConfig": {
    object (InteractiveFeatureConfig)
  },
  "avatarUri": string,
  "state": enum (AppState),
  "errorLoggingEnabled": boolean,
  "markupSyntax": enum (MarkupSyntax)
}
Champs
name

string

Obligatoire. Identifiant. Nom de ressource de la configuration de l'application Chat.

Format : projects/{project}/chatAppConfig, où {project} est le numéro du projet Google Cloud.
displayName

string

Obligatoire. Nom à afficher de l'application Chat. Il doit comporter entre 3 et 25 caractères.
description

string

Obligatoire. Brève description de l'application Chat. Elle doit comporter entre 1 et 40 caractères.
interactiveFeatureConfig

object (InteractiveFeatureConfig)

Facultatif. Paramètres des fonctionnalités interactives de l'application. Si ce champ n'est pas renseigné, l'application ne sera pas interactive, ce qui signifie qu'elle pourra utiliser l'API Chat, mais que les utilisateurs ne pourront pas interagir avec elle.
avatarUri

string

Facultatif. URL de l'avatar de l'application. Il doit s'agir d'une URL HTTPS qui héberge une image PNG carrée (format 1:1). Taille minimale recommandée : 256 x 256 pixels. Si aucun avatar n'est spécifié, un avatar par défaut sera utilisé pour l'application.
state

enum (AppState)

Facultatif. État de l'application. La valeur par défaut est ACTIVE si elle n'est pas spécifiée.
errorLoggingEnabled

boolean

Facultatif. Indique si les erreurs doivent être consignées dans Cloud Logging. En l'absence de spécification, la valeur par défaut est false.
markupSyntax

enum (MarkupSyntax)

Facultatif. Syntaxe de balisage par défaut pour les messages envoyés ou lus par cette application Chat. La valeur par défaut est MARKUP_SYNTAX_MARKDOWN si elle n'est pas spécifiée.

AppState

État actuel de l'application Chat.

Enums
APP_STATE_UNSPECIFIED Valeur par défaut. Non spécifié.
ACTIVE Correspond à "LIVE" sur la page de configuration de l'API Chat. L'application est active. Elle peut être trouvée et utilisée par les personnes qui y ont accès.
DISABLED L'application est désactivée. Elle n'est plus visible par personne, et plus personne ne peut interagir avec elle.

InteractiveFeatureConfig

Paramètres des fonctionnalités interactives de l'application.

Représentation JSON 
{
  "connectionConfig": {
    object (ConnectionConfig)
  },
  "appCommands": [
    {
      object (AppCommand)
    }
  ],
  "urlPatterns": [
    {
      object (UrlPattern)
    }
  ],
  "allowlistedTestingPrincipals": [
    string
  ],
  "supportsMultiuserSpaces": boolean
}
Champs
connectionConfig

object (ConnectionConfig)

Obligatoire. Comment l'application reçoit les événements de Google Chat.
appCommands[]

object (AppCommand)

Facultatif. Configuration des commandes de l'application.
urlPatterns[]

object (UrlPattern)

Facultatif. Configuration des aperçus de liens.
allowlistedTestingPrincipals[]

string

Facultatif. Adresses e-mail des utilisateurs et des groupes de votre domaine Google Workspace qui peuvent trouver et utiliser l'application.
supportsMultiuserSpaces

boolean

Facultatif. Indique si l'application peut être ajoutée aux MP individuels, aux chats de groupe et aux espaces. En l'absence de spécification, la valeur par défaut est false.

ConnectionConfig

Comment l'application reçoit les événements.

Représentation JSON 
{

  "httpEndpointConfig": {
    object (HttpEndpointConfig)
  },
  "appsScriptEndpointConfig": {
    object (AppsScriptEndpointConfig)
  },
  "cloudPubSubEndpointConfig": {
    object (CloudPubSubEndpointConfig)
  },
  "dialogflowEndpointConfig": {
    object (DialogflowEndpointConfig)
  }
}
Champs
Type de connexion. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
httpEndpointConfig

object (HttpEndpointConfig)

Configuration du point de terminaison HTTP.
appsScriptEndpointConfig

object (AppsScriptEndpointConfig)

Configuration du déploiement Apps Script.
cloudPubSubEndpointConfig

object (CloudPubSubEndpointConfig)

Configuration des sujets Pub/Sub.
dialogflowEndpointConfig

object (DialogflowEndpointConfig)

Configuration de Dialogflow.
Fin des champs mutuellement exclusifs.

HttpEndpointConfig

Configuration du point de terminaison HTTP.

Représentation JSON 
{

  "commonUrl": string,
  "perEventEndpointConfig": {
    object (HttpPerEventEndpointConfig)
  }
}
Champs
Configuration de l'URL du point de terminaison HTTP. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
commonUrl

string

Facultatif. URL HTTPS vers laquelle Google Chat envoie tous les événements interactifs.
perEventEndpointConfig

object (HttpPerEventEndpointConfig)

Facultatif. URL HTTPS distinctes auxquelles Google Chat envoie chaque type d'événement interactif.
Fin des champs mutuellement exclusifs.

HttpPerEventEndpointConfig

Configuration du point de terminaison HTTP pour des types d'événements spécifiques.

Représentation JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Champs
appCommandEndpoint

string

Obligatoire. Point de terminaison d'URL HTTPS pour les événements de commande d'application.
addedToSpaceEndpoint

string

Obligatoire. Point de terminaison d'URL HTTPS pour les événements d'ajout à un espace.
messageEndpoint

string

Obligatoire. Point de terminaison d'URL HTTPS pour les événements de message.
removedFromSpaceEndpoint

string

Obligatoire. Point de terminaison d'URL HTTPS pour les événements de suppression d'un espace.

AppsScriptEndpointConfig

Configuration du point de terminaison Apps Script.

Représentation JSON 
{
  "deploymentId": string,
  "perEventEndpointConfig": {
    object (AppsScriptPerEventEndpointConfig)
  }
}
Champs
deploymentId

string

Obligatoire. ID de déploiement Apps Script.
perEventEndpointConfig

object (AppsScriptPerEventEndpointConfig)

Facultatif. Les noms des fonctions Apps Script que Google Chat appelle pour chaque type d'événement interactif. Si ce paramètre n'est pas spécifié, Chat appelle la fonction par défaut pour chaque type d'événement.

AppsScriptPerEventEndpointConfig

Configuration du point de terminaison Apps Script pour des types d'événements spécifiques.

Représentation JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Champs
appCommandEndpoint

string

Facultatif. Nom de la fonction pour les événements de commande d'application. Si aucune valeur n'est spécifiée, le nom de fonction par défaut onAppCommand sera utilisé.
addedToSpaceEndpoint

string

Facultatif. Nom de la fonction pour les événements d'ajout à un espace. Si aucune valeur n'est spécifiée, le nom de fonction onAddedToSpace par défaut sera utilisé.
messageEndpoint

string

Facultatif. Nom de la fonction pour les événements de message. Si aucune valeur n'est spécifiée, le nom de fonction onMessage par défaut sera utilisé.
removedFromSpaceEndpoint

string

Facultatif. Nom de la fonction pour les événements de suppression d'un espace. Si aucune valeur n'est spécifiée, le nom de fonction onRemovedFromSpace par défaut sera utilisé.

CloudPubSubEndpointConfig

Configuration du point de terminaison Pub/Sub.

Représentation JSON 
{
  "topic": string
}
Champs
topic

string

Obligatoire. Sujet Pub/Sub dans lequel Google Chat publie tous les événements interactifs. Le sujet doit se trouver dans le même projet Google Cloud que l'application, et Chat doit être autorisé à publier des messages sur le sujet. Pour en savoir plus, consultez Créer une application Google Chat avec Pub/Sub.

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

DialogflowEndpointConfig

Configuration du point de terminaison Dialogflow.

Représentation JSON 
{
  "dialogflowEdition": enum (DialogflowEdition),
  "agent": string
}
Champs
dialogflowEdition

enum (DialogflowEdition)

Obligatoire. Édition Dialogflow.
agent

string

Facultatif. Nom de l'agent ou de l'environnement Dialogflow CX. Obligatoire pour Dialogflow CX. Ne définissez pas cette option pour Dialogflow ES.

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

DialogflowEdition

Type d'édition Dialogflow.

Enums
DIALOGFLOW_EDITION_UNSPECIFIED Valeur par défaut. Non spécifié.
ES Édition Dialogflow ES. Pour utiliser cette édition, un agent Dialogflow ES doit exister dans le même projet Google Cloud que l'application. Google Chat envoie tous les événements interactifs à cet agent.
CX Édition Dialogflow CX. Pour utiliser cette édition, un agent Dialogflow CX doit exister dans le même projet Google Cloud que l'application et être spécifié dans le champ agent. Google Chat envoie tous les événements interactifs à cet agent.

AppCommand

Configuration d'une commande d'application.

Représentation JSON 
{
  "commandType": enum (CommandType),
  "commandId": integer,
  "command": string,
  "displayName": string,
  "description": string,
  "dialogEnabled": boolean,
  "loadingNotificationMessage": string
}
Champs
commandType

enum (CommandType)

Obligatoire. Type de cette commande.
commandId

integer

Obligatoire. ID de la commande (1-1000). Il doit être unique dans l'application.
command

string

Facultatif. Nom de la commande. Obligatoire pour SLASH_COMMAND. Ne pas définir pour les autres types de commandes. Doit commencer par "/", par exemple "/command".
displayName

string

Facultatif. Nom à afficher convivial de la commande. Obligatoire pour MESSAGE_ACTION et QUICK_COMMAND, ne pas définir pour SLASH_COMMAND.
description

string

Obligatoire. Brève description de la commande.
dialogEnabled

boolean

Facultatif. Indique si cette commande doit déclencher une boîte de dialogue. En l'absence de spécification, la valeur par défaut est false.
loadingNotificationMessage

string

Facultatif. Notification à envoyer à l'utilisateur lorsqu'il déclenche l'action liée au message. Uniquement compatible avec les commandes MESSAGE_ACTION.

CommandType

Type de la commande d'application.

Enums
COMMAND_TYPE_UNSPECIFIED Valeur par défaut. Non spécifié.
SLASH_COMMAND Commande appelée en saisissant un "/" suivi du nom de la commande. Il peut accepter des arguments supplémentaires dans le texte du message.
QUICK_COMMAND Commande rapide appelée depuis le menu contextuel de rédaction d'un message. Les commandes rapides n'acceptent pas d'arguments supplémentaires.
MESSAGE_ACTION Commande appelée à partir d'un menu contextuel de message.

UrlPattern

Configuration d'un aperçu de lien.

Représentation JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
Champs
hostPattern

string

Obligatoire. Domaine à mettre en correspondance. Faites correspondre un sous-domaine spécifique, comme "subdomain.example.com", ou un domaine entier en incluant un astérisque (*) comme caractère générique de début. Par exemple, "*.example.com" correspond à "https://subdomain.example.com" et "https://any.number.of.subdomains.example.com".
pathPrefix

string

Facultatif. Préfixe de chemin ajouté au format d'hôte. S'il est vide, il correspond à toutes les URL du format d'hôte. Par exemple, lorsqu'il est associé au format d'hôte "subdomain.example.com", spécifiez "path/" pour qu'il corresponde aux URL de page commençant par "https://subdomain.example.com/path/".

MarkupSyntax

Syntaxe de balisage utilisée pour mettre en forme le texte des messages de cette application Chat.

Enums
MARKUP_SYNTAX_UNSPECIFIED Valeur par défaut. Non spécifié. Les applications Chat existantes créées avant l'introduction de markup_syntax ont cette valeur et utilisent MARKUP_SYNTAX_CHAT jusqu'à ce qu'elles soient explicitement mises à jour.
MARKUP_SYNTAX_CHAT Utilise la syntaxe de balisage de Google Chat. Pour en savoir plus, consultez https://developers.google.com/workspace/chat/format-messages#format-texts.
MARKUP_SYNTAX_MARKDOWN Utilise la syntaxe Markdown. Cette syntaxe est basée sur la spécification CommonMark, avec des extensions supplémentaires. Pour en savoir plus, consultez https://developers.google.com/workspace/chat/format-messages#format-texts.

Méthodes

get

 Récupère la configuration de l'application Chat d'un projet.

patch

 Met à jour la configuration de l'application Chat d'un projet.