Method: spaces.search

แสดงผลรายการพื้นที่ทำงานในองค์กร Google Workspace ดูตัวอย่างได้ที่ ค้นหาและจัดการพื้นที่ทำงาน

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

pageSize

integer

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

หากไม่ได้ระบุ ระบบจะแสดงผลพื้นที่ทำงานไม่เกิน 100 รายการ

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

string

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

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

string

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

คุณสามารถค้นหาโดยใช้พารามิเตอร์ต่อไปนี้เมื่อตั้งค่า useAdminAccess เป็น true

  • createTime
  • customer
  • displayName
  • externalUserAllowed
  • lastActiveTime
  • spaceHistoryState
  • spaceType

เมื่อตั้งค่า useAdminAccess เป็น false

  • displayName
  • externalUserAllowed
  • spaceType

createTime และ lastActiveTime ยอมรับการประทับเวลาในรูปแบบ RFC-3339 และตัวดำเนินการเปรียบเทียบที่รองรับคือ: =, <, >, <=, >=

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

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

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"

ตัวอย่างการค้นหาต่อไปนี้ถูกต้องเมื่อตั้งค่า useAdminAccess เป็น true

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")

ตัวอย่างการค้นหาต่อไปนี้ถูกต้องเมื่อตั้งค่า useAdminAccess เป็น false

displayName:"Hello World" AND spaceType = "SPACE"

(displayName:"Hello" OR displayName:"Fun") AND spaceType = "SPACE"

(externalUserAllowed = "true" AND spaceType = "SPACE") // Returns an
empty response.

(externalUserAllowed = "true" AND displayName:"Hello" AND spaceType =
"SPACE")
orderBy

string

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

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

  • membershipCount.joined_direct_human_user_count \- ระบุจำนวนผู้ใช้ที่เป็นบุคคลจริงที่เข้าร่วมพื้นที่ทำงานโดยตรง
  • lastActiveTime \- ระบุเวลาที่เพิ่มรายการสุดท้ายที่มีสิทธิ์ลงในหัวข้อใดก็ได้ของพื้นที่ทำงานนี้
  • createTime \- ระบุเวลาที่สร้างพื้นที่ทำงาน

เมื่อ useAdminAccess เป็น false ระบบจะรองรับเฉพาะ createTime และ relevance สำหรับการจัดเรียง เฉพาะ DESC เท่านั้นที่รองรับสำหรับช่องเหล่านี้ในการค้นหาที่ไม่ใช่ของผู้ดูแลระบบ

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

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

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

ไวยากรณ์ที่รองรับคือเมื่อตั้งค่า useAdminAccess เป็น true

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

เมื่อตั้งค่า useAdminAccess เป็น false

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

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

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

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

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

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

object (Space)

เลิกใช้งานแล้ว: โปรดใช้ช่อง results ใหม่แทน พื้นที่ทำงานที่ขอเป็นหน้า ระบบจะป้อนข้อมูลในช่องนี้เมื่อตั้งค่า useAdminAccess เป็น true เท่านั้น และจะเลิกใช้งานช่องนี้เพื่อใช้ช่อง results ใหม่แทน
nextPageToken

string

โทเค็นที่ใช้ดึงข้อมูลหน้าถัดไป หากช่องนี้ว่างเปล่า แสดงว่าไม่มีหน้าถัดไป
totalSize

integer

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

object (SearchSpaceResult)

แสดงผลเท่านั้น รายการผลการค้นหาที่ตรงกับคำค้นหา

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

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

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

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

SearchSpaceResult

รายการผลลัพธ์เดียวจากการค้นหาพื้นที่ทำงาน

การแสดง JSON 
{
  "space": {
    object (Space)
  }
}
ช่อง
space

object (Space)

แสดงผลเท่านั้น พื้นที่ทำงานที่ตรงกัน