Method: courses.studentGroups.patch
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Aggiorna uno o più campi in un gruppo di studenti.Questo metodo restituisce i seguenti codici di errore:
PERMISSION_DENIED se l'utente richiedente non è autorizzato a modificare il gruppo di studenti richiesto o per errori di accesso.NOT_FOUND se il gruppo di studenti non esiste o l'utente non ha accesso al gruppo di studenti.INVALID_ARGUMENT se nella maschera di aggiornamento vengono specificati campi non validi o se non viene fornita alcuna maschera di aggiornamento.
Richiesta HTTP
PATCH https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{id}
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
| Parametri |
courseId |
string
Obbligatorio. L'identificatore del corso.
|
id |
string
Obbligatorio. Identificatore del gruppo di studenti.
|
Parametri di query
| Parametri |
updateMask |
string (FieldMask format)
Obbligatorio. Maschera che identifica i campi del gruppo di studenti da aggiornare. Questo campo è obbligatorio per eseguire un aggiornamento. L'aggiornamento non riesce se vengono specificati campi non validi. I seguenti campi possono essere specificati dagli insegnanti:
Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".
|
previewVersion |
enum (PreviewVersion)
Facoltativo. La versione di anteprima dell'endpoint. Questo valore deve essere impostato per accedere alle nuove funzionalità API rese disponibili agli sviluppatori nel programma di anteprima.
|
Corpo della richiesta
Il corpo della richiesta contiene un'istanza di StudentGroup.
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene un'istanza di StudentGroup.
Ambiti di autorizzazione
Richiede il seguente ambito OAuth:
https://www.googleapis.com/auth/classroom.rosters
Per ulteriori informazioni, consulta la Guida all'autorizzazione.
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-08-08 UTC.
[null,null,["Ultimo aggiornamento 2025-08-08 UTC."],[],[],null,["# Method: courses.studentGroups.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\n\u003cbr /\u003e\n\n| **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. This feature is available in [V1_20250630_PREVIEW](https://developers.google.com/workspace/classroom/reference/rest/v1/PreviewVersion) and later. See [Access Preview APIs](https://developers.google.com/workspace/classroom/reference/preview) to learn more.\nUpdates one or more fields in a student group.\n\n\u003cbr /\u003e\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested student group or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `NOT_FOUND` if the student group does not exist or the user does not have access to the student group.\n- `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied.\n\n### HTTP request\n\n`PATCH https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{id}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|-----------------------------------------------------|\n| `courseId` | `string` Required. Identifier of the course. |\n| `id` | `string` Required. Identifier of the student group. |\n\n### Query parameters\n\n| Parameters ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Required. Mask that identifies which fields on the student group to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields can be specified by teachers: - `title` This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n| `previewVersion` | `enum (`[PreviewVersion](/workspace/classroom/reference/rest/v1/PreviewVersion)`)` Optional. The endpoint preview version. This must be set in order to access new API capabilities made available to developers in the Preview Program. |\n\n### Request body\n\nThe request body contains an instance of [StudentGroup](/workspace/classroom/reference/rest/v1/courses.studentGroups#StudentGroup).\n\n### Response body\n\nIf successful, the response body contains an instance of [StudentGroup](/workspace/classroom/reference/rest/v1/courses.studentGroups#StudentGroup).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.rosters`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
