לפני שאתם קוראים ל-Mail Admin Quarantine API, אתם צריכים לבצע את השלבים שבדף הזה כדי להפעיל את ה-API, למצוא את המזהים שנדרשים לכל בקשה ולהעניק את הרשאות האדמין הנדרשות בחשבון Google Workspace שלכם.
דרישות מוקדמות
- חשבון Google Workspace עם התכונה "הסגר אדמין". מידע נוסף על הגדרה וניהול של הסגרים לאימייל
- פרויקט ב-Google Cloud. איך יוצרים פרויקט?
- חברות בתוכנית של Google Workspace לתצוגה מקדימה למפתחים. כדי לשלוח קריאה ל-Admin Quarantine API, צריך לרשום את פרויקט בענן לתוכנית.
- גישה לסופר-אדמין במסוף Google Admin, כדי להעניק הרשאות אדמין ולאשר הענקת גישה ברמת הדומיין.
הפעלת ה-API
מפעילים את mailadminquarantine.googleapis.com בפרויקט בענן שמארח את השילוב.
המסוף
במסוף Google Cloud, מפעילים את Mail Admin Quarantine API.
gcloud
מריצים את הפקודה הבאה, ומחליפים את PROJECT_ID במזהה הפרויקט בענן:
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
מצא את זיהוי הלקוח שלך
כל בקשה ל-Admin Quarantine API מזהה את חשבון Google Workspace שלכם באמצעות שם המשאב customers/CUSTOMER_ID.
כדי למצוא את מספר הלקוח:
- נכנסים למסוף Admin כאדמינים.
- עוברים אל חשבון > הגדרות חשבון > פרופיל.
- מעתיקים את מספר הלקוח.
אם מספר הלקוח מתחיל ב-C, צריך להסיר את C ולהשתמש בערך האלפאנומרי שנותר בשם המשאב, לדוגמה customers/01abc23de.
אל תשתמשו בשם הדומיין בתור מספר הלקוח.
הענקת הרשאות האדמין הנדרשות
Admin Quarantine API אוכף את אותן בדיקות של הרשאות אדמין כמו ההסגר של האדמין במסוף Admin. כל בקשה מופעלת בשם אדמין ב-Google Workspace, והאדמין הזה צריך להחזיק באחת מההרשאות הבאות ב-Gmail:
| סיור מיוחד מותאם אישית | מה אפשר לעשות עם הפיצ'ר |
|---|---|
| גישה להסגר של האדמין | לגשת להודעות בכל ההסגרים, כולל הסגר ברירת המחדל, ולנהל אותן. |
| גישה לאימיילים מוגבלים שהועברו להסגר | לגשת להודעות ולנהל אותן רק בהסגרים שמשויכים לקבוצות שהאדמין משתייך אליהן. |
לסופר-אדמינים יש את ההרשאות האלה באופן אוטומטי. לאדמינים אחרים, מקצים תפקיד שכולל את ההרשאה:
- נכנסים למסוף Admin כסופר-אדמין.
- עוברים אל חשבון > תפקידי אדמין.
- בוחרים תפקיד קיים או לוחצים על תפקיד חדש.
- בכרטיסייה הרשאות, נכנסים אל שירותים > Gmail ובוחרים באפשרות גישה להסגר של האדמין או גישה להסגרים מוגבלים.
- מקצים את התפקיד לחשבון האדמין שהשילוב מתחזה אליו כשהוא שולח קריאה ל-API.
פרטים נוספים על תפקידי אדמין עם הרשאות מוגבלות מופיעים במאמרים הקצאת הרשאות אדמין ב-Gmail והגדרות של הרשאות אדמין.
אם לאדמין שהתחזו אליו אין את ההרשאה הנדרשת, ה-API מחזיר שגיאת 403 PERMISSION_DENIED.