Verwaltet Kurse, Teilnehmerlisten und Einladungen in Google Classroom.
- REST-Ressource: v1.courses
- REST-Ressource: v1.courses.aliases
- REST-Ressource: v1.courses.announcements
- REST-Ressource: v1.courses.announcements.addOnAttachments
- REST-Ressource: v1.courses.courseWork
- REST-Ressource: v1.courses.courseWork.addOnAttachments
- REST-Ressource: v1.courses.courseWork.addOnAttachments.studentSubmissions
- REST-Ressource: v1.courses.courseWork.rubrics
- REST-Ressource: v1.courses.courseWork.studentSubmissions
- REST-Ressource: v1.courses.courseWorkMaterials
- REST-Ressource: v1.courses.courseWorkMaterials.addOnAttachments
- REST-Ressource: v1.courses.posts
- REST-Ressource: v1.courses.posts.addOnAttachments
- REST-Ressource: v1.courses.posts.addOnAttachments.studentSubmissions
- REST-Ressource: v1.courses.students
- REST-Ressource: v1.courses.teachers
- REST-Ressource: v1.courses.topics
- REST-Ressource: v1.invitations
- REST-Ressource: v1.registrations
- REST-Ressource: v1.userProfiles
- REST-Ressource: v1.userProfiles.guardianInvitations
- REST-Ressource: v1.userProfiles.guardians
Dienst: classroom.googleapis.com
Zum Aufrufen dieses Dienstes empfehlen wir die Verwendung der von Google bereitgestellten Clientbibliotheken. Wenn Ihre Anwendung Ihre eigenen Bibliotheken zum Aufrufen dieses Dienstes verwenden muss, verwenden Sie bei den API-Anfragen die folgenden Informationen.
Discovery-Dokument
Ein Discovery-Dokument ist eine maschinenlesbare Spezifikation zum Beschreiben und Nutzen von REST APIs. Sie wird verwendet, um Clientbibliotheken, IDE-Plug-ins und andere Tools zu erstellen, die mit Google APIs interagieren. Ein Dienst kann mehrere Discovery-Dokumente haben. Der Dienst bietet das folgende Discovery-Dokument:
Dienstendpunkt
Ein Dienstendpunkt ist eine Basis-URL, die die Netzwerkadresse eines API-Dienstes angibt. Ein Dienst kann mehrere Dienstendpunkte haben. Dieser Dienst hat den folgenden Dienstendpunkt und alle nachstehenden URIs beziehen sich auf ihn:
https://classroom.googleapis.com
REST-Ressource: v1.courses
Methoden | |
---|---|
checkAddOnCreationEligibility |
GET /v1/courses/{courseId}:checkAddOnCreationEligibility Gibt zurück, ob ein Nutzer in einem bestimmten Kurs Add-on-Anhänge erstellen darf. |
checkGradingPeriodsSetupEligibility |
GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility Gibt zurück, ob ein Nutzer „GradingPeriodSettings“ in einem bestimmten Kurs aktualisieren kann. |
create |
POST /v1/courses Erstellt einen Kurs. |
delete |
DELETE /v1/courses/{id} Löscht einen Kurs. |
get |
GET /v1/courses/{id} Gibt einen Kurs zurück. |
getGradingPeriodSettings |
GET /v1/courses/{courseId}/gradingPeriodSettings Gibt die Einstellungen für den Benotungszeitraum in einem Kurs zurück. |
list |
GET /v1/courses Gibt eine Liste der Kurse zurück, die der anfragende Nutzer ansehen darf, beschränkt auf die Kurse, die der Anfrage entsprechen. |
patch |
PATCH /v1/courses/{id} Aktualisiert ein oder mehrere Felder in einem Kurs. |
update |
PUT /v1/courses/{id} Aktualisiert einen Kurs. |
updateGradingPeriodSettings |
PATCH /v1/courses/{courseId}/gradingPeriodSettings Aktualisiert die Einstellungen für den Benotungszeitraum eines Kurses. |
REST-Ressource: v1.courses.aliases
Methoden | |
---|---|
create |
POST /v1/courses/{courseId}/aliases Erstellt einen Alias für einen Kurs. |
delete |
DELETE /v1/courses/{courseId}/aliases/{alias} Löscht den Alias eines Kurses. |
list |
GET /v1/courses/{courseId}/aliases Gibt eine Liste der Aliasse für einen Kurs zurück. |
REST-Ressource: v1.courses.announcements
Methoden | |
---|---|
create |
POST /v1/courses/{courseId}/announcements Erstellt eine Ankündigung. |
delete |
DELETE /v1/courses/{courseId}/announcements/{id} Löscht eine Ankündigung. |
get |
GET /v1/courses/{courseId}/announcements/{id} Gibt eine Mitteilung zurück. |
getAddOnContext |
GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext Ruft Metadaten für Classroom-Add-ons im Kontext eines bestimmten Beitrags ab. |
list |
GET /v1/courses/{courseId}/announcements Gibt eine Liste der Mitteilungen zurück, die der Anforderer sehen darf. |
modifyAssignees |
POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees Ändert den Modus der zuständigen Person und die Optionen einer Ankündigung. |
patch |
PATCH /v1/courses/{courseId}/announcements/{id} Aktualisiert ein oder mehrere Felder einer Mitteilung. |
REST-Ressource: v1.courses.announcements.addOnAttachments
Methoden | |
---|---|
create |
POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments Erstellt einen Add-on-Anhang unter einem Beitrag. |
delete |
DELETE /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId} Löscht einen Add-on-Anhang. |
get |
GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId} Gibt einen Add-on-Anhang zurück. |
list |
GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments Gibt alle Anhänge zurück, die von einem Add-on unter dem Beitrag erstellt wurden |
patch |
PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId} Aktualisiert einen Add-on-Anhang. |
REST-Ressource: v1.courses.courseWork
Methoden | |
---|---|
create |
POST /v1/courses/{courseId}/courseWork Erstellt Kursarbeiten. |
delete |
DELETE /v1/courses/{courseId}/courseWork/{id} Löscht eine Kursaufgabe. |
get |
GET /v1/courses/{courseId}/courseWork/{id} Gibt die Kursaufgabe zurück. |
getAddOnContext |
GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext Ruft Metadaten für Classroom-Add-ons im Kontext eines bestimmten Beitrags ab. |
list |
GET /v1/courses/{courseId}/courseWork Gibt eine Liste der Kursarbeiten zurück, die der Anforderer ansehen darf. |
modifyAssignees |
POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees Ändert den Modus für die Zuständige und die Optionen einer Kursaufgabe. |
patch |
PATCH /v1/courses/{courseId}/courseWork/{id} Aktualisiert ein oder mehrere Felder einer Kursaufgabe. |
REST-Ressource: v1.courses.courseWork.addOnAttachments
Methoden | |
---|---|
create |
POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments Erstellt einen Add-on-Anhang unter einem Beitrag. |
delete |
DELETE /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId} Löscht einen Add-on-Anhang. |
get |
GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId} Gibt einen Add-on-Anhang zurück. |
list |
GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments Gibt alle Anhänge zurück, die von einem Add-on unter dem Beitrag erstellt wurden |
patch |
PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId} Aktualisiert einen Add-on-Anhang. |
REST-Ressource: v1.courses.courseWork.addOnAttachments.studentSubmissions
Methoden | |
---|---|
get |
GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId} Gibt die abgegebene Aufgabe eines Schülers/Studenten für einen Add-on-Anhang zurück. |
patch |
PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId} Aktualisiert die Daten, die mit einem eingereichten Add-on-Anhang verknüpft sind. |
REST-Ressource: v1.courses.courseWork.rubrics
Methoden | |
---|---|
create |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics Ein Bewertungsschema wird erstellt. |
delete |
DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id} Löscht ein Bewertungsschema. |
get |
GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id} Gibt ein Bewertungsschema zurück. |
list |
GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics Gibt eine Liste von Bewertungsschemas zurück, die der Anforderer aufrufen darf. |
patch |
PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id} Ein Bewertungsschema wird aktualisiert. |
REST-Ressource: v1.courses.courseWork.studentSubmissions
Methoden | |
---|---|
get |
GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id} Gibt die abgegebene Aufgabe eines Schülers/Studenten zurück. |
list |
GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions Gibt eine Liste der abgegebenen Aufgaben von Schülern/Studenten zurück, die der Anforderer ansehen darf. Dabei werden die OAuth-Bereiche der Anfrage berücksichtigt. |
modifyAttachments |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments Ändert Anhänge von abgegebenen Aufgaben von Schülern/Studenten. |
patch |
PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id} Aktualisiert ein oder mehrere Felder einer abgegebenen Aufgabe eines Schülers/Studenten. |
reclaim |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim Fordert die Aufgabe eines Schülers/Studenten im Namen des Schülers/Studenten zurück. |
return |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return Gibt die abgegebene Aufgabe eines Schülers/Studenten zurück. |
turnIn |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn Die Aufgabe eines Schülers/Studenten wird abgegeben. |
REST-Ressource: v1.courses.courseWorkMaterials
Methoden | |
---|---|
create |
POST /v1/courses/{courseId}/courseWorkMaterials Erstellt ein Arbeitsmaterial zum Kurs. |
delete |
DELETE /v1/courses/{courseId}/courseWorkMaterials/{id} Löscht ein Arbeitsmaterial. |
get |
GET /v1/courses/{courseId}/courseWorkMaterials/{id} Gibt ein Arbeitsmaterial zurück. |
getAddOnContext |
GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext Ruft Metadaten für Classroom-Add-ons im Kontext eines bestimmten Beitrags ab. |
list |
GET /v1/courses/{courseId}/courseWorkMaterials Gibt eine Liste von Kursarbeiten zurück, die der Anforderer ansehen darf. |
patch |
PATCH /v1/courses/{courseId}/courseWorkMaterials/{id} Aktualisiert mindestens ein Feld eines Kursarbeitsmaterials. |
REST-Ressource: v1.courses.courseWorkMaterials.addOnAttachments
Methoden | |
---|---|
create |
POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments Erstellt einen Add-on-Anhang unter einem Beitrag. |
delete |
DELETE /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId} Löscht einen Add-on-Anhang. |
get |
GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId} Gibt einen Add-on-Anhang zurück. |
list |
GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments Gibt alle Anhänge zurück, die von einem Add-on unter dem Beitrag erstellt wurden |
patch |
PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId} Aktualisiert einen Add-on-Anhang. |
REST-Ressource: v1.courses.posts
Methoden | |
---|---|
getAddOnContext |
GET /v1/courses/{courseId}/posts/{postId}/addOnContext Ruft Metadaten für Classroom-Add-ons im Kontext eines bestimmten Beitrags ab. |
REST-Ressource: v1.courses.posts.addOnAttachments
Methoden | |
---|---|
create |
POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments Erstellt einen Add-on-Anhang unter einem Beitrag. |
delete |
DELETE /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId} Löscht einen Add-on-Anhang. |
get |
GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId} Gibt einen Add-on-Anhang zurück. |
list |
GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments Gibt alle Anhänge zurück, die von einem Add-on unter dem Beitrag erstellt wurden |
patch |
PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId} Aktualisiert einen Add-on-Anhang. |
REST-Ressource: v1.courses.posts.addOnAttachments.studentSubmissions
Methoden | |
---|---|
get |
GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId} Gibt die abgegebene Aufgabe eines Schülers/Studenten für einen Add-on-Anhang zurück. |
patch |
PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId} Aktualisiert die Daten, die mit einem eingereichten Add-on-Anhang verknüpft sind. |
REST-Ressource: v1.courses.students
Methoden | |
---|---|
create |
POST /v1/courses/{courseId}/students Fügt einen Nutzer als Teilnehmer eines Kurses hinzu. |
delete |
DELETE /v1/courses/{courseId}/students/{userId} Löscht einen Teilnehmer eines Kurses. |
get |
GET /v1/courses/{courseId}/students/{userId} Gibt den Teilnehmer eines Kurses zurück. |
list |
GET /v1/courses/{courseId}/students Gibt eine Liste der Teilnehmer dieses Kurses zurück, die der Anforderer aufrufen darf. |
REST-Ressource: v1.courses.teachers
Methoden | |
---|---|
create |
POST /v1/courses/{courseId}/teachers Erstellt die Lehrkraft eines Kurses. |
delete |
DELETE /v1/courses/{courseId}/teachers/{userId} Entfernt die angegebene Lehrkraft aus dem angegebenen Kurs. |
get |
GET /v1/courses/{courseId}/teachers/{userId} Gibt die Lehrkraft eines Kurses zurück. |
list |
GET /v1/courses/{courseId}/teachers Gibt eine Liste der Lehrkräfte dieses Kurses zurück, die der Anforderer aufrufen darf. |
REST-Ressource: v1.courses.topics
Methoden | |
---|---|
create |
POST /v1/courses/{courseId}/topics Erstellt ein Thema. |
delete |
DELETE /v1/courses/{courseId}/topics/{id} Löscht ein Thema. |
get |
GET /v1/courses/{courseId}/topics/{id} Gibt ein Thema zurück. |
list |
GET /v1/courses/{courseId}/topics Gibt die Liste der Themen zurück, die der Anforderer aufrufen darf. |
patch |
PATCH /v1/courses/{courseId}/topics/{id} Aktualisiert ein oder mehrere Felder eines Themas. |
REST-Ressource: v1.invitations
Methoden | |
---|---|
accept |
POST /v1/invitations/{id}:accept Nimmt eine Einladung an, wird sie entfernt und der eingeladene Nutzer wird den Lehrkräften bzw. Schülern oder Studenten des angegebenen Kurses hinzugefügt. |
create |
POST /v1/invitations Erstellt eine Einladung. |
delete |
DELETE /v1/invitations/{id} Löscht eine Einladung. |
get |
GET /v1/invitations/{id} Gibt eine Einladung zurück. |
list |
GET /v1/invitations Gibt eine Liste der Einladungen zurück, die der anfragende Nutzer ansehen darf, beschränkt auf die Einladungen, die der Listenanfrage entsprechen. |
REST-Ressource: v1.registrations
Methoden | |
---|---|
create |
POST /v1/registrations Erstellt eine Registration , sodass Classroom beginnt, Benachrichtigungen von der angegebenen feed an das in cloudPubSubTopic angegebene Ziel zu senden. |
delete |
DELETE /v1/registrations/{registrationId} Löscht eine Registration , sodass Classroom keine Benachrichtigungen für diese Registration mehr sendet. |
REST-Ressource: v1.userProfiles
Methoden | |
---|---|
get |
GET /v1/userProfiles/{userId} Gibt ein Nutzerprofil zurück. |
REST-Ressource: v1.userProfiles.guardianInvitations
Methoden | |
---|---|
create |
POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations Erstellt eine Einladung für einen Erziehungsberechtigten und sendet eine E-Mail an ihn, in der er gebeten wird, zu bestätigen, dass es sich um einen Erziehungsberechtigten des Schülers handelt. |
get |
GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId} Gibt eine bestimmte Einladung für einen Erziehungsberechtigten zurück. |
list |
GET /v1/userProfiles/{studentId}/guardianInvitations Gibt eine Liste der Einladungen für Erziehungsberechtigte zurück, die der anfragende Nutzer ansehen darf, gefiltert nach den angegebenen Parametern. |
patch |
PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId} Ändert die Einladung für einen Erziehungsberechtigten. |
REST-Ressource: v1.userProfiles.guardians
Methoden | |
---|---|
delete |
DELETE /v1/userProfiles/{studentId}/guardians/{guardianId} Löscht einen Erziehungsberechtigten. |
get |
GET /v1/userProfiles/{studentId}/guardians/{guardianId} Gibt einen bestimmten Erziehungsberechtigten zurück. |
list |
GET /v1/userProfiles/{studentId}/guardians Gibt eine Liste der Erziehungsberechtigten zurück, die der anfragende Nutzer sehen darf, beschränkt auf die Erziehungsberechtigten, die der Anfrage entsprechen. |