Method: spaces.search

Kullanıcının aramasına göre alanların listesini döndürür. Kullanıcı kimlik doğrulaması gerektirir. Kullanıcı, Google Workspace kuruluşunda yönetici olmalıdır. İstekte useAdminAccess öğesini 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ı, 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ını 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 boşluk sayısı. Hizmet bu değerden daha az sonuç döndürebilir.

Belirtilmemesi durumunda 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 bir jeton. Sonraki sayfayı almak için bu parametreyi sağlayın.

Sayfalara ayırırken, sağlanan tüm diğer parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Diğer parametrelere farklı değerler geçirmek beklenmedik sonuçlara yol açabilir.
query

string

Zorunlu. Arama sorgusu.

Şu 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. customers/my_customer, desteklenen tek değerdir.

displayName yalnızca HAS (:) operatörünü kabul eder. Eşleştirilecek metin önce jetonlara ayrılır ve her jeton, alanın displayName içindeki herhangi bir yerinde alt dize olarak bağımsız bir şekilde ve büyük/küçük harfe duyarlı olmayacak şekilde önek ile 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 eder.

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

spaceType gerekli ve geçerli tek değer SPACE.

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" örneğidir.

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 biçimi.

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 alandaki herhangi bir konuya, uygun olan en son öğenin eklendiği zamanı belirtir.
  • createTime: Alanın oluşturulduğu zamanı gösterir.

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

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

  • Azalan için DESC.

Desteklenen söz dizimi şu şekildedir:

  • 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

Alan arama 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 boşluk sayısı. Sonuç 10.000'den fazla boşluk varsa bu değer tahminidir.

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.