Method: spreadsheets.get
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Menampilkan spreadsheet pada ID yang diberikan. Pemanggil harus menentukan ID spreadsheet.
Secara default, data dalam petak tidak ditampilkan. Anda dapat menyertakan data petak dengan salah satu dari 2 cara:
Tentukan mask kolom yang mencantumkan kolom yang Anda inginkan menggunakan parameter URL fields di HTTP
Tetapkan parameter URL includeGridData ke benar (true). Jika mask kolom ditetapkan, parameter includeGridData akan diabaikan
Untuk spreadsheet besar, sebagai praktik terbaik, hanya ambil kolom spreadsheet tertentu yang Anda inginkan.
Untuk hanya mengambil subkumpulan data spreadsheet, gunakan parameter URL ranges. Rentang ditentukan menggunakan notasi A1. Anda dapat menentukan satu sel (misalnya, A1) atau beberapa sel (misalnya, A1:D5). Anda juga bisa mendapatkan sel dari sheet lain dalam spreadsheet yang sama (misalnya, Sheet2!A1:C4) atau mengambil beberapa rentang sekaligus (misalnya, ?ranges=A1:D5&ranges=Sheet2!A1:C4). Membatasi rentang hanya akan menampilkan bagian spreadsheet yang bersimpangan dengan rentang yang diminta.
Permintaan HTTP
GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
| Parameter |
spreadsheetId |
string
Spreadsheet yang akan diminta.
|
Parameter kueri
| Parameter |
ranges[] |
string
Rentang yang akan diambil dari spreadsheet.
|
includeGridData |
boolean
Benar jika data petak harus ditampilkan. Parameter ini diabaikan jika mask kolom ditetapkan dalam permintaan.
|
excludeTablesInBandedRanges |
boolean
Benar jika tabel harus dikecualikan dalam rentang berband. Salah jika tidak ditetapkan.
|
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat instance Spreadsheet.
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/drivehttps://www.googleapis.com/auth/drive.readonlyhttps://www.googleapis.com/auth/drive.filehttps://www.googleapis.com/auth/spreadsheetshttps://www.googleapis.com/auth/spreadsheets.readonly
Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-04-30 UTC.
[null,null,["Terakhir diperbarui pada 2025-04-30 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)."]]
