Method: invitations.list

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

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

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

בקשת HTTP

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

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

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

פרמטרים
userId

string

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

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

string

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

integer

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

יכול להיות שהשרת יחזיר פחות מהמספר שצוין של תוצאות.
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

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