Requests

בקשה

עדכון יחיד שחל על מסמך.

ייצוג ב-JSON 
{

  // 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)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  }
  // End of list of possible types for union field request.
}
שדות
שדה איחוד request. הבקשה הספציפית להחלת השינוי. צריך למפות שדה אחד בדיוק. ‫request יכול להיות רק אחד מהבאים:
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)

יוצר כותרת.

createFootnote

object (CreateFootnoteRequest)

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

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

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

updateSectionStyle

object (UpdateSectionStyleRequest)

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

insertSectionBreak

object (InsertSectionBreakRequest)

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

deleteHeader

object (DeleteHeaderRequest)

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

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

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

insertPerson

object (InsertPersonRequest)

הוספת תיוג של משתמש.

ReplaceAllTextRequest

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

ייצוג ב-JSON 
{
  "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.
}
שדות
replaceText

string

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

tabsCriteria

object (TabsCriteria)

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

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

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

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

  • אם לא מציינים את מספר הכרטיסייה, ההחלפה מתבצעת בכרטיסייה היחידה.

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

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

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

שדה איחוד criteria. הקריטריונים שמשמשים להתאמת הטקסט להחלפה. ‫criteria יכול להיות רק אחד מהבאים:
containsText

object (SubstringMatchCriteria)

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

SubstringMatchCriteria

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

ייצוג ב-JSON 
{
  "text": string,
  "matchCase": boolean,
  "searchByRegex": boolean
}
שדות
text

string

הטקסט שמחפשים במסמך.

matchCase

boolean

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

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

boolean

אופציונלי. ‫True אם צריך להתייחס לערך החיפוש כאל ביטוי רגולרי. צריך להוסיף תווי בריחה (escape) לכל קו נטוי הפוך בתבנית.

  • True : הטקסט לחיפוש מטופל כביטוי רגולרי.
  • False ‫: the search text is treated as a substring for matching.

TabsCriteria

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

ייצוג ב-JSON 
{
  "tabIds": [
    string
  ]
}
שדות
tabIds[]

string

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

InsertTextRequest

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

ייצוג ב-JSON 
{
  "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.
}
שדות
text

string

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

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

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

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

שדה איחוד insertion_location. המיקום שבו הטקסט יוכנס. ‫insertion_location יכול להיות רק אחד מהבאים:
location

object (Location)

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

מיקום

מיקום מסוים במסמך.

ייצוג ב-JSON 
{
  "segmentId": string,
  "index": integer,
  "tabId": string
}
שדות
segmentId

string

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

index

integer

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

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

tabId

string

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

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

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

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

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

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

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

EndOfSegmentLocation

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

ייצוג ב-JSON 
{
  "segmentId": string,
  "tabId": string
}
שדות
segmentId

string

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

tabId

string

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

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

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

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

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

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

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

UpdateTextStyleRequest

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

ייצוג ב-JSON 
{
  "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.
}
שדות
textStyle

object (TextStyle)

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

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

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

fields

string (FieldMask format)

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

צריך לציין לפחות שדה אחד. האלמנט root textStyle מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

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

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

שדה איחוד insertion_location. סוג הטווח שבו יתבצע עדכון של סגנון הטקסט. ‫insertion_location יכול להיות רק אחד מהבאים:
range

object (Range)

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

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

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

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

CreateParagraphBulletsRequest

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

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

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

ייצוג ב-JSON 
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
שדות
range

object (Range)

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

bulletPreset

enum (BulletGlyphPreset)

סוגי התווים של התבליטים שבהם רוצים להשתמש.

BulletGlyphPreset

תבניות מוגדרות מראש של גליפים של תבליטים לרשימות.

בדפוסים האלה נעשה שימוש בסוגי התבליטים הבאים:

  • ARROW : חץ, שמתאים לנקודת קוד Unicode U+2794
  • ARROW3D : חץ עם הצללה תלת-ממדית, שמתאים לנקודת קוד Unicode U+27a2
  • CHECKBOX : ריבוע חלול, שמתאים למיקום תו (code point) של Unicode ‏U+274f
  • CIRCLE : עיגול חלול, שמתאים למיקום תו (code point) של Unicode U+25cb
  • DIAMOND ‫: A solid diamond, corresponding to a Unicode U+25c6 code point
  • DIAMONDX : מעוין עם X, שמתאים למיקום תו (code point) של Unicode U+2756
  • HOLLOWDIAMOND : יהלום חלול, שמתאים למיקום תו (code point) של Unicode U+25c7
  • ‫DISC : עיגול מלא, שמתאים למיקום תו (code point) של Unicode U+25cf
  • SQUARE : ריבוע מלא, שמתאים למיקום תו (code point) של Unicode U+25a0
  • STAR ‫: כוכב, שמתאים לנקודת קוד Unicode U+2605
  • ALPHA : אות קטנה, כמו 'a',‏ 'b' או 'c'.
  • UPPERALPHA ‫: אות רישית, כמו A,‏ B או C.
  • DECIMAL ‫: מספר, כמו '1',‏ '2' או '3'.
  • ZERODECIMAL : מספר שבו למספרים חד-ספרתיים מתווסף אפס בתחילתם, כמו 01, 02 או 03. למספרים עם יותר מספרה אחת לא מתווסף אפס בתחילת המספר.
  • ‫ROMAN : ספרה רומית באותיות קטנות, כמו i,‏ ii או iii.
  • ‫UPPERROMAN : ספרה רומית באותיות רישיות, כמו 'I',‏ 'II' או 'III'.
  • LEFTTRIANGLE : משולש שמצביע שמאלה, שמתאים למיקום תו (code point) של Unicode U+25c4
טיפוסים בני מנייה (enum)
BULLET_GLYPH_PRESET_UNSPECIFIED לא צוין גליף מוגדר מראש לתבליטים.
BULLET_DISC_CIRCLE_SQUARE רשימה עם תבליטים עם DISC, CIRCLE ו- SQUARE סמל תבליט ל-3 רמות הקינון הראשונות ברשימה.
BULLET_DIAMONDX_ARROW3D_SQUARE רשימה עם תבליטים עם DIAMONDX, ARROW3D ו- SQUARE סמל תבליט ל-3 רמות הקינון הראשונות ברשימה.
BULLET_CHECKBOX רשימת תבליטים עם CHECKBOX תבליטים לכל רמות הקינון של הרשימה.
BULLET_ARROW_DIAMOND_DISC רשימה עם תבליטים עם ARROW, DIAMOND ו- DISC סמל תבליט ל-3 רמות הקינון הראשונות ברשימה.
BULLET_STAR_CIRCLE_SQUARE רשימה עם תבליטים עם STAR, CIRCLE ו- SQUARE סמל תבליט ל-3 רמות הקינון הראשונות ברשימה.
BULLET_ARROW3D_CIRCLE_SQUARE רשימה עם תבליטים עם ARROW3D, CIRCLE ו- SQUARE סמל תבליט ל-3 רמות הקינון הראשונות ברשימה.
BULLET_LEFTTRIANGLE_DIAMOND_DISC רשימה עם תבליטים עם LEFTTRIANGLE, DIAMOND ו- DISC סמל תבליט ל-3 רמות הקינון הראשונות ברשימה.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE רשימה עם תבליטים עם DIAMONDX, HOLLOWDIAMOND ו- SQUARE סמל תבליט ל-3 רמות הקינון הראשונות ברשימה.
BULLET_DIAMOND_CIRCLE_SQUARE רשימה עם תבליטים עם DIAMOND, CIRCLE ו- SQUARE סמל תבליט ל-3 רמות הקינון הראשונות ברשימה.
NUMBERED_DECIMAL_ALPHA_ROMAN רשימה ממוספרת עם DECIMAL, ALPHA ו- ROMAN סמלים מספריים ל-3 רמות הקינון הראשונות ברשימה, ואחריהם נקודות.
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS רשימה ממוספרת עם DECIMAL, ALPHA ו- ROMAN סמלים מספריים ל-3 רמות הקינון הראשונות ברשימה, ואחריהם סוגריים.
NUMBERED_DECIMAL_NESTED רשימה ממוספרת עם DECIMAL סמלי גליף מספריים שמופרדים באמצעות נקודות, כשכל רמת קינון משתמשת בסמל הגליף של רמת הקינון הקודמת כקידומת. לדוגמה: '1.', '1.1.', ‪'2.', ‫'2.2.'.
NUMBERED_UPPERALPHA_ALPHA_ROMAN רשימה ממוספרת עם UPPERALPHA, ALPHA ו- ROMAN סמלים מספריים ל-3 רמות הקינון הראשונות ברשימה, ואחריהם נקודות.
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL רשימה ממוספרת עם UPPERROMAN, UPPERALPHA ו- DECIMAL סמלים מספריים ל-3 רמות הקינון הראשונות ברשימה, ואחריהם נקודות.
NUMBERED_ZERODECIMAL_ALPHA_ROMAN רשימה ממוספרת עם ZERODECIMAL, ALPHA ו- ROMAN סמלים מספריים ל-3 רמות הקינון הראשונות ברשימה, ואחריהם נקודות.

DeleteParagraphBulletsRequest

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

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

ייצוג ב-JSON 
{
  "range": {
    object (Range)
  }
}
שדות
range

object (Range)

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

CreateNamedRangeRequest

הפונקציה יוצרת NamedRange שמפנה לטווח הנתון.

ייצוג ב-JSON 
{
  "name": string,
  "range": {
    object (Range)
  }
}
שדות
name

string

השם של NamedRange. השמות לא צריכים להיות ייחודיים.

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

range

object (Range)

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

DeleteNamedRangeRequest

מוחק את NamedRange.

ייצוג ב-JSON 
{
  "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.
}
שדות
tabsCriteria

object (TabsCriteria)

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

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

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

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

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

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

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

שדה איחוד named_range_reference. הערך שקובע איזה טווח או טווחים יימחקו. צריך להגדיר בדיוק אחד מהם. ‫named_range_reference יכול להיות רק אחד מהבאים:
namedRangeId

string

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

name

string

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

UpdateParagraphStyleRequest

עדכון הסגנון של כל הפסקאות שחופפות לטווח הנתון.

ייצוג ב-JSON 
{
  "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.
}
שדות
paragraphStyle

object (ParagraphStyle)

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

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

fields

string (FieldMask format)

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

צריך לציין לפחות שדה אחד. האלמנט root paragraphStyle מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

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

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

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

object (Range)

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

DeleteContentRangeRequest

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

ייצוג ב-JSON 
{
  "range": {
    object (Range)
  }
}
שדות
range

object (Range)

טווח התוכן למחיקה.

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

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

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

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

InsertInlineImageRequest

הוספת תג InlineObject עם תמונה במיקום שצוין.

ייצוג ב-JSON 
{
  "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.
}
שדות
uri

string

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

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

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

objectSize

object (Size)

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

שדה איחוד insertion_location. המיקום שבו התמונה תתווסף. ‫insertion_location יכול להיות רק אחד מהבאים:
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

InsertTableRequest

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

תווסף שורה חדשה לפני הטבלה.

ייצוג ב-JSON 
{
  "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.
}
שדות
rows

integer

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

columns

integer

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

שדה איחוד insertion_location. המיקום שבו הטבלה תוכנס. ‫insertion_location יכול להיות רק אחד מהבאים:
location

object (Location)

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

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

InsertTableRowRequest

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

ייצוג ב-JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
שדות
tableCellLocation

object (TableCellLocation)

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

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

insertBelow

boolean

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

  • True ‫: insert below the cell.
  • False ‫: insert above the cell.

TableCellLocation

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

ייצוג ב-JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
שדות
tableStartLocation

object (Location)

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

rowIndex

integer

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

columnIndex

integer

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

InsertTableColumnRequest

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

ייצוג ב-JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
שדות
tableCellLocation

object (TableCellLocation)

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

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

insertRight

boolean

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

  • True ‫: הוספה מימין.
  • False ‫: insert to the left.

DeleteTableRowRequest

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

ייצוג ב-JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
שדות
tableCellLocation

object (TableCellLocation)

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

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

DeleteTableColumnRequest

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

ייצוג ב-JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
שדות
tableCellLocation

object (TableCellLocation)

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

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

InsertPageBreakRequest

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

ייצוג ב-JSON 
{

  // 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.
}
שדות
שדה איחוד insertion_location. המיקום שבו יתווסף מעבר הדף. ‫insertion_location יכול להיות רק אחד מהבאים:
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

DeletePositionedObjectRequest

מוחק את PositionedObject מהמסמך.

ייצוג ב-JSON 
{
  "objectId": string,
  "tabId": string
}
שדות
objectId

string

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

tabId

string

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

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

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

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

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

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

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

UpdateTableColumnPropertiesRequest

עדכון של TableColumnProperties של עמודות בטבלה.

ייצוג ב-JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
שדות
tableStartLocation

object (Location)

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

columnIndices[]

integer

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

tableColumnProperties

object (TableColumnProperties)

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

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

fields

string (FieldMask format)

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

צריך לציין לפחות שדה אחד. האלמנט root tableColumnProperties מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

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

UpdateTableCellStyleRequest

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

ייצוג ב-JSON 
{
  "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.
}
שדות
tableCellStyle

object (TableCellStyle)

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

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

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

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

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

צריך לציין לפחות שדה אחד. האלמנט root tableCellStyle מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

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

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

שדה איחוד cells. התאים שיעודכנו. ‫cells יכול להיות רק אחד מהבאים:
tableRange

object (TableRange)

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

tableStartLocation

object (Location)

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

TableRange

טווח טבלה מייצג הפניה לקבוצת משנה של טבלה.

חשוב לציין שהתאים שמוגדרים בטווח של טבלה לא בהכרח יוצרים מלבן. לדוגמה, נניח שיש לנו טבלה בגודל 3x3 שבה כל התאים בשורה האחרונה מוזגו. הטבלה נראית כך: 

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

טווח טבלה עם מיקום תא בטבלה = (tableStartLocation, row = 0, column = 0), טווח שורות = 3 וטווח עמודות = 2 מציין את התאים הבאים: 

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
ייצוג ב-JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
שדות
tableCellLocation

object (TableCellLocation)

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

rowSpan

integer

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

columnSpan

integer

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

UpdateTableRowStyleRequest

מעדכן את TableRowStyle של שורות בטבלה.

ייצוג ב-JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}
שדות
tableStartLocation

object (Location)

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

rowIndices[]

integer

רשימת האינדקסים של השורות (החל מ-0) שרוצים לעדכן את הסגנון שלהן. אם לא מציינים אינדקסים, כל השורות יעודכנו.

tableRowStyle

object (TableRowStyle)

הסגנונות שיוגדרו בשורות.

fields

string (FieldMask format)

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

צריך לציין לפחות שדה אחד. האלמנט root tableRowStyle מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

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

ReplaceImageRequest

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

החלפת תמונה מסירה חלק מהתמונה הקיימת כדי לשקף את ההתנהגות של עורך Docs.image effects

ייצוג ב-JSON 
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}
שדות
imageObjectId

string

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

uri

string

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

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

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

imageReplaceMethod

enum (ImageReplaceMethod)

שיטת ההחלפה.

tabId

string

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

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

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

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

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

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

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

ImageReplaceMethod

השיטה להחלפת התמונה.

טיפוסים בני מנייה (enum)
IMAGE_REPLACE_METHOD_UNSPECIFIED שיטה לא מוגדרת להחלפת תמונה. אסור להשתמש בערך הזה.
CENTER_CROP התמונה מוגדלת וממוקמת במרכז כדי למלא את הגבולות של התמונה המקורית. יכול להיות שהתמונה תיחתך כדי למלא את הגבולות של התמונה המקורית. הגודל של התמונה שתוצג יהיה זהה לגודל של התמונה המקורית.

UpdateDocumentStyleRequest

מעדכן את DocumentStyle.

ייצוג ב-JSON 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}
שדות
documentStyle

object (DocumentStyle)

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

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

fields

string (FieldMask format)

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

צריך לציין לפחות שדה אחד. האלמנט root documentStyle מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

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

tabId

string

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

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

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

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

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

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

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

MergeTableCellsRequest

ממזגת תאים ב-Table.

ייצוג ב-JSON 
{
  "tableRange": {
    object (TableRange)
  }
}
שדות
tableRange

object (TableRange)

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

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

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

UnmergeTableCellsRequest

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

ייצוג ב-JSON 
{
  "tableRange": {
    object (TableRange)
  }
}
שדות
tableRange

object (TableRange)

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

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

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

CreateHeaderRequest

יוצר Header. הכותרת החדשה מוחלת על SectionStyle במיקום של SectionBreak אם הוא צוין, אחרת היא מוחלת על DocumentStyle.

אם כבר קיימת כותרת מהסוג שצוין, תוחזר שגיאה מסוג 400 בקשה שגויה.

ייצוג ב-JSON 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
שדות
type

enum (HeaderFooterType)

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

sectionBreakLocation

object (Location)

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

HeaderFooterType

סוגי הכותרות העליונות והתחתונות שאפשר ליצור.

טיפוסים בני מנייה (enum)
DEFAULT כותרת עליונה או תחתונה שמוגדרות כברירת מחדל.

CreateFooterRequest

יוצר Footer. הכותרת התחתונה החדשה מוחלת על SectionStyle במיקום של SectionBreak אם צוין, אחרת היא מוחלת על DocumentStyle.

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

ייצוג ב-JSON 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
שדות
type

enum (HeaderFooterType)

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

sectionBreakLocation

object (Location)

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

CreateFootnoteRequest

יוצר פלח Footnote ומכניס אליו FootnoteReference חדש במיקום שצוין.

הפלח החדש Footnote יכיל רווח ואחריו תו של שורה חדשה.

ייצוג ב-JSON 
{

  // 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.
}
שדות
שדה איחוד footnote_reference_location. המיקום שבו רוצים להוסיף את ההפניה להערת שוליים. ‫footnote_reference_location יכול להיות רק אחד מהבאים:
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

ReplaceNamedRangeContentRequest

החלפת התוכן של NamedRange או NamedRanges שצוינו בתוכן החלופי שניתן.

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

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

ייצוג ב-JSON 
{
  "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.
}
שדות
tabsCriteria

object (TabsCriteria)

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

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

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

  • אם לא מציינים את מספר הכרטיסייה, ההחלפה מתבצעת בכרטיסייה היחידה.

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

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

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

שדה איחוד replacement_content. התוכן שצריך להחליף את התוכן הקיים של הטווח בעל השם. ‫replacement_content יכול להיות רק אחד מהבאים:
text

string

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

שדה איחוד named_range_reference. הפניה לטווח התאים בעלי השם שהתוכן שלהם יוחלף. ‫named_range_reference יכול להיות רק אחד מהבאים:
namedRangeId

string

המזהה של הטווח בעל השם שהתוכן שלו יוחלף.

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

namedRangeName

string

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

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

UpdateSectionStyleRequest

מעדכן את SectionStyle.

ייצוג ב-JSON 
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
שדות
range

object (Range)

הטווח שחופף לקטעים שרוצים להחיל עליהם סגנון.

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

sectionStyle

object (SectionStyle)

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

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

fields

string (FieldMask format)

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

צריך לציין לפחות שדה אחד. האלמנט root sectionStyle מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

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

InsertSectionBreakRequest

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

תו של שורה חדשה יתווסף לפני מעבר הקטע.

ייצוג ב-JSON 
{
  "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.
}
שדות
sectionType

enum (SectionType)

סוג הקטע להוספה.

שדה איחוד insertion_location. המיקום שבו יתווסף המעבר. ‫insertion_location יכול להיות רק אחד מהבאים:
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

מוסיף שורה חדשה ומעבר בין קטעים בסוף גוף המסמך.

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

DeleteHeaderRequest

מוחק את Header מהמסמך.

ייצוג ב-JSON 
{
  "headerId": string,
  "tabId": string
}
שדות
headerId

string

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

tabId

string

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

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

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

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

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

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

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

DeleteFooterRequest

מוחק את Footer מהמסמך.

ייצוג ב-JSON 
{
  "footerId": string,
  "tabId": string
}
שדות
footerId

string

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

tabId

string

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

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

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

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

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

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

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

PinTableHeaderRowsRequest

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

ייצוג ב-JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
שדות
tableStartLocation

object (Location)

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

pinnedHeaderRowsCount

integer

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

InsertPersonRequest

הוספת תיוג של משתמש.

ייצוג ב-JSON 
{
  "personProperties": {
    object (PersonProperties)
  },

  // 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.
}
שדות
personProperties

object (PersonProperties)

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

שדה איחוד insertion_location. המיקום שבו יתווסף התיוג של האדם. ‫insertion_location יכול להיות רק אחד מהבאים:
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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