Method: invitations.list

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

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

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של 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

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