Method: spreadsheets.getByDataFilter

يؤدي ذلك إلى عرض جدول البيانات على المعرّف المحدّد. يجب أن يحدد المتصل رقم تعريف جدول البيانات.

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

بشكل افتراضي، لا يتم عرض البيانات داخل الشبكات. يمكنك تضمين بيانات الشبكة بإحدى الطريقتين التاليتين:

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

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

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

طلب HTTP

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

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

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

المَعلمات
spreadsheetId

string

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

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

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

object (DataFilter)

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

boolean

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

نص الاستجابة

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

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

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