Method: groups.list

Bir alan adının veya kullanıcı anahtarı verilen bir kullanıcının tüm gruplarını getirir (sayfalandırılmış).

HTTP isteği

GET https://admin.googleapis.com/admin/directory/v1/groups

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

Sorgu parametreleri

Parametreler
customer

string

Müşterinin Google Workspace hesabının benzersiz kimliği. Birden fazla alan adı içeren bir hesapta, bir müşterinin tüm gruplarını almak için domain yerine bu alanı kullanın. Hesabınızın customerId değerini temsil etmek için my_customer takma adını da kullanabilirsiniz. customerId, Users kaynağının bir parçası olarak da döndürülür. customer veya domain parametresini sağlamanız gerekir.
domain

string

Alan adı. Yalnızca bir alandan grup almak için bu alanı kullanın. Bir müşteri hesabının tüm alanlarını döndürmek için bunun yerine customer sorgu parametresini kullanın.
maxResults

integer

Döndürülecek maksimum sonuç sayısı. İzin verilen maksimum değer 200'dür.
orderBy

enum (OrderBy)

Sonuçları sıralamak için kullanılacak sütun
pageToken

string

Listede sonraki sayfayı belirtmek için jeton
query

string

Sorgu dizesi araması. "" biçiminde olmalıdır. Tam dokümanlar https: //developers.google.com/workspace/admin/directory/v1/guides/search-groups adresindedir.
sortOrder

enum (SortOrder)

Sonuçların artan düzende mi yoksa azalan düzende mi döndürüleceğini belirtir. Yalnızca orderBy da kullanıldığında yararlıdır.
userKey

string

Yalnızca söz konusu kullanıcının üyesi olduğu grupların listeleneceği durumlarda, kullanıcının e-posta adresi veya değişmez kimliği. Kimlik ise kullanıcı nesnesinin kimliğiyle eşleşmelidir. customer parametresiyle kullanılamaz.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

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

JSON gösterimi 
{
  "kind": string,
  "etag": string,
  "groups": [
    {
      object (Group)
    }
  ],
  "nextPageToken": string
}
Alanlar
kind

string

Bu kaynağın türü.
etag

string

Kaynağın ETag'i.
groups[]

object (Group)

Grup nesnelerinin listesi.
nextPageToken

string

Bu sonucun bir sonraki sayfasına erişmek için kullanılan jeton.

Yetkilendirme kapsamları

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

  • https://apps-apis.google.com/a/feeds/groups/
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.group.readonly

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

Şuna göre sırala

Sıralamalar
EMAIL Grubun e-posta adresi.

SortOrder

Sıralamalar
ASCENDING Artan düzen.
DESCENDING Azalan düzen.