Struktura błędów interfejsu Google Classroom API

Classroom API zwraca informacje o błędach, które mogą pomóc deweloperom w debugowaniu problemów i przekazywaniu użytkownikom końcowym przydatnych informacji, które można wykorzystać. Ten przewodnik wyjaśnia, jak analizować informacje o błędach zwracane przez API.

Classroom API zwraca informacje o błędach na 2 poziomach:

  • kod błędu HTTP w nagłówku;
  • obiekt w treści odpowiedzi z dodatkowymi szczegółami.

Struktura komunikatu o błędzie

Błędy zwracane w treści odpowiedzi zawierają te pola:

  • code: numeryczny kod błędu HTTP. Na przykład 403.
  • message: dodatkowe informacje o błędzie. Jeśli jest dostępny, komunikat o błędzie jest poprzedzony znakiem @ i konkretnym typem błędu. Na przykład @ClassroomApiDisabled.
  • status: stan żądania HTTP. Na przykład PERMISSION_DENIED lub NOT_FOUND.

Jeśli żądanie nie powiedzie się z powodu błędu ClassroomApiDisabled, odpowiedź będzie wyglądać tak:

{
  "error": {
    "code": 403,
    "message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
    "status": "PERMISSION_DENIED"
  }
}

Możesz użyć treści odpowiedzi, aby pomóc w debugowaniu przyczyny błędu i przekazywaniu użytkownikom przydatnych informacji. Podczas sprawdzania konkretnego komunikatu o błędzie dodaj na końcu spację, aby uniknąć dopasowania do innych wartości, które zaczynają się od tego samego ciągu znaków. W podanym przykładzie błędu możesz sprawdzić, czy pole wiadomości zaczyna się od "@ClassroomApiDisabled " , aby wyświetlić użytkownikom odpowiednie informacje.

Informacje o niektórych błędach, które mogą być zwracane przez Classroom API, znajdziesz na stronie Typowe błędy.

Dalej
Częste komunikaty o błędach