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

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

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

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

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

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

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)

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

צריך לציין שדה אחד לפחות. השורש 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 בבלוק של התאים שלא מוזגו. התא '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 מרמז על כך שכל השורות לא מוצמדות.