Obtenir les paramètres de notification d'un espace pour un utilisateur

Ce guide explique comment utiliser la méthode get() sur la ressource SpaceNotificationSetting de l'API Google Chat pour obtenir les paramètres de notification d'un espace utilisateur.

La ressource SpaceNotificationSetting est une ressource singleton qui représente les détails des paramètres de notification d'un espace pour un utilisateur spécifié.

Prérequis

Node.js

• Compte Google Workspace Business ou Enterprise ayant accès à Google Chat.

• Configurez votre environnement :
  • Créez un projet Google Cloud.
  • Configurez l'écran de consentement OAuth.
  • Activez et configurez l'API Google Chat en attribuant un nom, une icône et une description à votre application Chat.
  • Installez la bibliothèque cliente Cloud Node.js.
  • Créez des identifiants d'ID client OAuth pour une application de bureau. Pour exécuter l'exemple de ce guide, enregistrez les identifiants dans un fichier JSON nommé credentials.json dans votre répertoire local.
  Pour obtenir de l'aide, suivez les étapes de configuration de votre environnement dans ce guide de démarrage rapide.
• Choisissez un champ d'application d'autorisation compatible avec l'authentification des utilisateurs.

Les exemples de code de cette page utilisent l'interface de l'API gRPC avec les bibliothèques clientes Google Cloud. Vous pouvez également utiliser l'interface de l'API REST. Pour en savoir plus sur les interfaces gRPC et REST, consultez la présentation de l'API Google Chat.

Obtenir les paramètres de notification de l'espace de l'utilisateur appelant

Pour obtenir des détails sur les paramètres de notification d'un utilisateur pour un espace, incluez les informations suivantes dans votre demande :

• Spécifiez le champ d'application de l'autorisation chat.users.spacesettings.
• Appelez la méthode GetSpaceNotificationSetting() en transmettant le name des paramètres de notification de l'espace pour obtenir un ID ou un alias d'utilisateur, ainsi qu'un ID d'espace. Vous ne pouvez obtenir les paramètres de notification que pour l'utilisateur appelant. Pour spécifier les paramètres, utilisez l'une des méthodes suivantes :
  • Alias me. Exemple : users/me/spaces/SPACE_ID/spaceNotificationSetting.
  • Adresse e-mail Google Workspace de l'utilisateur qui appelle. Par exemple, users/[e-mail]/spaces/SPACE_ID/spaceNotificationSetting.
  • ID utilisateur de l'utilisateur appelant. Par exemple, users/USER/spaces/SPACE/spaceNotificationSetting.

L'exemple suivant permet d'obtenir les paramètres de notification de l'espace de l'utilisateur appelant :

Node.js

chat/client-libraries/cloud/get-space-notification-setting-user-cred.js

Afficher sur GitHub

import {createClientWithUserCredentials} from './authentication-utils.js';

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

// This sample shows how to get the space notification setting for the calling
// user
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s), replace the SPACE_NAME with an actual space
  // name.
  const request = {
    name: 'users/me/spaces/SPACE_NAME/spaceNotificationSetting',
  };

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

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

await main();

Pour exécuter cet exemple, remplacez SPACE_ID par l'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.

L'API Google Chat récupère les paramètres de notification de l'espace spécifié et renvoie une instance de SpaceNotificationSetting.

Articles associés

• Mettez à jour le paramètre de notification de l'espace de l'utilisateur qui appelle.