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

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