Modifier l'appartenance d'un utilisateur à un espace Google Chat

Ce guide explique comment utiliser la méthode update() sur la ressource Membership de l'API Google Chat pour modifier les attributs d'un membre, par exemple en remplaçant un membre par un gestionnaire ou un gestionnaire par un membre.

Si vous êtes administrateur Google Workspace, vous pouvez appeler la méthode update() pour mettre à jour l'appartenance à un espace dans votre organisation Google Workspace.

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

Prérequis

Node.js

Modifier une appartenance

Pour mettre à jour l'appartenance à un espace, transmettez les éléments suivants dans votre requête :

  • Spécifiez un champ d'application d'autorisation :
  • Appelez la méthode UpdateMembership().
  • Transmettez membership en tant qu'instance de Membership avec les éléments suivants :
    • Le champ name est défini sur l'appartenance à mettre à jour, qui inclut un ID d'espace et un ID de membre.
    • Les champs d'abonnement à mettre à jour sont définis sur les nouvelles valeurs.
  • Transmettez updateMask pour spécifier les aspects de l'abonnement à mettre à jour. Il inclut les éléments suivants :
    • role : rôle de l'utilisateur dans un espace Chat, qui détermine les actions qu'il est autorisé à effectuer dans l'espace. Les valeurs possibles sont les suivantes :
      • ROLE_MEMBER : membre de l'espace. L'utilisateur dispose d'autorisations de base, comme l'envoi de messages dans l'espace. Dans les conversations privées et de groupe sans nom, tous les participants ont ce rôle.
      • ROLE_MANAGER : gestionnaire de l'espace. L'utilisateur dispose de toutes les autorisations de base, ainsi que d'autorisations administratives lui permettant de gérer l'espace, par exemple en ajoutant ou en supprimant des membres. Uniquement disponible dans les espaces où spaceType est défini sur SPACE (espaces nommés).

Désigner un membre standard comme gestionnaire de l'espace en tant qu'utilisateur

L'exemple suivant appelle l'API Chat à l'aide de l'authentification de l'utilisateur pour attribuer le rôle de gestionnaire d'espace à un membre régulier en spécifiant role comme ROLE_MANAGER :

Node.js

chat/client-libraries/cloud/update-membership-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.memberships'];

// This sample shows how to update a membership with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    membership: {
      // Replace SPACE_NAME and MEMBER_NAME here
      name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
      // Replace ROLE_NAME here with ROLE_MEMBER or ROLE_MANAGER
      role: 'ROLE_NAME'
    },
    updateMask: {
      // The field paths to update.
      paths: ['role']
    }
  };

  // Make the request
  const response = await chatClient.updateMembership(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Pour exécuter l'exemple, remplacez les éléments suivants :

  • SPACE_NAME : ID de l'name de l'espace. Vous pouvez obtenir l'ID en appelant la méthode ListSpaces() ou à partir de l'URL de l'espace.
  • MEMBER_NAME : ID de l'name de l'abonnement. Vous pouvez obtenir l'ID en appelant la méthode ListMemberships() ou à partir du corps de réponse renvoyé après la création asynchrone d'un membre avec l'API Chat.
  • ROLE_NAME : rôle mis à jour, ROLE_MANAGER.

L'API Google Chat attribue le rôle de gestionnaire de l'espace à l'adhésion spécifiée et renvoie une instance de Membership.

Définir un gestionnaire d'espace comme membre standard en tant qu'utilisateur

L'exemple suivant appelle l'API Chat à l'aide de l'authentification de l'utilisateur pour faire passer un gestionnaire d'espace au statut de membre régulier en spécifiant role comme ROLE_MEMBER :

Node.js

chat/client-libraries/cloud/update-membership-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.memberships'];

// This sample shows how to update a membership with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    membership: {
      // Replace SPACE_NAME and MEMBER_NAME here
      name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
      // Replace ROLE_NAME here with ROLE_MEMBER or ROLE_MANAGER
      role: 'ROLE_NAME'
    },
    updateMask: {
      // The field paths to update.
      paths: ['role']
    }
  };

  // Make the request
  const response = await chatClient.updateMembership(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Pour exécuter l'exemple, remplacez les éléments suivants :

  • SPACE_NAME : ID de l'name de l'espace. Vous pouvez obtenir l'ID en appelant la méthode ListSpaces() ou à partir de l'URL de l'espace.
  • MEMBER_NAME : ID de l'name de l'abonnement. Vous pouvez obtenir l'ID en appelant la méthode ListMemberships() ou à partir du corps de réponse renvoyé après la création asynchrone d'un membre avec l'API Chat.
  • ROLE_NAME : rôle mis à jour, ROLE_MEMBER.

L'API Google Chat attribue le rôle de gestionnaire de l'espace à l'adhésion spécifiée et renvoie une instance de Membership.

Désigner un membre régulier comme gestionnaire d'un espace dans l'application Chat

L'authentification des applications nécessite une approbation unique de l'administrateur.

Écrire un script qui appelle l'API Chat

L'exemple suivant appelle l'API Chat à l'aide de l'authentification d'application pour attribuer à un membre régulier d'un espace le rôle de gestionnaire de l'espace en spécifiant role comme ROLE_MANAGER dans le body qui spécifie les attributs d'appartenance mis à jour :

Python

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

  2. Incluez le code suivant dans chat_membership_update_to_manager_app.py :

    from google.oauth2 import service_account
from apiclient.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.app.memberships"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then updates a specified space member to change
    it from a regular member to a space manager.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # 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().patch(

        # The membership to update, and the updated role.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace MEMBERSHIP with a membership name.
        # Obtain the membership name from the membership of Chat API.
        name='spaces/SPACE/members/MEMBERSHIP',
        updateMask='role',
        body={'role': 'ROLE_MANAGER'}

      ).execute()

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

if __name__ == '__main__':
    main()

  3. Dans le code, remplacez les éléments suivants :

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

    • MEMBERSHIP : nom d'un membre, que vous pouvez obtenir à partir de la méthode spaces.members.list de l'API Chat.

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

    python3 chat_membership_update_to_manager_app.py

Transformer un gestionnaire d'espace en membre standard dans l'application Chat

L'authentification des applications nécessite une approbation unique de l'administrateur.

Écrire un script qui appelle l'API Chat

L'exemple suivant appelle l'API Chat à l'aide de l'authentification d'application pour faire passer un gestionnaire d'espace au statut de membre régulier en spécifiant role comme ROLE_MEMBER dans le body qui spécifie les attributs d'appartenance mis à jour :

Python

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

  2. Incluez le code suivant dans chat_membership_update_to_member_app.py :

    from google.oauth2 import service_account
from apiclient.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.app.memberships"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then updates a specified space member to change
    it from a regular member to a space manager.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # 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().patch(

        # The membership to update, and the updated role.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace MEMBERSHIP with a membership name.
        # Obtain the membership name from the membership of Chat API.
        name='spaces/SPACE/members/MEMBERSHIP',
        updateMask='role',
        body={'role': 'ROLE_MEMBER'}

      ).execute()

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

if __name__ == '__main__':
    main()

  3. Dans le code, remplacez les éléments suivants :

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

    • MEMBERSHIP : nom d'un membre, que vous pouvez obtenir à partir de la méthode spaces.members.list de l'API Chat.

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

    python3 chat_membership_update_to_member_app.py

Modifier les membres en tant qu'administrateur Google Workspace

Si vous êtes administrateur Google Workspace, vous pouvez appeler la méthode update() pour mettre à jour les membres de n'importe quel espace de votre organisation Google Workspace.

Pour appeler cette méthode en tant qu'administrateur Google Workspace, procédez comme suit :

Pour en savoir plus et obtenir des exemples, consultez Gérer les espaces Google Chat en tant qu'administrateur Google Workspace.