Method: spreadsheets.values.batchGetByDataFilter

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

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

درخواست HTTP

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

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

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

پارامترها
spreadsheetId

string

شناسه‌ی صفحه‌گسترده‌ای که قرار است داده‌ها از آن بازیابی شوند.

درخواست بدنه

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

نمایش JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "majorDimension": enum (Dimension),
  "valueRenderOption": enum (ValueRenderOption),
  "dateTimeRenderOption": enum (DateTimeRenderOption)
}
فیلدها
dataFilters[]

object ( DataFilter )

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

majorDimension

enum ( Dimension )

بُعد اصلی که نتایج باید از آن استفاده کنند.

برای مثال، اگر داده‌های صفحه‌گسترده به صورت زیر باشد: A1=1,B1=2,A2=3,B2=4 ، درخواستی که آن محدوده را انتخاب کرده و majorDimension=ROWS را تنظیم می‌کند، مقدار [[1,2],[3,4]] را برمی‌گرداند، در حالی که درخواستی که majorDimension=COLUMNS را تنظیم می‌کند، مقدار [[1,3],[2,4]] را برمی‌گرداند.

valueRenderOption

enum ( ValueRenderOption )

نحوه نمایش مقادیر در خروجی. گزینه رندر پیش‌فرض FORMATTED_VALUE است.

dateTimeRenderOption

enum ( DateTimeRenderOption )

نحوه نمایش تاریخ‌ها، زمان‌ها و مدت زمان‌ها در خروجی. اگر valueRenderOption برابر با FORMATTED_VALUE باشد، این مورد نادیده گرفته می‌شود. گزینه پیش‌فرض رندر dateTime SERIAL_NUMBER است.

بدنه پاسخ

پاسخ هنگام بازیابی بیش از یک محدوده از مقادیر در یک صفحه گسترده انتخاب شده توسط DataFilters .

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

نمایش JSON 
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (MatchedValueRange)
    }
  ]
}
فیلدها
spreadsheetId

string

شناسه صفحه‌گسترده‌ای که داده‌ها از آن بازیابی شده‌اند.

valueRanges[]

object ( MatchedValueRange )

مقادیر درخواستی به همراه فهرست فیلترهای داده‌ای که با آنها مطابقت دارند.

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

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

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

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

محدوده مقادیر منطبق

محدوده‌ای از مقادیر که با یک یا چند فایل‌ساز داده مطابقت دارد.

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

object ( ValueRange )

مقادیری که توسط DataFilter مطابقت داده شده‌اند.

dataFilters[]

object ( DataFilter )

فیلترهای DataFilters از درخواستی که با محدوده مقادیر مطابقت دارد.