Method: groups.list

همه گروه های یک دامنه یا کاربری که یک userKey داده شده (صفحه بندی شده) را بازیابی می کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
customer

string

شناسه منحصر به فرد برای حساب Google Workspace مشتری. در مورد حساب چند دامنه ای، برای واکشی همه گروه ها برای مشتری، به جای domain از این فیلد استفاده کنید. همچنین می توانید از نام مستعار my_customer برای نشان دادن customerId حساب خود استفاده کنید. customerId نیز به عنوان بخشی از منبع کاربران بازگردانده می شود. شما باید یا customer یا پارامتر domain را ارائه دهید.

domain

string

نام دامنه. از این فیلد برای دریافت گروه تنها از یک دامنه استفاده کنید. برای بازگرداندن همه دامنه ها برای حساب مشتری، به جای آن از پارامتر query customer استفاده کنید.

maxResults

integer

حداکثر تعداد نتایج برای بازگشت. حداکثر مقدار مجاز 200 است.

orderBy

enum ( OrderBy )

ستون مورد استفاده برای مرتب سازی نتایج

pageToken

string

رمزی برای تعیین صفحه بعدی در لیست

query

string

جستجوی رشته پرس و جو باید به شکل " ". اسناد کامل در https://developers.google.com/admin-sdk/directory/v1/guides/search-groups موجود است

sortOrder

enum ( SortOrder )

اینکه نتایج را به ترتیب صعودی یا نزولی برگرداند. فقط زمانی استفاده می شود که orderBy نیز استفاده می شود

userKey

string

ایمیل یا شناسه غیرقابل تغییر کاربر در صورتی که فقط آن گروه ها فهرست شوند، کاربر معین عضو آن است. اگر یک شناسه است، باید با شناسه شی کاربر مطابقت داشته باشد. نمی توان با پارامتر customer استفاده کرد.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "kind": string,
  "etag": string,
  "groups": [
    {
      object (Group)
    }
  ],
  "nextPageToken": string
}
فیلدها
kind

string

نوعی منبع این است.

etag

string

ETag منبع

groups[]

object ( Group )

لیستی از اشیاء گروهی

nextPageToken

string

رمز برای دسترسی به صفحه بعدی این نتیجه استفاده می شود.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • 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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

سفارش توسط

Enums
EMAIL ایمیل گروه

مرتب سازی

Enums
ASCENDING ترتیب صعودی
DESCENDING ترتیب نزولی