Method: spreadsheets.batchUpdate

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

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

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

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

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
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 )

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

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

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