Method: spreadsheets.values.batchUpdate

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

طلب HTTP

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

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

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

المعلمات
spreadsheetId

string

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

نص الطلب

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

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

enum (ValueInputOption)

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

object (ValueRange)

القيم الجديدة التي سيتم تطبيقها على جدول البيانات
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 (UpdateValuesResponse)
    }
  ]
}
الحقول
spreadsheetId

string

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

integer

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

integer

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

integer

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

integer

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

object (UpdateValuesResponse)

عنصر UpdateValuesResponse واحد لكل نطاق مطلوب، بالترتيب نفسه الذي ظهرت به الطلبات

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

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

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

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