Google Classroom-Add-ons sind jetzt allgemein für Entwickler verfügbar. Weitere Informationen finden Sie in der
Dokumentation zu Add-ons.
Method: courses.aliases.list
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Gibt eine Liste der Aliasse für einen Kurs zurück.
Diese Methode gibt die folgenden Fehlercodes zurück:
PERMISSION_DENIED, wenn der anfragende Nutzer keinen Zugriff auf den Kurs hat, oder bei Zugriffsfehlern.NOT_FOUND, wenn der Kurs nicht vorhanden ist.
HTTP-Anfrage
GET https://classroom.googleapis.com/v1/courses/{courseId}/aliases
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
| Parameter |
courseId |
string
Die Kennung des Kurses. Diese Kennung kann entweder die in Classroom zugewiesene Kennung oder eine alias sein.
|
Abfrageparameter
| Parameter |
pageSize |
integer
Die maximale Anzahl der Elemente, die zurückgegeben werden sollen. „0“ oder „nicht angegeben“ bedeutet, dass der Server ein Maximum zuweisen kann. Der Server gibt möglicherweise weniger als die angegebene Anzahl von Ergebnissen zurück.
|
pageToken |
string
nextPageToken-Wert, der von einem vorherigen list-Aufruf zurückgegeben wurde und angibt, dass die nächste Ergebnisseite zurückgegeben werden soll.
Die list-Anfrage muss ansonsten mit der Anfrage identisch sein, die zu diesem Token geführt hat.
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Antwort beim Auflisten von Kursaliassen.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
| JSON-Darstellung |
{
"aliases": [
{
object (CourseAlias)
}
],
"nextPageToken": string
} |
| Felder |
aliases[] |
object (CourseAlias)
Die Kursaliasse.
|
nextPageToken |
string
Token, das die nächste Ergebnisseite identifiziert, die zurückgegeben werden soll. Ist das Feld leer, sind keine weiteren Ergebnisse verfügbar.
|
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/classroom.courses
https://www.googleapis.com/auth/classroom.courses.readonly
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-25 (UTC)."],[],[],null,["# Method: courses.aliases.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCourseAliasesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `NOT_FOUND` if the course does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/aliases`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` The identifier of the course. This identifier can be either the Classroom-assigned identifier or an [alias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias). |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/courses.aliases/list#body.ListCourseAliasesResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/courses.aliases/list#google.classroom.v1.Courses.ListCourseAliases) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/courses.aliases/list#google.classroom.v1.Courses.ListCourseAliases) request must be otherwise identical to the one that resulted in this token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse when listing course aliases.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"aliases\": [ { object (/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------|\n| `aliases[]` | `object (`[CourseAlias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias)`)` The course aliases. |\n| `nextPageToken` | `string` Token identifying the next page of results to return. If empty, no further results are available. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.courses`\n- `\n https://www.googleapis.com/auth/classroom.courses.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
