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)

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