Add-on Google Classroom kini tersedia secara umum untuk developer. Lihat
dokumentasi add-on untuk informasi selengkapnya.
Method: courses.students.list
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Menampilkan daftar siswa mata pelajaran ini yang diizinkan untuk dilihat oleh pemohon.
Metode ini menampilkan kode error berikut:
NOT_FOUND jika kursus tidak ada.PERMISSION_DENIED untuk error akses.
Permintaan HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/students
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
| Parameter |
courseId |
string
ID kursus. ID ini dapat berupa ID yang ditetapkan Classroom atau alias.
|
Parameter kueri
| Parameter |
pageSize |
integer
Jumlah maksimum item yang akan ditampilkan. Nilai defaultnya adalah 30 jika tidak ditentukan atau 0. Server mungkin menampilkan lebih sedikit dari jumlah hasil yang ditentukan.
|
pageToken |
string
Nilai nextPageToken yang ditampilkan dari panggilan list sebelumnya, yang menunjukkan bahwa halaman hasil berikutnya harus ditampilkan. Permintaan list harus identik dengan permintaan yang menghasilkan token ini.
|
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Respons saat mencantumkan siswa.
Jika berhasil, isi respons memuat data dengan struktur berikut:
| Representasi JSON |
{
"students": [
{
object (Student)
}
],
"nextPageToken": string
} |
| Kolom |
students[] |
object (Student)
Siswa yang cocok dengan permintaan daftar.
|
nextPageToken |
string
Token yang mengidentifikasi halaman hasil berikutnya yang akan ditampilkan. Jika kosong, tidak ada hasil lebih lanjut yang tersedia.
|
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/classroom.rosters
https://www.googleapis.com/auth/classroom.rosters.readonly
https://www.googleapis.com/auth/classroom.profile.emails
https://www.googleapis.com/auth/classroom.profile.photos
Untuk informasi selengkapnya, lihat Panduan otorisasi.
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-25 UTC.
[null,null,["Terakhir diperbarui pada 2025-07-25 UTC."],[],[],null,["# Method: courses.students.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.ListStudentsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of students of this course that the requester is permitted to view.\n\nThis method returns the following error codes:\n\n- `NOT_FOUND` if the course does not exist.\n- `PERMISSION_DENIED` for [access errors](/workspace/classroom/reference/Access.Errors).\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/students`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` Identifier of the course. This identifier can be either the Classroom-assigned identifier or an [alias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias). |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/courses.students/list#body.ListStudentsResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/courses.students/list#google.classroom.v1.Users.ListStudents) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/courses.students/list#google.classroom.v1.Users.ListStudents) request must be otherwise identical to the one that resulted in this token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse when listing students.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"students\": [ { object (/workspace/classroom/reference/rest/v1/courses.students#Student) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------|\n| `students[]` | `object (`[Student](/workspace/classroom/reference/rest/v1/courses.students#Student)`)` Students who match the list request. |\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- `\n https://www.googleapis.com/auth/classroom.profile.emails`\n- `\n https://www.googleapis.com/auth/classroom.profile.photos`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
