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