Add-on Google Classroom kini tersedia secara umum untuk developer. Lihat
dokumentasi add-on untuk informasi selengkapnya.
Struktur error Google Classroom API
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Classroom API menampilkan informasi error yang dapat membantu developer men-debug masalah dan memberikan informasi yang berguna dan dapat ditindaklanjuti kepada pengguna akhir. Panduan ini menjelaskan cara mengurai informasi error yang ditampilkan dari API.
Classroom API menampilkan dua tingkat informasi error:
- Kode error HTTP di header.
- Objek di isi respons dengan detail tambahan.
Struktur pesan error
Error yang ditampilkan di isi respons mencakup kolom berikut:
code: Kode error HTTP numerik. Misalnya, 403.message: Detail tambahan tentang error. Jika tersedia, pesan
error diawali dengan @ dan jenis error tertentu. Contohnya,
@ClassroomApiDisabled.status: Status permintaan HTTP. Misalnya, PERMISSION_DENIED atau NOT_FOUND.
Jika permintaan gagal dengan error ClassroomApiDisabled, responsnya adalah:
{
"error": {
"code": 403,
"message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
"status": "PERMISSION_DENIED"
}
}
Anda dapat menggunakan isi respons untuk membantu Anda men-debug penyebab error dan memberikan informasi yang bermanfaat kepada pengguna. Sertakan spasi di akhir saat memeriksa pesan error tertentu untuk menghindari pencocokan dengan nilai lain yang dimulai dengan string yang sama. Dalam contoh error yang diberikan, Anda dapat memeriksa apakah kolom pesan diawali dengan "@ClassroomApiDisabled " untuk menyajikan informasi yang sesuai kepada pengguna.
Lihat halaman Error umum untuk mengetahui informasi tentang beberapa error yang dapat ditampilkan oleh Classroom API.
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-08-29 UTC.
[null,null,["Terakhir diperbarui pada 2025-08-29 UTC."],[],[],null,["# Google Classroom API error structure\n\nThe Classroom API returns error information that can help developers\ndebug issues and provide helpful, actionable information to end users. This\nguide explains how to parse error information returned from the API.\n\nThe Classroom API returns two levels of error information:\n\n- HTTP error code in the header.\n- An object in the response body with additional details.\n\nError message structure\n-----------------------\n\nErrors returned in the response body include the following fields:\n\n- `code`: The numerical HTTP error code. For example, `403`.\n- `message`: Additional details about the error. When available, the error message is prepended with `@` and a specific error type. For example, `@ClassroomApiDisabled`.\n- `status`: The HTTP request status. For example, `PERMISSION_DENIED` or `NOT_FOUND`.\n\nIf a request failed with a [`ClassroomApiDisabled`](/workspace/classroom/troubleshooting/common-errors#classroom-api-disabled) error, the response would\nbe: \n\n {\n \"error\": {\n \"code\": 403,\n \"message\": \"@ClassroomApiDisabled The user is not permitted to access the Classroom API.\",\n \"status\": \"PERMISSION_DENIED\"\n }\n }\n\nYou can use the response body to help you debug the cause of the error and\nprovide helpful information to users. Include a trailing space when checking\nfor a specific error message to avoid matching other values that start with\nthe same string. In the provided error example, you can check if the message\nfield begins with `\"@ClassroomApiDisabled \"` to present appropriate information\nto users.\n\nReference the [Common errors](/workspace/classroom/troubleshooting/common-errors) page for information on some errors that\ncan be returned by the Classroom API."]]
