Requests

בקשה

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

ייצוג ב-JSON 
{

  "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)
  },
  "addDocumentTab": {
    object (AddDocumentTabRequest)
  },
  "deleteTab": {
    object (DeleteTabRequest)
  },
  "updateDocumentTabProperties": {
    object (UpdateDocumentTabPropertiesRequest)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  },
  "updateNamedStyle": {
    object (UpdateNamedStyleRequest)
  },
  "insertRichLink": {
    object (InsertRichLinkRequest)
  },
  "insertDate": {
    object (InsertDateRequest)
  },
  "insertComment": {
    object (InsertCommentRequest)
  },
  "addCommentReply": {
    object (AddCommentReplyRequest)
  },
  "updateCommentPost": {
    object (UpdateCommentPostRequest)
  },
  "deleteComment": {
    object (DeleteCommentRequest)
  },
  "deleteCommentReply": {
    object (DeleteCommentReplyRequest)
  },
  "acceptSuggestion": {
    object (AcceptSuggestionRequest)
  },
  "rejectSuggestion": {
    object (RejectSuggestionRequest)
  },
  "deleteSuggestion": {
    object (DeleteSuggestionRequest)
  }
}
שדות
הבקשה הספציפית להגשת ערעור. חובה למפות שדה אחד בדיוק. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
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)

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

addDocumentTab

object (AddDocumentTabRequest)

מוסיף כרטיסיית מסמך.

deleteTab

object (DeleteTabRequest)

מחיקת כרטיסייה במסמך.

updateDocumentTabProperties

object (UpdateDocumentTabPropertiesRequest)

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

insertPerson

object (InsertPersonRequest)

הוספת תיוג של אדם.

updateNamedStyle

object (UpdateNamedStyleRequest)

מעדכן סגנון עם שם.

insertDate

object (InsertDateRequest)

הוספת תאריך.

insertComment

object (InsertCommentRequest)

מוסיפים את התו CommentThread למסמך.

addCommentReply

object (AddCommentReplyRequest)

מוסיפים תשובה ל-CommentThread או ל-SuggestionThread.

updateCommentPost

object (UpdateCommentPostRequest)

עדכון של פוסט קיים (פוסט ראשי או תשובה) ב-CommentThread או ב-SuggestionThread.

deleteComment

object (DeleteCommentRequest)

מוחק את CommentThread.

deleteCommentReply

object (DeleteCommentReplyRequest)

מחיקת תגובה Post מתוך CommentThread או SuggestionThread.

acceptSuggestion

object (AcceptSuggestionRequest)

מאשרים הצעה.

rejectSuggestion

object (RejectSuggestionRequest)

דחיית הצעה.

deleteSuggestion

object (DeleteSuggestionRequest)

מחיקת הצעה.

סוף השדות הבלעדיים.

ReplaceAllTextRequest

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

ייצוג ב-JSON 
{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

  "containsText": {
    object (SubstringMatchCriteria)
  }
}
שדות
replaceText

string

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

tabsCriteria

object (TabsCriteria)

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

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

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

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

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

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

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

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

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

object (SubstringMatchCriteria)

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

סוף השדות הבלעדיים.

SubstringMatchCriteria

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

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

string

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

matchCase

boolean

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

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

boolean

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

  • True ‫: the search text is treated as a regular expressions.
  • False ‫: הטקסט לחיפוש נחשב למחרוזת משנה לצורך התאמה.

TabsCriteria

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

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

string

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

InsertTextRequest

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

ייצוג ב-JSON 
{
  "text": string,

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
שדות
text

string

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

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

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

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

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

  "range": {
    object (Range)
  }
}
שדות
textStyle

object (TextStyle)

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

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

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

fields

string (FieldMask format)

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

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

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

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

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

object (Range)

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

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

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

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

סוף השדות הבלעדיים.

CreateParagraphBulletsRequest

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

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

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

ייצוג ב-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 ‫: יהלום מלא, שמתאים למיקום תו (code point) ב-Unicode‏ U+25c6
  • 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  : כוכב, שמתאים למיקום תו (code point) של 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

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

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

range

object (Range)

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

DeleteNamedRangeRequest

מוחק את NamedRange.

ייצוג ב-JSON 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  "namedRangeId": string,
  "name": string
}
שדות
tabsCriteria

object (TabsCriteria)

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

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

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

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

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

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

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

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

string

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

name

string

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

סוף השדות הבלעדיים.

UpdateParagraphStyleRequest

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

ייצוג ב-JSON 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  "range": {
    object (Range)
  }
}
שדות
paragraphStyle

object (ParagraphStyle)

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

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

fields

string (FieldMask format)

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

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

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

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

סוג הטווח שבו יתעדכן סגנון הפסקה. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
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)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
שדות
uri

string

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

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

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

objectSize

object (Size)

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

המיקום שבו התמונה תווסף. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

סוף השדות הבלעדיים.

InsertTableRequest

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

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

ייצוג ב-JSON 
{
  "rows": integer,
  "columns": integer,

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
שדות
rows

integer

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

columns

integer

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

המיקום שבו הטבלה תוכנס. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
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

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

columnIndex

integer

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

InsertTableColumnRequest

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

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

object (TableCellLocation)

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

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

insertRight

boolean

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

  • True ‫: insert to the right.
  • False  : הוספה משמאל.

DeleteTableRowRequest

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

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

object (TableCellLocation)

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

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

DeleteTableColumnRequest

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

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

object (TableCellLocation)

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

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

InsertPageBreakRequest

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

ייצוג ב-JSON 
{

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
שדות
המיקום שבו יתווסף מעבר הדף. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
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

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

tableColumnProperties

object (TableColumnProperties)

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

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

fields

string (FieldMask format)

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

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

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

UpdateTableCellStyleRequest

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

ייצוג ב-JSON 
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
}
שדות
tableCellStyle

object (TableCellStyle)

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

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

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

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

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

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

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

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

התאים שיעודכנו. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
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

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

החלפת תמונה מסירה חלק 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)

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

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

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

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
שדות
המיקום שבו רוצים להוסיף את ההפניה להערת השוליים. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

סוף השדות הבלעדיים.

ReplaceNamedRangeContentRequest

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

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

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

ייצוג ב-JSON 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  "text": string

  "namedRangeId": string,
  "namedRangeName": string
}
שדות
tabsCriteria

object (TabsCriteria)

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

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

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

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

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

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

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

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

string

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

סוף השדות הבלעדיים.
הפניה לטווח תאים בעל שם(או טווחי תאים בעלי שמות) שהתוכן שלהם יוחלף. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
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),

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
שדות
sectionType

enum (SectionType)

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

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

AddDocumentTabRequest

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

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

object (TabProperties)

המאפיינים של הכרטיסייה שרוצים להוסיף. כל המאפיינים הם אופציונליים.

DeleteTabRequest

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

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

string

המזהה של הכרטיסייה שרוצים למחוק.

UpdateDocumentTabPropertiesRequest

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

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

object (TabProperties)

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

fields

string (FieldMask format)

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

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

InsertPersonRequest

הוספת תיוג של אדם.

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

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
שדות
personProperties

object (PersonProperties)

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

המיקום שבו יוכנס התיוג של האדם. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

סוף השדות הבלעדיים.

UpdateNamedStyleRequest

מעדכן סגנון עם שם.

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

object (NamedStyle)

סגנון המסמך שרוצים לעדכן.

fields

string (FieldMask format)

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

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

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

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

tabId

string

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

InsertRichLinkRequest

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

ייצוג ב-JSON 
{
  "richLinkProperties": {
    object (RichLinkProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
שדות
המיקום שבו יוצג הקישור העשיר. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

סוף השדות הבלעדיים.

InsertDateRequest

הוספת תאריך במיקום שצוין.

ייצוג ב-JSON 
{
  "dateElementProperties": {
    object (DateElementProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
שדות
dateElementProperties

object (DateElementProperties)

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

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

object (Location)

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

סוף השדות הבלעדיים.

InsertCommentRequest

מוסיפים את התו CommentThread למסמך.

ייצוג ב-JSON 
{
  "content": string,
  "assigneeEmailAddress": string,

  "range": {
    object (Range)
  }
}
שדות
content

string

הטקסט של התגובה, כטקסט פשוט.

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

חובה למלא את השדה הזה, והוא לא יכול לכלול יותר מ-2,048 יחידות קוד UTF-8.

assigneeEmailAddress

string

אופציונלי. כתובת האימייל של המשתמש שהוקצתה לו התגובה.

אם רוצים להשאיר תגובה שלא משויכת לאף אחד, משאירים את השדה ריק.

הערך לא יכול לכלול יותר מ-2,048 יחידות קוד UTF-8.

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

object (Range)

הקטע Range במסמך שמקושר לתגובה הזו.

סוף השדות הבלעדיים.

AddCommentReplyRequest

מוסיף תשובה Post לתוך CommentThread או SuggestionThread.

ייצוג ב-JSON 
{
  "post": {
    object (Post)
  },

  "commentId": string,
  "suggestionId": string
}
שדות
post

object (Post)

Post התשובה.

המזהה של השרשור שאליו רוצים להוסיף את התשובה. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
commentId

string

המזהה של CommentThread שאליו רוצים להוסיף את התשובה.

suggestionId

string

המזהה של SuggestionThread שאליו רוצים להוסיף את התשובה.

סוף השדות הבלעדיים.

UpdateCommentPostRequest

עדכון של Post ב-CommentThread או ב-SuggestionThread.

הפונקציה מחזירה שגיאת בקשה שגויה (400) אם:

  • הפוסט הוא headPost של SuggestionThread.

  • המשתמש ששולח את הבקשה לא כתב את הפוסט.

ייצוג ב-JSON 
{
  "postId": string,
  "content": string,

  "commentId": string,
  "suggestionId": string
}
שדות
postId

string

המזהה של הפוסט שעובר עדכון.

content

string

הטקסט החדש של התגובה, כטקסט פשוט.

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

חובה למלא את השדה הזה, והוא לא יכול לכלול יותר מ-2,048 יחידות קוד UTF-8.

המזהה של השרשור שהפוסט שייך אליו. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
commentId

string

המזהה של CommentThread שהפוסט שייך אליו.

suggestionId

string

המזהה של SuggestionThread שהפוסט שייך אליו.

סוף השדות הבלעדיים.

DeleteCommentRequest

מוחק את CommentThread.

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

ייצוג ב-JSON 
{
  "commentId": string
}
שדות
commentId

string

המזהה של CommentThread שנמחק.

DeleteCommentReplyRequest

מחיקת תשובה Post מתוך CommentThread או SuggestionThread.

הפונקציה מחזירה שגיאת בקשה שגויה (400) אם:

  • המשתמש ששולח את הבקשה לא כתב את הפוסט.

  • הפוסט עם התגובה מכיל [פעולה][google.apps.docs.v1.Post.action].

  • התשובה מכילה את התג assignee.

ייצוג ב-JSON 
{
  "postId": string,

  "commentId": string,
  "suggestionId": string
}
שדות
postId

string

המזהה של התשובה Post שנמחקת.

המזהה של השרשור שהפוסט שייך אליו. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
commentId

string

המזהה של CommentThread שהפוסט שייך אליו.

suggestionId

string

המזהה של SuggestionThread שהפוסט שייך אליו.

סוף השדות הבלעדיים.

AcceptSuggestionRequest

מאשרים הצעה.

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

ייצוג ב-JSON 
{
  "suggestionId": string
}
שדות
suggestionId

string

המזהה של ההצעה.

RejectSuggestionRequest

דחיית הצעה.

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

ייצוג ב-JSON 
{
  "suggestionId": string
}
שדות
suggestionId

string

המזהה של ההצעה.

DeleteSuggestionRequest

מחיקת הצעה.

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

ייצוג ב-JSON 
{
  "suggestionId": string
}
שדות
suggestionId

string

המזהה של ההצעה.