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

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