คุณค้นหากลุ่มที่ตรงกับแอตทริบิวต์บางอย่างได้ด้วยเมธอด
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*