Method: spreadsheets.get
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
صفحه گسترده را در شناسه داده شده برمی گرداند. تماس گیرنده باید شناسه صفحه گسترده را مشخص کند.
به‌طور پیش‌فرض، داده‌های درون شبکه‌ها برگردانده نمی‌شوند. می‌توانید داده‌های شبکه‌ای را به یکی از ۲ روش اضافه کنید:
با استفاده از پارامتر URL fields در HTTP، یک فیلد ماسک لیست فیلدهای مورد نظر خود را مشخص کنید
پارامتر URL includeGridData را روی true تنظیم کنید. اگر یک فیلد ماسک تنظیم شده باشد، پارامتر includeGridData نادیده گرفته می شود
برای صفحات گسترده بزرگ، به عنوان بهترین روش، فقط فیلدهای صفحه گسترده خاصی را که می خواهید بازیابی کنید.
برای بازیابی فقط زیرمجموعه های داده های صفحه گسترده، از پارامتر URL ranges استفاده کنید. محدوده ها با استفاده از نماد A1 مشخص می شوند. شما می توانید یک سلول واحد (به عنوان مثال، A1 ) یا چند سلول (به عنوان مثال، A1:D5 ) تعریف کنید. همچنین می‌توانید سلول‌ها را از برگه‌های دیگر در همان صفحه‌گسترده (به عنوان مثال، Sheet2!A1:C4 ) دریافت کنید یا چندین محدوده را به طور همزمان بازیابی کنید (به عنوان مثال، ?ranges=A1:D5&ranges=Sheet2!A1:C4 ). محدود کردن محدوده تنها بخش‌هایی از صفحه‌گسترده را برمی‌گرداند که محدوده‌های درخواستی را قطع می‌کنند.
درخواست HTTP
GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
spreadsheetId | string صفحه گسترده برای درخواست. |
پارامترهای پرس و جو
| پارامترها |
|---|
ranges[] | string محدوده های بازیابی از صفحه گسترده. |
includeGridData | boolean اگر داده های شبکه باید برگردانده شوند درست است. اگر یک فیلد ماسک در درخواست تنظیم شده باشد، این پارامتر نادیده گرفته می شود. |
excludeTablesInBandedRanges | boolean درست است اگر جداول باید در محدوده نواری حذف شوند. نادرست اگر تنظیم نشده باشد. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Spreadsheet است.
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
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
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-04-29 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-04-29 بهوقت ساعت هماهنگ جهانی."],[],[],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)."]]
