คุณสามารถค้นหากลุ่มที่ตรงกับแอตทริบิวต์บางอย่างด้วยเมธอด groups.list ของ Directory API เมธอดนี้จะยอมรับพารามิเตอร์ query ซึ่งเป็นข้อความค้นหาที่รวมคำสั่งค้นหาอย่างน้อย 1 รายการ ประโยคการค้นหาแต่ละประโยคประกอบด้วย 3 ส่วนดังนี้
- ช่อง
- แอตทริบิวต์กลุ่มที่ค้นหา เช่น
name - โอเปอเรเตอร์
- การทดสอบที่ดำเนินการกับข้อมูลเพื่อให้การจับคู่ เช่น
=โอเปอเรเตอร์จะทดสอบว่าแอตทริบิวต์ข้อความตรงกับค่าหรือไม่ - ค่า
- เนื้อหาของแอตทริบิวต์ที่ทดสอบ เช่น
groupName
ประโยคย่อยหลายรายการจะคั่นด้วยเว้นวรรคและจะรวมกันโดยนัยด้วยโอเปอเรเตอร์
AND
ช่อง
| ช่อง | ประเภทค่า | โอเปอเรเตอร์ | คำอธิบาย |
|---|---|---|---|
email |
สตริง | =, :{PREFIX}* |
อีเมลของกลุ่ม หมายเหตุ: ไม่สามารถใช้กับพารามิเตอร์ memberKey ในการค้นหาเดียวกัน |
name |
สตริง | =, :{PREFIX}* |
ชื่อที่แสดงของกลุ่ม หมายเหตุ: ไม่สามารถใช้กับพารามิเตอร์ memberKey ในคําค้นหาเดียวกัน |
memberKey |
สตริง | = |
พารามิเตอร์การค้นหา memberKey จะแสดงผลกลุ่มทั้งหมดที่ผู้ใช้หรือกลุ่มเป็นสมาชิก ค่านี้อาจเป็นอีเมลหลักหรืออีเมลแทนของผู้ใช้ อีเมลหลักหรืออีเมลแทนของกลุ่ม หรือรหัสที่ไม่ซ้ำของผู้ใช้ หมายเหตุ: ใช้ร่วมกับพารามิเตอร์ email หรือ name ในข้อความค้นหาเดียวกันไม่ได้ |
ประเภทค่า
| ประเภทค่า | หมายเหตุ |
|---|---|
| สตริง | ใส่เครื่องหมายคำพูดเดี่ยว ' ล้อมรอบหากข้อความค้นหามีเว้นวรรค หนีเครื่องหมายคำพูดเดี่ยวในการค้นหาด้วย \' เช่น 'Valentine\'s Day' |
โอเปอเรเตอร์
| โอเปอเรเตอร์ | ประเภทค่าที่รองรับ | หมายเหตุ |
|---|---|---|
= |
สตริง บูลีน ตัวเลข วันที่ | ฟิลด์และค่าตรงกันทุกประการ เช่น name=contact จะจับคู่กับกลุ่มทั้งหมดที่มีแอตทริบิวต์ name "contact" แต่ไม่จับคู่กับ "contactgroup" รองรับในฟิลด์สตริงส่วนใหญ่ (ดูด้านบน) |
:{PREFIX}* |
สตริง | ช่องจะขึ้นต้นด้วยค่า ตัวอย่างเช่น คําค้นหาที่มี 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
ค้นหากลุ่มที่มีชื่อและอีเมลที่ขึ้นต้นด้วย contact
name:contact* email:contact*