Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Dịch vụ Chat nâng cao cho phép bạn sử dụng API Google Chat trong Apps Script. API này cho phép tập lệnh tìm, tạo và sửa đổi không gian Chat, thêm hoặc xoá thành viên khỏi không gian, cũng như đọc hoặc đăng tin nhắn có văn bản, thẻ, tệp đính kèm và biểu tượng cảm xúc.
Điều kiện tiên quyết
Một ứng dụng Google Chat được định cấu hình bằng Apps Script trên trang cấu hình Chat API trong Google Cloud Console. Dự án Apps Script của ứng dụng phải sử dụng một dự án Google Cloud tiêu chuẩn thay vì dự án mặc định được tạo tự động cho các dự án Apps Script. Để tạo một ứng dụng Google Chat tương thích, hãy xem bài viết Tạo ứng dụng Google Chat bằng Google Apps Script.
Để biết thêm thông tin về dịch vụ này, hãy xem Tài liệu tham khảo về Chat API.
Giống như tất cả các dịch vụ nâng cao trong Apps Script, dịch vụ Chat sử dụng các đối tượng, phương thức và tham số giống như API công khai.
Mã mẫu
Các mẫu này cho thấy cách thực hiện các thao tác phổ biến của API Google Chat bằng dịch vụ nâng cao.
Đăng thông báo bằng thông tin đăng nhập của người dùng
Ví dụ sau đây minh hoạ cách đăng một tin nhắn vào một không gian trò chuyện thay cho người dùng.
Thêm phạm vi uỷ quyền chat.messages.create vào tệp appsscript.json của dự án Apps Script:
/** * Posts a new message to the specified space on behalf of the user. * @param {string} spaceName The resource name of the space. */functionpostMessageWithUserCredentials(spaceName){try{constmessage={'text':'Hello world!'};Chat.Spaces.Messages.create(message,spaceName);}catch(err){// TODO (developer) - Handle exceptionconsole.log('Failed to create message with error %s',err.message);}}
Đăng thông báo có thông tin xác thực ứng dụng
Ví dụ sau đây minh hoạ cách đăng một thông báo lên một không gian trên Chat thay cho ứng dụng. Khi sử dụng dịch vụ Chat nâng cao bằng tài khoản dịch vụ, bạn không cần chỉ định phạm vi uỷ quyền trong appsscript.json. Để biết thông tin chi tiết về việc xác thực bằng tài khoản dịch vụ, hãy xem phần Xác thực dưới dạng ứng dụng Google Chat.
/** * Posts a new message to the specified space on behalf of the app. * @param {string} spaceName The resource name of the space. */functionpostMessageWithAppCredentials(spaceName){try{// See https://developers.google.com/chat/api/guides/auth/service-accounts// for details on how to obtain a service account OAuth token.constappToken=getToken_();constmessage={'text':'Hello world!'};Chat.Spaces.Messages.create(message,spaceName,{},// Authenticate with the service account token.{'Authorization':'Bearer '+appToken});}catch(err){// TODO (developer) - Handle exceptionconsole.log('Failed to create message with error %s',err.message);}}
Mua không gian
Ví dụ sau đây minh hoạ cách lấy thông tin về một không gian trò chuyện.
Thêm phạm vi uỷ quyền chat.spaces.readonly vào tệp appsscript.json của dự án Apps Script:
/** * Gets information about a Chat space. * @param {string} spaceName The resource name of the space. */functiongetSpace(spaceName){try{constspace=Chat.Spaces.get(spaceName);console.log('Space display name: %s',space.displayName);console.log('Space type: %s',space.spaceType);}catch(err){// TODO (developer) - Handle exceptionconsole.log('Failed to get space with error %s',err.message);}}
Tạo không gian
Ví dụ sau đây minh hoạ cách tạo một không gian trong Chat.
Thêm phạm vi uỷ quyền chat.spaces.create vào tệp appsscript.json của dự án Apps Script:
/** * Creates a new Chat space. */functioncreateSpace(){try{constspace={'displayName':'New Space','spaceType':'SPACE'};Chat.Spaces.create(space);}catch(err){// TODO (developer) - Handle exceptionconsole.log('Failed to create space with error %s',err.message);}}
Liệt kê các gói hội viên
Ví dụ sau đây minh hoạ cách liệt kê tất cả thành viên của một không gian trò chuyện.
Thêm phạm vi uỷ quyền chat.memberships.readonly vào tệp appsscript.json của dự án Apps Script:
/** * Lists all the members of a Chat space. * @param {string} spaceName The resource name of the space. */functionlistMemberships(spaceName){letresponse;letpageToken=null;try{do{response=Chat.Spaces.Members.list(spaceName,{pageSize:10,pageToken:pageToken});if(!response.memberships||response.memberships.length===0){pageToken=response.nextPageToken;continue;}response.memberships.forEach((membership)=>console.log('Member resource name: %s (type: %s)',membership.name,membership.member.type));pageToken=response.nextPageToken;}while(pageToken);}catch(err){// TODO (developer) - Handle exceptionconsole.log('Failed with error %s',err.message);}}
Khắc phục sự cố
Nếu bạn gặp Error 400: invalid_scope với thông báo lỗi Some requested scopes cannot be shown, tức là bạn chưa chỉ định phạm vi uỷ quyền nào trong tệp appsscript.json của dự án Apps Script. Trong hầu hết các trường hợp, Apps Script sẽ tự động xác định những phạm vi mà một tập lệnh cần, nhưng khi sử dụng dịch vụ nâng cao của Chat, bạn phải tự thêm các phạm vi uỷ quyền mà tập lệnh sử dụng vào tệp kê khai của dự án Apps Script. Xem phần Đặt phạm vi rõ ràng.
Để giải quyết lỗi này, hãy thêm các phạm vi uỷ quyền thích hợp vào tệp appsscript.json của dự án Apps Script trong mảng oauthScopes. Ví dụ: để gọi phương thức spaces.messages.create, hãy thêm nội dung sau:
[[["Dễ hiểu","easyToUnderstand","thumb-up"],["Giúp tôi giải quyết được vấn đề","solvedMyProblem","thumb-up"],["Khác","otherUp","thumb-up"]],[["Thiếu thông tin tôi cần","missingTheInformationINeed","thumb-down"],["Quá phức tạp/quá nhiều bước","tooComplicatedTooManySteps","thumb-down"],["Đã lỗi thời","outOfDate","thumb-down"],["Vấn đề về bản dịch","translationIssue","thumb-down"],["Vấn đề về mẫu/mã","samplesCodeIssue","thumb-down"],["Khác","otherDown","thumb-down"]],["Cập nhật lần gần đây nhất: 2025-08-31 UTC."],[[["\u003cp\u003eThe Advanced Chat service enables Apps Script to interact with the Google Chat API, allowing scripts to manage spaces, members, and messages.\u003c/p\u003e\n"],["\u003cp\u003eUtilizing this service requires setting up a Google Chat app in the Google Cloud console and configuring proper authentication (user or app).\u003c/p\u003e\n"],["\u003cp\u003eSample code snippets demonstrate common actions like posting messages and managing spaces using user or app credentials.\u003c/p\u003e\n"],["\u003cp\u003eThe service mirrors the Chat API's objects and methods but has limitations, such as not supporting media downloads or Developer Preview methods.\u003c/p\u003e\n"],["\u003cp\u003eTroubleshooting steps and workarounds are provided for potential issues like scope errors.\u003c/p\u003e\n"]]],[],null,["# Advanced Chat Service\n\nThe Advanced Chat service lets you use the\n[Google Chat API](/chat/api/guides) in\nApps Script. This API allows scripts to find, create, and modify\nChat spaces, add or remove members to spaces, and read or post\nmessages with text, cards, attachments, and reactions.\n\nPrerequisites\n-------------\n\n- An Apps Script Google Chat app configured on the Chat API configuration page in the Google Cloud console. The app's Apps Script project must use a standard Google Cloud project instead of the default one created automatically for Apps Script projects. To create a compatible Google Chat app, see [Build a Google Chat app with Google Apps Script](/workspace/add-ons/chat/quickstart-apps-script).\n- Authentication configured for the Chat app. Performing an action on behalf of a user requires [user authentication](/chat/api/guides/auth/users). Performing an action as the Chat app requires [app authentication with a service account](/chat/api/guides/auth/service-accounts). To check which form of authentication a Chat API method supports, see [Types of required authentication for Google Chat API calls](/chat/api/guides/auth#asynchronous-chat-calls).\n\n| **Note:** This is an advanced service that you must [turn on before use](/apps-script/guides/services/advanced).\n\nReference\n---------\n\nFor more information about this service, see the\n[Chat API reference documentation](/chat/api/reference/rest).\nLike all advanced services in Apps Script, the\nChat service uses the same objects, methods, and parameters as\nthe public API.\n\nSample code\n-----------\n\nThese samples show you how to perform common\n[Google Chat API](/chat/api/guides)\nactions using the advanced service.\n\n### Post a message with user credentials\n\nThe following example demonstrates how to post a message to a\nChat space on behalf of the user.\n\n1. Add the `chat.messages.create` authorization scope to the\n Apps Script project's `appsscript.json` file:\n\n \"oauthScopes\": [\n \"https://www.googleapis.com/auth/chat.messages.create\"\n ]\n\n2. Add a function like this one to the Apps Script project's\n code:\n\n advanced/chat.gs \n [View on GitHub](https://github.com/googleworkspace/apps-script-samples/blob/main/advanced/chat.gs) \n\n ```javascript\n /**\n * Posts a new message to the specified space on behalf of the user.\n * @param {string} spaceName The resource name of the space.\n */\n function postMessageWithUserCredentials(spaceName) {\n try {\n const message = {'text': 'Hello world!'};\n Chat.Spaces.Messages.create(message, spaceName);\n } catch (err) {\n // TODO (developer) - Handle exception\n console.log('Failed to create message with error %s', err.message);\n }\n }\n ```\n\n### Post a message with app credentials\n\nThe following example demonstrates how to post a message to a\nChat space on behalf of the app. Using the advanced\nChat service with a service account doesn't require you to\nspecify authorization scopes in `appsscript.json`. For details about\nauthentication with service accounts, see\n[Authenticate as a Google Chat app](/chat/api/guides/auth/service-accounts). \nadvanced/chat.gs \n[View on GitHub](https://github.com/googleworkspace/apps-script-samples/blob/main/advanced/chat.gs) \n\n```javascript\n/**\n * Posts a new message to the specified space on behalf of the app.\n * @param {string} spaceName The resource name of the space.\n */\nfunction postMessageWithAppCredentials(spaceName) {\n try {\n // See https://developers.google.com/chat/api/guides/auth/service-accounts\n // for details on how to obtain a service account OAuth token.\n const appToken = getToken_();\n const message = {'text': 'Hello world!'};\n Chat.Spaces.Messages.create(\n message,\n spaceName,\n {},\n // Authenticate with the service account token.\n {'Authorization': 'Bearer ' + appToken});\n } catch (err) {\n // TODO (developer) - Handle exception\n console.log('Failed to create message with error %s', err.message);\n }\n}\n```\n\n### Get a space\n\nThe following example demonstrates how to get information about a\nChat space.\n\n1. Add the `chat.spaces.readonly` authorization scope to the\n Apps Script project's `appsscript.json` file:\n\n \"oauthScopes\": [\n \"https://www.googleapis.com/auth/chat.spaces.readonly\"\n ]\n\n2. Add a function like this one to the Apps Script project's\n code:\n\n advanced/chat.gs \n [View on GitHub](https://github.com/googleworkspace/apps-script-samples/blob/main/advanced/chat.gs) \n\n ```javascript\n /**\n * Gets information about a Chat space.\n * @param {string} spaceName The resource name of the space.\n */\n function getSpace(spaceName) {\n try {\n const space = Chat.Spaces.get(spaceName);\n console.log('Space display name: %s', space.displayName);\n console.log('Space type: %s', space.spaceType);\n } catch (err) {\n // TODO (developer) - Handle exception\n console.log('Failed to get space with error %s', err.message);\n }\n }\n ```\n\n### Create a space\n\nThe following example demonstrates how to create a Chat space.\n\n1. Add the `chat.spaces.create` authorization scope to the\n Apps Script project's `appsscript.json` file:\n\n \"oauthScopes\": [\n \"https://www.googleapis.com/auth/chat.spaces.create\"\n ]\n\n2. Add a function like this one to the Apps Script project's\n code:\n\n advanced/chat.gs \n [View on GitHub](https://github.com/googleworkspace/apps-script-samples/blob/main/advanced/chat.gs) \n\n ```javascript\n /**\n * Creates a new Chat space.\n */\n function createSpace() {\n try {\n const space = {'displayName': 'New Space', 'spaceType': 'SPACE'};\n Chat.Spaces.create(space);\n } catch (err) {\n // TODO (developer) - Handle exception\n console.log('Failed to create space with error %s', err.message);\n }\n }\n ```\n\n### List memberships\n\nThe following example demonstrates how to list all the members of a\nChat space.\n\n1. Add the `chat.memberships.readonly` authorization scope to the\n Apps Script project's `appsscript.json` file:\n\n \"oauthScopes\": [\n \"https://www.googleapis.com/auth/chat.memberships.readonly\"\n ]\n\n2. Add a function like this one to the Apps Script project's\n code:\n\n advanced/chat.gs \n [View on GitHub](https://github.com/googleworkspace/apps-script-samples/blob/main/advanced/chat.gs) \n\n ```javascript\n /**\n * Lists all the members of a Chat space.\n * @param {string} spaceName The resource name of the space.\n */\n function listMemberships(spaceName) {\n let response;\n let pageToken = null;\n try {\n do {\n response = Chat.Spaces.Members.list(spaceName, {\n pageSize: 10,\n pageToken: pageToken\n });\n if (!response.memberships || response.memberships.length === 0) {\n pageToken = response.nextPageToken;\n continue;\n }\n response.memberships.forEach((membership) =\u003e console.log(\n 'Member resource name: %s (type: %s)',\n membership.name,\n membership.member.type));\n pageToken = response.nextPageToken;\n } while (pageToken);\n } catch (err) {\n // TODO (developer) - Handle exception\n console.log('Failed with error %s', err.message);\n }\n }\n ```\n\nTroubleshoot\n------------\n\nIf you encounter `Error 400: invalid_scope` with the error message\n`Some requested scopes cannot be shown`,\nit means you haven't specified any authorization scopes in the\nApps Script project's `appsscript.json` file. In most cases,\nApps Script automatically determines what scopes a script needs,\nbut when you use the Chat advanced service, you must manually add\nthe authorization scopes that your script uses to your\nApps Script project's manifest file. See\n[Setting explicit scopes](/apps-script/concepts/scopes#setting_explicit_scopes).\n\nTo resolve the error, add the appropriate authorization scopes\nto the Apps Script project's `appsscript.json` file as part of\nthe `oauthScopes` array. For example, to call the\n[`spaces.messages.create`](/chat/api/reference/rest/v1/spaces.messages/create)\nmethod, add the following: \n\n \"oauthScopes\": [\n \"https://www.googleapis.com/auth/chat.messages.create\"\n ]\n\nLimits and considerations\n-------------------------\n\nThe Advanced Chat service doesn't support:\n\n- The Chat API method [`media.download`](/chat/api/reference/rest/v1/media/download).\n- Chat API methods available in [Developer Preview](/workspace/preview)\n\nTo download a message attachment or call a developer preview method, use\n[`UrlFetchApp`](/apps-script/reference/url-fetch/url-fetch-app) instead."]]
