تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
أنشئ تطبيق سطر أوامر Node.js يرسل طلبات إلى Google Chat API.
توضّح أدلة التشغيل السريع كيفية إعداد تطبيق وتشغيله، وهو تطبيق يستدعي إحدى واجهات Google Workspace API. يستخدم دليل البدء السريع هذا أسلوبًا مبسطًا للمصادقة مناسبًا لبيئة الاختبار. بالنسبة إلى بيئة الإنتاج، ننصحك بالتعرّف على
المصادقة والتفويض
قبل
اختيار بيانات اعتماد الوصول
المناسبة لتطبيقك.
يستخدم هذا الدليل السريع مكتبات برامج Google Workspace API المقترَحة
للتعامل مع بعض تفاصيل عملية المصادقة ومنح الإذن.
الأهداف
إعداد البيئة
ثبِّت مكتبة البرامج.
اضبط العيّنة.
شغِّل العيّنة.
المتطلبات الأساسية
لتنفيذ هذا التشغيل السريع، يجب استيفاء المتطلبات الأساسية التالية:
إذا كنت تستخدم مشروعًا جديدًا على Google Cloud لإكمال هذا الدليل السريع، عليك إعداد شاشة موافقة OAuth. إذا سبق لك إكمال هذه الخطوة لمشروعك على السحابة الإلكترونية، انتقِل إلى القسم التالي.
في "وحدة تحكّم Google Cloud"، انتقِل إلى "القائمة" menu>Google Auth platform>العلامة التجارية.
إذا سبق لك ضبط Google Auth platform، يمكنك ضبط إعدادات "شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth" التالية في العلامة التجارية والجمهور والوصول إلى البيانات. إذا ظهرت لك الرسالة Google Auth platform لم يتم الإعداد بعد، انقر على البدء:
ضمن معلومات التطبيق، في اسم التطبيق، أدخِل اسمًا للتطبيق.
في البريد الإلكتروني لدعم المستخدمين، اختَر عنوان بريد إلكتروني للدعم يمكن للمستخدمين التواصل معك من خلاله إذا كانت لديهم أسئلة حول موافقتهم.
انقر على التالي.
ضمن الجمهور، اختَر داخلي.
انقر على التالي.
ضمن معلومات الاتصال، أدخِل عنوان بريد إلكتروني يمكنك تلقّي إشعارات فيه بشأن أي تغييرات تطرأ على مشروعك.
يمكنك حاليًا تخطّي إضافة النطاقات.
في المستقبل، عند إنشاء تطبيق لاستخدامه خارج مؤسسة Google Workspace، عليك تغيير نوع المستخدم إلى خارجي. بعد ذلك، أضِف نطاقات التفويض التي يتطلّبها تطبيقك. لمزيد من المعلومات، يُرجى الاطّلاع على دليل
ضبط موافقة OAuth الكامل.
تفويض بيانات اعتماد لتطبيق على الكمبيوتر
لمصادقة المستخدمين النهائيين والوصول إلى بيانات المستخدمين في تطبيقك، عليك إنشاء معرّف عميل واحد أو أكثر من معرّفات عملاء OAuth 2.0. يُستخدَم معرّف العميل لتحديد تطبيق واحد لخوادم OAuth من Google. إذا كان تطبيقك يعمل على منصات متعددة، عليك إنشاء معرّف عميل منفصل لكل منصة.
في "وحدة تحكّم Google Cloud"، انتقِل إلى "القائمة" menu>Google Auth platform>العملاء.
في حقل الاسم، اكتب اسمًا لبيانات الاعتماد. لا يظهر هذا الاسم إلا في "وحدة تحكّم Google Cloud".
انقر على إنشاء.
تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن "معرّفات عملاء OAuth 2.0".
احفظ ملف JSON الذي تم تنزيله باسم credentials.json، وانقل الملف إلى دليل العمل.
ضبط إعدادات تطبيق Google Chat
لاستدعاء Google Chat API، عليك ضبط تطبيق Google Chat. بالنسبة إلى أي طلبات كتابة، ينسب Google Chat تطبيق Google Chat في واجهة المستخدم باستخدام المعلومات التالية.
في وحدة تحكّم Google Cloud، انتقِل إلى صفحة الإعداد الخاصة بواجهة Chat API:
constfs=require('fs').promises;constpath=require('path');constprocess=require('process');const{authenticate}=require('@google-cloud/local-auth');const{ChatServiceClient}=require('@google-apps/chat');const{auth}=require('google-auth-library');// If modifying these scopes, delete token.json.constSCOPES=['https://www.googleapis.com/auth/chat.spaces.readonly'];// The file token.json stores the user's access and refresh tokens, and is// created automatically when the authorization flow completes for the first// time.constTOKEN_PATH=path.join(process.cwd(),'token.json');constCREDENTIALS_PATH=path.join(process.cwd(),'credentials.json');/** * Reads previously authorized credentials from the save file. * * @return {Promise<OAuth2Client|null>} */asyncfunctionloadSavedCredentialsIfExist(){try{constcontent=awaitfs.readFile(TOKEN_PATH);constcredentials=JSON.parse(content);returnauth.fromJSON(credentials);}catch(err){console.log(err);returnnull;}}/** * Serializes credentials to a file compatible with GoogleAuth.fromJSON. * * @param {OAuth2Client} client * @return {Promise<void>} */asyncfunctionsaveCredentials(client){constcontent=awaitfs.readFile(CREDENTIALS_PATH);constkeys=JSON.parse(content);constkey=keys.installed||keys.web;constpayload=JSON.stringify({type:'authorized_user',client_id:key.client_id,client_secret:key.client_secret,refresh_token:client.credentials.refresh_token,});awaitfs.writeFile(TOKEN_PATH,payload);}/** * Load or request or authorization to call APIs. * * @return {Promise<OAuth2Client>} */asyncfunctionauthorize(){letclient=awaitloadSavedCredentialsIfExist();if(client){returnclient;}client=awaitauthenticate({scopes:SCOPES,keyfilePath:CREDENTIALS_PATH,});if(client.credentials){awaitsaveCredentials(client);}returnclient;}/** * Lists spaces with user credential. * @param {OAuth2Client} authClient An authorized OAuth2 client. */asyncfunctionlistSpaces(authClient){// Create a clientconstchatClient=newChatServiceClient({authClient:authClient,scopes:SCOPES,});// Initialize request argument(s)constrequest={// Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)filter:'space_type = "SPACE"'};// Make the requestconstpageResult=chatClient.listSpacesAsync(request);// Handle the response. Iterating over pageResult will yield results and// resolve additional pages automatically.forawait(constresponseofpageResult){console.log(response);}}authorize().then(listSpaces).catch(console.error);
تشغيل العيّنة
في دليل العمل، شغِّل النموذج:
node .
في المرة الأولى التي تُشغّل فيها النموذج، سيُطلب منك السماح بالوصول:
سجِّل الدخول إلى حسابك على Google عندما يُطلب منك ذلك إذا لم يسبق لك تسجيل الدخول. إذا كنت مسجّلاً الدخول إلى حسابات متعددة، اختَر حسابًا واحدًا لاستخدامه في التفويض.
انقر على قبول.
يتم تشغيل تطبيق Nodejs ويطلب بيانات من Google Chat API.
يتم تخزين معلومات التفويض في نظام الملفات، لذا لن يُطلب منك تقديم تفويض في المرة التالية التي تشغّل فيها نموذج الرمز.
تاريخ التعديل الأخير: 2025-08-29 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-08-29 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eThis quickstart demonstrates creating a Node.js command-line application that interacts with the Google Chat API using client libraries for authentication and authorization.\u003c/p\u003e\n"],["\u003cp\u003eBefore running, you'll need to enable the Google Chat API, configure the OAuth consent screen, authorize credentials for a desktop application, and set up a Google Chat app.\u003c/p\u003e\n"],["\u003cp\u003eYou'll need Node.js and npm installed, a Google Cloud Project, and a Google Workspace account with access to Google Chat to use this guide.\u003c/p\u003e\n"],["\u003cp\u003eThe provided code sample lists spaces based on specified criteria (e.g., filtering by space type).\u003c/p\u003e\n"],["\u003cp\u003eAfter initial authorization, subsequent runs of the sample code will utilize stored authorization information, streamlining the process.\u003c/p\u003e\n"]]],["This document outlines setting up a Node.js application to interact with the Google Chat API. Key actions include enabling the Google Chat API in a Google Cloud project, configuring an OAuth consent screen, and creating OAuth 2.0 Client IDs for desktop app credentials. Users must install the necessary client libraries using npm and create `credentials.json` to authorize access. The `index.js` code then lists spaces via the Chat API, handling authentication and authorization automatically on subsequent runs. It is important to note that this is designed for testing and production environments require a different approach to handle credentials.\n"],null,["Create a Node.js command-line application that makes requests to the\nGoogle Chat API.\n\nQuickstarts explain how to set up and run an app that calls a\nGoogle Workspace API. This quickstart uses a\nsimplified authentication approach that is appropriate for a testing\nenvironment. For a production environment, we recommend learning about\n[authentication and authorization](/workspace/guides/auth-overview)\nbefore\n[choosing the access credentials](/workspace/guides/create-credentials#choose_the_access_credential_that_is_right_for_you)\nthat are appropriate for your app.\n\nThis quickstart uses Google Workspace's recommended API client libraries\nto handle some details of the authentication and authorization flow.\n\nObjectives\n\n- Set up your environment.\n- Install the client library.\n- Set up the sample.\n- Run the sample.\n\nPrerequisites\n\nTo run this quickstart, you need the following prerequisites:\n\n- [Node.js \\& npm](https://docs.npmjs.com/getting-started/installing-node#1-install-nodejs--npm) installed.\n- [A Google Cloud project](/workspace/guides/create-project).\n\n\n- A Business or Enterprise [Google Workspace](//support.google.com/a/answer/6043576) account with access to [Google Chat](//workspace.google.com/products/chat/).\n\n\u003cbr /\u003e\n\nSet up your environment\n\nTo complete this quickstart, set up your environment.\n\nEnable the API Before using Google APIs, you need to turn them on in a Google Cloud project. You can turn on one or more APIs in a single Google Cloud project.\n\n- In the Google Cloud console, enable the Google Chat API.\n\n [Enable the API](https://console.cloud.google.com/flows/enableapi?apiid=chat.googleapis.com)\n\nConfigure the OAuth consent screen\n\nIf you're using a new Google Cloud project to complete this quickstart, configure\nthe OAuth consent screen. If you've already\ncompleted this step for your Cloud project, skip to the next section.\n\n1. In the Google Cloud console, go to Menu menu \\\u003e **Google Auth platform** \\\u003e **Branding** .\n\n [Go to Branding](https://console.cloud.google.com/auth/branding)\n2. If you have already configured the Google Auth platform, you can configure the following OAuth Consent Screen settings in [Branding](https://console.cloud.google.com/auth/branding), [Audience](https://console.cloud.google.com/auth/audience), and [Data Access](https://console.cloud.google.com/auth/scopes). If you see a message that says **Google Auth platform not configured yet** , click **Get Started**:\n 1. Under **App Information** , in **App name**, enter a name for the app.\n 2. In **User support email**, choose a support email address where users can contact you if they have questions about their consent.\n 3. Click **Next**.\n 4. Under **Audience** , select **Internal**.\n 5. Click **Next**.\n 6. Under **Contact Information** , enter an **Email address** where you can be notified about any changes to your project.\n 7. Click **Next**.\n 8. Under **Finish** , review the [Google API Services User Data Policy](https://developers.google.com/terms/api-services-user-data-policy) and if you agree, select **I agree to the Google API Services: User Data Policy**.\n 9. Click **Continue**.\n 10. Click **Create**.\n3. For now, you can skip adding scopes. In the future, when you create an app for use outside of your Google Workspace organization, you must change the **User type** to **External** . Then add the authorization scopes that your app requires. To learn more, see the full [Configure OAuth consent](/workspace/guides/configure-oauth-consent) guide.\n\nAuthorize credentials for a desktop application To authenticate end users and access user data in your app, you need to create one or more OAuth 2.0 Client IDs. A client ID is used to identify a single app to Google's OAuth servers. If your app runs on multiple platforms, you must create a separate client ID for each platform. **Caution:** This quickstart must be run locally and with access to a browser. It doesn't work if run on a remote terminal such as Cloud Shell or over SSH.\n\n1. In the Google Cloud console, go to Menu menu \\\u003e **Google Auth platform** \\\u003e **Clients** .\n\n [Go to Clients](https://console.cloud.google.com/auth/clients)\n2. Click **Create Client**.\n3. Click **Application type** \\\u003e **Desktop app**.\n4. In the **Name** field, type a name for the credential. This name is only shown in the Google Cloud console.\n5. Click **Create** .\n\n\n The newly created credential appears under \"OAuth 2.0 Client IDs.\"\n6. Save the downloaded JSON file as `credentials.json`, and move the file to your working directory.\n\nConfigure the Google Chat app\n\nTo call the Google Chat API, you must configure a\nGoogle Chat app. For any write requests, Google Chat\nattributes the Google Chat app in the UI using\nthe following information.\n\n1. In the Google Cloud console, go to the Chat API **Configuration** page:\n\n [Go to Chat API Configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat)\n2. Under **Application info**, enter the following information:\n\n 1. In the **App name** field, enter `Chat API quickstart app`.\n 2. In the **Avatar URL** field, enter `https://developers.google.com/chat/images/quickstart-app-avatar.png`.\n 3. In the **Description** field, enter `Quickstart for calling the Chat API`.\n3. Under **Interactive features** , click the **Enable interactive features**\n toggle to the off position to disable interactive features for the\n Chat app.\n\n4. Click **Save**.\n\nInstall the client library\n\n- Install the libraries using npm:\n\n ```\n npm install @google-apps/chat @google-cloud/local-auth@2.1.0 --save\n ```\n\nSet up the sample\n\n1. In your working directory, create a file named `index.js`.\n\n2. In the file, paste the following code:\n\n\n chat/quickstart/index.js \n [View on GitHub](https://github.com/googleworkspace/node-samples/blob/main/chat/quickstart/index.js) \n\n ```javascript\n const fs = require('fs').promises;\n const path = require('path');\n const process = require('process');\n const {authenticate} = require('@google-cloud/local-auth');\n const {ChatServiceClient} = require('@google-apps/chat');\n const {auth} = require('google-auth-library');\n\n // If modifying these scopes, delete token.json.\n const SCOPES = ['https://www.googleapis.com/auth/chat.spaces.readonly'];\n\n // The file token.json stores the user's access and refresh tokens, and is\n // created automatically when the authorization flow completes for the first\n // time.\n const TOKEN_PATH = path.join(process.cwd(), 'token.json');\n const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');\n\n /**\n * Reads previously authorized credentials from the save file.\n *\n * @return {Promise\u003cOAuth2Client|null\u003e}\n */\n async function loadSavedCredentialsIfExist() {\n try {\n const content = await fs.readFile(TOKEN_PATH);\n const credentials = JSON.parse(content);\n return auth.fromJSON(credentials);\n } catch (err) {\n console.log(err);\n return null;\n }\n }\n\n /**\n * Serializes credentials to a file compatible with GoogleAuth.fromJSON.\n *\n * @param {OAuth2Client} client\n * @return {Promise\u003cvoid\u003e}\n */\n async function saveCredentials(client) {\n const content = await fs.readFile(CREDENTIALS_PATH);\n const keys = JSON.parse(content);\n const key = keys.installed || keys.web;\n const payload = JSON.stringify({\n type: 'authorized_user',\n client_id: key.client_id,\n client_secret: key.client_secret,\n refresh_token: client.credentials.refresh_token,\n });\n await fs.writeFile(TOKEN_PATH, payload);\n }\n\n /**\n * Load or request or authorization to call APIs.\n *\n * @return {Promise\u003cOAuth2Client\u003e}\n */\n async function authorize() {\n let client = await loadSavedCredentialsIfExist();\n if (client) {\n return client;\n }\n client = await authenticate({\n scopes: SCOPES,\n keyfilePath: CREDENTIALS_PATH,\n });\n if (client.credentials) {\n await saveCredentials(client);\n }\n return client;\n }\n\n /**\n * Lists spaces with user credential.\n * @param {OAuth2Client} authClient An authorized OAuth2 client.\n */\n async function listSpaces(authClient) {\n // Create a client\n const chatClient = new ChatServiceClient({\n authClient: authClient,\n scopes: SCOPES,\n });\n\n // Initialize request argument(s)\n const request = {\n // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)\n filter: 'space_type = \"SPACE\"'\n };\n\n // Make the request\n const pageResult = chatClient.listSpacesAsync(request);\n\n // Handle the response. Iterating over pageResult will yield results and\n // resolve additional pages automatically.\n for await (const response of pageResult) {\n console.log(response);\n }\n }\n\n authorize().then(listSpaces).catch(console.error);\n ```\n\n \u003cbr /\u003e\n\n \u003cbr /\u003e\n\nRun the sample\n\n1. In your working directory, run the sample:\n\n ```\n node .\n ```\n\n\u003c!-- --\u003e\n\n2. The first time you run the sample, it prompts you to authorize access:\n 1. If you're not already signed in to your Google Account, sign in when prompted. If you're signed in to multiple accounts, select one account to use for authorization.\n 2. Click **Accept**.\n\n\n Your Nodejs application runs and calls the Google Chat API.\n\n\n Authorization information is stored in the file system, so the next time you run the sample\n code, you aren't prompted for authorization.\n\nNext steps\n\n- [Try the Google Workspace APIs in the APIs explorer](/workspace/explore)\n- [Google Chat API Client on GitHub](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-chat)"]]