Inviter ou ajouter un utilisateur ou une application Google Chat à un espace

Ce guide explique comment utiliser la méthode create sur la ressource membership de l'API Google Chat pour inviter ou ajouter un utilisateur ou une application Chat à un espace, également appelé "abonnement". Lors de la création d'un abonnement, si le membre spécifié a désactivé la règle d'acceptation automatique, il est invité et doit accepter l'invitation à l'espace avant de rejoindre l'espace. Sinon, la création d'un abonnement ajoute le membre directement à l'espace spécifié.

La ressource Membership indique si un utilisateur humain ou une application Google Chat est invité à un espace, en fait partie ou absent.

Prérequis

Python

  • Python 3.6 ou version ultérieure
  • L'outil de gestion des packages pip

  • Les dernières bibliothèques clientes Google pour Python. Pour les installer ou les mettre à jour, exécutez la commande suivante dans votre interface de ligne de commande:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • Un projet Google Cloud avec l'API Google Chat activée et configurée Pour connaître la procédure à suivre, consultez Créer une application Google Chat.

  • Autorisation configurée pour l'application Chat. La création d'un abonnement nécessite une authentification des utilisateurs avec le niveau d'autorisation chat.memberships ou chat.memberships.app.

Node.js

  • Node.js et npm

  • Les dernières bibliothèques clientes Google pour Node.js. Pour les installer, exécutez la commande suivante dans votre interface de ligne de commande:

    npm install @google-cloud/local-auth @googleapis/chat
  • Un projet Google Cloud avec l'API Google Chat activée et configurée Pour connaître la procédure à suivre, consultez Créer une application Google Chat.

  • Autorisation configurée pour l'application Chat. La création d'un abonnement nécessite une authentification des utilisateurs avec le niveau d'autorisation chat.memberships ou chat.memberships.app.

Inviter ou ajouter un utilisateur à un espace

Pour inviter ou ajouter un utilisateur à un espace, transmettez les éléments suivants dans votre requête:

  • Spécifiez le champ d'application des autorisations chat.memberships.
  • Appelez la méthode create sur la ressource membership.
  • Définissez parent sur le nom de ressource de l'espace dans lequel créer un abonnement.
  • Définissez member sur users/{user}, où {user} correspond à la personne pour laquelle vous souhaitez créer un abonnement et est :
    • ID de la personne dans l'API People. Par exemple, si l'API People (person) resourceName est people/123456789, définissez membership.member.name sur users/123456789.
    • ID de l'utilisateur dans l'API Directory.
    • Adresse e-mail de l'utilisateur. Par exemple, users/222larabrown@gmail.com ou users/larabrown@cymbalgroup.com. Si l'utilisateur possède un compte Google ou appartient à une autre organisation Google Workspace, vous devez utiliser son adresse e-mail.

L'exemple suivant ajoute un utilisateur à un espace:

Python

  1. Dans votre répertoire de travail, créez un fichier nommé chat_membership_user_create.py.

  2. Incluez le code suivant dans chat_membership_user_create.py:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.memberships"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then adds a user to a Chat space by creating a membership.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().members().create(

        # The space in which to create a membership.
        parent = 'spaces/SPACE',

        # Specify which user the membership is for.
        body = {
          'member': {
            'name':'users/USER',
            'type': 'HUMAN'
          }
        }

    ).execute()

    # Prints details about the created membership.
    print(result)

if __name__ == '__main__':
    main()

  3. Dans le code, remplacez ce qui suit:

    • SPACE: nom d'espace, que vous pouvez obtenir à l'aide de la méthode spaces.list de l'API Chat ou de l'URL d'un espace.

    • USER: ID utilisateur.

  4. Dans votre répertoire de travail, créez et exécutez l'exemple:

    python3 chat_membership_user_create.py

Node.js

  1. Dans votre répertoire de travail, créez un fichier nommé add-user-to-space.js.

  2. Incluez le code suivant dans add-user-to-space.js:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Adds the user to the Chat space.
* @return {!Promise<!Object>}
*/
async function addUserToSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.memberships.app',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.members.create({
    parent: 'spaces/SPACE',
    requestBody: {member: {name: 'users/USER', type: 'HUMAN'}}
  });
}

addUserToSpace().then(console.log);

  3. Dans le code, remplacez ce qui suit:

    • SPACE: nom d'espace, que vous pouvez obtenir à l'aide de la méthode spaces.list de l'API Chat ou de l'URL d'un espace.

    • USER: ID utilisateur.

  4. Dans votre répertoire de travail, exécutez l'exemple:

    node add-user-to-space.js

L'API Chat renvoie une instance de membership qui détaille l'appartenance créée.

Ajouter une application Chat à un espace

Une application Chat ne peut pas ajouter une autre application en tant que membre d'un espace. Pour ajouter une application Chat à un espace ou un message privé entre deux utilisateurs humains, transmettez les éléments suivants dans votre requête:

  • Spécifiez le champ d'application des autorisations chat.memberships.app.
  • Appelez la méthode create sur la ressource membership.
  • Définissez parent sur le nom de ressource de l'espace dans lequel créer un abonnement.
  • Définissez member sur users/app, un alias qui représente l'application qui appelle l'API Chat.

Dans l'exemple suivant, une application Chat est ajoutée à un espace:

Python

  1. Dans votre répertoire de travail, créez un fichier nommé chat_membership_app_create.py.

  2. Incluez le code suivant dans chat_membership_app_create.py:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.memberships.app"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then adds the Chat app to a Chat space.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().members().create(

        # The space in which to create a membership.
        parent = 'spaces/SPACE',

        # Set the Chat app as the entity that gets added to the space.
        # 'app' is an alias for the Chat app calling the API.
        body = {
            'member': {
              'name':'users/app',
              'type': 'BOT'
            }
        }

    ).execute()

    # Prints details about the created membership.
    print(result)

if __name__ == '__main__':
    main()

  3. Dans le code, remplacez SPACE par le nom d'un espace, que vous pouvez obtenir à partir de la méthode spaces.list de l'API Chat ou de l'URL d'un espace.

  4. Dans votre répertoire de travail, créez et exécutez l'exemple:

    python3 chat_membership_app_create.py

Node.js

  1. Dans votre répertoire de travail, créez un fichier nommé add-app-to-space.js.

  2. Incluez le code suivant dans add-app-to-space.js:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Adds the app to the Chat space.
* @return {!Promise<!Object>}
*/
async function addAppToSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.memberships.app',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.members.create({
    parent: 'spaces/SPACE',
    requestBody: {member: {name: 'users/app', type: 'BOT'}}
  });
}

addAppToSpace().then(console.log);

  3. Dans le code, remplacez SPACE par le nom d'un espace, que vous pouvez obtenir à partir de la méthode spaces.list de l'API Chat ou de l'URL d'un espace.

  4. Dans votre répertoire de travail, exécutez l'exemple:

    node add-app-to-space.js

L'API Chat renvoie une instance de membership qui détaille l'appartenance créée.