ดึงข้อมูลกลุ่มทั้งหมดของโดเมนหรือของผู้ใช้ที่ได้รับ userKey (แบ่งเป็นหน้า)
คำขอ HTTP
GET https://admin.googleapis.com/admin/directory/v1/groups
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
customer |
รหัสที่ไม่ซ้ำสำหรับบัญชี Google Workspace ของลูกค้า ในกรณีของบัญชีหลายโดเมน หากต้องการดึงข้อมูลกลุ่มทั้งหมดสำหรับลูกค้า ให้ใช้ช่องนี้แทน |
domain |
ชื่อโดเมน ใช้ฟิลด์นี้เพื่อรับกลุ่มจากโดเมนเดียวเท่านั้น หากต้องการแสดงโดเมนทั้งหมดสำหรับบัญชีลูกค้า ให้ใช้พารามิเตอร์การค้นหา |
maxResults |
จำนวนผลลัพธ์สูงสุดที่จะแสดง ค่าสูงสุดที่อนุญาตคือ 200 |
orderBy |
คอลัมน์ที่จะใช้จัดเรียงผลลัพธ์ |
pageToken |
โทเค็นที่จะระบุหน้าถัดไปในรายการ |
query |
การค้นหาสตริงการค้นหา ควรอยู่ในรูปแบบ " |
sortOrder |
แสดงผลลัพธ์ในลำดับจากน้อยไปมากหรือมากไปน้อย มีประโยชน์เฉพาะเมื่อใช้ orderBy ด้วย |
userKey |
อีเมลหรือรหัสที่เปลี่ยนแปลงไม่ได้ของผู้ใช้ หากมีการระบุเฉพาะกลุ่มเหล่านั้น แสดงว่าผู้ใช้ดังกล่าวเป็นสมาชิกของ หากเป็นรหัส รหัสควรตรงกับรหัสของออบเจ็กต์ผู้ใช้ ใช้กับพารามิเตอร์ |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"kind": string,
"etag": string,
"groups": [
{
object ( |
ช่อง | |
---|---|
kind |
นี่เป็นแหล่งข้อมูล |
etag |
ETag ของทรัพยากร |
groups[] |
รายการออบเจ็กต์กลุ่ม |
nextPageToken |
โทเค็นที่ใช้ในการเข้าถึงหน้าถัดไปของผลการค้นหานี้ |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต 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 |
เรียงลำดับจากมากไปน้อย |