Struktura błędów interfejsu Google Classroom API

Interfejs Classroom API zwraca informacje o błędach, które mogą pomóc programistom w debugowaniu problemów i przekazywaniu użytkownikom przydatnych informacji. Ten przewodnik wyjaśnia, jak analizować informacje o błędach zwracane przez interfejs API.

Interfejs Classroom API zwraca 2 poziomy informacji o błędach:

  • 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 symbolem @ i konkretnym typem błędu. Na przykład:@ClassroomApiDisabled.
  • status: stan żądania HTTP. Na przykład PERMISSION_DENIED lub NOT_FOUND.

Jeśli żądanie zakończyło się niepowodzeniem z błędem 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 debugować przyczynę błędu i przekazywać użytkownikom przydatne informacje. Podczas sprawdzania konkretnego komunikatu o błędzie dodaj na końcu spację, aby uniknąć dopasowania 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 message zaczyna się od znaku "@ClassroomApiDisabled ", aby wyświetlić użytkownikom odpowiednie informacje.

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

Dalej
Częste komunikaty o błędach