Method: spaces.search

Bir yöneticinin aramasına göre Google Workspace kuruluşundaki alanların listesini döndürür. İstekle ilgili olarak useAdminAccess değerini true olarak ayarlayın. Örnek için Alanları arama ve yönetme başlıklı makaleyi inceleyin.

Yönetici ayrıcalıklarıyla kullanıcı kimlik doğrulaması ve aşağıdaki yetkilendirme kapsamlarından biri gerekir:

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

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.

Bu yöntem şu anda yalnızca yönetici erişimini desteklemektedir. Bu nedenle, bu alan için yalnızca true kabul edilir.
pageSize

integer

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

Belirtilmezse en fazla 100 boşluk 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.

Sayfalama 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

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 gereklidir ve alanların hangi müşteriden getirileceğini 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 harfe 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.

externalUserAllowed, true veya false değerini kabul eder.

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

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.

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ıralanma şekli.

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

  • membershipCount.joined_direct_human_user_count: Bir alana doğrudan katılan 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.

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

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

  • Azalan düzende sıralamak için DESC.

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 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 toplam alan sayısı. Sonuç 10.000 boşluktan fazlaysa 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ılavuzu'na bakın.