Method: spreadsheets.getByDataFilter

صفحه گسترده را در شناسه داده شده برمی‌گرداند. فراخوانی‌کننده باید شناسه صفحه گسترده را مشخص کند. برای اطلاعات بیشتر، به خواندن، نوشتن و جستجوی فراداده مراجعه کنید.

این روش با spreadsheets.get متفاوت است زیرا با مشخص کردن پارامتر dataFilters امکان انتخاب زیرمجموعه‌هایی از داده‌های صفحه گسترده برای بازگشت را فراهم می‌کند. می‌توان چندین DataFilters تعیین کرد. تعیین یک یا چند فیلتر داده، بخش‌هایی از صفحه گسترده را که با محدوده‌های منطبق با هر یک از فیلترها تلاقی دارند، برمی‌گرداند.

به طور پیش‌فرض، داده‌های درون gridها بازگردانده نمی‌شوند. می‌توانید داده‌های grid را به یکی از دو روش زیر وارد کنید:

  • با استفاده از پارامتر URL fields در HTTP، یک ماسک فیلد مشخص کنید که فیلدهای مورد نظر شما را فهرست کند.

  • پارامتر includeGridData را روی true تنظیم کنید. اگر یک ماسک فیلد تنظیم شده باشد، پارامتر includeGridData نادیده گرفته می‌شود.

برای صفحات گسترده بزرگ، به عنوان بهترین روش، فقط فیلدهای صفحه گسترده خاصی را که می‌خواهید بازیابی کنید.

درخواست HTTP

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:getByDataFilter

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
spreadsheetId

string

صفحه گسترده مورد درخواست.

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "includeGridData": boolean,
  "excludeTablesInBandedRanges": boolean
}
فیلدها
dataFilters[]

object ( DataFilter )

فیلترهای DataFilters که برای انتخاب محدوده‌هایی که باید از صفحه گسترده بازیابی شوند، استفاده می‌شوند.

includeGridData

boolean

اگر داده‌های شبکه‌ای باید برگردانده شوند، صحیح است. اگر در درخواست، ماسک فیلد تنظیم شده باشد، این پارامتر نادیده گرفته می‌شود.

excludeTablesInBandedRanges

boolean

اگر جداول باید در محدوده‌های نواری حذف شوند، مقدار صحیح (true) و اگر تنظیم نشده باشند، مقدار غلط (false) برمی‌گرداند.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل نمونه‌ای از Spreadsheet است.

دامنه‌های مجوز

به یکی از حوزه‌های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.