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