Add-on Google Classroom kini tersedia secara umum untuk developer. Lihat
dokumentasi add-on untuk informasi selengkapnya.
Method: invitations.list
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Menampilkan daftar undangan yang diizinkan untuk dilihat oleh pengguna yang meminta, yang dibatasi untuk undangan yang cocok dengan permintaan daftar.
Catatan: Setidaknya salah satu dari userId atau courseId harus diberikan. Kedua kolom dapat diberikan.
Metode ini menampilkan kode error berikut:
Permintaan HTTP
GET https://classroom.googleapis.com/v1/invitations
URL menggunakan sintaksis gRPC Transcoding.
Parameter kueri
| Parameter |
userId |
string
Membatasi undangan yang ditampilkan hanya untuk pengguna tertentu. ID dapat berupa salah satu dari hal berikut:
- ID numerik untuk pengguna
- alamat email pengguna
- literal string
"me", yang menunjukkan pengguna yang meminta
|
courseId |
string
Membatasi undangan yang ditampilkan untuk undangan kursus dengan ID yang ditentukan.
|
pageSize |
integer
Jumlah maksimum item yang akan ditampilkan. Nilai defaultnya adalah 500 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 undangan.
Jika berhasil, isi respons memuat data dengan struktur berikut:
| Representasi JSON |
{
"invitations": [
{
object (Invitation)
}
],
"nextPageToken": string
} |
| Kolom |
invitations[] |
object (Invitation)
Undangan 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
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: invitations.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListInvitationsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request.\n\n*Note:* At least one of `userId` or `courseId` must be supplied. Both fields can be supplied.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` for [access errors](/workspace/classroom/reference/Access.Errors).\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/invitations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `userId` | `string` Restricts returned invitations to those for a specific user. The identifier can be one of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user |\n| `courseId` | `string` Restricts returned invitations to those for a course with the specified identifier. |\n| `pageSize` | `integer` Maximum number of items to return. The default is 500 if unspecified or `0`. The server may return fewer than the specified number of results. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/invitations/list#body.ListInvitationsResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/invitations/list#google.classroom.v1.Invitations.ListInvitations) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/invitations/list#google.classroom.v1.Invitations.ListInvitations) 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 invitations.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"invitations\": [ { object (/workspace/classroom/reference/rest/v1/invitations#Invitation) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `invitations[]` | `object (`[Invitation](/workspace/classroom/reference/rest/v1/invitations#Invitation)`)` Invitations that 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\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
