Method: spaces.search

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

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

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

คำขอ HTTP

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

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

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

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

boolean

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

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

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

การตั้งค่า useAdminAccess เป็น false จะพร้อมใช้งานในเวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์

pageSize

integer

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

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

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

string

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

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

string

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

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

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

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

  • displayName
  • externalUserAllowed

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 เมื่อตั้งค่า useAdminAccess เป็น true และค่าที่ใช้ได้มีเพียง 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"

(displayName:"Hello" OR displayName:"Fun")

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

(externalUserAllowed = "true" AND displayName:"Hello")
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

  • createTime DESC
  • relevance DESC

เนื้อความของคำขอ

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

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

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

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

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

เอาต์พุตเท่านั้น พื้นที่ทำงานที่ตรงกัน