Obsługa błędów interfejsu Classroom API

Interfejs Classroom API zwraca informacje o błędach, które mogą pomóc deweloperom w debugowaniu problemów i dostarczaniu przydatnych informacji użytkownikom. 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 zawierający dodatkowe informacje.

Struktura komunikatu o błędzie

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

• code: numeryczny kod błędu HTTP. Na przykład: 403.
• message: dodatkowe informacje o błędzie. Jeśli to możliwe, komunikat o błędzie jest poprzedzony symbolem @ i określonym 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 debugować przyczynę błędu i przekazać użytkownikom przydatne informacje. Podczas sprawdzania konkretnego komunikatu o błędzie należy uwzględnić spacje na końcu, 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 wiadomości zaczyna się od "@ClassroomApiDisabled ", aby wyświetlać użytkownikom odpowiednie informacje.

Informacje o niektórych błędach, które mogą być zwracane przez interfejs Classroom API, znajdziesz na stronach błędów dostępu, błędów żądania i błędów dodatków.