ה-API של Postmaster Tools הוא API מסוג RESTful שמספק גישה פרוגרמטית למדדים של תעבורת אימייל (כמו דוחות ספאם, שגיאות מסירה וכו'), שזמינים כרגע דרך ממשק המשתמש של Postmaster Tools של Gmail.
שירות: gmailpostmastertools.googleapis.com
כדי לקרוא לשירות הזה, מומלץ להשתמש בספריות הלקוח ש-Google מספקת. אם האפליקציה צריכה להשתמש בספריות משלה כדי לקרוא לשירות הזה, צריך להשתמש במידע הבא כשמבצעים את בקשות ה-API.
מסמך Discovery
Discovery Document הוא מפרט שניתן לקריאה על ידי מכונה, שמתאר ומאפשר שימוש בממשקי API ל-REST. היא משמשת לבניית ספריות לקוח, תוספים ל-IDE וכלים אחרים שמתקשרים עם Google APIs. שירות אחד יכול לספק כמה מסמכי גילוי. השירות הזה מספק את מסמך הגילוי הבא:
נקודת קצה של שירות
נקודת קצה של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות API. לשירות אחד יכולות להיות כמה נקודות קצה של שירות. לשירות הזה יש נקודת קצה (endpoint) משלו, וכל כתובות ה-URI שבהמשך הן יחסיות לנקודת הקצה הזו:
https://gmailpostmastertools.googleapis.com
משאב REST: v2beta.domainStats
| Methods | |
|---|---|
batchQuery |
POST /v2beta/domainStats:batchQuery מבצע בקשות באצווה של QueryDomainStats עבור כמה דומיינים. |
משאב REST: v2beta.domains
| Methods | |
|---|---|
get |
GET /v2beta/{name=domains/*} אחזור מידע מפורט על דומיין שרשמתם. |
getComplianceStatus |
GET /v2beta/{name=domains/*/complianceStatus} מאחזר את סטטוס התאימות של דומיין נתון. |
list |
GET /v2beta/domains אחזור רשימה של כל הדומיינים שרשמתם, יחד עם המטא-נתונים התואמים שלהם. |
משאב REST: v2beta.domains.domainStats
| Methods | |
|---|---|
query |
POST /v2beta/{parent=domains/*}/domainStats:query מאחזר רשימה של נתונים סטטיסטיים של דומיין עבור דומיין ותקופת זמן נתונים. |