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,
  "commentsViewMode": enum (CommentsViewMode)
}
الحقول
requests[]

object (Request)

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

boolean

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

string

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

boolean

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

enum (CommentsViewMode)

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

نص الاستجابة

الردّ على تعديل جدول بيانات بشكل مجمّع

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

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

string

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

object (Response)

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

object (Spreadsheet)

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

enum (CommentUpdateState)

تُستخدَم لتحديد ما إذا تم تطبيق تعديلات التعليقات في طلب الدفعة.

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

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

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

CommentUpdateState

حالة تعديلات التعليقات في طلب الدفعة.

عمليات التعداد
COMMENT_UPDATE_STATE_UNSPECIFIED حالة تعديلات التعليقات غير محدّدة.
NO_UPDATES_REQUESTED لم يتم طلب أي تعديلات على التعليقات في طلب الدفعة.
ALL_SAVED تم تطبيق جميع التعديلات المطلوبة على التعليقات في طلب الدفعات.
ALL_FAILED_UNKNOWN_REASON تعذّر إجراء جميع التعديلات المطلوبة على التعليقات.