Method: alerts.list

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

בקשת HTTP

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

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

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

פרמטרים
customerId

string

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

integer

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

string

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

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