Method: spaces.search

Google Workspace kuruluşundaki alanların listesini döndürür. Örnek için Alanları arama ve yönetme başlıklı makaleyi inceleyin.

useAdminAccess, false olarak ayarlandığında sonuçlar, arayan kullanıcının üye olduğu alanlarla sınırlıdır. Yönetici ayrıcalıklarıyla arama yapmak için useAdminAccess değerini true olarak ayarlayın. useAdminAccess ayarını false olarak ayarlama, Geliştirici Önizlemesi kapsamında kullanılabilir.

Aşağıdaki kimlik doğrulama türlerini destekler:

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ı, Sohbet ve alan 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ı gerektirir.

useAdminAccess ayarını false olarak ayarlama, Geliştirici Önizlemesi kapsamında kullanılabilir.

pageSize

integer

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

Belirtilmezse en fazla 100 alan döndürülür.

Maksimum değer 1.000'dir. 1.000'den büyük 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 jeton. Sonraki sayfayı almak için bu parametreyi sağlayın.

Sayfalara ayırma işlemi 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 iletmek beklenmedik sonuçlara yol açabilir.
query

string

Zorunlu. Arama sorgusu

useAdminAccess, true olarak ayarlandığında aşağıdaki parametreleri kullanarak arama yapabilirsiniz:

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

useAdminAccess, false olarak ayarlandığında:

  • displayName
  • externalUserAllowed

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

useAdminAccess, true olarak ayarlandığında customer gereklidir ve alanların hangi müşteriden alınacağını belirtmek için kullanılır. Yalnızca customers/my_customer değeri desteklenir.

displayName yalnızca HAS (:) operatörünü kabul eder. Eşleştirilecek metin önce jetonlara ayrılır ve her jeton, alanın displayName herhangi bir yerindeki alt dize olarak büyük/küçük harf duyarsız ve bağımsız bir şekilde önek eşlemesi yapılır. Örneğin, Fun Eve, Fun event veya The evening was fun ile eşleşir ancak notFun event veya even ile eşleşmez. useAdminAccess, false olarak ayarlandığında anlamlı sonuçlar almak için displayName gereklidir. Aksi takdirde, varsayılan davranış boş bir yanıt döndürmektir.

externalUserAllowed, true veya false'yi kabul eder.

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

useAdminAccess, true olarak ayarlandığında spaceType gereklidir ve tek geçerli değer SPACE'dir.

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ı alan içinde 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.

useAdminAccess, true olarak ayarlandığında 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")

useAdminAccess, false olarak ayarlandığında aşağıdaki örnek sorgular geçerlidir:

displayName:"Hello World"

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

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

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

string

İsteğe bağlı. Alan listesinin nasıl sıralandığı.

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

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

useAdminAccess, false olduğunda sıralama için yalnızca createTime ve relevance desteklenir. Yönetici olmayan kullanıcıların yaptığı aramalarda bu alanlar için yalnızca DESC desteklenir.

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

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

  • DESC azalan için.

useAdminAccess, true olarak ayarlandığında desteklenen söz dizimleri:

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

useAdminAccess, false olarak ayarlandığında:

  • createTime DESC
  • relevance DESC

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

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,
  "results": [
    {
      object (SearchSpaceResult)
    }
  ]
}
Alanlar
spaces[]
(deprecated)

object (Space)

Kullanımdan kaldırıldı: Lütfen bunun yerine yeni results alanını kullanın. İstenen alanların sayfası. Bu alan yalnızca useAdminAccess, true olarak ayarlandığında doldurulur ve yeni results alanı lehine kullanımdan kaldırılır.
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 toplam alan sayısı. Sonuç 10.000 boşluktan fazlaysa bu değer tahmini bir değerdir.
results[]

object (SearchSpaceResult)

Yalnızca çıkış.

Sorguyla eşleşen arama sonuçlarının listesi.

Yetkilendirme kapsamları

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

  • 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

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

SearchSpaceResult

Alan aramasından elde edilen tek bir sonuç öğesi.

JSON gösterimi 
{
  "space": {
    object (Space)
  }
}
Alanlar
space

object (Space)

Yalnızca çıkış. Eşleşen alan.