Requests

{

  // Union field request can be only one of the following:
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "createNamedRange": {
    object (CreateNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "deleteContentRange": {
    object (DeleteContentRangeRequest)
  },
  "insertInlineImage": {
    object (InsertInlineImageRequest)
  },
  "insertTable": {
    object (InsertTableRequest)
  },
  "insertTableRow": {
    object (InsertTableRowRequest)
  },
  "insertTableColumn": {
    object (InsertTableColumnRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "insertPageBreak": {
    object (InsertPageBreakRequest)
  },
  "deletePositionedObject": {
    object (DeletePositionedObjectRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableCellStyle": {
    object (UpdateTableCellStyleRequest)
  },
  "updateTableRowStyle": {
    object (UpdateTableRowStyleRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateDocumentStyle": {
    object (UpdateDocumentStyleRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "createHeader": {
    object (CreateHeaderRequest)
  },
  "createFooter": {
    object (CreateFooterRequest)
  },
  "createFootnote": {
    object (CreateFootnoteRequest)
  },
  "replaceNamedRangeContent": {
    object (ReplaceNamedRangeContentRequest)
  },
  "updateSectionStyle": {
    object (UpdateSectionStyleRequest)
  },
  "insertSectionBreak": {
    object (InsertSectionBreakRequest)
  },
  "deleteHeader": {
    object (DeleteHeaderRequest)
  },
  "deleteFooter": {
    object (DeleteFooterRequest)
  },
  "pinTableHeaderRows": {
    object (PinTableHeaderRowsRequest)
  }
  // End of list of possible types for union field request.
}

object (ReplaceAllTextRequest)

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

object (InsertTextRequest)

הוספת טקסט במיקום שצוין.

object (UpdateTextStyleRequest)

עדכון סגנון הטקסט בטווח שצוין.

object (CreateParagraphBulletsRequest)

יוצרת סמלי נקודה-קו עבור פסקאות.

object (DeleteParagraphBulletsRequest)

מחיקת תוויות של נקודות מפסיק מהפסקאות.

object (CreateNamedRangeRequest)

יצירת טווח בעל שם.

object (DeleteNamedRangeRequest)

מחיקה של טווח תאים בעל שם.

object (UpdateParagraphStyleRequest)

עדכון סגנון הפסקה בטווח שצוין.

object (DeleteContentRangeRequest)

מחיקת תוכן מהמסמך.

object (InsertInlineImageRequest)

הוספת תמונה בתוך הטקסט במיקום שצוין.

object (InsertTableRequest)

הוספת טבלה במיקום שצוין.

object (InsertTableRowRequest)

הוספת שורה ריקה לטבלה.

object (InsertTableColumnRequest)

הוספת עמודה ריקה לטבלה.

object (DeleteTableRowRequest)

מחיקה של שורה מטבלה.

object (DeleteTableColumnRequest)

מחיקה של עמודה מטבלה.

object (InsertPageBreakRequest)

הוספת מעבר דף במיקום שצוין.

object (DeletePositionedObjectRequest)

מחיקה של אובייקט ממוקם מהמסמך.

object (UpdateTableColumnPropertiesRequest)

עדכון המאפיינים של עמודות בטבלה.

object (UpdateTableCellStyleRequest)

עדכון הסגנון של תאי הטבלה.

object (UpdateTableRowStyleRequest)

עדכון סגנון השורה בטבלה.

object (ReplaceImageRequest)

החלפת תמונה במסמך.

object (UpdateDocumentStyleRequest)

עדכון הסגנון של המסמך.

object (MergeTableCellsRequest)

מיזוג תאים בטבלה.

object (UnmergeTableCellsRequest)

ביטול המיזוג של תאים בטבלה.

object (CreateHeaderRequest)

יצירת כותרת.

object (CreateFooterRequest)

יצירת כותרת תחתונה.

object (CreateFootnoteRequest)

יצירת הערת שוליים.

object (ReplaceNamedRangeContentRequest)

מחליפה את התוכן בטווח בעל שם.

object (UpdateSectionStyleRequest)

עדכון סגנון הקטע של הטווח שצוין.

object (InsertSectionBreakRequest)

הוספת מעבר קטע במיקום שצוין.

object (DeleteHeaderRequest)

מחיקה של כותרת מהמסמך.

object (DeleteFooterRequest)

מחיקת כותרת תחתונה מהמסמך.

object (PinTableHeaderRowsRequest)

מעדכנת את מספר שורות הכותרת המוצמדות בטבלה.

{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}

string

הטקסט שיחליף את הטקסט התואם.

object (TabsCriteria)

זה שינוי אופציונלי. הקריטריונים שמשמשים לציון באילו כרטיסיות מתבצעת ההחלפה.

אם השדה הזה לא יצוין, ההחלפה תחול על כל הכרטיסיות.

במסמך שמכיל כרטיסייה אחת:

• אם צוין, חייב להתאים למזהה הכרטיסייה היחידה.

• אם השדה הזה יושמט, ההחלפה תחול על הכרטיסייה היחידה.

במסמך שמכיל כמה כרטיסיות:

• אם צוין, ההחלפה תחול על הכרטיסיות שצוינו.

• אם לא צוין, ההחלפה תחול על כל הכרטיסיות.

object (SubstringMatchCriteria)

חיפוש טקסט במסמך שמתאים למחרוזת המשנה הזו.

{
  "text": string,
  "matchCase": boolean
}

string

הטקסט שרוצים לחפש במסמך.

boolean

מציין אם החיפוש צריך להתחשב ברישיות:

• True : החיפוש תלוי אותיות רישיות.
• False : החיפוש לא תלוי באותיות רישיות.

{
  "tabIds": [
    string
  ]
}

string

רשימת מזהי הכרטיסיות שבהן הבקשה מתבצעת.

{
  "text": string,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

string

הטקסט שרוצים להוסיף.

הוספת תו של שורה חדשה תיצור באופן משתמע Paragraph חדש באותו אינדקס. סגנון הפסקה של הפסקה החדשה יועתק מהפסקה שמופיעה באינדקס ההוספה הנוכחי, כולל רשימות ותווי כוכב.

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

תווי בקרה מסוימים (U+0000-U+0008, ‏ U+000C-U+001F) ותווים מאזור השימוש הפרטי של מישור Unicode Basic Multilingual (U+E000-U+F8FF) יוסרו מהטקסט שהוכנס.

object (Location)

הוספת הטקסט באינדקס ספציפי במסמך.

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

object (EndOfSegmentLocation)

הטקסט יתווסף בסוף כותרת עליונה, כותרת תחתונה, הערת שוליים או גוף המסמך.

{
  "segmentId": string,
  "index": integer,
  "tabId": string
}

string

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

integer

האינדקס שמתחיל באפס, ביחידות קוד UTF-16.

המדד הוא ביחס לתחילת הקטע שצוין על ידי segmentId.

string

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

במסמך שמכיל כרטיסייה אחת:

• אם צוין, חייב להתאים למזהה הכרטיסייה היחידה.

• אם השדה הזה לא יצוין, הבקשה תחול על הכרטיסייה היחידה.

במסמך שמכיל כמה כרטיסיות:

• אם צוין כרטיסייה, הבקשה תחול על הכרטיסייה שצוינה.

• אם השמטתם את הפרמטר, הבקשה תחול על הכרטיסייה הראשונה במסמך.

{
  "segmentId": string,
  "tabId": string
}

string

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

string

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

במסמך שמכיל כרטיסייה אחת:

• אם צוין, חייב להתאים למזהה הכרטיסייה היחידה.

• אם השדה הזה לא יצוין, הבקשה תחול על הכרטיסייה היחידה.

במסמך שמכיל כמה כרטיסיות:

• אם צוין כרטיסייה, הבקשה תחול על הכרטיסייה שצוינה.

• אם השמטתם את הפרמטר, הבקשה תחול על הכרטיסייה הראשונה במסמך.

{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}

object (TextStyle)

הסגנונות שרוצים להגדיר לטקסט.

אם הערך של סגנון מסוים תואם לערך של ההורה, הסגנון הזה יוגדר לירושה.

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

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין שדה אחד לפחות. השורש textStyle הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

לדוגמה, כדי לעדכן את סגנון הטקסט למודגש, מגדירים את הערך של fields ל-"bold".

כדי לאפס נכס לערך ברירת המחדל שלו, צריך לכלול את שם השדה שלו במסיכת השדה, אבל להשאיר את השדה עצמו ללא הגדרה.

object (Range)

טווח הטקסט שרוצים לעצב.

הטווח עשוי להתארך כך שיכלול שורות חדשות סמוכות.

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

אי אפשר להוסיף טווחים בתוך UpdateTextStyleRequest יחסי.

{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}

object (Range)

הטווח שבו רוצים להחיל את הגדרת התבליטים המוגדרת מראש.

enum (BulletGlyphPreset)

סוגי הסמלים של הנקודות ליד הטקסט שישמשו.

{
  "range": {
    object (Range)
  }
}

object (Range)

הטווח שממנו רוצים למחוק את הנקודות.

{
  "name": string,
  "range": {
    object (Range)
  }
}

string

השם של NamedRange. השמות לא חייבים להיות ייחודיים.

השמות חייבים להכיל לפחות תו אחד ולא יותר מ-256 תווים, נמדדים ביחידות קוד UTF-16.

object (Range)

הטווח שאליו רוצים להחיל את השם.

{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}

object (TabsCriteria)

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

במסמך שמכיל כרטיסייה אחת:

• אם צוין, חייב להתאים למזהה הכרטיסייה היחידה.

• אם השדה הזה יושמט, המחיקה של הטווח תחול על הכרטיסייה היחידה.

במסמך שמכיל כמה כרטיסיות:

• אם מציינים כרטיסיות, המחיקה של הטווח תחול על הכרטיסיות שצוינו.

• אם לא מציינים טווח, המחיקה תחול על כל הכרטיסיות.

string

המזהה של טווח התאים בעל השם שרוצים למחוק.

string

השם של הטווחים שרוצים למחוק. כל הטווחים עם השם הנתון יימחקו.

{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}

object (ParagraphStyle)

הסגנונות שרוצים להגדיר בפסקאות.

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

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין שדה אחד לפחות. השורש paragraphStyle הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

לדוגמה, כדי לעדכן את מאפיין ההתאמה של סגנון הפסקה, מגדירים את fields לערך "alignment".

כדי לאפס נכס לערך ברירת המחדל שלו, צריך לכלול את שם השדה שלו במסיכת השדה, אבל להשאיר את השדה עצמו ללא הגדרה.

object (Range)

הטווח שחופף לפסקות שרוצים לעצב.

{
  "range": {
    object (Range)
  }
}

object (Range)

טווח התוכן שרוצים למחוק.

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

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

דוגמאות לבקשות לא חוקיות למחיקה:

• מחיקה של יחידת קוד אחת מצמד חלופי.
• מחיקת התו האחרון של שורת ההתחלה של Body,‏ Header,‏ Footer,‏ Footnote,‏ TableCell או TableOfContents.
• מחיקה של ההתחלה או הסוף של Table,‏ TableOfContents או Equation בלי למחוק את הרכיב כולו.
• מחיקת התו של שורת חדשה לפני Table,‏ TableOfContents או SectionBreak בלי למחוק את הרכיב.
• מחיקה של שורות או תאים ספציפיים בטבלה. מותר למחוק את התוכן בתוך תא בטבלה.

{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

string

ה-URI של התמונה.

התמונה מאוחזרת פעם אחת בזמן ההוספה, ועותק שלה נשמר להצגה בתוך המסמך. התמונות צריכות להיות בגודל של עד 50MB, לא יכולות לחרוג מ-25 מגה-פיקסל וצריכות להיות בפורמט PNG,‏ JPEG או GIF.

ה-URI שסופק חייב להיות גלוי לכולם באורך של עד 2KB. ה-URI עצמו נשמר עם התמונה וחשוף דרך השדה ImageProperties.content_uri.

object (Size)

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

object (Location)

הוספת התמונה לאינדקס ספציפי במסמך.

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

אי אפשר להוסיף תמונות בתוך הערה שוליים או נוסחה.

object (EndOfSegmentLocation)

הטקסט יתווסף בסוף הכותרת העליונה, הכותרת התחתונה או גוף המסמך.

אי אפשר להוסיף תמונות מוטבעות בתוך הערה שוליים.

{
  "rows": integer,
  "columns": integer,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

integer

מספר השורות בטבלה.

integer

מספר העמודות בטבלה.

object (Location)

הוספת הטבלה לאינדקס מודלים ספציפי.

תו של שורת חדשה יוכנס לפני הטבלה שהוכנסה, לכן אינדקס ההתחלה של הטבלה יהיה אינדקס המיקום שצוין + 1.

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

אי אפשר להוסיף טבלאות בתוך הערה שוליים או בתוך משוואה.

object (EndOfSegmentLocation)

הוספת הטבלה בסוף הכותרת העליונה, הכותרת התחתונה או גוף המסמך. תו של מעבר שורה יתווסף לפני הטבלה שתתווסף.

אי אפשר להוסיף טבלאות בתוך הערה שוליים.

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}

object (TableCellLocation)

מיקום התא בטבלת העזר שממנו יתווספו שורות.

תתווסף שורה חדשה מעל (או מתחת) לשורה שבה נמצא תא העזר. אם תא העזר הוא תא ממוזג, תתווסף שורה חדשה מעל (או מתחת) לתא הממוזג.

boolean

האם להוסיף שורה חדשה מתחת למיקום של תא העזר.

• True : הוספה מתחת לתא.
• False : הוספה מעל התא.

{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}

object (Location)

המיקום שבו מתחילה הטבלה במסמך.

integer

מספר השורה שמתחיל ב-0. לדוגמה, האינדקס של השורה השנייה בטבלה הוא 1.

integer

אינדקס העמודה שמתחיל ב-0. לדוגמה, העמודה השנייה בטבלה היא בעלת אינדקס העמודה 1.

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}

object (TableCellLocation)

מיקום התא בטבלת העזר שממנו יתווספו העמודות.

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

boolean

האם להוסיף עמודה חדשה מימין למיקום של תא העזר.

• True : הוספה שמאלה.
• False : הוספה שמאלה.

{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}

object (TableCellLocation)

מיקום התא בטבלת העזר שממנו השורה תימחק.

השורה שהתא הזה משתרע עליה תימחק. אם מדובר בתא ממוזג שמשתרע על כמה שורות, כל השורות שבהן התא משתרע יימחקו. אם לא נותרו שורות בטבלה אחרי המחיקה הזו, כל הטבלה נמחקת.

{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}

object (TableCellLocation)

מיקום התא בטבלת העזר שממנה תימחק העמודה.

העמודה שהתא הזה משתרע עליה תימחק. אם מדובר בתא משולב שמשתרע על כמה עמודות, כל העמודות שבהן התא משתרע יימחקו. אם לא נותרו עמודות בטבלה אחרי המחיקה הזו, כל הטבלה נמחקת.

{

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

object (Location)

הוספת מעבר דף במקום ספציפי במסמך.

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

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

object (EndOfSegmentLocation)

הוספת מעבר דף בסוף גוף המסמך.

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

{
  "objectId": string,
  "tabId": string
}

string

המזהה של האובייקט הממוקם שרוצים למחוק.

string

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

במסמך שמכיל כרטיסייה אחת:

• אם צוין, חייב להתאים למזהה הכרטיסייה היחידה.

• אם השדה הזה לא יצוין, הבקשה תחול על הכרטיסייה היחידה.

במסמך שמכיל כמה כרטיסיות:

• אם צוין כרטיסייה, הבקשה תחול על הכרטיסייה שצוינה.

• אם השמטתם את הפרמטר, הבקשה תחול על הכרטיסייה הראשונה במסמך.

{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}

object (Location)

המיקום שבו מתחילה הטבלה במסמך.

integer

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

object (TableColumnProperties)

מאפייני העמודה בטבלה שרוצים לעדכן.

אם הערך של tableColumnProperties#width קטן מ-5 נקודות (5/72 אינץ'), תוחזר שגיאה 400 של בקשה לא חוקית.

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין שדה אחד לפחות. השורש tableColumnProperties הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

לדוגמה, כדי לעדכן את רוחב העמודה, מגדירים את fields ל-"width".

{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  // Union field cells can be only one of the following:
  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
  // End of list of possible types for union field cells.
}

object (TableCellStyle)

הסגנון שרוצים להגדיר בתאי הטבלה.

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

מכיוון שעדכון של גבול שמשותף בין תאים סמוכים באותה בקשה עלול לגרום לעדכוני גבול סותרים, עדכוני גבול חלים בסדר הבא:

• borderRight
• borderLeft
• borderBottom
• borderTop

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין שדה אחד לפחות. השורש tableCellStyle הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

לדוגמה, כדי לעדכן את צבע הרקע של תא בטבלה, מגדירים את הערך של fields כ-"backgroundColor".

כדי לאפס נכס לערך ברירת המחדל שלו, צריך לכלול את שם השדה שלו במסיכת השדה, אבל להשאיר את השדה עצמו ללא הגדרה.

object (TableRange)

טווח הטבלה שמייצג את קבוצת המשנה של הטבלה שאליה חלים העדכונים.

object (Location)

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

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}

object (TableCellLocation)

מיקום התא שבו מתחיל טווח הטבלה.

integer

היקף השורות של טווח הטבלה.

integer

היקף העמודות של טווח הטבלה.

{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}

object (Location)

המיקום שבו מתחילה הטבלה במסמך.

integer

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

object (TableRowStyle)

הסגנונות שייקבעו לשורות.

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין שדה אחד לפחות. השורש tableRowStyle הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

לדוגמה, כדי לעדכן את גובה השורה המינימלי, מגדירים את fields לערך "minRowHeight".

{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}

string

המזהה של התמונה הקיימת שתוחליף. אפשר לאחזר את המזהה מהתגובה של בקשת get.

string

ה-URI של התמונה החדשה.

התמונה מאוחזרת פעם אחת בזמן ההוספה, ועותק שלה נשמר להצגה בתוך המסמך. התמונות צריכות להיות בגודל של עד 50MB, לא יכולות לחרוג מ-25 מגה-פיקסל וצריכות להיות בפורמט PNG,‏ JPEG או GIF.

אורך כתובת ה-URI שצוינה לא יכול לחרוג מ-2KB. ה-URI נשמר עם התמונה וחשוף דרך השדה ImageProperties.source_uri.

enum (ImageReplaceMethod)

שיטת ההחלפה.

string

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

במסמך שמכיל כרטיסייה אחת:

• אם צוין, חייב להתאים למזהה הכרטיסייה היחידה.

• אם השדה הזה לא יצוין, הבקשה תחול על הכרטיסייה היחידה.

במסמך שמכיל כמה כרטיסיות:

• אם צוין כרטיסייה, הבקשה תחול על הכרטיסייה שצוינה.

• אם השמטתם את השדה, הבקשה תחול על הכרטיסייה הראשונה במסמך.

{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}

object (DocumentStyle)

הסגנונות שרוצים להגדיר במסמך.

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

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין שדה אחד לפחות. השורש documentStyle הוא מרומז ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

לדוגמה, כדי לעדכן את הרקע, מגדירים את הערך של fields ל-"background".

string

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

במסמך שמכיל כרטיסייה אחת:

• אם צוין, חייב להתאים למזהה הכרטיסייה היחידה.

• אם השדה הזה לא יצוין, הבקשה תחול על הכרטיסייה היחידה.

במסמך שמכיל כמה כרטיסיות:

• אם צוין כרטיסייה, הבקשה תחול על הכרטיסייה שצוינה.

• אם לא מציינים כרטיסייה, הבקשה חלה על הכרטיסייה הראשונה במסמך.

{
  "tableRange": {
    object (TableRange)
  }
}

object (TableRange)

טווח הטבלה שמציין אילו תאים בטבלה למזג.

כל הטקסט בתאים שמוזגו יקושרת ויישמר בתא 'head' של הטווח. זהו התא הימני העליון של הטווח כשכיוון התוכן הוא משמאל לימין, והתא הימני העליון של הטווח במקרים אחרים.

אם הטווח לא מרובע (מצב שיכול לקרות במקרים מסוימים שבהם הטווח מכסה תאים שכבר מוזגו או שהטבלה לא מרובע), תוחזר שגיאה 400 של בקשה לא חוקית.

{
  "tableRange": {
    object (TableRange)
  }
}

object (TableRange)

טווח הטבלה שמציין אילו תאים בטבלה צריך לבטל את המיזוג שלהם.

כל התאים הממוזגים בטווח הזה יבוטלו, ותאים שכבר בוטלו לא יושפעו. אם אין בטווח תאים ממוזגים, הבקשה לא תבצע שום פעולה.

אם יש טקסט באחד מהתאים הממוזגים, הטקסט יישאר בתא 'הראש' של הבלוק שנוצר של תאים לא ממוזגים. התא 'head' הוא התא הימני העליון כשכיוון התוכן הוא משמאל לימין, והתא הימני העליון במקרים אחרים.

{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}

enum (HeaderFooterType)

סוג הכותרת שרוצים ליצור.

object (Location)

המיקום של ה-SectionBreak שמתחיל את הקטע שאליו הכותרת הזו צריכה להשתייך. אם לא מגדירים את 'sectionBreakLocation' או אם הוא מתייחס לפסקת המעבר הראשונה בגוף המסמך, הכותרת חלה על DocumentStyle

{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}

enum (HeaderFooterType)

סוג הכותרת התחתונה שרוצים ליצור.

object (Location)

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

{

  // Union field footnote_reference_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field footnote_reference_location.
}

object (Location)

הוספת ההפניה להערת השוליים באינדקס ספציפי במסמך.

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

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

object (EndOfSegmentLocation)

הוספת ההפניה להערת השוליים בסוף גוף המסמך.

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

{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field replacement_content can be only one of the following:
  "text": string
  // End of list of possible types for union field replacement_content.

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}

object (TabsCriteria)

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

במסמך שמכיל כרטיסייה אחת:

• אם צוין, חייב להתאים למזהה הכרטיסייה היחידה.

• אם השדה הזה יושמט, ההחלפה תחול על הכרטיסייה היחידה.

במסמך שמכיל כמה כרטיסיות:

• אם צוין, ההחלפה תחול על הכרטיסיות שצוינו.

• אם לא צוין, ההחלפה תחול על כל הכרטיסיות.

string

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

string

המזהה של טווח השמות שתוכנו יוחלף.

אם אין טווח בעל שם עם המזהה שצוין, תוחזר שגיאה 400 (בקשה לא חוקית).

string

השם של NamedRanges שהתוכן שלו יוחלף.

אם יש כמה named ranges עם השם הזה, התוכן של כל אחד מהם יוחלף. אם אין טווחים בעלי שם עם השם שצוין, הבקשה תהיה פעולה ללא תוצאה.

{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}

object (Range)

הטווח שחופף לקטעים שרוצים לעצב.

מכיוון שאפשר להוסיף חלוקות לקטעים רק בגוף, השדה segment ID חייב להיות ריק.

object (SectionStyle)

הסגנונות שייקבעו בקטע.

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

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין שדה אחד לפחות. השורש sectionStyle הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

לדוגמה, כדי לעדכן את השוליים השמאליים, מגדירים את fields ל-"marginLeft".

{
  "sectionType": enum (SectionType),

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

enum (SectionType)

סוג הקטע שרוצים להוסיף.

object (Location)

הוספת שורה חדשה ופסק קטע במקום ספציפי במסמך.

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

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

object (EndOfSegmentLocation)

הוספת שורה חדשה וקטע חדש בסוף גוף המסמך.

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

{
  "headerId": string,
  "tabId": string
}

string

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

string

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

במסמך שמכיל כרטיסייה אחת:

• אם צוין, חייב להתאים למזהה הכרטיסייה היחידה.

• אם השדה הזה לא יצוין, הבקשה תחול על הכרטיסייה היחידה.

במסמך שמכיל כמה כרטיסיות:

• אם צוין כרטיסייה, הבקשה תחול על הכרטיסייה שצוינה.

• אם השמטתם את הפרמטר, הבקשה תחול על הכרטיסייה הראשונה במסמך.

{
  "footerId": string,
  "tabId": string
}

string

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

string

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

במסמך שמכיל כרטיסייה אחת:

• אם צוין, חייב להתאים למזהה הכרטיסייה היחידה.

• אם השדה הזה לא יצוין, הבקשה תחול על הכרטיסייה היחידה.

במסמך שמכיל כמה כרטיסיות:

• אם צוין כרטיסייה, הבקשה תחול על הכרטיסייה שצוינה.

• אם השמטתם את הפרמטר, הבקשה תחול על הכרטיסייה הראשונה במסמך.

{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}

object (Location)

המיקום שבו מתחילה הטבלה במסמך.

integer

מספר שורות הטבלה שרוצים להצמיד. הערך 0 מציין שכל השורות לא מוצמדות.