Method: userProfiles.checkUserCapability

Zwraca informację, czy użytkownik może korzystać z określonej funkcji Classroom. Za pomocą tego punktu końcowego można na przykład sprawdzić, czy użytkownik może tworzyć załączniki dodatków.

Użytkownik, który wysłał prośbę, może sprawdzić swoje możliwości tylko samodzielnie.

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

  • PERMISSION_DENIED, jeśli użytkownik wysyłający prośbę nie może sprawdzić, czy określony użytkownik spełnia wymagania.
  • INVALID_ARGUMENT, jeśli żądanie jest uszkodzone.

Żądanie HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{userId}:checkUserCapability

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
userId

string

Wymagane. Identyfikator użytkownika.

Ten identyfikator może być określony jako parametr żądania:

  • identyfikator liczbowy użytkownika;
  • adres e-mail użytkownika.
  • literał ciągu "me", który wskazuje użytkownika wysyłającego żądanie

Parametry zapytania

Parametry
capability

enum (Capability)

Wymagane. Umiejętność, którą należy zaznaczyć w przypadku tego użytkownika. Aby na przykład sprawdzić, czy użytkownik może utworzyć załącznik dodatku, ustaw tę opcję na CREATE_ADD_ON_ATTACHMENT.
previewVersion

enum (PreviewVersion)

Opcjonalnie: Wersja wstępna interfejsu API.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź z sprawdzaniem możliwości użytkownika

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "capability": enum (Capability),
  "allowed": boolean
}
Pola
capability

enum (Capability)

Funkcjonalność Classroom.
allowed

boolean

Określa, czy użytkownik ma dostęp do określonej funkcji.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

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

Możliwości

Wyliczenie reprezentujące umiejętność.

Wartości w polu enum
CAPABILITY_UNSPECIFIED Nieobsługiwane.
CREATE_ADD_ON_ATTACHMENT Umożliwianie tworzenia i modyfikowania załączników dodatków powiązanych z projektem w Konsoli deweloperów, którego identyfikator klienta OAuth został użyty do wysłania żądania.
UPDATE_GRADING_PERIOD_SETTINGS możliwość modyfikowania ustawień okresu oceniania.