Stay organized with collections
Save and categorize content based on your preferences.
This guide explains how to use the
get()
method on the SpaceNotificationSetting resource of the Google Chat API to get
a user's space notification settings.
The
SpaceNotificationSetting resource
is a singleton resource that represents details about a specified user's space
notification settings.
Create OAuth client ID credentials for a desktop application. To run the sample in this
guide, save the credentials as a JSON file named credentials.json to your
local directory.
For guidance, complete the steps for setting up your environment in this
quickstart.
Get the calling user's space notification settings
To get details about a user's space notification settings, include the following
in your request:
Specify the chat.users.spacesettings authorization scope.
Call the
GetSpaceNotificationSetting()
method, passing the name of the space notification settings to get which
includes a user ID or alias and a space ID. You can only get notification
settings for the calling user. To specify the settings, use one of the following:
The me alias. For example,
users/me/spaces/SPACE_ID/spaceNotificationSetting.
The calling user's Google Workspace email address. For example,
users/user@example.com/spaces/SPACE_ID/spaceNotificationSetting.
The calling user's user ID. For example,
users/USER/spaces/SPACE/spaceNotificationSetting.
The following example gets the calling user's space notification settings:
import{createClientWithUserCredentials}from'./authentication-utils.js';constUSER_AUTH_OAUTH_SCOPES=['https://www.googleapis.com/auth/chat.users.spacesettings'];// This sample shows how to get the space notification setting for the calling userasyncfunctionmain(){// Create a clientconstchatClient=awaitcreateClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);// Initialize request argument(s), replace the SPACE_NAME with an actual space name.constrequest={name:'users/me/spaces/SPACE_NAME/spaceNotificationSetting'};// Make the requestconstresponse=awaitchatClient.getSpaceNotificationSetting(request);// Handle the responseconsole.log(response);}main().catch(console.error);
To run this sample, replace SPACE_ID with the ID from
the space's
name.
You can obtain the ID by calling the
ListSpaces()
method or from the space's URL.
The Google Chat API gets the specified space notification settings and returns
an instance of
SpaceNotificationSetting.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Get a user's space notification settings\n\nThis guide explains how to use the\n[`get()`](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.ChatService.GetSpaceNotificationSetting)\nmethod on the `SpaceNotificationSetting` resource of the Google Chat API to get\na user's space notification settings.\n\nThe\n[`SpaceNotificationSetting` resource](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.SpaceNotificationSetting)\nis a singleton resource that represents details about a specified user's space\nnotification settings.\n\nPrerequisites\n-------------\n\n\n### Node.js\n\n- A Business or Enterprise [Google Workspace](https://support.google.com/a/answer/6043576) account with access to [Google Chat](https://workspace.google.com/products/chat/).\n\n\u003c!-- --\u003e\n\n- Set up your environment:\n - [Create a Google Cloud project](/workspace/guides/create-project).\n - [Configure the OAuth consent screen](/workspace/guides/configure-oauth-consent).\n - [Enable and configure the Google Chat API](/workspace/chat/configure-chat-api) with a name, icon, and description for your Chat app.\n - Install the Node.js [Cloud Client Library](/workspace/chat/libraries?tab=nodejs#cloud-client-libraries).\n - [Create OAuth client ID credentials](/workspace/chat/authenticate-authorize-chat-user#step-2:) for a desktop application. To run the sample in this guide, save the credentials as a JSON file named `credentials.json` to your local directory.\n\n For guidance, complete the steps for setting up your environment in this [quickstart](/workspace/chat/api/guides/quickstart/nodejs\n #set-up-environment).\n- [Choose an authorization scope](/workspace/chat/authenticate-authorize#asynchronous-chat-calls) that supports user authentication.\n\n\n| The code samples in this page use the gRPC API interface with the Google Cloud client libraries. Alternatively, you can use the REST API interface. For more information about the gRPC and REST interfaces, see [Google Chat API overview](/workspace/chat/api/reference).\n\n\u003cbr /\u003e\n\nGet the calling user's space notification settings\n--------------------------------------------------\n\nTo get details about a user's space notification settings, include the following\nin your request:\n\n- Specify the `chat.users.spacesettings` authorization scope.\n- Call the [`GetSpaceNotificationSetting()`](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.ChatService.GetSpaceNotificationSetting) method, passing the `name` of the space notification settings to get which includes a user ID or alias and a space ID. You can only get notification settings for the calling user. To specify the settings, use one of the following:\n - The `me` alias. For example, `users/me/spaces/`\u003cvar translate=\"no\"\u003eSPACE_ID\u003c/var\u003e`/spaceNotificationSetting`.\n - The calling user's Google Workspace email address. For example, `users/user@example.com/spaces/`\u003cvar translate=\"no\"\u003eSPACE_ID\u003c/var\u003e`/spaceNotificationSetting`.\n - The calling user's user ID. For example, `users/`\u003cvar translate=\"no\"\u003eUSER\u003c/var\u003e`/spaces/`\u003cvar translate=\"no\"\u003eSPACE\u003c/var\u003e`/spaceNotificationSetting`.\n\nThe following example gets the calling user's space notification settings: \n\n### Node.js\n\nchat/client-libraries/cloud/get-space-notification-setting-user-cred.js \n[View on GitHub](https://github.com/googleworkspace/node-samples/blob/main/chat/client-libraries/cloud/get-space-notification-setting-user-cred.js) \n\n```javascript\nimport {createClientWithUserCredentials} from './authentication-utils.js';\n\nconst USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.users.spacesettings'];\n\n// This sample shows how to get the space notification setting for the calling user\nasync function main() {\n // Create a client\n const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);\n\n // Initialize request argument(s), replace the SPACE_NAME with an actual space name.\n const request = {\n name : 'users/me/spaces/SPACE_NAME/spaceNotificationSetting'\n };\n\n // Make the request\n const response = await chatClient.getSpaceNotificationSetting(request);\n\n // Handle the response\n console.log(response);\n}\n\nmain().catch(console.error);\n```\n\nTo run this sample, replace \u003cvar translate=\"no\"\u003eSPACE_ID\u003c/var\u003e with the ID from\nthe space's\n[`name`](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.Space.FIELDS.string.google.chat.v1.Space.name).\nYou can obtain the ID by calling the\n[`ListSpaces()`](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.ChatService.ListSpaces)\nmethod or from the space's URL.\n\nThe Google Chat API gets the specified space notification settings and returns\nan instance of\n[`SpaceNotificationSetting`](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.SpaceNotificationSetting).\n\nRelated topics\n--------------\n\n- [Update the calling user's space notification setting](/workspace/chat/update-space-notification-setting)."]]