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
Wir empfehlen, die von Google bereitgestellten Clientbibliotheken zu verwenden, um diesen Dienst aufzurufen. Wenn Ihre Anwendung zum Aufrufen dieses Dienstes Ihre eigenen Bibliotheken verwenden muss, verwenden Sie die folgenden Informationen für die API-Anfragen.
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 an, ob ein Nutzer Add-on-Anhänge in einem bestimmten Kurs erstellen darf. |
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. |
list |
GET /v1/courses Gibt eine Liste der Kurse zurück, die der anfragende Nutzer ansehen darf, beschränkt auf die Kurse, die mit der Anfrage übereinstimmen. |
patch |
PATCH /v1/courses/{id} Aktualisiert ein oder mehrere Felder in einem Kurs. |
update |
PUT /v1/courses/{id} Aktualisiert einen Kurs. |
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 einen 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 Ankündigungen zurück, die der Anforderer ansehen darf. |
modifyAssignees |
POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees Ändert den Modus für die zuständige Person und die Optionen einer Ankündigung. |
patch |
PATCH /v1/courses/{courseId}/announcements/{id} Aktualisiert ein oder mehrere Felder einer Ankündigung. |
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 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 oder Studenten für einen Add-on-Anhang zurück. |
patch |
PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId} Aktualisiert Daten, die mit einem abgegebenen Add-on-Anhang verknüpft sind. |
REST-Ressource: v1.courses.courseWork.rubrics
Methoden | |
---|---|
create |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics Erstellt ein Bewertungsschema. |
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 Antragsteller aufrufen darf. |
patch |
PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id} Aktualisiert ein Bewertungsschema. |
REST-Ressource: v1.courses.courseWork.studentSubmissions
Methoden | |
---|---|
get |
GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id} Gibt die von einem Schüler oder Studenten eingereichte Aufgabe zurück. |
list |
GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions Gibt eine Liste der Aufgaben von Schülern oder Studenten zurück, die der Anforderer unter Berücksichtigung der OAuth-Bereiche der Anfrage ansehen darf. |
modifyAttachments |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments Ändert die Anhänge zu abgegebenen Aufgaben der Schüler/Studenten. |
patch |
PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id} Aktualisiert ein oder mehrere Felder einer abgegebenen Aufgabe. |
reclaim |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim Die abgegebene Aufgabe eines Schülers/Studenten wird im Namen des Schülers/Studenten, dem sie gehört, zurückgefordert. |
return |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return Gibt die von einem Schüler oder Studenten eingereichte Aufgabe zurück. |
turnIn |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn Gibt eine Aufgabe des Schülers/Studenten ab. |
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 eines Kurses. |
get |
GET /v1/courses/{courseId}/courseWorkMaterials/{id} Gibt ein Arbeitsmaterial des Kurses 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 der Kursmaterialien zurück, die der Antragsteller ansehen darf. |
patch |
PATCH /v1/courses/{courseId}/courseWorkMaterials/{id} Aktualisiert ein oder mehrere Felder eines Kursmaterials. |
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 oder Studenten für einen Add-on-Anhang zurück. |
patch |
PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId} Aktualisiert Daten, die mit einem abgegebenen Add-on-Anhang verknüpft sind. |
REST-Ressource: v1.courses.students
Methoden | |
---|---|
create |
POST /v1/courses/{courseId}/students Fügt einen Nutzer als Schüler/Student einem Kurs hinzu. |
delete |
DELETE /v1/courses/{courseId}/students/{userId} Löscht einen Schüler/Studenten aus einem Kurs. |
get |
GET /v1/courses/{courseId}/students/{userId} Gibt einen Schüler/Studenten eines Kurses zurück. |
list |
GET /v1/courses/{courseId}/students Gibt eine Liste der Teilnehmer dieses Kurses zurück, die sich der Antragsteller ansehen darf. |
REST-Ressource: v1.courses.teachers
Methoden | |
---|---|
create |
POST /v1/courses/{courseId}/teachers Erstellt einen Kursleiter für einen Kurs. |
delete |
DELETE /v1/courses/{courseId}/teachers/{userId} Entfernt die angegebene Lehrkraft aus dem angegebenen Kurs. |
get |
GET /v1/courses/{courseId}/teachers/{userId} Gibt den Kursleiter eines Kurses zurück. |
list |
GET /v1/courses/{courseId}/teachers Gibt eine Liste der Lehrkräfte dieses Kurses zurück, auf die der Antragsteller zugreifen 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 Wenn die Einladung angenommen wird, wird sie entfernt und der eingeladene Nutzer wird den Lehrkräften oder Schülern/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 von Einladungen zurück, die der anfragende Nutzer ansehen darf, wobei die Liste auf die Einladungen beschränkt ist, die mit der Listenanfrage übereinstimmen. |
REST-Ressource: v1.registrations
Methoden | |
---|---|
create |
POST /v1/registrations Erstellt eine Registration . Dadurch sendet Classroom Benachrichtigungen von der angegebenen feed an das in cloudPubSubTopic angegebene Ziel. |
delete |
DELETE /v1/registrations/{registrationId} Löscht eine Registration , wodurch Classroom keine Benachrichtigungen mehr für diese Registration 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 Erziehungsberechtigte und sendet eine E-Mail an diesen, in der er gebeten wird, zu bestätigen, dass er der Erziehungsberechtigte des Schülers ist. |
get |
GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId} Gibt eine Einladung für einen bestimmten Erziehungsberechtigten zurück. |
list |
GET /v1/userProfiles/{studentId}/guardianInvitations Gibt eine Liste der Einladungen von Erziehungsberechtigten zurück, die der anfragende Nutzer ansehen darf, gefiltert nach den angegebenen Parametern. |
patch |
PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId} Ändert die Einladung als Erziehungsberechtigter. |
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 ansehen darf, beschränkt auf die Erziehungsberechtigten, die der Anfrage entsprechen. |