Method: spreadsheets.get
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Gibt die Tabelle mit der angegebenen ID zurück. Der Aufrufer muss die Tabellen-ID angeben.
Standardmäßig werden keine Daten innerhalb von Rastern zurückgegeben. Sie haben zwei Möglichkeiten, Rasterdaten einzufügen:
Geben Sie mit dem URL-Parameter fields
in HTTP eine Feldmaske an, in der die gewünschten Felder aufgeführt sind.
Legen Sie den URL-Parameter includeGridData
auf „wahr“ fest. Wenn eine Feldmaske festgelegt ist, wird der Parameter includeGridData
ignoriert.
Bei großen Tabellen sollten Sie nur die gewünschten Tabellenfelder abrufen.
Wenn Sie nur Teilmengen von Tabellendaten abrufen möchten, verwenden Sie den URL-Parameter ranges
. Bereiche werden in A1-Notation angegeben. Sie können eine einzelne Zelle (z. B. A1
) oder mehrere Zellen (z. B. A1:D5
) definieren. Außerdem können Sie Zellen aus anderen Tabellen innerhalb derselben Tabelle abrufen (z. B. Sheet2!A1:C4
) oder mehrere Bereiche gleichzeitig abrufen (z. B. ?ranges=A1:D5&ranges=Sheet2!A1:C4
). Wenn Sie den Bereich einschränken, werden nur die Bereiche der Tabelle zurückgegeben, die sich mit den angeforderten Bereichen überschneiden.
HTTP-Anfrage
GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter |
spreadsheetId |
string
Die anzufordernde Tabelle.
|
Abfrageparameter
Parameter |
ranges[] |
string
Die Bereiche, die aus der Tabelle abgerufen werden sollen.
|
includeGridData |
boolean
„True“, wenn Rasterdaten zurückgegeben werden sollen. Dieser Parameter wird ignoriert, wenn in der Anfrage eine Feldmaske festgelegt wurde.
|
excludeTablesInBandedRanges |
boolean
„Wahr“, wenn Tabellen aus den gruppierten Bereichen ausgeschlossen werden sollen. „False“, wenn nicht festgelegt.
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Spreadsheet
.
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/spreadsheets
https://www.googleapis.com/auth/spreadsheets.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-04-29 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-04-29 (UTC)."],[],[],null,["# Method: spreadsheets.get\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- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns the spreadsheet at the given ID. The caller must specify the spreadsheet ID.\n\nBy default, data within grids is not returned. You can include grid data in one of 2 ways:\n\n- Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP\n\n- Set the [includeGridData](/workspace/sheets/api/reference/rest/v4/spreadsheets/get#body.QUERY_PARAMETERS.include_grid_data) URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored\n\nFor large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want.\n\nTo retrieve only subsets of spreadsheet data, use the [ranges](/workspace/sheets/api/reference/rest/v4/spreadsheets/get#body.QUERY_PARAMETERS.ranges) URL parameter. Ranges are specified using [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.\n\n### HTTP request\n\n`GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------------|--------------------------------------|\n| `spreadsheetId` | `string` The spreadsheet to request. |\n\n### Query parameters\n\n| Parameters ||\n|-------------------------------|-------------------------------------------------------------------------------------------------------------------|\n| `ranges[]` | `string` The ranges to retrieve from the spreadsheet. |\n| `includeGridData` | `boolean` True if grid data should be returned. This parameter is ignored if a field mask was set in the request. |\n| `excludeTablesInBandedRanges` | `boolean` True if tables should be excluded in the banded ranges. False if not set. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Spreadsheet](/workspace/sheets/api/reference/rest/v4/spreadsheets#Spreadsheet).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/drive`\n- `https://www.googleapis.com/auth/drive.readonly`\n- `https://www.googleapis.com/auth/drive.file`\n- `https://www.googleapis.com/auth/spreadsheets`\n- `https://www.googleapis.com/auth/spreadsheets.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]