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

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

نص الاستجابة

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

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

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

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