Add-on Google Classroom kini tersedia secara umum untuk developer. Lihat
dokumentasi add-on untuk informasi selengkapnya.
REST Resource: invitations
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Resource: Undangan
Undangan untuk bergabung ke kursus.
| Representasi JSON |
{
"id": string,
"userId": string,
"courseId": string,
"role": enum (CourseRole)
} |
| Kolom |
id |
string
ID yang ditetapkan oleh Classroom. Hanya baca.
|
userId |
string
ID pengguna yang diundang. Jika ditentukan sebagai parameter permintaan, ID ini dapat ditetapkan ke salah satu dari berikut:
- ID numerik untuk pengguna
- alamat email pengguna
- literal string
"me", yang menunjukkan pengguna yang meminta
|
courseId |
string
ID kursus yang akan diundang pengguna.
|
role |
enum (CourseRole)
Peran yang akan diberikan kepada pengguna yang diundang. Tidak boleh COURSE_ROLE_UNSPECIFIED.
|
CourseRole
Kemungkinan peran yang dapat diundang untuk dimiliki pengguna.
| Enum |
COURSE_ROLE_UNSPECIFIED |
Tidak ada peran kursus. |
STUDENT |
Siswa dalam kursus. |
TEACHER |
Pengajar kursus. |
OWNER |
Pemilik kursus. |
Metode |
|
|
Menerima undangan, menghapusnya, dan menambahkan pengguna yang diundang ke pengajar atau siswa (sebagaimana mestinya) dari kursus yang ditentukan. |
|
|
Membuat undangan. |
|
|
Menghapus undangan. |
|
|
Menampilkan undangan. |
|
|
Menampilkan daftar undangan yang diizinkan untuk dilihat oleh pengguna yang meminta, yang dibatasi untuk undangan yang cocok dengan permintaan daftar. |
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,["# REST Resource: invitations\n\n- [Resource: Invitation](#Invitation)\n - [JSON representation](#Invitation.SCHEMA_REPRESENTATION)\n- [CourseRole](#CourseRole)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Invitation\n--------------------\n\nAn invitation to join a course.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"userId\": string, \"courseId\": string, \"role\": enum (/workspace/classroom/reference/rest/v1/invitations#CourseRole) } ``` |\n\n| Fields ||\n|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Identifier assigned by Classroom. Read-only. |\n| `userId` | `string` Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to 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` Identifier of the course to invite the user to. |\n| `role` | `enum (`[CourseRole](/workspace/classroom/reference/rest/v1/invitations#CourseRole)`)` Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`. |\n\nCourseRole\n----------\n\nPossible roles a user may be invite to have.\n\n| Enums ||\n|---------------------------|------------------------|\n| `COURSE_ROLE_UNSPECIFIED` | No course role. |\n| `STUDENT` | Student in the course. |\n| `TEACHER` | Teacher of the course. |\n| `OWNER` | Owner of the course. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| ### [accept](/workspace/classroom/reference/rest/v1/invitations/accept) | Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. |\n| ### [create](/workspace/classroom/reference/rest/v1/invitations/create) | Creates an invitation. |\n| ### [delete](/workspace/classroom/reference/rest/v1/invitations/delete) | Deletes an invitation. |\n| ### [get](/workspace/classroom/reference/rest/v1/invitations/get) | Returns an invitation. |\n| ### [list](/workspace/classroom/reference/rest/v1/invitations/list) | Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. |"]]
