Method: userProfiles.guardians.get

Zwraca konkretnego opiekuna.

Ta metoda zwraca te kody błędów:

  • PERMISSION_DENIED jeśli użytkownik nie widzi żadnego użytkownika pasującego do podanego identyfikatora studentId, jeśli użytkownik nie ma uprawnień do wyświetlania informacji o opiekunie ucznia określonego przez studentId, jeśli opiekunowie nie są włączeni w danej domenie lub z innych błędów dostępu.
  • INVALID_ARGUMENT, jeśli podano wartość studentId, ale jej format nie może zostać rozpoznany (nie jest to adres e-mail, studentId z interfejsu API ani ciąg znaków me).
  • NOT_FOUND, jeśli użytkownik, który wysłał żądanie, ma uprawnienia do wyświetlania opiekunów dla studentId, ale dla tego ucznia nie ma rekordu Guardian, który pasuje do podanego identyfikatora guardianId.

Żądanie HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
studentId

string

Uczeń, którego opiekuna dotyczy prośba. Jedna z tych wartości:

  • identyfikator liczbowy użytkownika.
  • adres e-mail użytkownika.
  • ciąg znaków "me" wskazujący użytkownika, który wysłał żądanie;
guardianId

string

Pole id w elementach Guardian.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Guardian.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.