Method: courses.studentGroups.patch

מעדכן שדה אחד או יותר בקבוצת תלמידים.

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

  • ‫PERMISSION_DENIED אם למשתמש ששולח את הבקשה אין הרשאה לשנות את קבוצת התלמידים המבוקשת או אם יש שגיאות גישה.
  • ‫NOT_FOUND אם קבוצת התלמידים לא קיימת או שלמשתמש אין גישה לקבוצת התלמידים.
  • INVALID_ARGUMENT אם צוינו שדות לא חוקיים במסכת העדכון או אם לא סופקה מסכת עדכון.

בקשת HTTP

PATCH https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{id}

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

פרמטרים של נתיב

פרמטרים
courseId

string

חובה. מזהה הקורס.
id

string

חובה. מזהה של קבוצת התלמידים.

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

פרמטרים
updateMask

string (FieldMask format)

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

המורים יכולים לציין את השדות הבאים:

  • title

זוהי רשימה של שמות שדות שמוגדרים במלואם, שמופרדים באמצעות פסיקים. דוגמה: "user.displayName,photo"
previewVersion

enum (PreviewVersion)

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

גוף הבקשה

גוף הבקשה מכיל מופע של StudentGroup.

גוף התשובה

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

היקפי הרשאה

נדרש היקף ההרשאות הבא של OAuth:

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

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