ก่อนเรียกใช้ Mail Admin Quarantine API ให้ทำตามขั้นตอนในหน้านี้เพื่อเปิดใช้ API, ค้นหาตัวระบุที่คำขอทุกรายการต้องการ และให้สิทธิ์ของผู้ดูแลระบบที่จำเป็นในบัญชี Google Workspace
ข้อกำหนดเบื้องต้น
- บัญชี Google Workspace ที่มีฟีเจอร์เขตกักบริเวณของผู้ดูแลระบบ ดูข้อมูลเพิ่มเติมได้ที่หัวข้อตั้งค่าและจัดการเขตกักเก็บอีเมล
- โปรเจ็กต์ Google Cloud หากต้องการสร้างโปรเจ็กต์ โปรดดูหัวข้อสร้างโปรเจ็กต์
- การเป็นสมาชิกในโปรแกรมเวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ Google Workspace โปรเจ็กต์ที่อยู่ในระบบคลาวด์ของคุณต้องลงทะเบียนในโปรแกรมก่อนจึงจะเรียกใช้ Admin Quarantine API ได้
- สิทธิ์เข้าถึงคอนโซลผู้ดูแลระบบของ Google ในฐานะผู้ดูแลระบบขั้นสูง เพื่อให้สิทธิ์ของผู้ดูแลระบบและให้สิทธิ์การมอบสิทธิ์ทั่วทั้งโดเมน
เปิดใช้ API
เปิดใช้ mailadminquarantine.googleapis.com ในโปรเจ็กต์ที่อยู่ในระบบคลาวด์ซึ่งโฮสต์การผสานรวมของคุณ
คอนโซล
เปิดใช้ Mail Admin Quarantine API ในคอนโซล Google Cloud
gcloud
เรียกใช้คำสั่งต่อไปนี้ โดยแทนที่ PROJECT_ID ด้วยรหัสโปรเจ็กต์ที่อยู่ในระบบคลาวด์
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
ค้นหารหัสลูกค้าของคุณ
คำขอทุกรายการที่ส่งไปยัง Admin Quarantine API จะระบุบัญชี Google Workspace ของคุณด้วยชื่อทรัพยากร customers/CUSTOMER_ID
วิธีค้นหารหัสลูกค้า
- ลงชื่อเข้าใช้คอนโซลผู้ดูแลระบบในฐานะผู้ดูแลระบบ
- ไปที่บัญชี > การตั้งค่าบัญชี > โปรไฟล์
- คัดลอกรหัสลูกค้า
หากรหัสลูกค้าขึ้นต้นด้วย C ให้นำ C ออกและใช้ค่าที่เป็นตัวอักษรและตัวเลขคละกันที่เหลือในชื่อทรัพยากร เช่น customers/01abc23de
อย่าใช้ชื่อโดเมนเป็นรหัสลูกค้า
ดูข้อมูลเพิ่มเติมได้ที่ค้นหารหัสลูกค้า
ให้สิทธิ์ของผู้ดูแลระบบที่จำเป็น
Admin Quarantine API จะบังคับใช้การตรวจสอบสิทธิ์ของผู้ดูแลระบบแบบเดียวกับเขตกักบริเวณของผู้ดูแลระบบในคอนโซลผู้ดูแลระบบ คำขอทุกรายการจะทำงานในนามของผู้ดูแลระบบ Google Workspace และผู้ดูแลระบบดังกล่าวต้องมีสิทธิ์ Gmail อย่างใดอย่างหนึ่งต่อไปนี้
| ทัวร์แบบพิเศษ | สิ่งที่ทำได้ |
|---|---|
| เข้าถึงเขตกักบริเวณของผู้ดูแลระบบ | เข้าถึงและจัดการข้อความในเขตกักบริเวณทั้งหมด รวมถึงเขตกักบริเวณเริ่มต้น |
| เข้าถึงเขตกักบริเวณที่ถูกจำกัด | เข้าถึงและจัดการข้อความเฉพาะในเขตกักเก็บที่เชื่อมโยงกับกลุ่มที่ผู้ดูแลระบบเป็นสมาชิก |
ซึ่งผู้ดูแลระบบขั้นสูงจะมีสิทธิ์เหล่านี้โดยอัตโนมัติ สำหรับผู้ดูแลระบบคนอื่นๆ ให้มอบหมายบทบาทที่มีสิทธิ์ต่อไปนี้
- ลงชื่อเข้าใช้คอนโซลผู้ดูแลระบบในฐานะผู้ดูแลระบบขั้นสูง
- ไปที่บัญชี > บทบาทผู้ดูแลระบบ
- เลือกบทบาทที่มีอยู่หรือคลิกสร้างบทบาทใหม่
- ในแท็บสิทธิ์ ให้ไปที่บริการ > Gmail แล้วเลือกเข้าถึงเขตกักเก็บของผู้ดูแลระบบหรือเข้าถึงเขตกักเก็บที่จำกัด
- มอบหมายบทบาทให้กับบัญชีผู้ดูแลระบบที่การผสานรวมของคุณแอบอ้างเมื่อเรียกใช้ API
โปรดดูรายละเอียดเกี่ยวกับบทบาทผู้ดูแลระบบที่ได้รับมอบสิทธิ์ที่หัวข้อมอบสิทธิ์ของผู้ดูแลระบบใน Gmail และความหมายของสิทธิ์ของผู้ดูแลระบบ
หากผู้ดูแลระบบที่ถูกแอบอ้างไม่มีสิทธิ์ที่จำเป็น API จะแสดงข้อผิดพลาด 403 PERMISSION_DENIED