Method: userProfiles.guardianInvitations.create

Tworzy zaproszenie dla opiekuna i wysyła do niego e-maila z prośbą o potwierdzenie, że jest opiekunem ucznia.

Gdy opiekun zaakceptuje zaproszenie, state zmieni się na COMPLETED i zacznie otrzymywać powiadomienia dla opiekunów. Zostanie też utworzony zasób Guardian, który będzie reprezentuje aktywnego opiekuna.

Obiekt żądania musi mieć ustawione pola studentId i invitedEmailAddress. Jeśli nie ustawisz tych pól lub innych pól w żądaniu, wyświetli się błąd.

Ta metoda zwraca następujące kody błędów:

  • PERMISSION_DENIED, jeśli obecny użytkownik nie ma uprawnień do zarządzania opiekunami, odrzucił już zbyt wiele próśb dotyczących tego ucznia, nie włączono opiekunów w danej domenie lub występują inne błędy dostępu.
  • RESOURCE_EXHAUSTED, jeśli uczeń lub opiekun przekroczył limit liczby linków dla opiekunów.
  • INVALID_ARGUMENT, jeśli adres e-mail opiekuna jest nieprawidłowy (na przykład jest za długi) lub nie można rozpoznać formatu legitymacji studenckiej (nie jest to adres e-mail ani userId z tego interfejsu API). Ten błąd jest też zwracany, jeśli ustawiono pola tylko do odczytu lub pole state ma wartość inną niż PENDING.
  • NOT_FOUND, jeśli przedstawiona legitymacja studencka jest ważna, ale w Classroom nie ma informacji o tym, kto jest uczniem.
  • ALREADY_EXISTS, jeśli istnieje już oczekujące zaproszenie opiekuna ucznia i invitedEmailAddress lub jeśli podane invitedEmailAddress odpowiada kontu Google istniejącego Guardian tego użytkownika.

Żądanie HTTP

POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
guardianInvitation.studentId

string

legitymacja ucznia (w formacie standardowym)

Treść żądania

Treść żądania zawiera wystąpienie elementu GuardianInvitation.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała nowo utworzoną instancję GuardianInvitation.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.