Method: domains.trafficStats.list

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

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

פרמטרים
parent

string

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

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

פרמטרים
startDate

object (Date)

היום הראשון של המדדים לאחזור הכללה. יש לציין תאריך התחלה ותאריך סיום, או לא לציין את שניהם. אם צוין רק אחד, או שהתאריך endDate מוקדם יותר מאשר startDate, אז מוחזר INVALID_XXXXX.
endDate

object (Date)

היום האחרון של המדדים לאחזור בלעדי. צריך לציין תאריך התחלה ותאריך סיום, או לא לציין את שניהם. אם צוין רק אחד, או שהתאריך endDate מוקדם יותר מאשר startDate, אז מוחזר INVALID_XXXXX.
pageSize

integer

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

string

הערך nextPageToken שהוחזר מבקשת רשימה קודמת, אם הייתה כזו. זהו הערך של 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 כדי לציין שנה בלבד או שנה וחודש שבהם היום לא משמעותי.