Method: groups.list

ดึงข้อมูลกลุ่มทั้งหมดของโดเมนหรือของผู้ใช้ที่ได้รับ userKey (แบ่งเป็นหน้า)

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์การค้นหา

พารามิเตอร์
customer

string

รหัสที่ไม่ซ้ำกันสำหรับบัญชี Google Workspace ของลูกค้า ในกรณีที่เป็นบัญชีหลายโดเมน หากต้องการดึงข้อมูลกลุ่มทั้งหมดสำหรับลูกค้า ให้ใช้ช่องนี้แทน domain นอกจากนี้ คุณยังใช้ชื่อแทน my_customer เพื่อแสดง customerId ของบัญชีได้ด้วย ระบบจะแสดง customerId เป็นส่วนหนึ่งของทรัพยากร Users ด้วย คุณต้องระบุพารามิเตอร์ customer หรือ domain
domain

string

ชื่อโดเมน ใช้ฟิลด์นี้เพื่อรับกลุ่มจากโดเมนเดียว หากต้องการแสดงโดเมนทั้งหมดของบัญชีลูกค้า ให้ใช้พารามิเตอร์การค้นหา customer แทน
maxResults

integer

จำนวนผลลัพธ์สูงสุดที่จะแสดง ค่าสูงสุดที่อนุญาตคือ 200
orderBy

enum (OrderBy)

คอลัมน์ที่จะใช้จัดเรียงผลลัพธ์
pageToken

string

โทเค็นสำหรับระบุหน้าถัดไปในรายการ
query

string

การค้นหาสตริงการค้นหา ควรอยู่ในรูปแบบ "" เอกสารประกอบฉบับเต็มอยู่ที่ https: //developers.google.com/workspace/admin/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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์

OrderBy

Enum
EMAIL อีเมลของกลุ่ม

SortOrder

Enum
ASCENDING เรียงลำดับจากน้อยไปมาก
DESCENDING เรียงลำดับจากมากไปน้อย