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.