Method: invitations.list

מחזירה רשימה של הזמנות שהמשתמש ששלח את הבקשה רשאי להציג, מוגבל להזמנות שתואמות לבקשת הרשימה.

הערה: יש לספק לפחות אחד מהערכים userId או courseId. אפשר לספק את שני השדות.

השיטה הזו מחזירה את קודי השגיאה הבאים:

בקשת HTTP

GET https://classroom.googleapis.com/v1/invitations

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

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

פרמטרים
userId

string

הגבלת הזמנות מוחזרות לאלה של משתמש מסוים. המזהה יכול להיות אחד מהבאים:

  • המזהה המספרי של המשתמש
  • כתובת האימייל של המשתמש
  • ליטרל המחרוזת "me", שמציין את המשתמש ששלח את הבקשה
courseId

string

הגבלת הזמנות מוחזרות לקורס עם המזהה שצוין.
pageSize

integer

מספר הפריטים המרבי להחזרה. אם לא צוין 0, ברירת המחדל היא 500.

השרת עשוי להחזיר פחות ממספר התוצאות שצוין.
pageToken

string

הערך nextPageToken הוחזר מקריאה קודמת של list. הערך מציין שצריך להחזיר את דף התוצאות הבא.

בכל מקרה אחר, הבקשה של list צריכה להיות זהה לבקשה שהובילה לאסימון הזה.

גוף הבקשה

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

גוף התגובה

תגובה במהלך הצגת ההזמנות.

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

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

object (Invitation)

הזמנות שתואמות לבקשת הרשימה.
nextPageToken

string

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

היקפי הרשאות

כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

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