Struktur error Google Classroom API

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 dalam isi respons dengan detail tambahan.

Struktur pesan error

Error yang ditampilkan dalam isi respons mencakup kolom berikut:

• code: Kode error HTTP numerik. Misalnya, 403.
• message: Detail tambahan tentang error. Jika tersedia, pesan error akan 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 akan berbunyi:

{
  "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 men-debug penyebab error dan memberikan informasi yang bermanfaat kepada pengguna. Sertakan spasi di akhir saat memeriksa pesan error tertentu untuk menghindari pencocokan nilai lain yang dimulai dengan string yang sama. Pada contoh error yang diberikan, Anda dapat memeriksa apakah kolom pesan dimulai dengan "@ClassroomApiDisabled " untuk menampilkan informasi yang sesuai kepada pengguna.

Lihat halaman Error umum untuk mengetahui informasi tentang beberapa error yang dapat ditampilkan oleh Classroom API.