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. خيار العرض التلقائي لـ dateTime هو 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)

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