คำแนะนำนี้จะอธิบายวิธีใช้เมธอด updateSpaceReadState
ในทรัพยากร SpaceReadState
ของ Google Chat API เพื่อทำเครื่องหมายพื้นที่ทำงานว่าอ่านแล้วหรือยังไม่อ่าน
ทรัพยากร SpaceReadState
คือทรัพยากร Singleton ที่แสดงรายละเอียดเกี่ยวกับข้อความที่อ่านล่าสุดของผู้ใช้ที่ระบุในพื้นที่ใน Google Chat
ข้อกำหนดเบื้องต้น
Python
- Python 3.6 ขึ้นไป
- เครื่องมือการจัดการแพ็กเกจ pip
ไลบรารีของไคลเอ็นต์ Google ล่าสุดสำหรับ Python หากต้องการติดตั้งหรืออัปเดต ให้เรียกใช้คำสั่งต่อไปนี้ในอินเทอร์เฟซบรรทัดคำสั่ง
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- โปรเจ็กต์ Google Cloud ที่เปิดใช้และกำหนดค่า Google Chat API โปรดดูขั้นตอนที่หัวข้อสร้างแอป Google Chat
การกําหนดค่าการให้สิทธิ์สําหรับแอป Chat การดูรายละเอียดเกี่ยวกับสถานะการอ่านของผู้ใช้ภายในพื้นที่ทำงานต้องใช้การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์
chat.users.readstate
Node.js
- Node.js และ npm
ไลบรารีของไคลเอ็นต์ Google ล่าสุดสำหรับ Node.js หากต้องการติดตั้ง ให้เรียกใช้คำสั่งต่อไปนี้ในอินเทอร์เฟซบรรทัดคำสั่ง
npm install @google-cloud/local-auth @googleapis/chat
- โปรเจ็กต์ Google Cloud ที่เปิดใช้และกำหนดค่า Google Chat API โปรดดูขั้นตอนที่หัวข้อสร้างแอป Google Chat
การกําหนดค่าการให้สิทธิ์สําหรับแอป Chat การดูรายละเอียดเกี่ยวกับสถานะการอ่านของผู้ใช้ภายในพื้นที่ทำงานต้องใช้การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์
chat.users.readstate
Apps Script
- บัญชี Google Workspace ที่มีสิทธิ์เข้าถึง Google Chat
- แอป Chat ที่เผยแพร่แล้ว หากต้องการสร้าง แอป Chat ให้ทำตาม quickstartนี้
- การกําหนดค่าการให้สิทธิ์สําหรับแอป Chat การดูรายละเอียดเกี่ยวกับสถานะการอ่านของผู้ใช้ภายในพื้นที่ทำงานต้องใช้การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์
chat.users.readstate
อัปเดตสถานะการอ่านพื้นที่ทำงานของผู้ใช้ที่โทร
หากต้องการอัปเดตสถานะการอ่านของผู้ใช้ภายในพื้นที่ทำงาน ให้ใส่ข้อมูลต่อไปนี้ในคำขอ
- ระบุขอบเขตการให้สิทธิ์
chat.users.readstate
- เรียกเมธอด
updateSpaceReadState
ในทรัพยากรSpaceReadState
- ส่ง
name
ของสถานะการอ่านพื้นที่ทำงานเพื่อรับ ซึ่งรวมถึงรหัสผู้ใช้หรือชื่อแทน และรหัสพื้นที่ทำงาน การรับสถานะการอ่านของพื้นที่รองรับการรับสถานะการอ่านของผู้ใช้ที่เรียกใช้เท่านั้น ซึ่งสามารถระบุได้โดยการตั้งค่าอย่างใดอย่างหนึ่งต่อไปนี้- ชื่อแทน
me
ตัวอย่างเช่นusers/me/spaces/SPACE/spaceReadState
- อีเมล Workspace ของผู้ใช้ที่โทร ตัวอย่างเช่น
users/user@example.com/spaces/SPACE/spaceReadState
- รหัสผู้ใช้ของผู้ใช้ที่โทร ตัวอย่างเช่น
users/USER/spaces/SPACE/spaceReadState
- ชื่อแทน
- ส่ง
updateMask
ซึ่งระบุแง่มุมของสถานะการอ่านพื้นที่ทำงานที่จะอัปเดต ซึ่งรองรับเส้นทางช่องต่อไปนี้lastReadTime
: เวลาที่อัปเดตสถานะการอ่านพื้นที่ทำงานของผู้ใช้ โดยปกติแล้ว เวลานี้จะตรงกับการประทับเวลาของข้อความที่อ่านล่าสุด หรือการประทับเวลาที่ผู้ใช้ระบุไว้เพื่อทำเครื่องหมายตำแหน่งที่อ่านล่าสุดในพื้นที่ทำงาน เมื่อlastReadTime
อยู่ก่อนเวลาที่สร้างข้อความล่าสุด พื้นที่ทำงานจะปรากฏเป็นยังไม่อ่านใน UI หากต้องการทำเครื่องหมายพื้นที่ทำงานว่าอ่านแล้ว ให้ตั้งค่าlastReadTime
เป็นค่าใดก็ได้ภายหลัง (ใหญ่กว่า) เวลาที่สร้างข้อความล่าสุด ระบบสลับlastReadTime
ให้ตรงกับเวลาที่สร้างข้อความล่าสุด โปรดทราบว่าสถานะการอ่านของพื้นที่ทำงานจะมีผลกับสถานะการอ่านของข้อความที่แสดงในการสนทนาระดับบนสุดของพื้นที่ทำงานเท่านั้น การประทับเวลานี้จะไม่มีผลกับการตอบกลับในชุดข้อความ และจะอาศัยสถานะอ่านของชุดข้อความแทน
ตัวอย่างต่อไปนี้จะอัปเดตสถานะการอ่านพื้นที่ทำงานของผู้ใช้ที่เรียกใช้
Python
- สร้างไฟล์ชื่อ
chat_spaceReadState_update.py
ในไดเรกทอรีการทำงาน ใส่รหัสต่อไปนี้ใน
chat_spaceReadState_update.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.users.readstate"] def main(): ''' Authenticates with Chat API via user credentials, then updates the space read state for the calling user. ''' # 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.users().spaces().updateSpaceReadState( # The space read state to update. # # Replace USER with the calling user's ID, Workspace email, # or the alias me. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='users/me/spaces/SPACE/spaceReadState', updateMask='lastReadTime', body={'lastReadTime': f'{datetime.datetime(2000, 1, 3).isoformat()}Z'} ).execute() # Prints the API's response. print(result) if __name__ == '__main__': main()
ในโค้ด ให้แทนที่ส่วนต่อไปนี้
SPACE
: ชื่อพื้นที่ทำงาน ซึ่งคุณดูได้จากเมธอดspaces.list
ใน Chat API หรือจาก URL ของพื้นที่ทำงาน
สร้างและเรียกใช้ตัวอย่างในไดเรกทอรีการทำงาน
python3 chat_spaceReadState_update.py
Node.js
- สร้างไฟล์ชื่อ
chat_spaceReadState_update.js
ในไดเรกทอรีการทำงาน ใส่รหัสต่อไปนี้ใน
chat_spaceReadState_update
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Authenticates with Chat API via user credentials, * then updates the space read state for the calling user. * @return {!Promise<!Object>} */ async function updateSpaceReadState() { /** * Authenticate with Google Workspace * and get user authorization. */ const scopes = [ 'https://www.googleapis.com/auth/chat.users.readstate', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); /** * Build a service endpoint for Chat API. */ const chatClient = await chat.chat({version: 'v1', auth: authClient}); /** * Use the service endpoint to call Chat API. */ return await chatClient.users.spaces.updateSpaceReadState({ /** * The space read state to update. * * Replace USER with the calling user's ID, Workspace email, * or the alias me. * * Replace SPACE with a space name. * Obtain the space name from the spaces resource of Chat API, * or from a space's URL. */ name: 'users/me/spaces/SPACE/spaceReadState', updateMask: 'lastReadTime', requestBody: { lastReadTime: '{datetime.datetime(2000, 1, 3).isoformat()}Z' } }); } /** * Use the service endpoint to call Chat API. */ getSpaceReadState().then(console.log);
ในโค้ด ให้แทนที่ส่วนต่อไปนี้
SPACE
: ชื่อพื้นที่ทำงาน ซึ่งคุณดูได้จากเมธอดspaces.list
ใน Chat API หรือจาก URL ของพื้นที่ทำงาน
สร้างและเรียกใช้ตัวอย่างในไดเรกทอรีการทำงาน
node chat_spaceReadState_update.js
Apps Script
ตัวอย่างนี้จะเรียก Chat API โดยใช้บริการ Chat ขั้นสูง
เพิ่มขอบเขตการให้สิทธิ์
chat.users.readstate
ลงในไฟล์appsscript.json
ของโปรเจ็กต์ Apps Script ดังนี้"oauthScopes": [ "https://www.googleapis.com/auth/chat.users.readstate" ]
เพิ่มฟังก์ชันที่คล้ายกับฟังก์ชันนี้ในโค้ดของโปรเจ็กต์ Apps Script:
/** * Authenticates with Chat API via user credentials, * then updates the space read state for the calling user. * @param {string} spaceReadStateName The resource name of the space read state. */ function updateSpaceReadState(spaceReadStateName) { try { const time = new Date('January 1, 2000')).toJSON(); const body = {'lastReadTime': time}; Chat.Users.Spaces.updateSpaceReadState(spaceReadStateName, body); } catch (err) { // TODO (developer) - Handle exception console.log('Failed to update read state with error %s', err.message); } }
Google Chat API จะอัปเดตสถานะการอ่านพื้นที่ทำงานที่ระบุและแสดงผลอินสแตนซ์ของทรัพยากร SpaceReadState