صفحه گسترده را در شناسه داده شده برمی گرداند. تماس گیرنده باید شناسه صفحه گسترده را مشخص کند.
این روش با spreadsheets.get تفاوت دارد زیرا امکان انتخاب زیرمجموعه های داده های صفحه گسترده را با تعیین پارامتر dataFilters
می دهد. DataFilters
چندگانه را می توان مشخص کرد. با تعیین یک یا چند فیلتر داده، بخش هایی از صفحه گسترده که محدوده های مطابق با هر یک از فیلترها را قطع می کنند، برمی گرداند.
بهطور پیشفرض، دادههای درون شبکهها برگردانده نمیشوند. میتوانید دادههای شبکه را به یکی از دو روش اضافه کنید:
با استفاده از پارامتر URL
fields
در HTTP، یک فیلد ماسک لیست فیلدهای مورد نظر خود را مشخص کنیدپارامتر
includeGridData
را روی true قرار دهید. اگر یک فیلد ماسک تنظیم شده باشد، پارامترincludeGridData
نادیده گرفته می شود
برای صفحات گسترده بزرگ، به عنوان بهترین روش، فقط فیلدهای صفحه گسترده خاصی را که می خواهید بازیابی کنید.
درخواست HTTP
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:getByDataFilter
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های | |
---|---|
spreadsheetId | صفحه گسترده برای درخواست. |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"dataFilters": [
{
object ( |
زمینه های | |
---|---|
dataFilters[] | |
includeGridData | درست است اگر داده های شبکه باید برگردانده شوند. اگر یک فیلد ماسک در درخواست تنظیم شده باشد، این پارامتر نادیده گرفته می شود. |
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Spreadsheet
است.
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/drive
-
https://www.googleapis.com/auth/drive.file
-
https://www.googleapis.com/auth/spreadsheets
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.