Method: spreadsheets.values.batchGetByDataFilter

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

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcode.

معلّمات المسار

المَعلمات
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

لمزيد من المعلومات، اطّلِع على دليل التفويض.

سلسلة ValueValueRange

نطاق قيمة تمت مطابقته من خلال مقدِّم واحد أو أكثر من مقدِّمي البيانات.

تمثيل JSON 
{
  "valueRange": {
    object (ValueRange)
  },
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
الحقول
valueRange

object (ValueRange)

القيم المطابقة للسمة DataFilter.
dataFilters[]

object (DataFilter)

تمثّل هذه السمة DataFilters من الطلب الذي يتطابق مع نطاق القيم.