- درخواست HTTP
- پارامترهای مسیر
- پارامترهای پرس و جو
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- آن را امتحان کنید!
صفحه گسترده را در شناسه داده شده برمی گرداند. تماس گیرنده باید شناسه صفحه گسترده را مشخص کند.
بهطور پیشفرض، دادههای درون شبکهها برگردانده نمیشوند. میتوانید دادههای شبکهای را به یکی از ۲ روش اضافه کنید:
با استفاده از پارامتر 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 | صفحه گسترده برای درخواست. |
پارامترهای پرس و جو
مولفه های | |
---|---|
ranges[] | محدوده های بازیابی از صفحه گسترده. |
includeGridData | اگر داده های شبکه باید برگردانده شوند درست است. اگر یک فیلد ماسک در درخواست تنظیم شده باشد، این پارامتر نادیده گرفته می شود. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از 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
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.