Method: spreadsheets.batchUpdate

یک یا چند به‌روزرسانی را در صفحه‌گسترده اعمال می‌کند.

هر request قبل از اعمال، اعتبارسنجی می‌شود. اگر هر درخواستی معتبر نباشد، کل درخواست با شکست مواجه می‌شود و هیچ چیزی اعمال نخواهد شد.

برخی از درخواست‌ها دارای replies هستند که اطلاعاتی در مورد نحوه اعمال آنها به شما می‌دهند. پاسخ‌ها، درخواست‌ها را منعکس می‌کنند. برای مثال، اگر ۴ به‌روزرسانی اعمال کرده باشید و سومین به‌روزرسانی دارای پاسخ باشد، در آن صورت پاسخ به ترتیب شامل ۲ پاسخ خالی، پاسخ اصلی و یک پاسخ خالی دیگر خواهد بود.

با توجه به ماهیت مشارکتی صفحات گسترده، تضمینی وجود ندارد که پس از تکمیل این مرحله، صفحه گسترده دقیقاً تغییرات شما را منعکس کند، با این حال تضمین می‌شود که به‌روزرسانی‌های درخواست به صورت خودکار اعمال شوند. تغییرات شما ممکن است با توجه به تغییرات همکاران تغییر کند. اگر هیچ همکاری وجود نداشته باشد، صفحه گسترده باید تغییرات شما را منعکس کند.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
spreadsheetId

string

صفحه‌گسترده‌ای که قرار است به‌روزرسانی‌ها روی آن اعمال شوند.

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean,
  "commentsViewMode": enum (CommentsViewMode)
}
فیلدها
requests[]

object ( Request )

فهرستی از به‌روزرسانی‌ها برای اعمال در صفحه‌گسترده. درخواست‌ها به ترتیبی که مشخص شده‌اند اعمال می‌شوند. اگر هر درخواستی معتبر نباشد، هیچ درخواستی اعمال نخواهد شد.

includeSpreadsheetInResponse

boolean

تعیین می‌کند که آیا پاسخ به‌روزرسانی باید شامل منبع صفحه گسترده باشد یا خیر.

responseRanges[]

string

محدوده‌های موجود در صفحه‌گسترده پاسخ را محدود می‌کند. فقط در صورتی معنی‌دار است که includeSpreadsheetInResponse برابر با 'true' باشد.

responseIncludeGridData

boolean

اگر داده‌های شبکه باید برگردانده شوند، صحیح است. فقط در صورتی معنی‌دار است که includeSpreadsheetInResponse برابر با 'true' باشد. اگر در درخواست، ماسک فیلد تنظیم شده باشد، این پارامتر نادیده گرفته می‌شود.

commentsViewMode

enum ( CommentsViewMode )

حالت نمایش نظرات برای اعمال به صفحه‌گسترده. این حالت امکان مشاهده صفحه‌گسترده را با نظرات حذف شده یا اضافه شده فراهم می‌کند. اگر نظری مشخص نشده باشد، COMMENTS_VIEW_MODE_OMITTED استفاده می‌شود. فقط در صورتی معنی‌دار است که includeSpreadsheetInResponse برابر با 'true' باشد.

بدنه پاسخ

پاسخ برای به‌روزرسانی دسته‌ای یک صفحه‌گسترده.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  },
  "commentUpdateState": enum (CommentUpdateState)
}
فیلدها
spreadsheetId

string

صفحه‌گسترده‌ای که به‌روزرسانی‌ها روی آن اعمال شده‌اند.

replies[]

object ( Response )

پاسخ به‌روزرسانی‌ها. این به صورت ۱:۱ با به‌روزرسانی‌ها نگاشت می‌شود، اگرچه پاسخ به برخی درخواست‌ها ممکن است خالی باشد.

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

وضعیت به‌روزرسانی دیدگاه

وضعیت به‌روزرسانی‌های نظرات در درخواست دسته‌ای.

انوم‌ها
COMMENT_UPDATE_STATE_UNSPECIFIED وضعیت به‌روزرسانی نظرات مشخص نیست.
NO_UPDATES_REQUESTED هیچ به‌روزرسانی نظری در درخواست دسته‌ای درخواست نشده بود.
ALL_SAVED تمام به‌روزرسانی‌های درخواستی نظرات در درخواست دسته‌ای اعمال شدند.
ALL_FAILED_UNKNOWN_REASON تمام به‌روزرسانی‌های درخواستی نظرات با شکست مواجه شد.