Method: spreadsheets.values.batchGetByDataFilter

لعرض نطاق واحد أو أكثر من القيم التي تتطابق مع فلاتر البيانات المحدّدة. على المتصل تحديد معرّف جدول البيانات وDataFilters واحد أو أكثر. سيتم عرض النطاقات التي تتطابق مع أيّ من فلاتر البيانات في الطلب.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز 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. الخيار التلقائي لعرض التاريخ والوقت هو 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 من الطلب الذي تطابق مع نطاق القيم.