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 ระบบจะเปลี่ยนค่าเป็น 1,000 โดยอัตโนมัติ
pageToken

string

โทเค็นที่ได้รับจากการเรียกใช้ Search Space ก่อนหน้า ระบุพารามิเตอร์นี้เพื่อดึงข้อมูลหน้าถัดไป

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

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

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

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

ตอบกลับพร้อมรายการพื้นที่ทำงานที่เกี่ยวข้องกับคำขอ Search Space

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

การแสดง 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

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