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 Plane (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)

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

יש לציין שדה אחד לפחות. הרמה הבסיסית (root) 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)

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

יש לציין שדה אחד לפחות. הרמה הבסיסית (root) paragraphStyle היא משתמעת ואין לציין אותה. סינגל "*" יכולים לשמש כקיצורים לכל שדה.

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

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

object (Range)

הטווח שחופף לפסקאות לסגנון.

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

object (Range)

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

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

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

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

• מחיקה של יחידת קוד אחת של זוג תווי Surogate.
• מחיקת התו האחרון בשורה החדשה של 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

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

integer

אינדקס העמודות המבוסס על אפס. לדוגמה, לעמודה השנייה בטבלה יהיה אינדקס עמודה של 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)

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

יש לציין שדה אחד לפחות. הרמה הבסיסית (root) 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)

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

יש לציין שדה אחד לפחות. הרמה הבסיסית (root) 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)

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

יש לציין שדה אחד לפחות. הרמה הבסיסית (root) tableRowStyle היא משתמעת ואין לציין אותה. סינגל "*" יכולים לשמש כקיצורים לכל שדה.

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

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

string

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

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)

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

יש לציין שדה אחד לפחות. הרמה הבסיסית (root) documentStyle היא משתמעת ואין לציין אותה. סינגל "*" יכולים לשמש כקיצורים לכל שדה.

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

string

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

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

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

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

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

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

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

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

object (TableRange)

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

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

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

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

object (TableRange)

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

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

אם יש טקסט באחד מהתאים שמוזגו, הטקסט יישאר ב-head בבלוק של התאים שלא מוזגו. "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)

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

יש לציין שדה אחד לפחות. הרמה הבסיסית (root) 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 מרמז על כך שכל השורות לא מוצמדות.