Method: spreadsheets.batchUpdate

تُطبِّق تعديلًا واحدًا أو أكثر على جدول البيانات.

يتم التحقّق من كل request قبل تطبيقه. إذا كان أي طلب غير صالح، لن يتم تنفيذ الطلب بأكمله ولن يتم تطبيق أي إجراء.

تحتوي بعض الطلبات على replies لمنحك بعض المعلومات حول كيفية تطبيقها. ستتطابق الردود مع الطلبات. على سبيل المثال، إذا طبّقت 4 تعديلات وكان التعديل الثالث يتضمّن ردًا، سيتضمّن الردّ ردّين فارغين والردّ الفعلي وردّ فارغ آخر، بهذا الترتيب.

بسبب الطبيعة التعاونية لجداول البيانات، لا يمكن ضمان أن يعكس جدول البيانات التغييرات التي أجريتها بعد اكتمال ذلك، ولكن يمكن ضمان تطبيق التعديلات في الطلب معًا بشكل موحّد. يمكن أن يتم تغيير التغييرات بالنسبة إلى تغييرات المتعاونين. إذا لم يكن هناك متعاونون، فيجب أن يعكس جدول البيانات التغييرات التي أجريتها.

طلب HTTP

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

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

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

المعلمات
spreadsheetId

string

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

نص الطلب

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

تمثيل JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean
}
الحقول
requests[]

object (Request)

قائمة بالتعديلات المطلوب تطبيقها على جدول البيانات سيتم تطبيق الطلبات بالترتيب الذي تم تحديده. إذا لم يكن أي طلب صالحًا، لن يتم تطبيق أي طلبات.
includeSpreadsheetInResponse

boolean

تحدِّد ما إذا كان يجب أن يتضمّن ردّ التعديل مرجع جدول البيانات.
responseRanges[]

string

تحدّد النطاقات المضمّنة في جدول بيانات الردود. هذه السمة مفيدة فقط إذا كانت قيمة includeSpreadsheetInResponse هي "صحيح".
responseIncludeGridData

boolean

صحيح إذا كان يجب عرض بيانات الشبكة. هذه السمة مفيدة فقط إذا كانت قيمة includeSpreadsheetInResponse هي "صحيح". يتم تجاهل هذه المَعلمة إذا تم ضبط قناع حقل في الطلب.

نص الاستجابة

الرد على التحديث المجمّع لجدول بيانات.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  }
}
الحقول
spreadsheetId

string

جدول البيانات الذي تم تطبيق التعديلات عليه
replies[]

object (Response)

ردّ على التعديلات ويتم ربط كل طلب بتحديث واحد، على الرغم من أنّ الردود على بعض الطلبات قد تكون فارغة.
updatedSpreadsheet

object (Spreadsheet)

جدول البيانات بعد تطبيق التعديلات لا يتم ضبط هذا الإعداد إلا إذا كان BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response يساوي true.

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

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

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