בקשה
עדכון אחד שיחול על המסמך.
ייצוג 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
|
עדכון מספר שורות הכותרת המוצמדות בטבלה. |
החלפת AllTextRequest
החלפת כל המופעים של טקסט שתואם לקריטריונים ב-
replace text
.
ייצוג JSON |
---|
{ "replaceText": string, // Union field |
שדות | |
---|---|
replaceText
|
הטקסט שיחליף את הטקסט התואם. |
שדה איחוד
criteria . הקריטריונים שמשמשים להתאמה של הטקסט להחלפה.
criteria
יכול להיות רק אחד מהבאים:
|
|
containsText
|
חיפוש טקסט במסמך שתואם למחרוזת המשנה הזו. |
מחרוזות משנה של התאמה
קריטריון שתואם למחרוזת טקסט ספציפית במסמך.
ייצוג JSON |
---|
{ "text": string, "matchCase": boolean } |
שדות | |
---|---|
text
|
הטקסט שיש לחפש במסמך. |
matchCase
|
מציין אם החיפוש צריך להתייחס לאותיות רישיות:
|
InsertTextRequest
הוספת טקסט במיקום שצוין.
ייצוג JSON |
---|
{ "text": string, // Union field |
שדות | |
---|---|
text
|
הטקסט להוספה.
הוספה של תו חדש של שורה תוביל ליצירת סגנונות טקסט עבור טקסט שנוסף ייקבעו באופן אוטומטי, תוך שימור כללי הסגנון של הטקסט הסמוך. ברוב המקרים, סגנון הטקסט של הטקסט שנוסף יתאים לטקסט מיד לפני אינדקס ההוספה. כמה תווי בקרה (U+0000-U+0008, U+000C-U+001F) ותווים מאזור השימוש הפרטי במטוס הרב-תרבותי של Unicode (U+E000-U+F8FF) יוסרו מהטקסט שנוסף. |
שדה איחוד
insertion_location . המיקום שבו הטקסט יוכנס.
insertion_location
יכול להיות רק אחד מהבאים:
|
|
location
|
הוספת הטקסט לאינדקס ספציפי במסמך.
צריך להוסיף טקסט בגבולות של
|
endOfSegmentLocation
|
הוספת הטקסט בסוף הכותרת העליונה, הכותרת התחתונה, הערות השוליים או גוף המסמך. |
מיקום
מיקום מסוים במסמך.
ייצוג JSON |
---|
{ "segmentId": string, "index": integer } |
שדות | |
---|---|
segmentId
|
מזהה הכותרת, הכותרת התחתונה או הערת השוליים שבה נמצא המיקום. מזהה פלח ריק מציין את תוכן המסמך. |
index
|
האינדקס מבוסס אפס, ביחידות קוד UTF-16.
האינדקס הוא יחסי לתחילת הקטע שצוין על ידי |
EndOfSegmentLocation
מיקום בסוף גוף, כותרת עליונה, כותרת תחתונה או הערת שוליים. המיקום נמצא מיד לפני השורה החדשה האחרונה בפלח המסמך.
ייצוג JSON |
---|
{ "segmentId": string } |
שדות | |
---|---|
segmentId
|
מזהה הכותרת, הכותרת התחתונה או הערת השוליים שבה נמצא המיקום. מזהה פלח ריק מציין את תוכן המסמך. |
עדכון TextTextStyle
מעדכנים את סגנון הטקסט.
ייצוג JSON |
---|
{ "textStyle": { object ( |
שדות | |
---|---|
textStyle
|
הסגנונות שיש להגדיר בטקסט. אם הערך של סגנון מסוים תואם לזה של ההורה, הסגנון הזה יקבל בירושה.
שינויים מסוימים בסגנון הטקסט עשויים לגרום לשינויים אחרים כדי לשקף את ההתנהגות של עורך Docs. למידע נוסף, אפשר לעיין במסמכי התיעוד של |
fields
|
השדות שצריך לעדכן.
יש לציין לפחות שדה אחד. השורש
לדוגמה, כדי לעדכן את סגנון הטקסט למודגש, צריך להגדיר את הערך כדי לאפס נכס לערך ברירת המחדל, צריך לכלול את שם השדה שלו במסכה של השדה, אבל להשאיר את השדה עצמו לא מוגדר. |
שדה איחוד
insertion_location . סוג הטווח שבו יבוצע עדכון בסגנון הטקסט.
insertion_location
יכול להיות רק אחד מהבאים:
|
|
range
|
טווח הטקסט לעיצוב. ניתן להרחיב את הטווח כך שיכלול שורות חדשות סמוכות. אם הטווח מכיל רק פסקה ששייכת לרשימה, תבליט הפסקה מעודכן גם הוא בסגנון הטקסט התואם. לא ניתן להוסיף טווחים בתוך UpdateUpdateTextStyleRequest יחסי. |
CreateParagraphbulletsRequest
יוצרת תבליטים לכל הפסקאות שחופפות לטווח הנתון.
רמת הסידור של כל פסקה תיקבע על ידי ספירת הכרטיסיות המובילות לפני כל פסקה. כדי להימנע ממרווח יתר בין התבליט לפסקה המתאימה, הבקשה הזו תוסר. הפעולה הזו עשויה לשנות את האינדקסים של חלקים בטקסט.
אם הפיסקה מייד לפני העדכון של הפסקאות נמצאת ברשימה עם הגדרה קבועה מראש תואמת, הפסקאות שעודכנו יתווספו לרשימה הקודמת.
ייצוג JSON |
---|
{ "range": { object ( |
שדות | |
---|---|
range
|
הטווח שעליו יש להחיל את ההגדרה הקבועה מראש עם תבליט. |
bulletPreset
|
סוגי הגליפים של התבליטים שבהם יש להשתמש. |
תבליט Greset
תבניות מוגדרות מראש של גלילי תבליטים ברשימות.
בתבניות האלה נעשה שימוש בתבליטים מהסוגים הבאים:
-
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 |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד
named_range_reference . הערך שקובע את הטווח או הטווחים למחיקה. חובה להגדיר ערך אחד בדיוק.
named_range_reference
יכול להיות רק אחד מהבאים:
|
|
namedRangeId
|
המזהה של הטווח בעל השם שיש למחוק. |
name
|
שם הטווחים למחיקה. כל הטווחים בעלי השם בשם הזה יימחקו. |
עדכוןParagraphStyleRequest
מעדכנים את הסגנון של כל הפסקאות שחופפות לטווח הנתון.
ייצוג JSON |
---|
{ "paragraphStyle": { object ( |
שדות | |
---|---|
paragraphStyle
|
הסגנונות שיש להגדיר בפסקאות.
שינויים מסוימים בפסקה עשויים לגרום לשינויים אחרים כדי לשקף את ההתנהגות של עורך Docs. למידע נוסף, אפשר לעיין במסמכי התיעוד של |
fields
|
השדות שצריך לעדכן.
יש לציין לפחות שדה אחד. השורש
לדוגמה, כדי לעדכן את מאפיין היישור של סגנון הפסקה, מגדירים את הערך כדי לאפס נכס לערך ברירת המחדל, צריך לכלול את שם השדה שלו במסכה של השדה, אבל להשאיר את השדה עצמו לא מוגדר. |
שדה איחוד
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
|
האם להוסיף שורה חדשה מתחת למיקום של ההפניה?
|
מיקום תא בטבלה
המיקום של תא יחיד בתוך טבלה.
ייצוג 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 } |
שדות | |
---|---|
objectId
|
המזהה של האובייקט הממוקם למחיקה. |
עדכוןTTColumnColumnRequest
עדכון
TableColumnProperties
העמודות בטבלה.
ייצוג JSON |
---|
{ "tableStartLocation": { object ( |
שדות | |
---|---|
tableStartLocation
|
המיקום שבו הטבלה מתחילה במסמך. |
columnIndices[]
|
רשימת האינדקסים של העמודות על בסיס אפס שיש לעדכן את הנכס שלהם. אם לא יצוינו אינדקסים, כל העמודות יעודכנו. |
tableColumnProperties
|
המאפיינים של עמודת הטבלה שיש לעדכן.
אם הערך של
|
fields
|
השדות שצריך לעדכן.
יש לציין לפחות שדה אחד. השורש
לדוגמה, כדי לעדכן את רוחב העמודה, מגדירים את |
עדכוןTTCellStyleRequest
עדכון הסגנון של טווח של תאים בטבלה.
ייצוג JSON |
---|
{ "tableCellStyle": { object ( |
שדות | |
---|---|
tableCellStyle
|
הסגנון שיוגדר בתאי הטבלה. כשמעדכנים גבולות, אם תא משתף גבול עם תא סמוך, גם מאפיין הגבול המתאים של התא הסמוך יעודכן. גבולות שאינם ממוזגים ולא מתעדכנים. עדכון גבול ששותף על ידי תאים סמוכים באותה בקשה עלול לגרום לעדכון גבולות מתנגש, ולכן החלת עדכוני הגבולות מתבצעת בסדר הבא:
|
fields
|
השדות שצריך לעדכן.
יש לציין לפחות שדה אחד. השורש
לדוגמה, כדי לעדכן את צבע הרקע של תא בטבלה, מגדירים את הערך
כדי לאפס נכס לערך ברירת המחדל, צריך לכלול את שם השדה שלו במסכה של השדה, אבל להשאיר את השדה עצמו לא מוגדר. |
שדה איחוד
cells . התאים שעודכנו.
cells
יכול להיות רק אחד מהבאים:
|
|
tableRange
|
טווח הטבלאות שמייצג את קבוצת המשנה של הטבלה שעליה מוחלים העדכונים. |
tableStartLocation
|
המיקום שבו הטבלה מתחילה במסמך. אם בוחרים באפשרות הזו, העדכונים יחולו על כל התאים בטבלה. |
טווח טבלאות
טווח של טבלה מייצג הפניה לקבוצת משנה של טבלה.
חשוב לציין שהתאים שצוינו בטווח טבלאות לא בהכרח יוצרים מלבן. לדוגמה, נניח שיש לנו טבלה בגודל 3 x 3, שבה כל התאים של השורה האחרונה ממוזגים יחד. הטבלה נראית כך:
[ ][ ][ ]
[ ][ ][ ]
[ ]
טווח טבלה עם מיקום תא בטבלה = (tableStartLocation, row = 0, column = 0), row span = 3 and column span = 2 מציין את התאים הבאים:
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
ייצוג JSON |
---|
{
"tableCellLocation": {
object (
|
שדות | |
---|---|
tableCellLocation
|
מיקום התא שבו מתחיל טווח הטבלה. |
rowSpan
|
אורך השורה של טווח הטבלה. |
columnSpan
|
טווח העמודות של טווח הטבלה. |
עדכוןTTRowStyleRequest
עדכון
TableRowStyle
השורות בטבלה.
ייצוג JSON |
---|
{ "tableStartLocation": { object ( |
שדות | |
---|---|
tableStartLocation
|
המיקום שבו הטבלה מתחילה במסמך. |
rowIndices[]
|
רשימת האינדקסים של השורות שלא מבוססות על אפס, שהסגנון שלהן צריך להתעדכן. אם לא יצוינו אינדקסים, כל השורות יעודכנו. |
tableRowStyle
|
הסגנונות שיוגדרו בשורות. |
fields
|
השדות שצריך לעדכן.
יש לציין לפחות שדה אחד. השורש
למשל, כדי לעדכן את גובה השורה המינימלי, מגדירים את הערך |
החלפת תמונה
מחליפה תמונה קיימת בתמונה חדשה.
החלפת תמונה גורמת להסרה של
image effects
מהתמונה הקיימת כדי לשקף את ההתנהגות של עורך Docs.
ייצוג JSON |
---|
{
"imageObjectId": string,
"uri": string,
"imageReplaceMethod": enum (
|
שדות | |
---|---|
imageObjectId
|
המזהה של התמונה הקיימת שיוחלף. ניתן לאחזר את המזהה מהתשובה של בקשת אחזור. |
uri
|
ה-URI של התמונה החדשה. התמונה מאוחזרת פעם אחת בזמן ההוספה, ועותק נשמר לתצוגה במסמך. התמונות חייבות להיות קטנות מ-50MB ובגודל של עד 25 מגה פיקסל. הן צריכות להיות בפורמט PNG, JPEG או GIF.
ה-URI שסופק לא יכול לחרוג מ- 2KB. ה-URI נשמר עם התמונה, וחשוף באמצעות השדה
|
imageReplaceMethod
|
שיטת ההחלפה. |
שיטת החלפת התמונה
שיטת החלפת התמונות.
טיפוסים בני מנייה (enum) | |
---|---|
IMAGE_REPLACE_METHOD_UNSPECIFIED
|
שיטה לא מוגדרת להחלפת תמונות. אין להשתמש בערך הזה. |
CENTER_CROP
|
שינוי הגודל והמרכז של התמונה כדי למלא את גבולות התמונה המקורית. יכול להיות שהתמונה תיחתך כדי למלא את הגבולות של התמונה המקורית. הגודל של התמונה המעובדת יהיה זהה לזה של התמונה המקורית. |
עדכון DocumentDocumentStyle
מתבצע עדכון של
DocumentStyle
.
ייצוג JSON |
---|
{
"documentStyle": {
object (
|
שדות | |
---|---|
documentStyle
|
הסגנונות שיש להגדיר במסמך.
שינויים מסוימים בטקסט של המסמך עשויים לגרום לשינויים אחרים כדי לשקף את ההתנהגות של עורך Docs. למידע נוסף, אפשר לעיין במסמכי התיעוד של |
fields
|
השדות שצריך לעדכן.
יש לציין לפחות שדה אחד. השורש
לדוגמה, כדי לעדכן את הרקע, מגדירים את
|
בקשת MergeTableCellsRequest
מיזוג תאים בתוך
Table
.
ייצוג JSON |
---|
{
"tableRange": {
object (
|
שדות | |
---|---|
tableRange
|
טווח הטבלה שמציין אילו תאים בטבלה יש למזג. כל טקסט בתאים שמוזגו יחובר ונשמר בתא "head" של הטווח. זהו התא השמאלי העליון של הטווח כאשר כיוון התוכן נמצא משמאל לימין, והתא הימני העליון של הטווח. אם הטווח הוא לא מלבני (מצב זה יכול להתרחש במקרים מסוימים שהטווח מכסה תאים שכבר ממוזגים או כאשר הטבלה אינה מלבנית), מוחזרת שגיאה 400 בבקשה שגויה. |
ביטול המיזוג של בקשה
ביטול המיזוג של תאים ב-Table
.
ייצוג JSON |
---|
{
"tableRange": {
object (
|
שדות | |
---|---|
tableRange
|
טווח הטבלה שמציין אילו תאים בטבלה יש לבטל. כל התאים שמוזגו בטווח הזה לא ימוזגו, ותאים שכבר לא מוזגו לא יושפעו. אם בטווח אין תאים שמוזגו, הבקשה לא תעשה דבר. אם יש טקסט באחד מהתאים שמוזגו, הטקסט יישאר בתא ה-head של הבלוק שמתקבל מהמיזוג של התאים. התא "ראש" הוא התא השמאלי העליון כאשר כיוון התוכן הוא משמאל לימין, ואילו התא הימני למעלה. |
CreateHeaderRequest
יוצר
Header
. הכותרת החדשה תחול על
SectionStyle
במיקום של
SectionBreak
אם צוין, אחרת היא תחול על
DocumentStyle
.
אם כבר קיימת כותרת מהסוג שצוין, תוחזר שגיאת 400 של בקשה שגויה.
ייצוג JSON |
---|
{ "type": enum ( |
שדות | |
---|---|
type
|
סוג הכותרת שיש ליצור. |
sectionBreakLocation
|
המיקום של |
CreateWorktnoteRequest
יצירת פלח
Footnote
והוספה של
FootnoteReference
חדש למיקום הנתון.
הפלח החדש של
Footnote
יכיל רווח ואחריו תו חדש.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד
footnote_reference_location . המיקום שבו יש להוסיף את ההפניה להערת השוליים.
footnote_reference_location
יכול להיות רק אחד מהבאים:
|
|
location
|
הוספת ההפניה להערת שוליים באינדקס ספציפי במסמך.
יש להוסיף את קובץ העזר להערת שוליים בגבולות של
לא ניתן להוסיף הפניות להערת שוליים בתוך משוואה, כותרת עליונה, כותרת תחתונה או הערת שוליים. ניתן להוסיף הפניות להערות שוליים רק בגוף הקובץ, ולכן השדה |
endOfSegmentLocation
|
הוספת ההפניה להערת שוליים בסוף גוף המסמך.
לא ניתן להוסיף הפניות להערת שוליים בכותרת עליונה, בכותרת תחתונה או בהערת שוליים. ניתן להוסיף הפניות להערות שוליים רק בגוף הקובץ, ולכן השדה |
החלפת NameNamedRangeContentRequest
החלפת התוכן של
NamedRange
או
NamedRanges
בתוכן החלופי שצוין.
לתשומת ליבכם, NamedRange
יכול להיות מורכב ממספר ranges
לא רציפים. במקרה כזה, רק התוכן בטווח הראשון יוחלף. הטווחים האחרים והתוכן שלהם יימחקו.
במקרים שבהם החלפה או מחיקה של טווחים תוביל למבנה מסמכים לא תקין, תוחזר שגיאת 400 של בקשה לא תקינה.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד
replacement_content . התוכן שיחליף את התוכן הקיים בטווח בעל השם.
replacement_content
יכול להיות רק אחד מהבאים:
|
|
text
|
התוכן של הטווחים בעלי השם שצוין מחליף את הטקסט הנתון. |
שדה איחוד
named_range_reference . הפניה לטווחים בעלי השם שהתוכן שלהם יוחלף.
named_range_reference
יכול להיות רק אחד מהבאים:
|
|
namedRangeId
|
המזהה של הטווח בעל השם שהתוכן שלו יוחלף. אם אין טווח בעל שם עם המזהה הנתון, תוחזר שגיאת 400. |
namedRangeName
|
השם של
אם יש כמה
|
עדכון הסגנון
מתבצע עדכון של
SectionStyle
.
ייצוג JSON |
---|
{ "range": { object ( |
שדות | |
---|---|
range
|
הטווח שחופף למקטעים.
מאחר שניתן להוסיף מעברי קטעים רק בתוך הגוף, השדה
|
sectionStyle
|
הסגנונות שיוגדרו בקטע הזה.
שינויים מסוימים בסעיפים עשויים לגרום לשינויים אחרים בהתנהגות של עורך Docs. למידע נוסף, אפשר לעיין במסמכי התיעוד של |
fields
|
השדות שצריך לעדכן.
יש לציין לפחות שדה אחד. השורש
לדוגמה, כדי לעדכן את השוליים השמאליים, מגדירים את הערך |
InsertSectionBreakRequest
הוספת מעבר קטע במיקום הנתון.
תו מעבר שורה חדשה יתווסף לפני מעבר הקטע.
ייצוג JSON |
---|
{ "sectionType": enum ( |
שדות | |
---|---|
sectionType
|
סוג הקטע להוספה. |
שדה איחוד
insertion_location . המיקום שבו תתבצע ההפסקה.
insertion_location
יכול להיות רק אחד מהבאים:
|
|
location
|
הוספת שורה חדשה ומעבר קטע באינדקס ספציפי במסמך.
צריך להוסיף את מעבר קטע בתוך הגבולות של
לא ניתן להוסיף מעברי קטעים בטבלה, במשוואה, בהערת שוליים, בכותרת עליונה או בכותרת תחתונה. מאחר שניתן להוסיף מעברי קטעים רק בתוך הגוף, השדה
|
endOfSegmentLocation
|
הוספת שורה חדשה ומעבר קטע בסוף גוף המסמך.
לא ניתן להוסיף מעברי קטעים בתוך הערת שוליים, כותרת עליונה או תחתונה. מאחר שניתן להוסיף מעברי קטעים רק בתוך הגוף, השדה
|
DeleteHeaderRequest
מתבצעת מחיקה של
Header
מהמסמך.
ייצוג JSON |
---|
{ "headerId": string } |
שדות | |
---|---|
headerId
|
המזהה של הכותרת למחיקה. אם הכותרת הזו מוגדרת בתאריך
|
PinTableHeaderRowsRequest
עדכון מספר שורות הכותרת בטבלה המוצמדת בטבלה.
ייצוג JSON |
---|
{
"tableStartLocation": {
object (
|
שדות | |
---|---|
tableStartLocation
|
המיקום שבו הטבלה מתחילה במסמך. |
pinnedHeaderRowsCount
|
מספר השורות בטבלה שיש להצמיד, כאשר 0 מרמז על כך שלא מתבצע ביטול הצמדה של כל השורות. |