Method: alerts.list

מפרט את ההתראות.

בקשת HTTP

GET https://alertcenter.googleapis.com/v1beta1/alerts

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

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

פרמטרים
customerId

string

אופציונלי. המזהה הייחודי של חשבון Google Workspace של הלקוח שההתראות משויכות אליו. בשדה customerId יש להסיר את האות "C" הראשונה (לדוגמה, 046psxkn). אם היא מסופקת, היא נגזרת מהזהות של המתקשר. איתור מספר הלקוח.
pageSize

integer

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

string

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

string

אופציונלי. מחרוזת שאילתה לסינון תוצאות ההתראה. מידע נוסף זמין במאמרים מסנני שאילתות ושדות נתמכים של שאילתות שאילתה.
orderBy

string

אופציונלי. סדר המיון של הרשימה. אם לא ציינת תוצאות, ניתן להחזיר אותן בסדר שרירותי. אפשר למיין את התוצאות בסדר יורד לפי חותמת הזמן של היצירה בעזרת orderBy="createTime desc". נכון לעכשיו, המיון הנתמך הוא createTime asc, createTime desc, updateTime desc

גוף הבקשה

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

גוף התשובה

הודעת תגובה לבקשה לרישום התראה.

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

ייצוג JSON 
{
  "alerts": [
    {
      object (Alert)
    }
  ],
  "nextPageToken": string
}
שדות
alerts[]

object (Alert)

רשימת ההתראות.
nextPageToken

string

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

היקפי הרשאה

נדרשת רמת OAuth הבאה:

  • https://www.googleapis.com/auth/apps.alerts

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