Method: spreadsheets.getByDataFilter

تعرض هذه الدالة جدول البيانات الذي يحمل رقم التعريف المحدّد. على المتصل تحديد رقم تعريف جدول البيانات. لمزيد من المعلومات، يُرجى الاطّلاع على قراءة البيانات الوصفية وكتابتها والبحث فيها.

تختلف هذه الطريقة عن spreadsheets.get في أنّها تتيح اختيار المجموعات الفرعية من بيانات جدول البيانات التي سيتم عرضها من خلال تحديد المَعلمة dataFilters. يمكن تحديد قيم DataFilters متعددة. يؤدي تحديد فلتر واحد أو أكثر من فلاتر البيانات إلى عرض أجزاء جدول البيانات التي تتقاطع مع النطاقات المطابقة لأي من الفلاتر.

لا يتم عرض البيانات داخل الجداول تلقائيًا. يمكنك تضمين بيانات الشبكة بإحدى الطريقتين التاليتين:

  • حدِّد قناع حقل يسرد الحقول المطلوبة باستخدام مَعلمة عنوان URL fields في HTTP.

  • اضبط المَعلمة includeGridData على true. في حال ضبط قناع الحقل، يتم تجاهل المَعلمة includeGridData.

بالنسبة إلى جداول البيانات الكبيرة، ننصحك باسترداد حقول جدول البيانات المحدّدة التي تريدها فقط.

طلب HTTP

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

يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.

مَعلمات المسار

المعلمات
spreadsheetId

string

جدول البيانات المطلوب

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "includeGridData": boolean,
  "excludeTablesInBandedRanges": boolean,
  "commentsViewMode": enum (CommentsViewMode)
}
الحقول
dataFilters[]

object (DataFilter)

DataFilters المستخدَم لاختيار النطاقات المطلوب استردادها من جدول البيانات
includeGridData

boolean

تكون القيمة "صحيح" إذا كان من المفترض عرض بيانات الشبكة. يتم تجاهل هذه المَعلمة إذا تم ضبط قناع حقل في الطلب.
excludeTablesInBandedRanges

boolean

تكون القيمة "صحيح" إذا كان من المفترض استبعاد الجداول في النطاقات المخطَّطة. يتم ضبط القيمة على "خطأ" إذا لم يتم ضبطها.
commentsViewMode

enum (CommentsViewMode)

وضع عرض التعليقات الذي سيتم تطبيقه على جدول البيانات يتيح ذلك عرض جدول البيانات مع إغفال التعليقات أو تضمينها. إذا لم يتم تحديد أيّ منها، يتم استخدام COMMENTS_VIEW_MODE_OMITTED.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نصها على مثال Spreadsheet.

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

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