Method: spaces.search

Yöneticinin yaptığı aramaya göre Google Workspace kuruluşundaki alanların listesini döndürür.

Yönetici ayrıcalıklarına sahip kullanıcı kimlik doğrulaması gerektirir. İstekte useAdminAccess değerini true olarak ayarlayın.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Sorgu parametreleri

Parametreler
useAdminAccess

boolean

true olduğunda yöntem, kullanıcının Google Workspace yönetici ayrıcalıkları kullanılarak çalıştırılır.

Arayan kullanıcı, Chat ve Alanlar görüşmelerini yönetme ayrıcalığına sahip bir Google Workspace yöneticisi olmalıdır.

chat.admin.spaces.readonly veya chat.admin.spaces OAuth 2.0 kapsamını gerektirir.

Bu yöntem şu anda yalnızca yönetici erişimini desteklediğinden bu alan için yalnızca true kabul edilir.
pageSize

integer

Döndürülecek maksimum boşluk sayısı. Hizmet bu değerden daha az bir değer döndürebilir.

Belirtilmemesi durumunda en fazla 100 alan döndürülür.

Maksimum değer 1.000'dir. 1.000'den yüksek bir değer kullanırsanız bu değer otomatik olarak 1.000 olarak değiştirilir.
pageToken

string

Önceki arama alanları çağrısından alınan bir jeton. Sonraki sayfayı almak için bu parametreyi sağlayın.

Sayfalandırma yapılırken sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Diğer parametrelere farklı değerler göndermek beklenmedik sonuçlara neden olabilir.
query

string

Zorunlu. Arama sorgusu.

Aşağıdaki parametreleri kullanarak arama yapabilirsiniz:

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

createTime ve lastActiveTime, RFC-3339 biçiminde bir zaman damgası kabul eder. Desteklenen karşılaştırma operatörleri şunlardır: =, <, >, <=, >=.

customer zorunludur ve alanların hangi müşteriden getirileceğini belirtmek için kullanılır. customers/my_customer desteklenen tek değerdir.

displayName yalnızca HAS (:) operatörünü kabul eder. Eşleştirilecek metin ilk olarak jetonlara dönüştürülür ve her jeton, alanın displayName herhangi bir yerinde alt dize olarak, büyük/küçük harfe duyarlı olmayan ve bağımsız bir şekilde ön ekle eşleşir. Örneğin, Fun Eve, Fun event veya The evening was fun ile eşleşir ancak notFun event veya even ile eşleşmez.

externalUserAllowed, true veya false kabul edilir.

spaceHistoryState yalnızca space kaynağının historyState alanındaki değerleri kabul eder.

spaceType gereklidir ve yalnızca SPACE değeri geçerlidir.

Farklı alanlarda yalnızca AND operatörleri desteklenir. Geçerli bir örnek spaceType = "SPACE" AND displayName:"Hello", geçersiz bir örnek ise spaceType = "SPACE" OR displayName:"Hello" şeklindedir.

Aynı alanda spaceType, AND veya OR operatörlerini desteklemez. displayName, "spaceHistoryState" ve "externalUserAllowed" yalnızca OR operatörlerini destekler. lastActiveTime ve createTime, hem AND hem de OR operatörlerini destekler. AND yalnızca lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00" gibi bir aralığı temsil etmek için kullanılabilir.

Aşağıdaki örnek sorgular geçerlidir:

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

İsteğe bağlı. Alan listesinin sıralaması.

Sıralama için desteklenen özellikler şunlardır:

  • membershipCount.joined_direct_human_user_count: Doğrudan alana katılan gerçek kullanıcıların sayısını belirtir.
  • lastActiveTime: Bu alanın herhangi bir konusuna son uygun öğenin eklendiği zamanı gösterir.
  • createTime: Alanın oluşturulduğu zamanı gösterir.

Geçerli sıralama işlemi değerleri şunlardır:

  • Artan için ASC. Varsayılan değer.

  • DESC için azalan.

Desteklenen söz dizimleri şunlardır:

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

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Arama alanları isteğine karşılık gelen alanların listesini içeren yanıt.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Alanlar
spaces[]

object (Space)

İstenen alanların bir sayfası.
nextPageToken

string

Sonraki sayfayı almak için kullanılabilecek bir jeton. Bu alan boşsa sonraki sayfa yoktur.
totalSize

integer

Tüm sayfalarda sorguyla eşleşen boşlukların toplam sayısı. Sonuç 10.000'den fazla boşluk içeriyorsa bu değer bir tahmindir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.