Method: domains.domainStats.query

מאחזר רשימה של נתונים סטטיסטיים של דומיין עבור דומיין ותקופת זמן נתונים. הפונקציה מחזירה PERMISSION_DENIED אם אין לכם הרשאה לגשת ל-DomainStats עבור הדומיין.

בקשת HTTP

POST https://gmailpostmastertools.googleapis.com/v2beta/{parent=domains/*}/domainStats:query

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם משאב האב שבו מתבצעת השאילתה לגבי הנתונים הסטטיסטיים. פורמט: domains/{domain}

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
שדות
metricDefinitions[]

object (MetricDefinition)

חובה. המדדים הספציפיים לשאילתה. אפשר להגדיר שם מותאם אישית לכל מדד, והשם הזה ישמש בתגובה.
timeQuery

object (TimeQuery)

חובה. טווח הזמן או התאריכים הספציפיים שרוצים לאחזר לגביהם את המדדים.
pageSize

integer

אופציונלי. מספר המשאבים המקסימלי מסוג DomainStats שיוחזרו בתשובה. יכול להיות שהשרת יחזיר פחות מהערך הזה. אם לא צוין ערך, המערכת תשתמש בערך ברירת המחדל 10. הערך המקסימלי הוא 200.
pageToken

string

אופציונלי. הערך של nextPageToken שמוחזר מבקשת List קודמת, אם יש כזה. אם רמת הגרנולריות של הצבירה היא DAILY, טוקן הדף יהיה התאריך המקודד + '/' + שם המדד. אם רמת הפירוט של הצבירה היא OVERALL, טוקן הדף יהיה שם המדד המקודד.
aggregationGranularity

enum (AggregationGranularity)

אופציונלי. רמת הפירוט שבה יצטברו הנתונים הסטטיסטיים. אם לא מציינים ערך, ברירת המחדל היא DAILY.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של QueryDomainStatsResponse.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/postmaster
  • https://www.googleapis.com/auth/postmaster.traffic.readonly

מידע נוסף זמין במדריך ההרשאות.