本指南說明如何在 Google Chat API 的 Space
資源上使用 findDirectMessage
方法,取得即時訊息 (DM) 聊天室的詳細資料。
Space
資源代表使用者和 Chat 應用程式可以傳送訊息、共用檔案及協同合作的地方。聊天室分為幾種類型:
- 即時訊息 (DM) 是兩個使用者或使用者和 Chat 應用程式之間的對話。
- 群組通訊是三位以上的使用者和 Chat 應用程式之間的對話。
- 已命名的聊天室是永久供使用者傳送訊息、分享檔案及協同合作的地方。
透過應用程式驗證進行驗證,可讓 Chat 應用程式接收即時訊息,以供 Chat 應用程式在 Google Chat 中存取 (例如其所屬的即時訊息)。以使用者驗證進行驗證時,會傳回已驗證使用者有權存取的 DM。
必要條件
Python
- Python 3.6 或更高版本
- pip 套件管理工具
最新的 Python 專用 Google 用戶端程式庫。如要安裝或更新,請在指令列介面中執行下列指令:
pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
- 已啟用並設定 Google Chat API 的 Google Cloud 專案。相關步驟請參閱「建構 Google Chat 應用程式」。
已為 Chat 應用程式設定授權。尋找即時訊息功能支援以下兩種功能:
Node.js
- Node.js 與 npm
最新的 Node.js 專用 Google 用戶端程式庫。如要安裝,請在指令列介面中執行下列指令:
npm install @google-cloud/local-auth @googleapis/chat
- 已啟用並設定 Google Chat API 的 Google Cloud 專案。相關步驟請參閱「建構 Google Chat 應用程式」。
已為 Chat 應用程式設定授權。尋找即時訊息功能支援以下兩種功能:
尋找即時訊息
如要在 Google Chat 中尋找即時訊息,請在要求中傳遞以下內容:
- 透過應用程式驗證,請指定
chat.bot
授權範圍。透過使用者驗證,請指定chat.spaces.readonly
或chat.spaces
授權範圍。 - 對
User
資源呼叫findDirectMessage
方法,傳遞 DM 中其他使用者的name
以傳回。透過使用者驗證,這個方法會傳回呼叫使用者和指定使用者之間的即時訊息。透過應用程式驗證,這個方法會在呼叫應用程式和指定使用者之間傳回即時訊息。 - 如要將人類使用者新增為聊天室成員,請指定
users/{user}
,其中{user}
是 People API 中person
的{person_id}
,或 Directory API 中user
的 ID。舉例來說,如果 People API 使用者resourceName
為people/123456789
,您就可以將使用者加入聊天室,方法是加入包含users/123456789
做為member.name
的成員資格。
尋找含有使用者驗證的即時訊息
以下說明如何使用使用者驗證功能尋找即時訊息:
Python
- 在工作目錄中,建立名為
chat_space_find_dm_user.py
的檔案。 在
chat_space_find_dm_user.py
中加入下列程式碼:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.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.spaces.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then returns details about a specified DM. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().findDirectMessage( # The other user in the direct message (DM) to return. # # Replace USER with a user name. name='users/USER' ).execute() # Prints details about the direct message. print(result) if __name__ == '__main__': main()
在程式碼中,將
USER
替換為 Google Chat 中User
的name
。在工作目錄中,建構並執行範例:
python3 chat_space_find_dm_user.py
Node.js
在工作目錄中,建立名為
find-direct-message-space.js
的檔案。在
find-direct-message-space.js
中加入下列程式碼:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Find a direct message Chat space for a user. * @return {!Promise<!Object>} */ async function findDirectMessageSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.spaces.readonly', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.findDirectMessage( {name: 'users/USER'}); } findDirectMessageSpace().then(console.log);
在程式碼中,將
USER
替換為 Google Chat 中User
的name
。在工作目錄中,執行範例:
node find-direct-message-space.js
Chat API 會傳回 Space
的執行個體,詳細說明所指定 DM。
尋找含有應用程式驗證的即時訊息
以下說明如何使用應用程式驗證尋找即時訊息:
Python
- 在工作目錄中,建立名為
chat_space_find_dm_app.py
的檔案。 在
chat_space_find_dm_app.py
中加入下列程式碼:from google.oauth2 import service_account from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', credentials=CREDENTIALS) # Use the service endpoint to call Chat API. result = chat.spaces().findDirectMessage( # The other user in the direct message (DM) to return. # # Replace USER with a user name. name='users/USER' ).execute() print(result)
在程式碼中,將
USER
替換為 Google Chat 中User
的name
。在工作目錄中,建構並執行範例:
python3 chat_space_find_dm_app.py
Node.js
在工作目錄中,建立名為
app-find-direct-message-space.js
的檔案。在
app-find-direct-message-space.js
中加入下列程式碼:const chat = require('@googleapis/chat'); /** * Find a direct message Chat space for a user. * @return {!Promise<!Object>} */ async function findDirectMessageSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.bot', ]; const auth = new chat.auth.GoogleAuth({ scopes, keyFilename: 'credentials.json', }); const authClient = await auth.getClient(); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.findDirectMessage( {name: 'users/USER'}); } findDirectMessageSpace().then(console.log);
在程式碼中,將
USER
替換為 Google Chat 中User
的name
。在工作目錄中,執行範例:
node app-find-direct-message-space.js
Chat API 會傳回 Space
的執行個體,詳細說明所指定 DM。