Method: spreadsheets.getByDataFilter

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

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

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

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

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

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

طلب HTTP

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

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

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

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

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