Method: spaces.search

แสดงรายการพื้นที่ทำงานตามการค้นหาของผู้ใช้ ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ ผู้ใช้ต้องเป็นผู้ดูแลระบบขององค์กร Google Workspace ตั้งค่า useAdminAccess เป็น true ในคำขอ

คำขอ HTTP

GET https://chat.googleapis.com/v1/spaces:search

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์การค้นหา

พารามิเตอร์
useAdminAccess

boolean

เมื่อใช้ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการการสนทนาในแชทและพื้นที่ทำงาน

ต้องมีขอบเขต OAuth 2.0 chat.admin.spaces.readonly หรือ chat.admin.spaces

ปัจจุบันวิธีนี้รองรับเฉพาะสิทธิ์เข้าถึงระดับผู้ดูแลระบบเท่านั้น จึงรองรับเพียง true สำหรับช่องนี้
pageSize

integer

จำนวนสูงสุดของพื้นที่ว่างที่จะแสดงผล บริการอาจแสดงผลน้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลเว้นวรรคไม่เกิน 100 รายการ

ค่าสูงสุดคือ 1,000 หากคุณใช้ค่ามากกว่า 1, 000 ระบบจะเปลี่ยนค่าดังกล่าวเป็น 1000 โดยอัตโนมัติ
pageToken

string

โทเค็นที่ได้รับจากการโทรในพื้นที่ทำงานก่อนหน้านี้ ระบุพารามิเตอร์นี้เพื่อดึงหน้าเว็บถัดไป

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกที่ระบุโทเค็นของหน้าเว็บ การส่งต่อค่าที่แตกต่างกันไปยังพารามิเตอร์อื่นๆ อาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิด
query

string

ต้องระบุ คำค้นหา

คุณสามารถค้นหาโดยใช้พารามิเตอร์ต่อไปนี้ - createTime - customer - displayName - externalUserAllowed - lastActiveTime - spaceHistoryState - spaceType

createTime และ lastActiveTime ยอมรับการประทับเวลาในรูปแบบ RFC-3339 และโอเปอเรเตอร์การเปรียบเทียบที่รองรับ ได้แก่ =, <, >, <=, >=

ต้องระบุ customer และใช้เพื่อระบุลูกค้าที่จะดึงข้อมูลพื้นที่ทำงาน customers/my_customer เป็นค่าเดียวที่รองรับ

displayName ยอมรับเฉพาะโอเปอเรเตอร์ HAS (:) ข้อความที่จะจับคู่จะได้รับการแปลงเป็นโทเค็นก่อน และโทเค็นแต่ละรายการจะจับคู่กับคำนำหน้าว่าไม่คำนึงถึงตัวพิมพ์เล็กหรือใหญ่และเป็นสตริงย่อยที่ใดก็ได้ใน displayName ของพื้นที่ทำงาน ตัวอย่างเช่น Fun Eve จะจับคู่กับ Fun event หรือ The evening was fun แต่ไม่จับคู่กับ notFun event หรือ even

externalUserAllowed ยอมรับ true หรือ false

spaceHistoryState ยอมรับเฉพาะค่าจากช่อง historyState ของทรัพยากร space เท่านั้น

ต้องระบุ spaceType และค่าที่ใช้ได้ค่าเดียวคือ SPACE

ในฟิลด์ต่างๆ จะสนับสนุนโอเปอเรเตอร์เพียง AND รายการเท่านั้น ตัวอย่างที่ถูกต้องคือ spaceType = "SPACE" AND displayName:"Hello" และตัวอย่างที่ไม่ถูกต้องคือ spaceType = "SPACE" OR displayName:"Hello"

ในช่องเดียวกัน spaceType ไม่รองรับโอเปอเรเตอร์ AND หรือ OR displayName, "spaceHistoryState" และ "externalUserAllowed" รองรับเฉพาะโอเปอเรเตอร์ OR เท่านั้น lastActiveTime และ createTime รองรับทั้งโอเปอเรเตอร์ AND และ OR AND สามารถใช้เพื่อแสดงช่วงเวลาเท่านั้น เช่น lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00"

ตัวอย่างคำค้นหาที่ใช้ได้มีดังนี้

customer = "customers/my_customer" AND spaceType = "SPACE"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
displayName:"Hello World"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(lastActiveTime < "2020-01-01T00:00:00+00:00" OR lastActiveTime >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(displayName:"Hello World" OR displayName:"Fun event") AND
(lastActiveTime > "2020-01-01T00:00:00+00:00" AND lastActiveTime <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(createTime > "2019-01-01T00:00:00+00:00" AND createTime <
"2020-01-01T00:00:00+00:00") AND (externalUserAllowed = "true") AND
(spaceHistoryState = "HISTORY_ON" OR spaceHistoryState = "HISTORY_OFF")
orderBy

string

ไม่บังคับ วิธีเรียงลำดับรายการพื้นที่ทำงาน

แอตทริบิวต์ที่รองรับการจัดเรียงมีดังนี้

  • membershipCount.joined_direct_human_user_count — แสดงจำนวนผู้ใช้ที่เป็นมนุษย์ที่เข้าร่วมพื้นที่ทำงานโดยตรง
  • lastActiveTime — แสดงเวลาที่เพิ่มรายการที่มีสิทธิ์รายการสุดท้ายในหัวข้อของพื้นที่ทำงานนี้
  • createTime — หมายถึงเวลาที่สร้างพื้นที่ทำงาน

ค่าของการดำเนินการเรียงลำดับที่ถูกต้องมีดังนี้

  • ASCสำหรับน้อยไปมาก ค่าเริ่มต้น

  • DESC สำหรับมากไปน้อย

ไวยากรณ์ที่รองรับมีดังนี้

  • membershipCount.joined_direct_human_user_count DESC
  • membershipCount.joined_direct_human_user_count ASC
  • lastActiveTime DESC
  • lastActiveTime ASC
  • createTime DESC
  • createTime ASC

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

ตอบกลับด้วยรายการพื้นที่ทำงานที่สอดคล้องกับคำขอพื้นที่ค้นหา

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
ช่อง
spaces[]

object (Space)

หน้าเว็บของพื้นที่ทำงานที่ขอ
nextPageToken

string

โทเค็นที่ใช้เพื่อเรียกดูหน้าถัดไปได้ หากฟิลด์นี้ว่างเปล่า จะไม่มีหน้าถัดไป
totalSize

integer

จำนวนพื้นที่ทำงานทั้งหมดที่ตรงกับคำค้นหาในทุกหน้า หากผลลัพธ์มีการเว้นวรรคเกิน 10,000 ช่อง ค่านี้จะเป็นค่าโดยประมาณ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

โปรดดูข้อมูลเพิ่มเติมที่คู่มือการให้สิทธิ์