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 من الطلب الذي تطابق مع نطاق القيم.