Method: domains.trafficStats.list

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

בקשת HTTP

GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats

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

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

פרמטרים
parent

string

שם המשאב של הדומיין שרוצים להציג את נתוני התנועה שלו. הפורמט שלו צריך להיות domains/{domain_name}, כאשר domain_name הוא שם הדומיין המלא.

פרמטרים של שאילתה

פרמטרים
startDate

object (Date)

היום המוקדם ביותר של המדדים לאחזור, כולל. צריך לציין את startDate ואת endDate, או לא לציין אף אחד מהם. אם מצוין רק אחד מהם, או ש-endDate מוקדם יותר מ-startDate, המערכת מחזירה את הערך INVALID_ARGUMENT.
endDate

object (Date)

היום האחרון של המדדים לאחזור, באופן בלעדי. צריך לציין את startDate ואת endDate, או לא לציין אף אחד מהם. אם מצוין רק אחד מהם, או ש-endDate מוקדם יותר מ-startDate, המערכת מחזירה את הערך INVALID_ARGUMENT.
pageSize

integer

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

string

הערך של nextPageToken שהוחזר מבקשת List קודמת, אם יש כזו. זהו הערך של ListTrafficStatsResponse.next_page_token שהוחזר מהקריאה הקודמת לשיטה trafficStats.list.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

הודעת התגובה עבור trafficStats.list.

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

ייצוג ב-JSON 
{
  "trafficStats": [
    {
      object (TrafficStats)
    }
  ],
  "nextPageToken": string
}
שדות
trafficStats[]

object (TrafficStats)

רשימת TrafficStats.
nextPageToken

string

אסימון לאחזור של דף התוצאות הבא, או ריק אם אין יותר תוצאות ברשימה.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

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

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

תאריך

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

  • תאריך מלא, עם ערכים שאינם אפס לשנה, לחודש וליום.
  • חודש ויום, עם אפס בשנה (לדוגמה, יום נישואין).
  • שנה לבד, עם אפס חודש ואפס יום.
  • שנה וחודש, עם יום אפס (לדוגמה, תאריך תפוגת תוקף של כרטיס אשראי).

סוגים קשורים:

ייצוג ב-JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
שדות
year

integer

השנה של התאריך. חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך ללא שנה.
month

integer

החודש בשנה. הערך צריך להיות בין 1 ל-12, או 0 כדי לציין שנה ללא חודש ויום.
day

integer

היום בחודש. הערך חייב להיות בין 1 ל-31 ותקף לשנה ולחודש, או 0 כדי לציין שנה בלבד או שנה וחודש שבהם היום לא רלוונטי.