Method: spreadsheets.values.batchUpdateByDataFilter

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

طلب HTTP

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

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

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

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

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

قيمة قيمة الفلتر

نطاق من القيم يتم تحديد موقعه الجغرافي بواسطة DataFilter.

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

object (DataFilter)

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

enum (Dimension)

البُعد الرئيسي للقيم
values[]

array (ListValue format)

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

تعديل القيم حسب البيانات

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

تمثيل 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.