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
}
الحقول
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

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