Method: documents.batchUpdate

یک یا چند به روز رسانی را در سند اعمال می کند.

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

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

برای مثال، فرض کنید BatchUpdate را با چهار به روز رسانی فراخوانی می کنید و تنها مورد سوم اطلاعات را برمی گرداند. پاسخ باید دو پاسخ خالی داشته باشد، پاسخ به درخواست سوم، و پاسخ خالی دیگر، به ترتیب.

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

درخواست HTTP

POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate

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

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

پارامترها
document Id

string

شناسه سند برای به روز رسانی.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
فیلدها
requests[]

object ( Request )

لیستی از به روز رسانی ها برای اعمال در سند.

write Control

object ( WriteControl )

کنترل نحوه اجرای درخواست های نوشتن را فراهم می کند.

بدن پاسخگو

پیام پاسخ از یک درخواست documents.batchUpdate .

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "documentId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
فیلدها
document Id

string

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

replies[]

object ( Response )

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

write Control

object ( WriteControl )

کنترل نوشتن به روز شده پس از اعمال درخواست.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

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

WriteControl

کنترل نحوه اجرای درخواست های نوشتن را فراهم می کند.

نمایندگی JSON 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
فیلدها
control میدان اتحادیه بازنگری سندی را تعیین می‌کند که باید به آن نامه بنویسید و اگر آن بازبینی ویرایش فعلی سند نباشد، درخواست چگونه باید رفتار کند. اگر هیچ یک از فیلدها مشخص نشده باشد، به‌روزرسانی‌ها برای آخرین نسخه اعمال می‌شوند. control فقط می تواند یکی از موارد زیر باشد:
required Revision Id

string

revision ID اختیاری سندی که درخواست نوشتن روی آن اعمال می‌شود. اگر این آخرین ویرایش سند نباشد، درخواست پردازش نمی‌شود و خطای 400 درخواست بد را برمی‌گرداند.

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

target Revision Id

string

revision ID هدف اختیاری سندی که درخواست نوشتن روی آن اعمال می‌شود.

اگر تغییرات مشارکت کننده پس از خواندن سند با استفاده از API رخ داده باشد، تغییرات ایجاد شده توسط این درخواست نوشتن در برابر تغییرات همکار اعمال می شود. این منجر به یک بازنگری جدید در سند می شود که هم تغییرات مشارکت کننده و هم تغییرات در درخواست را در بر می گیرد و سرور Docs تغییرات متناقض را حل می کند. هنگام استفاده از شناسه بازبینی هدف، مشتری API را می توان به عنوان یکی دیگر از همکاران سند در نظر گرفت.

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