Method: spreadsheets.values.batchUpdateByDataFilter

تُستخدَم لضبط القيم في نطاق واحد أو أكثر من جدول بيانات. على المتصل تحديد معرّف جدول البيانات وvalueInputOption وDataFilterValueRanges واحد أو أكثر.

طلب HTTP

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

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

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

المعلمات
spreadsheetId

string

رقم تعريف جدول البيانات المطلوب تعديله

نص الطلب

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

تمثيل JSON 
{
  "valueInputOption": enum (ValueInputOption),
  "data": [
    {
      object (DataFilterValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
الحقول
valueInputOption

enum (ValueInputOption)

كيفية تفسير بيانات الإدخال
data[]

object (DataFilterValueRange)

القيم الجديدة التي سيتم تطبيقها على جدول البيانات إذا تطابق أكثر من نطاق واحد مع DataFilter المحدّد، يتم تطبيق القيم المحدّدة على جميع هذه النطاقات.
includeValuesInResponse

boolean

لتحديد ما إذا كان يجب أن يتضمّن ردّ التعديل قيم الخلايا التي تم تعديلها. لا تتضمّن الردود تلقائيًا القيم المعدَّلة. يحتوي الحقل updatedData ضمن كل BatchUpdateValuesResponse.responses على القيم المعدَّلة. إذا كان النطاق المطلوب كتابته أكبر من النطاق الذي تم كتابته فعليًا، يتضمّن الردّ جميع القيم في النطاق المطلوب (باستثناء الصفوف والأعمدة الفارغة في نهاية النطاق).
responseValueRenderOption

enum (ValueRenderOption)

تحدِّد كيفية عرض القيم في الاستجابة. الخيار التلقائي للعرض هو FORMATTED_VALUE.
responseDateTimeRenderOption

enum (DateTimeRenderOption)

لتحديد كيفية عرض التواريخ والأوقات والمدد في الاستجابة يتم تجاهل هذا الإجراء إذا كان responseValueRenderOption هو FORMATTED_VALUE. الخيار التلقائي لعرض التاريخ والوقت هو SERIAL_NUMBER.

نص الاستجابة

الاستجابة عند تعديل نطاق قيم في جدول بيانات

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "spreadsheetId": string,
  "totalUpdatedRows": integer,
  "totalUpdatedColumns": integer,
  "totalUpdatedCells": integer,
  "totalUpdatedSheets": integer,
  "responses": [
    {
      object (UpdateValuesByDataFilterResponse)
    }
  ]
}
الحقول
spreadsheetId

string

جدول البيانات الذي تم تطبيق التعديلات عليه
totalUpdatedRows

integer

إجمالي عدد الصفوف التي تم تحديث خلية واحدة على الأقل في كل صف منها
totalUpdatedColumns

integer

إجمالي عدد الأعمدة التي تم تعديل خلية واحدة على الأقل فيها
totalUpdatedCells

integer

إجمالي عدد الخلايا التي تم تعديلها
totalUpdatedSheets

integer

إجمالي عدد الأوراق التي تم تعديل خلية واحدة على الأقل فيها
responses[]

object (UpdateValuesByDataFilterResponse)

تم تعديل الردّ لكل نطاق.

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

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

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

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

DataFilterValueRange

نطاق من القيم التي يتم تحديد موقعها بواسطة DataFilter

تمثيل JSON 
{
  "dataFilter": {
    object (DataFilter)
  },
  "majorDimension": enum (Dimension),
  "values": [
    array
  ]
}
الحقول
dataFilter

object (DataFilter)

فلتر البيانات الذي يصف موقع القيم في جدول البيانات
majorDimension

enum (Dimension)

السمة الرئيسية للقيم
values[]

array (ListValue format)

البيانات المطلوب كتابتها إذا تجاوزت القيم المقدَّمة أيًّا من النطاقات التي يتطابق معها فلتر البيانات، سيتعذّر تنفيذ الطلب. إذا كانت القيم المقدَّمة أقل من النطاقات المطابقة، يتم فقط كتابة القيم المحدّدة، ولا تتأثر القيم الحالية في النطاقات المطابقة.

UpdateValuesByDataFilterResponse

الاستجابة عند تعديل نطاق من القيم باستخدام فلتر بيانات في جدول بيانات

تمثيل JSON 
{
  "updatedRange": string,
  "updatedRows": integer,
  "updatedColumns": integer,
  "updatedCells": integer,
  "dataFilter": {
    object (DataFilter)
  },
  "updatedData": {
    object (ValueRange)
  }
}
الحقول
updatedRange

string

النطاق (باستخدام ترميز A1) الذي تم تطبيق التعديلات عليه.
updatedRows

integer

عدد الصفوف التي تم تحديث خلية واحدة على الأقل في كل صف منها
updatedColumns

integer

عدد الأعمدة التي تم تعديل خلية واحدة على الأقل في كل منها
updatedCells

integer

عدد الخلايا التي تم تعديلها
dataFilter

object (DataFilter)

فلتر البيانات الذي اختار النطاق الذي تم تعديله.
updatedData

object (ValueRange)

قيم الخلايا في النطاق الذي يتطابق معه فلتر البيانات بعد تطبيق جميع التعديلات لا يتم تضمين هذا الحقل إلا إذا كان حقل includeValuesInResponse في الطلب هو true.