Method: domainStats.batchQuery

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

בקשת HTTP

POST https://gmailpostmastertools.googleapis.com/v2beta/domainStats:batchQuery

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

גוף הבקשה

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

ייצוג ב-JSON 
{
  "requests": [
    {
      object (QueryDomainStatsRequest)
    }
  ]
}
שדות
requests[]

object (QueryDomainStatsRequest)

חובה. רשימה של בקשות שאילתה ספציפיות. כל בקשה יכולה להיות לדומיין אחר. אפשר לכלול עד 100 בקשות באצווה אחת.

גוף התשובה

הודעת התגובה ל-domainStats.batchQuery.

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

ייצוג ב-JSON 
{
  "results": [
    {
      object (BatchQueryDomainStatsResult)
    }
  ]
}
שדות
results[]

object (BatchQueryDomainStatsResult)

רשימת תשובות, אחת לכל שאילתה ב-BatchQueryDomainStatsRequest. סדר התשובות יהיה זהה לסדר הבקשות.

היקפי הרשאה

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

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

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

QueryDomainStatsRequest

הודעת בקשה ל-QueryDomainStats.

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

string

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

object (MetricDefinition)

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

object (TimeQuery)

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

integer

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

string

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

enum (AggregationGranularity)

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

BatchQueryDomainStatsResult

מייצג את התוצאה של QueryDomainStatsRequest יחיד באצווה.

ייצוג ב-JSON 
{

  // Union field result can be only one of the following:
  "response": {
    object (QueryDomainStatsResponse)
  },
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
שדות
שדה איחוד result. התוצאה של השאילתה הספציפית. הערך result יכול להיות רק אחד מהבאים:
response

object (QueryDomainStatsResponse)

התגובה שמתקבלת אם השאילתה הספציפית מצליחה.
error

object (Status)

סטטוס השגיאה אם השאילתה הספציפית נכשלה.

סטטוס

הסוג Status מגדיר מודל שגיאות לוגי שמתאים לסביבות תכנות שונות, כולל ממשקי API ל-REST ול-RPC. היא משמשת את gRPC. כל הודעת Status מכילה שלושה חלקי נתונים: קוד שגיאה, הודעת שגיאה ופרטי שגיאה.

מידע נוסף על מודל השגיאות הזה ועל אופן השימוש בו זמין ב-API Design Guide.

ייצוג ב-JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
שדות
code

integer

קוד הסטטוס, שצריך להיות ערך enum של google.rpc.Code.
message

string

הודעת שגיאה שמוצגת למפתחים, שצריכה להיות באנגלית. כל הודעת שגיאה שמוצגת למשתמש צריכה להיות מותאמת לשפה המקומית ולהישלח בשדה google.rpc.Status.details, או להיות מותאמת לשפה המקומית על ידי הלקוח.
details[]

object

רשימה של הודעות שכוללות את פרטי השגיאה. יש קבוצה משותפת של סוגי הודעות לשימוש בממשקי API.