בקשה
עדכון יחיד שיחול על מסמך.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד
request הבקשה הספציפית שיש להחיל. חובה למלא רק שדה אחד.
request
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
replaceAllText
|
מחליפה את כל המופעים של הטקסט שצוין. |
insertText
|
מוסיפה טקסט במיקום שצוין. |
updateTextStyle
|
עדכון סגנון הטקסט בטווח שצוין. |
createParagraphBullets
|
יצירת תבליטים לפסקאות. |
deleteParagraphBullets
|
מחיקת תבליטים מפסקאות. |
createNamedRange
|
הפונקציה יוצרת טווח בעל שם. |
deleteNamedRange
|
מחיקה של טווח תאים בעל שם. |
updateParagraphStyle
|
עדכון סגנון הפסקה בטווח שצוין. |
deleteContentRange
|
מחיקת התוכן מהמסמך. |
insertInlineImage
|
הוספת תמונה בתוך שורה במיקום שצוין. |
insertTable
|
הוספת טבלה במיקום שצוין. |
insertTableRow
|
מוסיפה שורה ריקה לטבלה. |
insertTableColumn
|
מוסיפה עמודה ריקה לטבלה. |
deleteTableRow
|
מחיקת שורה מטבלה. |
deleteTableColumn
|
מחיקת עמודה מטבלה. |
insertPageBreak
|
הוספת מעבר דף במיקום שצוין. |
deletePositionedObject
|
מחיקה של אובייקט ממוקם מהמסמך. |
updateTableColumnProperties
|
עדכון המאפיינים של העמודות בטבלה. |
updateTableCellStyle
|
עדכון הסגנון של תאים בטבלה. |
updateTableRowStyle
|
עדכון סגנון השורה בטבלה. |
replaceImage
|
מחליפה תמונה במסמך. |
updateDocumentStyle
|
עדכון הסגנון של המסמך. |
mergeTableCells
|
מיזוג תאים בטבלה. |
unmergeTableCells
|
ביטול המיזוג של התאים בטבלה. |
createHeader
|
יצירת כותרת |
createFooter
|
יצירת כותרת תחתונה. |
createFootnote
|
יצירת הערת שוליים. |
replaceNamedRangeContent
|
הפונקציה מחליפה את התוכן בטווח בעל שם. |
updateSectionStyle
|
עדכון סגנון הקטע של הטווח שצוין. |
insertSectionBreak
|
הוספת מעבר קטע במיקום שצוין. |
deleteHeader
|
מחיקת כותרת מהמסמך. |
deleteFooter
|
מחיקת כותרת תחתונה מהמסמך. |
pinTableHeaderRows
|
עדכון מספר שורות הכותרת המוצמדות בטבלה. |
ReplaceAllTextRequest
הפונקציה מחליפה את כל המופעים של טקסט שתואם לקריטריונים ב-
replace text
ייצוג JSON |
---|
{ "replaceText": string, "tabsCriteria": { object ( |
שדות | |
---|---|
replaceText
|
הטקסט שיחליף את הטקסט התואם. |
tabsCriteria
|
זה שינוי אופציונלי. הקריטריונים שמשמשים כדי לציין באילו כרטיסיות ההחלפה תתבצע. אם לא מציינים את הפרמטר הזה, ההחלפה תחול על כל הכרטיסיות. במסמך שמכיל כרטיסייה אחת:
במסמך שמכיל כמה כרטיסיות:
|
שדה איחוד
criteria הקריטריונים שמשמשים להתאמת הטקסט להחלפה.
criteria
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
containsText
|
חיפוש טקסט במסמך שתואם למחרוזת המשנה הזו. |
SubstringMatchCriteria
קריטריון שתואם למחרוזת טקסט ספציפית במסמך.
ייצוג JSON |
---|
{ "text": string, "matchCase": boolean } |
שדות | |
---|---|
text
|
הטקסט לחיפוש במסמך. |
matchCase
|
מציינת אם החיפוש צריך להתייחס לאותיות רישיות:
|
TabsCriteria
קריטריון שמציין באילו כרטיסיות הבקשה תופעל.
ייצוג JSON |
---|
{ "tabIds": [ string ] } |
שדות | |
---|---|
tabIds[]
|
רשימת מזהי הכרטיסיות שבה הבקשה מופעלת. |
InsertTextRequest
מוסיפה טקסט במיקום שצוין.
ייצוג JSON |
---|
{ "text": string, // Union field |
שדות | |
---|---|
text
|
הטקסט להוספה.
הוספת תו חדש בשורה תיצור באופן מרומז
סגנונות הטקסט של הטקסט שנוסף ייקבעו באופן אוטומטי, תוך שמירה על העיצוב של הטקסט שמסביב. ברוב המקרים, סגנון הטקסט של הטקסט שהוזן יתאים לטקסט שקודם לאינדקס ההוספה. חלק מתווי הבקרה (U+0000-U+0008, U+000C-U+001F) ותווים מהאזור לשימוש פרטי במטוס פרטי Unicode Basic Multilingual Plane (U+E000-U+F8FF) יוסרו מהטקסט שהוזן. |
שדה איחוד
insertion_location המיקום שאליו יתווסף הטקסט.
insertion_location
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
location
|
מאכלס את הטקסט באינדקס ספציפי במסמך.
צריך להזין טקסט בגבולות של
|
endOfSegmentLocation
|
הוספת הטקסט בסוף הכותרת העליונה, הכותרת התחתונה, הערת שוליים או גוף המסמך. |
מיקום
מיקום מסוים במסמך.
ייצוג JSON |
---|
{ "segmentId": string, "index": integer, "tabId": string } |
שדות | |
---|---|
segmentId
|
המזהה של הכותרת העליונה, הכותרת התחתונה או הערת השוליים במיקום הזה. מזהה מקטע ריק מציין את גוף המסמך. |
index
|
האינדקס מבוסס אפס, ביחידות קוד מסוג UTF-16.
האינדקס מייצג את תחילת הקטע שצוין על ידי
|
tabId
|
הכרטיסייה שבה נמצא המיקום. אם לא מציינים את הפרמטר הזה, הבקשה מוחלת על הכרטיסייה הראשונה. במסמך שמכיל כרטיסייה אחת:
במסמך שמכיל כמה כרטיסיות:
|
EndOfSegmentLocation
המיקום בסוף גוף הטקסט, הכותרת העליונה, הכותרת התחתונה או הערת שוליים המיקום מופיע ממש לפני השורה החדשה האחרונה בקטע המסמך.
ייצוג JSON |
---|
{ "segmentId": string, "tabId": string } |
שדות | |
---|---|
segmentId
|
המזהה של הכותרת העליונה, הכותרת התחתונה או הערת השוליים במיקום הזה. מזהה מקטע ריק מציין את גוף המסמך. |
tabId
|
הכרטיסייה שבה נמצא המיקום. אם לא מציינים את הפרמטר הזה, הבקשה מוחלת על הכרטיסייה הראשונה. במסמך שמכיל כרטיסייה אחת:
במסמך שמכיל כמה כרטיסיות:
|
UpdateTextStyleRequest
מעדכנים את עיצוב הטקסט.
ייצוג JSON |
---|
{ "textStyle": { object ( |
שדות | |
---|---|
textStyle
|
הסגנונות שיוגדרו בטקסט. אם הערך של סגנון מסוים תואם לזה של סגנון ההורה, הסגנון יוגדר בירושה.
אם תבצעו שינויים מסוימים בסגנון הטקסט, יכול להיות ששינויים אחרים ישקפו את ההתנהגות של עורך Docs. יש לעיין במסמכי התיעוד של
|
fields
|
השדות שצריך לעדכן.
יש לציין שדה אחד לפחות. הרמה הבסיסית (root)
לדוגמה, כדי לעדכן את סגנון הטקסט למודגש, צריך להגדיר
כדי לאפס נכס לערך ברירת המחדל שלו, כוללים את שם השדה שלו במסכת השדות, אבל משאירים את השדה עצמו לא מוגדר. |
שדה איחוד
insertion_location סוג הטווח שבו יתבצע העדכון של סגנון הטקסט.
insertion_location
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
range
|
טווח הטקסט לסגנון. ניתן להרחיב את הטווח כך שיכלול שורות חדשות סמוכות. אם הטווח מכיל במלואו פסקה השייכת לרשימה, גם התבליט של הפסקה יתעדכן בסגנון הטקסט התואם. לא ניתן להוסיף טווחים בתוך UpdateTextStyleRequest היחסי. |
CreateParagraphBulletsRequest
יצירת תבליטים לכל הפסקאות שחופפות לטווח הנתון.
רמת הסידור הפנימי של כל פסקה נקבעת על ידי ספירת הכרטיסיות המובילות שלפני כל פסקה. כדי למנוע רווח מיותר בין התבליט לפסקה המתאימה, הכרטיסיות המובילות האלה יוסרו על ידי הבקשה הזו. הפעולה הזו עשויה לשנות את האינדקסים של חלקי הטקסט.
אם הפסקה שלפני עדכון הפסקאות נמצאת ברשימה עם הגדרה קבועה מראש תואמת, הפסקאות המתעדכנות יתווספו לרשימה הקודמת.
ייצוג JSON |
---|
{ "range": { object ( |
שדות | |
---|---|
range
|
הטווח שעליו יש להחיל את התבליט שהוגדר מראש. |
bulletPreset
|
סוגי הגליפים של התבליטים שבהם יש להשתמש. |
BulletGlyphPreset
תבניות מוגדרות מראש של גליפים של תבליטים לרשימות.
בתבניות האלה נעשה שימוש בתבליטים מהסוגים הבאים:
-
ARROW
: חץ שתואם לנקודת קוד בפורמט Unicode U+2794 -
ARROW3D
: חץ עם הצללה בתלת-ממד, שתואם לנקודת קוד ב-Unicode U+27a2 -
CHECKBOX
: ריבוע חלול שתואם לנקודת קוד בפורמט Unicode U+274f -
CIRCLE
: עיגול חלול שתואם לנקודת קוד בפורמט Unicode U+25cb -
DIAMOND
: יהלום מלא, שתואם לנקודת קוד של Unicode U+25c6 -
DIAMONDX
: יהלום עם 'x', שתואם לנקודת קוד של Unicode U+2756 -
HOLLOWDIAMOND
: יהלום חלול שתואם לנקודת קוד ב-Unicode U+25c7 -
DISC
: עיגול מלא, שתואם לנקודת קוד בפורמט Unicode U+25cf -
SQUARE
: ריבוע מלא, שתואם לנקודת קוד של Unicode U+25a0 -
STAR
: כוכב, שתואם לנקודת קוד בפורמט Unicode U+2605 -
ALPHA
: אות קטנה, כמו 'a', 'b' או 'c'. -
UPPERALPHA
: אות גדולה, כמו 'A', 'B' או 'C'. -
DECIMAL
: מספר, כמו '1', '2' או '3'. -
ZERODECIMAL
: מספר שבו התחילית של מספרים בני ספרה אחת היא אפס, לדוגמה '01', '02' או '03'. מספרים שיש להם יותר מספרה אחת לא קידומת אפס. -
ROMAN
: ספרה רומית קטנה, כמו 'i', 'ii' או 'iii'. -
UPPERROMAN
: ספרה רומית גדולה, כמו 'I', 'II' או 'III'. -
LEFTTRIANGLE
: משולש שמצביע שמאלה, התואם לנקודת קוד של 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
|
הטווח שממנו יש למחוק את התבליטים. |
CreateNamedRangeRequest
יוצר
NamedRange
התייחסות לטווח הנתון.
ייצוג JSON |
---|
{
"name": string,
"range": {
object (
|
שדות | |
---|---|
name
|
שם ה-NamedRange. השמות לא חייבים להיות ייחודיים. השמות חייבים להיות באורך של תו אחד לפחות ו-256 תווים לכל היותר. המדידה מתבצעת ביחידות קוד מסוג UTF-16. |
range
|
הטווח שעליו צריך להחיל את השם. |
DeleteNamedRangeRequest
מוחק
NamedRange
ייצוג JSON |
---|
{ "tabsCriteria": { object ( |
שדות | |
---|---|
tabsCriteria
|
זה שינוי אופציונלי. הקריטריונים שמשמשים לציון הכרטיסיות שבהן צריך למחוק את הטווח. אם לא מציינים את הפרמטר הזה, מחיקת הטווח חלה על כל הכרטיסיות. במסמך שמכיל כרטיסייה אחת:
במסמך שמכיל כמה כרטיסיות:
|
שדה איחוד
named_range_reference הערך שקובע איזה טווח או טווח צריך למחוק. יש להגדיר אחד בדיוק.
named_range_reference
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
namedRangeId
|
המזהה של טווח התאים בעל השם למחיקה. |
name
|
שמות הטווחים למחיקה. כל טווחי התאים בעלי השם הנתון יימחקו. |
UpdateParagraphStyleRequest
עדכון העיצוב של כל הפסקאות שחופפות לטווח הנתון.
ייצוג JSON |
---|
{ "paragraphStyle": { object ( |
שדות | |
---|---|
paragraphStyle
|
הסגנונות שיוגדרו בפסקאות.
שינויים מסוימים בסגנון הפסקה עשויים לגרום לשינויים אחרים, שמשקפות את ההתנהגות של עורך Docs. יש לעיין במסמכי התיעוד של
|
fields
|
השדות שצריך לעדכן.
יש לציין שדה אחד לפחות. הרמה הבסיסית (root)
לדוגמה, כדי לעדכן את מאפיין היישור של סגנון הפסקה, מגדירים
כדי לאפס נכס לערך ברירת המחדל שלו, כוללים את שם השדה שלו במסכת השדות, אבל משאירים את השדה עצמו לא מוגדר. |
שדה איחוד
insertion_location סוג הטווח שבו יתבצע עדכון של סגנון הפסקה.
insertion_location
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
range
|
הטווח שחופף לפסקאות לסגנון. |
DeleteContentRangeRequest
מחיקת התוכן מהמסמך.
ייצוג JSON |
---|
{
"range": {
object (
|
שדות | |
---|---|
range
|
טווח התוכן שצריך למחוק. מחיקת טקסט שחוצה גבולות של פסקה עשויה לגרום לשינויים בסגנונות של פסקאות, ברשימות, באובייקטים ובסימניות ממוקמים בזמן מיזוג שתי הפסקאות. הניסיון למחוק טווחים מסוימים עלול לגרום למבנה מסמך לא חוקי, ובמקרה כזה תוחזר שגיאה של בקשה שגויה מסוג 400. דוגמאות לבקשות מחיקה לא חוקיות:
|
InsertInlineImageRequest
מוסיף
InlineObject
שכולל תמונה במיקום הנתון.
ייצוג JSON |
---|
{ "uri": string, "objectSize": { object ( |
שדות | |
---|---|
uri
|
ה-URI של התמונה. התמונה תאוחזר פעם אחת בזמן ההוספה, ועותק יאוחסן להצגה בתוך המסמך. התמונות צריכות להיות בגודל של פחות מ-50MB, לא יותר מ-25 מגה-פיקסל. בנוסף, הן צריכות להיות בפורמט PNG , JPEG או GIF.
ה-URI שסופק חייב להיות נגיש לציבור ובאורך של 2kB לכל היותר. ה-URI עצמו נשמר בתמונה, והוא נחשף דרך
|
objectSize
|
גודל התמונה שאמורה להופיע במסמך. המאפיין הזה הוא אופציונלי, והגודל הסופי של התמונה במסמך נקבע לפי הכללים הבאים: * אם לא מציינים רוחב או גובה, המערכת מחשבת את גודל ברירת המחדל של התמונה על סמך הרזולוציה שלה. * אם צוין מימד אחד, המימד השני מחושב כדי לשמר את יחס הגובה-רוחב של התמונה. * אם תציינו גם רוחב וגם גובה, גודל התמונה ישתנה כדי שתתאים למידות שצוינו, תוך שמירה על יחס הגובה-רוחב שלה. |
שדה איחוד
insertion_location המיקום שאליו תוכנס התמונה.
insertion_location
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
location
|
הוספת התמונה לאינדקס ספציפי במסמך.
יש להכניס את התמונה לגבולות של
אי אפשר להוסיף תמונות ישירות להערת שוליים או משוואה. |
endOfSegmentLocation
|
הוספת הטקסט בסוף הכותרת העליונה, הכותרת התחתונה או גוף המסמך. לא ניתן להוסיף תמונות ישירות להערת שוליים. |
InsertTableRequest
הוספת טבלה במיקום שצוין.
תו של שורה חדשה יתווסף לפני הטבלה שנוספה.
ייצוג JSON |
---|
{ "rows": integer, "columns": integer, // Union field |
שדות | |
---|---|
rows
|
מספר השורות בטבלה. |
columns
|
מספר העמודות בטבלה. |
שדה איחוד
insertion_location המיקום שבו הטבלה תתווסף.
insertion_location
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
location
|
מוסיפה את הטבלה באינדקס ספציפי של מודל. תו שורה חדשה יתווסף לפני הטבלה שהוכנסה, ולכן אינדקס ההתחלה של הטבלה יופיע באינדקס המיקומים שצוין + 1.
צריך להוסיף את הטבלה בתוך הגבולות של
אי אפשר להוסיף טבלאות בתוך הערת שוליים או משוואה. |
endOfSegmentLocation
|
הוספת הטבלה בסוף הכותרת, הכותרת התחתונה או גוף המסמך. תו של שורה חדשה יתווסף לפני הטבלה שנוספה. אי אפשר להוסיף טבלאות בתוך הערת שוליים. |
InsertTableRowRequest
מוסיפה שורה ריקה לטבלה.
ייצוג JSON |
---|
{
"tableCellLocation": {
object (
|
שדות | |
---|---|
tableCellLocation
|
מיקום התא בטבלת ההפניה שממנו יתווספו השורות. שורה חדשה מתווספת מעל (או מתחת) לשורה שבה נמצא תא ההפניה. אם תא ההפניה הוא תא ממוזג, שורה חדשה תתווסף מעל (או מתחת) לתא שמוזג. |
insertBelow
|
הגדרה שקובעת אם להוסיף שורה חדשה מתחת למיקום של התא להפניה.
|
TableCellLocation
המיקום של תא יחיד בטבלה.
ייצוג JSON |
---|
{
"tableStartLocation": {
object (
|
שדות | |
---|---|
tableStartLocation
|
המיקום שבו הטבלה מתחילה במסמך. |
rowIndex
|
אינדקס השורות המבוסס על אפס. לדוגמה, בשורה השנייה בטבלה מופיע אינדקס השורה 1. |
columnIndex
|
אינדקס העמודות המבוסס על אפס. לדוגמה, לעמודה השנייה בטבלה יהיה אינדקס עמודה של 1. |
InsertTableColumnRequest
מוסיפה עמודה ריקה לטבלה.
ייצוג JSON |
---|
{
"tableCellLocation": {
object (
|
שדות | |
---|---|
tableCellLocation
|
מיקום התא בטבלת ההפניות שממנו העמודות יתווספו. עמודה חדשה מתווספת משמאל (או מימין) לעמודה שבה נמצא תא ההפניה. אם תא ההפניה הוא תא ממוזג, עמודה חדשה תתווסף משמאל (או מימין) לתא שמוזג. |
insertRight
|
הגדרה שקובעת אם להוסיף עמודה חדשה מימין למיקום של תא ההפניה.
|
DeleteTableRowRequest
מחיקת שורה מטבלה.
ייצוג JSON |
---|
{
"tableCellLocation": {
object (
|
שדות | |
---|---|
tableCellLocation
|
מיקום התא בטבלת ההפניה שממנו השורה תימחק. השורה שמתפרסת על התא הזה תימחק. אם התא ממוזג שמתפרס על כמה שורות, כל השורות שהתא מתפרס עליהן יימחקו. אם לא יישארו בטבלה שורות אחרי המחיקה, הטבלה כולה תימחק. |
DeleteTableColumnRequest
מחיקת עמודה מטבלה.
ייצוג JSON |
---|
{
"tableCellLocation": {
object (
|
שדות | |
---|---|
tableCellLocation
|
מיקום התא בטבלת ההפניה שממנו העמודה תימחק. העמודה שמתפרסת על התא הזה תימחק. אם התא ממוזג שמתפרס על כמה עמודות, כל העמודות שהתא מתפרס עליהן יימחקו. אם לא יישארו בטבלה עמודות אחרי המחיקה, הטבלה כולה תימחק. |
InsertPageBreakRequest
הוספת מעבר דף ואחריו שורה חדשה במיקום שצוין.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד
insertion_location המיקום שבו יתווסף מעבר הדף.
insertion_location
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
location
|
מוסיפה את מעבר הדף באינדקס ספציפי במסמך.
יש להכניס את מעבר הדף בתוך הגבולות של
לא ניתן להוסיף מעברי דפים בתוך טבלה, משוואה, הערת שוליים, כותרת עליונה או כותרת תחתונה. מכיוון שניתן להוסיף מעברי דף רק לגוף,
|
endOfSegmentLocation
|
הוספת מעבר עמוד בסוף גוף המסמך.
לא ניתן להוסיף מעברי דפים בתוך הערת שוליים, כותרת עליונה או כותרת תחתונה. מכיוון שניתן להוסיף מעברי דף רק לגוף,
|
DeletePositionedObjectRequest
מוחק
PositionedObject
מהמסמך.
ייצוג JSON |
---|
{ "objectId": string, "tabId": string } |
שדות | |
---|---|
objectId
|
המזהה של האובייקט הממוקם שרוצים למחוק. |
tabId
|
הכרטיסייה שבה נמצאת האובייקט הממוקם למחיקה. אם לא מציינים את הפרמטר הזה, הבקשה חלה על הכרטיסייה הראשונה. במסמך שמכיל כרטיסייה אחת:
במסמך שמכיל כמה כרטיסיות:
|
UpdateTableColumnPropertiesRequest
מעדכן את
TableColumnProperties
מספר העמודות בטבלה.
ייצוג JSON |
---|
{ "tableStartLocation": { object ( |
שדות | |
---|---|
tableStartLocation
|
המיקום שבו הטבלה מתחילה במסמך. |
columnIndices[]
|
רשימת אינדקסים של עמודות המבוססים על אפס, שיש לעדכן את המאפיין שלהן. אם לא תציינו אינדקסים, כל העמודות יעודכנו. |
tableColumnProperties
|
מאפייני העמודה בטבלה שצריך לעדכן.
אם הערך של
|
fields
|
השדות שצריך לעדכן.
יש לציין שדה אחד לפחות. הרמה הבסיסית (root)
לדוגמה, כדי לעדכן את רוחב העמודה, מגדירים
|
UpdateTableCellStyleRequest
עדכון הסגנון של טווח תאים בטבלה.
ייצוג JSON |
---|
{ "tableCellStyle": { object ( |
שדות | |
---|---|
tableCellStyle
|
הסגנון שצריך להגדיר בתאים בטבלה. כשמעדכנים גבולות, אם תא משותף גבול עם תא סמוך, תכונת הגבול המתאימה של התא שקרוב אליו מתעדכנת גם כן. גבולות שממוזגים ואינם נראים לא מתעדכנים. עדכון גבול שמשותף על ידי תאים סמוכים באותה בקשה יכול לגרום לעדכוני גבולות מתנגשים, עדכוני גבולות מוחלים בסדר הבא:
|
fields
|
השדות שצריך לעדכן.
יש לציין שדה אחד לפחות. הרמה הבסיסית (root)
לדוגמה, כדי לעדכן את צבע הרקע של התא בטבלה, אפשר להגדיר
כדי לאפס נכס לערך ברירת המחדל שלו, כוללים את שם השדה שלו במסכת השדות, אבל משאירים את השדה עצמו לא מוגדר. |
שדה איחוד
cells התאים יעודכנו.
cells
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
tableRange
|
הטווח של הטבלה שמייצג את קבוצת המשנה של הטבלה שעליה העדכונים חלים. |
tableStartLocation
|
המיקום שבו הטבלה מתחילה במסמך. אם מצוין אחרת, העדכונים יחולו על כל התאים בטבלה. |
TableRange
טווח של טבלה מייצג הפניה לקבוצת משנה של טבלה.
חשוב לציין שהתאים שצוינו בטווח של הטבלה לא בהכרח יוצרים מלבן. לדוגמה, נניח שיש לנו טבלה בגודל 3 x 3 שבה כל התאים בשורה האחרונה ממוזגים יחד. הטבלה נראית כך:
[ ][ ][ ]
[ ][ ][ ]
[ ]
טווח בטבלה שבו מיקום התא בטבלה = (tableStartLocation, שורה = 0, עמודה = 0), שורה = 3 וטווח העמודה = 2 מציין את התאים הבאים:
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
ייצוג JSON |
---|
{
"tableCellLocation": {
object (
|
שדות | |
---|---|
tableCellLocation
|
מיקום התא שבו מתחיל טווח הטבלה. |
rowSpan
|
טווח השורות בטווח הטבלה. |
columnSpan
|
טווח העמודה של טווח הטבלה. |
UpdateTableRowStyleRequest
מעדכן את
TableRowStyle
לשורות בטבלה.
ייצוג JSON |
---|
{ "tableStartLocation": { object ( |
שדות | |
---|---|
tableStartLocation
|
המיקום שבו הטבלה מתחילה במסמך. |
rowIndices[]
|
רשימה של אינדקסים של שורות המבוססים על אפס שיש לעדכן את הסגנון שלהם. אם לא תציינו אינדקסים, כל השורות יעודכנו. |
tableRowStyle
|
הסגנונות שיוגדרו בשורות. |
fields
|
השדות שצריך לעדכן.
יש לציין שדה אחד לפחות. הרמה הבסיסית (root)
לדוגמה כדי לעדכן את גובה השורה המינימלי, מגדירים
|
ReplaceImageRequest
החלפה של תמונה קיימת בתמונה חדשה.
החלפת תמונה מסירה חלק
image effects
מהתמונה הקיימת, כדי לשקף את ההתנהגות של עורך Docs.
ייצוג JSON |
---|
{
"imageObjectId": string,
"uri": string,
"imageReplaceMethod": enum (
|
שדות | |
---|---|
imageObjectId
|
המזהה של התמונה הקיימת שיוחלף. ניתן לאחזר את המזהה מהתגובה לבקשת אחזור. |
uri
|
ה-URI של התמונה החדשה. התמונה תאוחזר פעם אחת בזמן ההוספה, ועותק יאוחסן להצגה בתוך המסמך. התמונות חייבות להיות קטנות מ-50MB, לא יותר מ-25 מגה-פיקסלים ועליהן להיות בפורמט PNG , JPEG או GIF.
ה-URI שצוין לא יכול לחרוג מאורך של 2KB. ה-URI נשמר בתמונה, והוא גלוי דרך
|
imageReplaceMethod
|
השיטה החלופית. |
tabId
|
הכרטיסייה שבה נמצאת התמונה להחלפה. אם לא מציינים את הפרמטר הזה, הבקשה מוחלת על הכרטיסייה הראשונה. במסמך שמכיל כרטיסייה אחת:
במסמך שמכיל כמה כרטיסיות:
|
ImageReplaceMethod
השיטה להחלפת תמונה.
טיפוסים בני מנייה (enum) | |
---|---|
IMAGE_REPLACE_METHOD_UNSPECIFIED
|
שיטה להחלפת תמונה לא צוינה. אסור להשתמש בערך הזה. |
CENTER_CROP
|
שינוי גודל התמונה ומרכז אותה כדי למלא את הגבולות של התמונה המקורית. ייתכן שהתמונה תיחתך כדי למלא את גבולות התמונה המקורית. גודל התמונה לאחר עיבוד יהיה זהה לגודל התמונה המקורית. |
UpdateDocumentStyleRequest
מעדכן את
DocumentStyle
ייצוג JSON |
---|
{
"documentStyle": {
object (
|
שדות | |
---|---|
documentStyle
|
הסגנונות שיוגדרו במסמך.
שינויים מסוימים בסגנון המסמך עשויים לגרום לשינויים אחרים, שמשקפות את ההתנהגות של עורך Docs. יש לעיין במסמכי התיעוד של
|
fields
|
השדות שצריך לעדכן.
יש לציין שדה אחד לפחות. הרמה הבסיסית (root)
לדוגמה, כדי לעדכן את הרקע, מגדירים
|
tabId
|
הכרטיסייה שמכילה את הסגנון שרוצים לעדכן. אם לא כוללים את הפרמטר הזה, הבקשה חלה על הכרטיסייה הראשונה. במסמך שמכיל כרטיסייה אחת:
במסמך שמכיל כמה כרטיסיות:
|
MergeTableCellsRequest
מיזוג תאים בתוך
Table
ייצוג JSON |
---|
{
"tableRange": {
object (
|
שדות | |
---|---|
tableRange
|
טווח התאים בטבלה שמציין אילו תאים בטבלה רוצים למזג. כל הטקסט בתאים שמוזגו יחובר ויאוחסן ב-'head' התא בטווח. זהו התא הימני העליון של הטווח כאשר כיוון התוכן הוא משמאל לימין, והתא הימני העליון של הטווח הוא התא הימני. אם הטווח לא מלבני (מצב כזה יכול לקרות במקרים מסוימים שבהם הטווח מכסה תאים שכבר ממוזגים או כשהטבלה לא מלבנית), מוחזר שגיאה 400 של בקשה שגויה. |
UnmergeTableCellsRequest
ביטול המיזוג של התאים בתוך
Table
ייצוג JSON |
---|
{
"tableRange": {
object (
|
שדות | |
---|---|
tableRange
|
טווח הטבלה שמציין אילו תאים בטבלה צריך לבטל את המיזוג. המיזוג של כל התאים שמוזגו בטווח הזה יבוטל, והתאים שכבר לא מוזגו לא יושפעו. אם אין בטווח תאים ממוזגים, הבקשה לא תשפיע. אם יש טקסט באחד מהתאים שמוזגו, הטקסט יישאר ב-head בבלוק של התאים שלא מוזגו. "head" התא הוא התא הימני העליון כשהכיוון של התוכן הוא משמאל לימין. אחרת, הוא מימין למעלה. |
CreateHeaderRequest
יוצר
Header
הכותרת החדשה תחול על
SectionStyle
במיקום של
SectionBreak
אם צוין, אחרת הוא חל על
DocumentStyle
.
אם כבר קיימת כותרת מהסוג שצוין, תוחזר שגיאת בקשה שגויה 400.
ייצוג JSON |
---|
{ "type": enum ( |
שדות | |
---|---|
type
|
סוג הכותרת שצריך ליצור. |
sectionBreakLocation
|
המיקום של
|
CreateFootnoteRequest
יוצר
Footnote
ומוסיפה מקטע חדש
FootnoteReference
אליו במיקום הנתון.
הגרסה החדשה
Footnote
הקטע יכיל רווח ואחריו תו שורה חדשה.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד
footnote_reference_location המיקום שבו יש להוסיף את ההפניה להערת שוליים.
footnote_reference_location
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
location
|
מוסיפה את ההפניה להערת שוליים באינדקס ספציפי במסמך.
יש להוסיף את ההפניה להערת שוליים בתוך הגבולות של פריט קיים
לא ניתן להוסיף הפניות להערות שוליים בתוך משוואה, כותרת עליונה, כותרת תחתונה או הערת שוליים. מכיוון שאפשר להוסיף הפניות להערות שוליים רק בגוף,
|
endOfSegmentLocation
|
הוספת ההפניה להערת שוליים בסוף גוף המסמך.
אי אפשר להוסיף הפניות להערות שוליים בתוך כותרת עליונה, כותרת תחתונה או הערת שוליים. מכיוון שאפשר להוסיף הפניות להערות שוליים רק בגוף,
|
ReplaceNamedRangeContentRequest
החלפת התוכן של הפריט שצוין
NamedRange
או
NamedRanges
עם התוכן החלופי הנתון.
שימו לב שבן אדם
NamedRange
עשוי לכלול מספר קטעים
ranges
. במקרה כזה, רק התוכן בטווח הראשון יוחלף. שאר הטווחים והתוכן שלהם יימחקו.
במקרים שבהם החלפה או מחיקה של טווחים יביאו למבנה מסמך לא חוקי, תוחזר שגיאה מסוג 'בקשה שגויה' 400.
ייצוג JSON |
---|
{ "tabsCriteria": { object ( |
שדות | |
---|---|
tabsCriteria
|
זה שינוי אופציונלי. הקריטריונים שמשמשים כדי לציין באילו כרטיסיות ההחלפה תתבצע. אם לא מציינים את הפרמטר הזה, ההחלפה תחול על כל הכרטיסיות. במסמך שמכיל כרטיסייה אחת:
במסמך שמכיל כמה כרטיסיות:
|
שדה איחוד
replacement_content התוכן שבו יוחלף התוכן הקיים של הטווח בעל השם.
replacement_content
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
text
|
הפונקציה מחליפה את התוכן של הטווחים בעלי השם שצוינו בטקסט הנתון. |
שדה איחוד
named_range_reference הפניה לטווחים בעלי שם שהתוכן שלהם יוחלף.
named_range_reference
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
namedRangeId
|
המזהה של טווח התאים בעל השם שהתוכן שלו יוחלף. אם אין טווח בעל שם עם המזהה הנתון, תוחזר שגיאה של בקשה שגויה מסוג 400. |
namedRangeName
|
השם של
אם יש כמה
|
UpdateSectionStyleRequest
מעדכן את
SectionStyle
ייצוג JSON |
---|
{ "range": { object ( |
שדות | |
---|---|
range
|
הטווח שחופף את הקטעים לסגנון.
מכיוון שניתן להוסיף מעברי קטעים רק בתוך הגוף,
|
sectionStyle
|
הסגנונות שיוגדרו בקטע.
אם תבצעו שינויים מסוימים בסגנון של קטע, יכול להיות ששינויים אחרים ישקפו את ההתנהגות של עורך Docs. יש לעיין במסמכי התיעוד של
|
fields
|
השדות שצריך לעדכן.
יש לציין שדה אחד לפחות. הרמה הבסיסית (root)
לדוגמה, כדי לעדכן את השוליים השמאליים, אפשר להגדיר
|
InsertSectionBreakRequest
הוספת מעבר קטע במיקום הנתון.
תו חדש בשורה יתווסף לפני מעבר הקטע.
ייצוג JSON |
---|
{ "sectionType": enum ( |
שדות | |
---|---|
sectionType
|
סוג הקטע להוספה. |
שדה איחוד
insertion_location המיקום שבו ההפסקה תוכנס.
insertion_location
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
location
|
הוספת שורה חדשה ומעבר קטע באינדקס ספציפי במסמך.
צריך להוסיף את מעבר הקטע בתוך הגבולות של
לא ניתן להוסיף מעברי קטעים בתוך טבלה, משוואה, הערת שוליים, כותרת עליונה או כותרת תחתונה. מכיוון שניתן להוסיף מעברי קטעים רק בתוך הגוף,
|
endOfSegmentLocation
|
הוספת שורה חדשה ומעבר קטע בסוף גוף המסמך.
לא ניתן להוסיף מעברי קטעים בתוך הערת שוליים, כותרת עליונה או כותרת תחתונה. מכיוון שניתן להוסיף מעברי קטעים רק בתוך הגוף,
|
DeleteHeaderRequest
מוחק
Header
מהמסמך.
ייצוג JSON |
---|
{ "headerId": string, "tabId": string } |
שדות | |
---|---|
headerId
|
המזהה של הכותרת שרוצים למחוק. אם הכותרת הזו מוגדרת
|
tabId
|
הכרטיסייה שמכילה את הכותרת למחיקה. אם לא מציינים את הפרמטר הזה, הבקשה מוחלת על הכרטיסייה הראשונה. במסמך שמכיל כרטיסייה אחת:
במסמך שמכיל כמה כרטיסיות:
|
PinTableHeaderRowsRequest
עדכון מספר שורות הכותרת של הטבלה המוצמדת.
ייצוג JSON |
---|
{
"tableStartLocation": {
object (
|
שדות | |
---|---|
tableStartLocation
|
המיקום שבו הטבלה מתחילה במסמך. |
pinnedHeaderRowsCount
|
מספר השורות בטבלה להצמדה, כאשר 0 מרמז על כך שכל השורות לא מוצמדות. |