Method: documents.batchUpdate

רלוונטי לעדכון אחד או יותר במסמך.

כל request מאומת לפני היישום. אם בקשה כלשהי אינה חוקית, הבקשה כולה תיכשל ושום דבר לא ייושם.

בקשות מסוימות כוללות replies כדי לספק לך מידע על אופן היישום שלהן. אין צורך להחזיר מידע לגבי בקשות אחרות. כל אחת מהן מחזירה תשובה ריקה. סדר התשובות תואם לזה של הבקשות.

לדוגמה, נניח שאתם קוראים ל-batUpdate עם ארבעה עדכונים, ורק השלישי מחזיר מידע. התשובה תהיה שתי תשובות ריקות, התשובה לבקשה השלישית ותשובה ריקה נוספת, בסדר הזה.

מכיוון שמשתמשים אחרים עשויים לערוך את המסמך, ייתכן שהמסמך לא משקף בדיוק את השינויים שערכת: ייתכן שהשינויים שלך יוחלו ביחס לשינויים של שותפי עריכה. אם אין שותפי עריכה, המסמך צריך לשקף את השינויים שביצעתם. בכל מקרה, העדכונים בבקשה שלך יוחלו יחד באופן אוטומטי.

בקשת HTTP

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

כתובת ה-URL כוללת תחביר של קידוד gRPC.

פרמטרים של נתיב

פרמטרים
documentId

string

מזהה המסמך לעדכון.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
שדות
requests[]

object (Request)

רשימת העדכונים שיחולו על המסמך.
writeControl

object (WriteControl)

מספקת שליטה על אופן הביצוע של בקשות לכתיבה.

גוף התשובה

הודעת תגובה מבקשה של documents.batchUpdate.

אם התגובה הצליחה, גוף התגובה מכיל נתונים עם המבנה הבא:

ייצוג JSON 
{
  "documentId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
שדות
documentId

string

המזהה של המסמך שעליו הוחלו העדכונים.
replies[]

object (Response)

התשובה לעדכונים. הפעולה הזו ממפהת 1:1 את העדכונים, אם כי התשובות לבקשות מסוימות עשויות להיות ריקות.
writeControl

object (WriteControl)

פקד הכתיבה המעודכן לאחר החלת הבקשה.

היקפי הרשאה

מחייב אחד מהיקפי ההרשאות הבאים של OAuth:

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

למידע נוסף, ניתן לעיין במדריך ההרשאה.

שליטה בכתיבה

מספקת שליטה על אופן הביצוע של בקשות לכתיבה.

ייצוג 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 יכול להיות רק אחד מהבאים:
requiredRevisionId

string

הערך הrevision ID של המסמך שבקשת הכתיבה חלה עליו. אם לא מדובר בגרסה האחרונה של המסמך, הבקשה לא תעובד ותחזיר שגיאת 400 של בקשה פגומה.

כאשר מוחזר מזהה תיקון נדרש בתגובה, הוא מציין את מזהה התיקון של המסמך לאחר החלת הבקשה.
targetRevisionId

string

היעד האופציונלי revision ID של המסמך שעליו חלה בקשת הכתיבה.

אם בוצעו שינויים על ידי שותפי עריכה לאחר שהמסמך נקרא באמצעות ממשק ה-API, השינויים שיופקו בבקשת הכתיבה יחולו על השינויים של שותפי העריכה. כתוצאה מכך מתקבלת גרסה חדשה של המסמך, שמשלבת את השינויים של שותפי העריכה ואת השינויים בבקשה, כאשר שרת Docs פותר שינויים סותרים. בעת שימוש במזהה עדכון יעד, ניתן לחשוב על לקוח ממשק ה-API כמשתף פעולה של המסמך.

מזהה הגרסה הקודמת יכול לשמש רק לכתיבת גרסאות עדכניות של מסמך. אם הגרסה הקודמת רחוקה מדי מאחורי הגרסה האחרונה, הבקשה לא תעובד ותחזיר שגיאת 400 (שגיאה) פגומה. יש לנסות לשלוח את הבקשה שוב אחרי אחזור הגרסה האחרונה של המסמך. בדרך כלל מזהה הגרסה הקודמת יישאר בתוקף כגרסה קודמת למשך מספר דקות לאחר הקריאה, אבל במקרה של מסמכים שעורכים בתדירות גבוהה, החלון הזה עשוי להיות קצר יותר.