ค้นหากลุ่ม

คุณจะค้นหากลุ่มที่ตรงกับแอตทริบิวต์บางอย่างได้โดยใช้เมธอด groups.list ของ Directory API เมธอดนี้จะยอมรับพารามิเตอร์ query ซึ่งเป็นคำค้นหาที่รวมวลีการค้นหาอย่างน้อย 1 รายการ แต่ละข้อความในการค้นหาประกอบด้วย 3 ส่วนดังนี้

ฟิลด์
แอตทริบิวต์กลุ่มที่ค้นหา เช่น name
ผู้ประกอบธุรกิจ
ทดสอบซึ่งดำเนินการกับข้อมูลเพื่อให้ได้ผลลัพธ์ที่ตรงกัน เช่น โอเปอเรเตอร์ = จะทดสอบว่าแอตทริบิวต์ข้อความตรงกับค่าหรือไม่
ค่า
เนื้อหาของแอตทริบิวต์ที่ทดสอบ เช่น groupName

วลีหลายรายการจะคั่นด้วยช่องว่างและรวมกันโดยปริยายด้วยโอเปอเรเตอร์ AND

ช่อง

ฟิลด์ ประเภทค่า โอเปอเรเตอร์ คำอธิบาย
email string = :{PREFIX}* อีเมลของกลุ่ม หมายเหตุ: ใช้ร่วมกับพารามิเตอร์ memberKey ในการค้นหาเดียวกันไม่ได้
name string = :{PREFIX}* ชื่อที่แสดงของกลุ่ม หมายเหตุ: ใช้ร่วมกับพารามิเตอร์ memberKey ในการค้นหาเดียวกันไม่ได้
memberKey string =, พารามิเตอร์การค้นหา memberKey จะแสดงกลุ่มทั้งหมดที่ผู้ใช้หรือกลุ่มเป็นสมาชิกอยู่ ค่านี้อาจเป็นอีเมลหลักหรืออีเมลแทนของผู้ใช้ อีเมลหลักหรืออีเมลแทนของกลุ่ม หรือรหัสที่ไม่ซ้ำกันของผู้ใช้ หมายเหตุ: ไม่สามารถใช้ร่วมกับพารามิเตอร์ email หรือ name ในการค้นหาเดียวกันได้

ประเภทค่า

ประเภทค่า Notes
string ล้อมรอบด้วยเครื่องหมายคำพูดเดี่ยว ' หากข้อความค้นหามีช่องว่าง ใช้เครื่องหมายคําพูดเดียวในข้อความค้นหาด้วย \' เช่น 'Valentine\'s Day'

โอเปอเรเตอร์

ผู้ประกอบธุรกิจ ประเภทค่าที่รองรับ Notes
= string, boolean, number, date ฟิลด์และค่าตรงกันทั้งหมด ตัวอย่างเช่น name=contact จะจับคู่กลุ่มทั้งหมดที่มีแอตทริบิวต์ name "contact" แต่ไม่ตรงกับ "contactgroup" ใช้ได้กับช่องสตริงส่วนใหญ่ (ดูด้านบน)
:{PREFIX}* string โดยฟิลด์นี้จะเริ่มต้นด้วยค่า ตัวอย่างเช่น การค้นหาที่มี email:support* จะตรงกับกลุ่มที่มีค่า email เป็น "supportgroup@" และ "support@" แต่ไม่จับคู่ "contactsupport" รองรับเฉพาะในช่องสตริงที่จำกัดเท่านั้น (ดูด้านบน)

ตัวอย่าง

คำค้นหาทั้งหมดจะใช้เมธอด groups.list ซึ่งมีคำขอ HTTP คล้ายกับข้อความต่อไปนี้ (มีการแบ่งบรรทัดเพื่อให้อ่านได้ง่าย)

GET https://admin.googleapis.com/admin/directory/v1/groups
?domain=primary domain
&query=query parameters

พารามิเตอร์ query ต้องเป็น URL ที่เข้ารหัส ตัวอย่างเช่น คําค้นหา query=email:support* คือ URL ที่เข้ารหัสเป็น query=email%3Asupport* ตัวอย่างทั้งหมดในหน้านี้แสดงพารามิเตอร์ query ที่ไม่เข้ารหัส ไลบรารีของไคลเอ็นต์จะจัดการการเข้ารหัส URL นี้โดยอัตโนมัติ

ค้นหากลุ่มตามชื่อที่แสดง

name='contact'

ค้นหากลุ่มที่ตรงกับคำนำหน้าอีเมล

email:admin*

ค้นหากลุ่มผู้ใช้ทั้งหมด

memberKey=user@company.com

ค้นหากลุ่มที่มีชื่อและอีเมลที่ขึ้นต้นด้วยรายชื่อติดต่อ

name:contact* email:contact*