Method: alerts.list

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

בקשת HTTP

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

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

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

פרמטרים
customerId

string

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

integer

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

string

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

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