Method: courses.studentGroups.studentGroupMembers.list
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Restituisce un elenco di studenti in un gruppo.Questo metodo restituisce i seguenti codici di errore:
NOT_FOUND
se il corso o il gruppo di studenti non esiste.
Richiesta HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
Parametri |
courseId |
string
Obbligatorio. L'identificatore del corso.
|
studentGroupId |
string
Obbligatorio. L'identificatore del gruppo di studenti.
|
Parametri di query
Parametri |
pageSize |
integer
Il numero massimo di elementi da restituire. Il valore zero o non specificato indica che il server può assegnare un valore massimo. Il server potrebbe restituire un numero di risultati inferiore a quello specificato.
|
pageToken |
string
Valore nextPageToken restituito da una precedente chiamata list , che indica che deve essere restituita la pagina successiva dei risultati. La richiesta list deve essere identica a quella che ha generato questo token.
|
previewVersion |
enum (PreviewVersion )
Facoltativo. La versione di anteprima dell'API. 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 deve essere vuoto.
Corpo della risposta
Risposta quando vengono elencati gli studenti di un gruppo.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
{
"studentGroupMembers": [
{
object (StudentGroupMember )
}
],
"nextPageToken": string
} |
Campi |
studentGroupMembers[] |
object (StudentGroupMember )
I membri del gruppo di studenti.
|
nextPageToken |
string
Token che identifica la pagina successiva dei risultati da restituire. Se è vuoto, non sono disponibili altri risultati.
|
Ambiti di autorizzazione
Richiede uno dei seguenti ambiti OAuth:
https://www.googleapis.com/auth/classroom.rosters
https://www.googleapis.com/auth/classroom.rosters.readonly
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.studentGroupMembers.list\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 - [JSON representation](#body.ListStudentGroupMembersResponse.SCHEMA_REPRESENTATION)\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.\nReturns a list of students in a group.\n\n\u003cbr /\u003e\n\nThis method returns the following error codes:\n\n- `NOT_FOUND` if the course or student group does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------------|---------------------------------------------------------|\n| `courseId` | `string` Required. The identifier of the course. |\n| `studentGroupId` | `string` Required. The identifier of the student group. |\n\n### Query parameters\n\n| Parameters ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/courses.studentGroups.studentGroupMembers/list#body.ListStudentGroupMembersResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/courses.studentGroups.studentGroupMembers/list#google.classroom.v1.Courses.ListStudentGroupMembers) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/courses.studentGroups.studentGroupMembers/list#google.classroom.v1.Courses.ListStudentGroupMembers) request must be otherwise identical to the one that resulted in this token. |\n| `previewVersion` | `enum (`[PreviewVersion](/workspace/classroom/reference/rest/v1/PreviewVersion)`)` Optional. The preview version of the API. 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 must be empty.\n\n### Response body\n\nResponse when listing students in a group.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"studentGroupMembers\": [ { object (/workspace/classroom/reference/rest/v1/courses.studentGroups.studentGroupMembers#StudentGroupMember) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `studentGroupMembers[]` | `object (`[StudentGroupMember](/workspace/classroom/reference/rest/v1/courses.studentGroups.studentGroupMembers#StudentGroupMember)`)` The student group members. |\n| `nextPageToken` | `string` Token identifying the next page of results to return. If empty, no further results are available. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.rosters`\n- `\n https://www.googleapis.com/auth/classroom.rosters.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]