คำแนะนำนี้จะอธิบายวิธีใช้แหล่งข้อมูล list
ในแหล่งข้อมูล Space
ของ
Google Chat API เพื่อแสดงรายการพื้นที่ทำงาน พื้นที่แสดงข้อมูลแสดงหน้าเว็บที่แบ่งหน้าและกรองได้
รายการพื้นที่ทำงาน
แหล่งข้อมูล Space
รายการ
แสดงถึงสถานที่ที่ผู้คนและแอป Chat ส่งข้อความได้
แชร์ไฟล์ และทำงานร่วมกัน พื้นที่ทำงานมีหลายประเภทดังนี้
- ข้อความส่วนตัว (DM) คือการสนทนาระหว่างผู้ใช้ 2 คนหรือผู้ใช้ 1 ราย แอปใน Chat
- แชทเป็นกลุ่มคือการสนทนาระหว่างผู้ใช้ 3 คนขึ้นไปและ แอปแชท
- พื้นที่ทำงานที่มีชื่อคือที่ที่ผู้คนส่งข้อความ แชร์ไฟล์ และทำงานร่วมกัน
การแสดงข้อมูลผลิตภัณฑ์ที่มี การตรวจสอบสิทธิ์แอป แสดงรายการพื้นที่ทำงานที่แอป Chat มีสิทธิ์เข้าถึง รายชื่อ พื้นที่ทำงานที่มี การตรวจสอบสิทธิ์ผู้ใช้ แสดงรายการพื้นที่ทำงานที่ผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์มีสิทธิ์เข้าถึง
ข้อกำหนดเบื้องต้น
Python
- ธุรกิจหรือองค์กร บัญชี Google Workspace ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมโดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API โดยใช้ชื่อ ไอคอนและคำอธิบายสำหรับแอป Chat ของคุณ
- ติดตั้ง งูหลาม ไลบรารีของไคลเอ็นต์ Google API
- สร้างข้อมูลเข้าสู่ระบบโดยอิงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ใน Google Chat API
คำขอ:
- วิธีตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat
สร้างรหัสไคลเอ็นต์ OAuth
ข้อมูลเข้าสู่ระบบและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
client_secrets.json
ไปยังไดเรกทอรีในเครื่อง - วิธีตรวจสอบสิทธิ์ว่าเป็นแอป Chat
สร้างบัญชีบริการ
ข้อมูลเข้าสู่ระบบและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
- วิธีตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat
สร้างรหัสไคลเอ็นต์ OAuth
ข้อมูลเข้าสู่ระบบและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์โดยพิจารณาว่าคุณต้องการตรวจสอบสิทธิ์เป็นผู้ใช้หรือ แอป Chat
Node.js
- ธุรกิจหรือองค์กร บัญชี Google Workspace ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมโดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API โดยใช้ชื่อ ไอคอนและคำอธิบายสำหรับแอป Chat ของคุณ
- ติดตั้ง Node.js ไลบรารีของไคลเอ็นต์ Google API
- สร้างข้อมูลเข้าสู่ระบบโดยอิงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ใน Google Chat API
คำขอ:
- วิธีตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat
สร้างรหัสไคลเอ็นต์ OAuth
ข้อมูลเข้าสู่ระบบและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
client_secrets.json
ไปยังไดเรกทอรีในเครื่อง - วิธีตรวจสอบสิทธิ์ว่าเป็นแอป Chat
สร้างบัญชีบริการ
ข้อมูลเข้าสู่ระบบและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
- วิธีตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat
สร้างรหัสไคลเอ็นต์ OAuth
ข้อมูลเข้าสู่ระบบและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์โดยพิจารณาว่าคุณต้องการตรวจสอบสิทธิ์เป็นผู้ใช้หรือ แอป Chat
แสดงรายการพื้นที่ทำงานที่มีการตรวจสอบสิทธิ์ผู้ใช้
หากต้องการแสดงพื้นที่ทำงานใน Google Chat ให้ส่งข้อมูลต่อไปนี้ใน คำขอ:
- ด้วย
การตรวจสอบสิทธิ์ผู้ใช้
ระบุขอบเขตการให้สิทธิ์
chat.spaces.readonly
หรือchat.spaces
- เรียกใช้
list
วิธี ใน แหล่งข้อมูลSpace
ตัวอย่างต่อไปนี้แสดงพื้นที่ทำงานที่มีชื่อและแชทเป็นกลุ่ม (แต่ไม่ใช่โดยตรง ที่ถูกกรองออก) ปรากฏแก่ผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว:
Python
- สร้างไฟล์ชื่อ
chat_space_list.py
ในไดเรกทอรีการทำงาน รวมรหัสต่อไปนี้ใน
chat_space_list.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 lists named spaces and group chats (but not direct messages) visible to the authenticated 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.spaces().list( # An optional filter that returns named spaces or unnamed group chats, # but not direct messages (DMs). filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"' ).execute() # Prints the returned list of spaces. print(result) if __name__ == '__main__': main()
ในไดเรกทอรีการทำงาน ให้สร้างและเรียกใช้ตัวอย่างด้วยคำสั่งต่อไปนี้
python3 chat_space_list.py
Node.js
- สร้างไฟล์ชื่อ
list-spaces.js
ในไดเรกทอรีการทำงาน รวมรหัสต่อไปนี้ใน
list-spaces.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * List Chat spaces. * @return {!Promise<!Object>} */ async function listSpaces() { 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.list({ filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"' }); } listSpaces().then(console.log);
ในไดเรกทอรีการทำงาน ให้เรียกใช้ตัวอย่าง
node list-spaces.js
Chat API จะแสดงผล อาร์เรย์ที่ใส่เลขหน้าของพื้นที่ทำงานและแชทเป็นกลุ่มที่มีชื่อ
แสดงรายการพื้นที่ทำงานด้วยการตรวจสอบสิทธิ์แอป
หากต้องการแสดงพื้นที่ทำงานใน Google Chat ให้ส่งข้อมูลต่อไปนี้ใน คำขอ:
- ด้วย
การตรวจสอบสิทธิ์แอป
ระบุขอบเขตการให้สิทธิ์
chat.bot
- เรียกใช้
list
วิธี ใน แหล่งข้อมูลSpace
ตัวอย่างต่อไปนี้แสดงพื้นที่ทำงานที่มีชื่อและแชทเป็นกลุ่ม (แต่ไม่ใช่โดยตรง ข้อความ) ที่แอป Chat มองเห็นได้
Python
- สร้างไฟล์ชื่อ
chat_space_list_app.py
ในไดเรกทอรีการทำงาน รวมรหัสต่อไปนี้ใน
chat_space_list_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().list( # An optional filter that returns named spaces or unnamed # group chats, but not direct messages (DMs). filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"' ).execute() print(result)
ในไดเรกทอรีการทำงาน ให้สร้างและเรียกใช้ตัวอย่างด้วยคำสั่งต่อไปนี้
python3 chat_space_list_app.py
Node.js
- สร้างไฟล์ชื่อ
app-list-spaces.js
ในไดเรกทอรีการทำงาน รวมรหัสต่อไปนี้ใน
app-list-spaces.js
:const chat = require('@googleapis/chat'); /** * List Chat spaces. * @return {!Promise<!Object>} */ async function listSpaces() { 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.list({ filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"' }); } listSpaces().then(console.log);
ในไดเรกทอรีการทำงาน ให้เรียกใช้ตัวอย่าง
node app-list-spaces.js
Chat API จะแสดงผลอาร์เรย์ที่ใส่เลขหน้าของพื้นที่ทำงาน
ปรับแต่งการใส่เลขหน้าหรือกรองรายการ
หากต้องการแสดงรายการพื้นที่ทำงานใน Google Chat ให้ส่งข้อมูลต่อไปนี้ (ไม่บังคับ) พารามิเตอร์การค้นหาเพื่อปรับแต่งการใส่เลขหน้าหรือกรองช่องว่างในรายการ
pageSize
: จำนวนช่องว่างสูงสุดที่จะแสดง บริการอาจกลับมา น้อยกว่าค่านี้ หากไม่ระบุ ระบบจะแสดงผลเว้นวรรคมากที่สุด 100 รายการ ค่าสูงสุดคือ 1,000 ค่าที่สูงกว่า 1,000 จะเปลี่ยนเป็น 1,000 คนpageToken
: โทเค็นของหน้าเว็บที่ได้รับจากการเรียกใช้รายการพื้นที่ทำงานก่อนหน้า ระบุโทเค็นนี้เพื่อเรียกข้อมูลหน้าถัดไป เมื่อใส่เลขหน้า พารามิเตอร์ ค่าตัวกรองควรตรงกับการเรียกใช้ที่ระบุโทเค็นหน้าเว็บ ส่งผ่าน ค่าที่แตกต่างกันอาจนำไปสู่ผลลัพธ์ที่ไม่คาดคิดfilter
: ตัวกรองการค้นหา โปรดดูรายละเอียดการค้นหาที่รองรับที่หัวข้อspaces.list
วิธี
หัวข้อที่เกี่ยวข้อง
- สร้างพื้นที่ทำงาน
- ตั้งค่าพื้นที่ทำงาน
- ดูรายละเอียดเกี่ยวกับพื้นที่ทำงาน
- อัปเดตพื้นที่ทำงาน
- ลบพื้นที่ทำงาน
- ค้นหาพื้นที่ข้อความส่วนตัว