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)
  }
  // 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)

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

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
}
שדות
text

string

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

matchCase

boolean

מציינת אם החיפוש צריך להתייחס לאותיות רישיות:

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

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

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

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

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

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

object (Range)

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

bulletPreset

enum (BulletGlyphPreset)

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

BulletGlyphPreset

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

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

  • ARROW : חץ, התואם למיקום התו (code point) U+2794 ב-Unicode
  • ARROW3D : חץ עם צללית תלת-ממדית, התואם למיקום תו (code point) U+27a2 ב-Unicode
  • CHECKBOX : ריבוע חלול, התואם למיקום תו (code point) ב-Unicode‏ U+274f
  • CIRCLE : עיגול חלול שתואם לנקודת קוד בפורמט Unicode U+25cb
  • DIAMOND : ריבוע שחור מלא, שתואם למיקום תו (code point) U+25c6 ב-Unicode
  • DIAMONDX : יהלום עם 'x', שתואם לנקודת קוד של Unicode U+2756
  • HOLLOWDIAMOND : יהלום חלול, התואם למיקום תו (code point) U+25c7 ב-Unicode
  • DISC : עיגול מלא, התואם למיקום תו (code point) ב-Unicode‏ U+25cf
  • SQUARE : ריבוע מלא, שתואם לנקודת קוד של Unicode U+25a0
  • STAR : כוכב, התואם למיקום התו (code point) U+2605 ב-Unicode
  • 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 : משולש שמצביע שמאלה, התואם לנקודת קוד של 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)

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

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

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

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

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

object (Range)

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

DeleteContentRangeRequest

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

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

object (Range)

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

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

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

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

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

TableCellLocation

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

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

object (Location)

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

rowIndex

integer

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

columnIndex

integer

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

InsertTableColumnRequest

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

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

object (TableCellLocation)

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

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

insertRight

boolean

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

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

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)

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

צריך לציין שדה אחד לפחות. השורש 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)

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

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

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

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

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

object (TableRange)

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

tableStartLocation

object (Location)

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

TableRange

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

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

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

טווח בטבלה שבו מיקום התא בטבלה = (tableStartLocation, שורה = 0, עמודה = 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

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

tableRowStyle

object (TableRowStyle)

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

fields

string (FieldMask format)

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

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

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

ReplaceImageRequest

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

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

ייצוג 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)

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

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

אם הטווח לא מלבני (מצב כזה יכול לקרות במקרים מסוימים שבהם הטווח מכסה תאים שכבר ממוזגים או כשהטבלה לא מלבנית), מוחזר שגיאה 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)

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

צריך לציין שדה אחד לפחות. השורש 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 מציין שכל השורות לא מוצמדות.