Gmail Postmaster Tools API

ה-API של Postmaster Tools הוא API מסוג RESTful שמספק גישה פרוגרמטית למדדים של תעבורת אימייל (כמו דוחות ספאם, שגיאות מסירה וכו'), שזמינים כרגע דרך ממשק המשתמש של Postmaster Tools של Gmail.

שירות: gmailpostmastertools.googleapis.com

כדי לקרוא לשירות הזה, מומלץ להשתמש בספריות הלקוח ש-Google מספקת. אם האפליקציה צריכה להשתמש בספריות משלה כדי לקרוא לשירות הזה, צריך להשתמש במידע הבא כשמבצעים את בקשות ה-API.

מסמך Discovery

Discovery Document הוא מפרט שניתן לקריאה על ידי מכונה, שמתאר ומאפשר שימוש בממשקי API ל-REST. היא משמשת לבניית ספריות לקוח, תוספים ל-IDE וכלים אחרים שמתקשרים עם Google APIs. שירות אחד יכול לספק כמה מסמכי גילוי. השירות הזה מספק את מסמך Discovery הבא:

נקודת קצה של שירות

נקודת קצה של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות API. יכול להיות שלשירות אחד יהיו כמה נקודות קצה של שירות. לשירות הזה יש נקודת קצה שירות משלו, וכל כתובות ה-URI שבהמשך הן יחסיות לנקודת קצה השירות הזו:

  • https://gmailpostmastertools.googleapis.com

משאב REST: ‏ v2beta.domainStats

Methods
batchQuery POST /v2beta/domainStats:batchQuery
מבצעת אצווה של בקשות QueryDomainStats לכמה דומיינים.

משאב REST: ‏ v2beta.domains

Methods
create POST /v2beta/domains
מוסיף דומיין לחשבון של המשתמש.
delete DELETE /v2beta/{name=domains/*}
מחיקת דומיין מחשבון המשתמש.
get GET /v2beta/{name=domains/*}
שליפת מידע מפורט על דומיין שרשמתם.
getComplianceStatus GET /v2beta/{name=domains/*/complianceStatus}
מאחזר את סטטוס התאימות של דומיין נתון.
getVerificationToken GET /v2beta/{name=domains/*/verificationToken}
מקבל אסימון אימות שמשמש לאימות הבעלות של משתמש על דומיין.
list GET /v2beta/domains
אחזור רשימה של כל הדומיינים שרשמתם, יחד עם המטא-נתונים התואמים שלהם.
verify POST /v2beta/{name=domains/*}:verify
מאמת את הבעלות של משתמש על דומיין ברמת ה-DNS.

משאב REST: ‏ v2beta.domains.domainStats

Methods
query POST /v2beta/{parent=domains/*}/domainStats:query
מאחזר רשימה של נתונים סטטיסטיים של דומיין עבור דומיין נתון ותקופה נתונה.

משאב REST: ‏ v2beta.domains.users

Methods
create POST /v2beta/{parent=domains/*}/users
יוצר משתמש עם גישה לדומיין.
delete DELETE /v2beta/{name=domains/*/users/*}
מחיקת משתמש מדומיין.
get GET /v2beta/{name=domains/*/users/*}
מאחזר מידע מפורט על משתמש שיש לו גישה לדומיין.
list GET /v2beta/{parent=domains/*}/users
רשימת המשתמשים שיש להם גישה לדומיין.
patch PATCH /v2beta/{user.name=domains/*/users/*}
מעדכן משתמש בדומיין.