Method: spreadsheets.values.batchGetByDataFilter

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

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
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]] را برمی‌گرداند. [[1,2],[3,4]] ، در حالی که درخواستی که majorDimension=COLUMNS را تنظیم می کند [[1,3],[2,4]] را برمی گرداند.

valueRenderOption

enum ( ValueRenderOption )

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

dateTimeRenderOption

enum ( DateTimeRenderOption )

چگونه تاریخ، زمان و مدت زمان باید در خروجی نمایش داده شود. اگر valueRenderOption FORMATTED_VALUE باشد، این نادیده گرفته می‌شود. گزینه پیش‌فرض render 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

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

MatchedValueRange

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

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

object ( ValueRange )

مقادیر مطابق با DataFilter .

dataFilters[]

object ( DataFilter )

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