Package google.chat.v1

Index

ChatService

Permet aux développeurs de créer des applications et des intégrations Chat sur la plate-forme Google Chat.

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

Finalise le processus d'importation pour l'espace spécifié et le rend visible pour les utilisateurs.

Nécessite l'authentification de l'utilisateur et la délégation au niveau du domaine avec le champ d'application de l'autorisation :

  • https://www.googleapis.com/auth/chat.import

Pour en savoir plus, consultez Autoriser les applications Google Chat à importer des données.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/chat.import

Pour en savoir plus, consultez le guide d'autorisation.

CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

Crée un emoji personnalisé.

Les emoji personnalisés ne sont disponibles que pour les comptes Google Workspace. L'administrateur doit les activer pour l'organisation. Pour en savoir plus, consultez À propos des emoji personnalisés dans Google Chat et Gérer les autorisations pour les emoji personnalisés.

Nécessite une authentification de l'utilisateur avec le champ d'application de l'autorisation :

  • https://www.googleapis.com/auth/chat.customemojis
Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/chat.customemojis

Pour en savoir plus, consultez le guide d'autorisation.

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Crée un abonnement pour l'application Chat pour les appels, un utilisateur ou un groupe Google. Il n'est pas possible de créer des abonnements pour d'autres applications de chat. Lorsque vous créez un abonnement, si le membre spécifié a désactivé sa règle d'acceptation automatique, il est invité et doit accepter l'invitation à rejoindre l'espace avant de pouvoir le faire. Sinon, la création d'un abonnement ajoute directement le membre à l'espace spécifié.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec approbation de l'administrateur et champ d'application de l'autorisation :

    • https://www.googleapis.com/auth/chat.app.memberships
  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (pour ajouter l'application d'appel à l'espace)
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)
    • L'authentification de l'utilisateur accorde des droits d'administrateur lorsqu'un compte administrateur s'authentifie, use_admin_access est true et que le champ d'application d'autorisation suivant est utilisé :
      • https://www.googleapis.com/auth/chat.admin.memberships

L'authentification des applications n'est pas compatible avec les cas d'utilisation suivants :

  • Inviter des utilisateurs externes à l'organisation Workspace propriétaire de l'espace
  • Ajouter un groupe Google à un espace
  • Ajout d'une application Chat à un espace

Pour obtenir un exemple d'utilisation, consultez :

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

Pour en savoir plus, consultez le guide d'autorisation.

CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

crée un message dans un espace Google Chat ; Pour obtenir un exemple, consultez Envoyer un message.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec le champ d'application de l'autorisation :
    • https://www.googleapis.com/auth/chat.bot
  • Authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)

Chat attribue l'expéditeur du message différemment selon le type d'authentification que vous utilisez dans votre requête.

L'image suivante montre comment Chat attribue un message lorsque vous utilisez l'authentification de l'application. Chat affiche l'application Chat comme expéditeur du message. Le contenu du message peut contenir du texte (text), des cartes (cardsV2) et des widgets accessoires (accessoryWidgets).

Message envoyé avec l'authentification de l'application

L'image suivante montre comment Chat attribue un message lorsque vous utilisez l'authentification des utilisateurs. Chat affiche l'utilisateur comme expéditeur du message et attribue l'application Chat au message en affichant son nom. Le contenu du message ne peut contenir que du texte (text).

Message envoyé avec authentification de l'utilisateur

La taille maximale d'un message, y compris son contenu, est de 32 000 octets.

Pour les requêtes webhook, la réponse ne contient pas le message complet. La réponse ne renseigne que les champs name et thread.name, en plus des informations contenues dans la requête.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

Pour en savoir plus, consultez le guide d'autorisation.

CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Crée une réaction et l'ajoute à un message. Pour obtenir un exemple, consultez Ajouter une réaction à un message.

Nécessite une authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :

  • https://www.googleapis.com/auth/chat.messages.reactions.create
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

Pour en savoir plus, consultez le guide d'autorisation.

CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Crée un espace. Permet de créer un espace nommé ou un chat de groupe dans Import mode. Pour obtenir un exemple, consultez Créer un espace.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec approbation de l'administrateur et l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.app.spaces.create
    • https://www.googleapis.com/auth/chat.app.spaces
  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.spaces.create
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)

Lors de l'authentification en tant qu'application, le champ space.customer doit être défini dans la requête.

Lorsque vous vous authentifiez en tant qu'application, l'application Chat est ajoutée en tant que membre de l'espace. Toutefois, contrairement à l'authentification humaine, l'application Chat n'est pas ajoutée en tant que gestionnaire de l'espace. Par défaut, tous les membres de l'espace peuvent supprimer l'application Chat de l'espace. Pour autoriser uniquement les gestionnaires d'espace à supprimer l'application d'un espace, définissez space.permission_settings.manage_apps sur managers_allowed.

L'adhésion à un espace lors de sa création dépend de l'endroit où il est créé dans Import mode :

  • Mode Importation : aucun membre n'est créé.
  • Tous les autres modes : l'utilisateur qui appelle est ajouté en tant que membre. Il s'agit :
    • L'application elle-même lors de l'utilisation de l'authentification par application.
    • Utilisateur humain lors de l'utilisation de l'authentification de l'utilisateur.

Si le message d'erreur ALREADY_EXISTS s'affiche lorsque vous créez un espace, essayez un autre displayName. Il est possible qu'un espace existant dans l'organisation Google Workspace utilise déjà ce nom à afficher.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Pour en savoir plus, consultez le guide d'autorisation.

DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

Supprime un emoji personnalisé. Par défaut, les utilisateurs ne peuvent supprimer que les emoji personnalisés qu'ils ont créés. Les gestionnaires d'emoji désignés par l'administrateur peuvent supprimer n'importe quel emoji personnalisé de l'organisation. Consultez À propos des emoji personnalisés dans Google Chat.

Les emoji personnalisés ne sont disponibles que pour les comptes Google Workspace. L'administrateur doit les activer pour l'organisation. Pour en savoir plus, consultez À propos des emoji personnalisés dans Google Chat et Gérer les autorisations pour les emoji personnalisés.

Nécessite une authentification de l'utilisateur avec le champ d'application de l'autorisation :

  • https://www.googleapis.com/auth/chat.customemojis
Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/chat.customemojis

Pour en savoir plus, consultez le guide d'autorisation.

DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

Supprime un abonnement. Pour obtenir un exemple, consultez Supprimer un utilisateur ou une application Google Chat d'un espace.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec approbation de l'administrateur et champ d'application de l'autorisation :

    • https://www.googleapis.com/auth/chat.app.memberships
  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (pour supprimer l'application d'appel de l'espace)
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)
    • L'authentification de l'utilisateur accorde des droits d'administrateur lorsqu'un compte administrateur s'authentifie, use_admin_access est true et que le champ d'application d'autorisation suivant est utilisé :
      • https://www.googleapis.com/auth/chat.admin.memberships

L'authentification des applications n'est pas compatible avec les cas d'utilisation suivants :

  • Supprimer un groupe Google d'un espace
  • Supprimer une application Chat d'un espace

Pour supprimer des membres d'un espace, le demandeur doit être gestionnaire de l'espace. Si vous utilisez l'authentification par application, l'application Chat doit être le créateur de l'espace.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

Pour en savoir plus, consultez le guide d'autorisation.

DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Supprime un message. Pour obtenir un exemple, consultez Supprimer un message.

Compatible avec les types d'authentification suivants :

  • Authentification par l'application avec le champ d'application de l'autorisation :

    • https://www.googleapis.com/auth/chat.bot
  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)

Lorsque vous utilisez l'authentification d'application, les requêtes ne peuvent supprimer que les messages créés par l'application Chat appelante.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

Pour en savoir plus, consultez le guide d'autorisation.

DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Supprime une réaction à un message. Pour obtenir un exemple, consultez Supprimer une réaction.

Nécessite une authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :

  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

Pour en savoir plus, consultez le guide d'autorisation.

DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

Supprime un espace nommé. Effectue toujours une suppression en cascade, ce qui signifie que les ressources enfants de l'espace (comme les messages publiés dans l'espace et les membres de l'espace) sont également supprimées. Pour obtenir un exemple, consultez Supprimer un espace.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec approbation de l'administrateur et champ d'application de l'autorisation :

    • https://www.googleapis.com/auth/chat.app.delete (uniquement dans les espaces créés par l'application)
  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.delete
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)
    • L'authentification de l'utilisateur accorde des droits d'administrateur lorsqu'un compte administrateur s'authentifie, use_admin_access est true et que le champ d'application d'autorisation suivant est utilisé :
      • https://www.googleapis.com/auth/chat.admin.delete
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.app.delete
  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

Pour en savoir plus, consultez le guide d'autorisation.

FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

Renvoie le message privé existant avec l'utilisateur spécifié. Si aucun espace de message privé n'est trouvé, une erreur 404 NOT_FOUND est renvoyée. Pour obtenir un exemple, consultez Rechercher un message privé.

Avec l'authentification de l'application, renvoie l'espace de message privé entre l'utilisateur spécifié et l'application Chat appelante.

Avec l'authentification de l'utilisateur, renvoie l'espace de messages privés entre l'utilisateur spécifié et l'utilisateur authentifié.

Compatible avec les types d'authentification suivants :

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Pour en savoir plus, consultez le guide d'autorisation.

GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

Obtient les métadonnées d'une pièce jointe d'un message. Les données des pièces jointes sont récupérées à l'aide de l'API Media. Pour obtenir un exemple, consultez Obtenir des métadonnées sur une pièce jointe d'un message.

Nécessite une authentification de l'application avec le champ d'application de l'autorisation :

  • https://www.googleapis.com/auth/chat.bot
Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/chat.bot

Pour en savoir plus, consultez le guide d'autorisation.

GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

Renvoie des informations sur un emoji personnalisé.

Les emoji personnalisés ne sont disponibles que pour les comptes Google Workspace. L'administrateur doit les activer pour l'organisation. Pour en savoir plus, consultez À propos des emoji personnalisés dans Google Chat et Gérer les autorisations pour les emoji personnalisés.

Nécessite une authentification de l'utilisateur avec l'un des