- משאב: מסמך
- Tab
- TabProperties
- DocumentTab
- גוף ההודעה
- StructuralElement
- פסקה
- ParagraphElement
- TextRun
- TextStyle
- OptionalColor
- צבע
- RgbColor
- מאפיין
- היחידה
- WeightedFontFamily
- BaselineOffset
- קישור
- BookmarkLink
- HeadingLink
- SuggestedTextStyle
- TextStyleSuggestionState
- AutoText
- סוג
- PageBreak
- ColumnBreak
- FootnoteReference
- HorizontalRule
- הנוסחה
- InlineObjectElement
- אדם
- PersonProperties
- RichLink
- RichLinkProperties
- ParagraphStyle
- NamedStyleType
- יישור
- ContentDirection
- SpacingMode
- ParagraphBorder
- DashStyle
- TabStop
- TabStopAlignment
- הצללה
- SuggestedParagraphStyle
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- Bullet
- SuggestedBullet
- BulletSuggestionState
- ObjectReferences
- SectionBreak
- SectionStyle
- SectionColumnProperties
- ColumnSeparatorStyle
- SectionType
- טבלה
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- ContentAlignment
- SuggestedTableCellStyle
- TableCellStyleSuggestionState
- TableRowStyle
- SuggestedTableRowStyle
- TableRowStyleSuggestionState
- TableStyle
- TableColumnProperties
- WidthType
- TableOfContents
- כותרת
- כותרת תחתונה
- הערת שוליים
- DocumentStyle
- רקע
- Size
- SuggestedDocumentStyle
- DocumentStyleSuggestionState
- BackgroundSuggestionState
- SizeSuggestionState
- NamedStyles
- NamedStyle
- SuggestedNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- רשימה
- ListProperties
- NestingLevel
- BulletAlignment
- GlyphType
- SuggestedListProperties
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- NamedRanges
- NamedRange
- טווח
- InlineObject
- InlineObjectProperties
- EmbeddedObject
- EmbeddedDrawingProperties
- ImageProperties
- CropProperties
- EmbeddedObjectBorder
- PropertyState
- LinkedContentReference
- SheetsChartReference
- SuggestedInlineObjectProperties
- InlineObjectPropertiesSuggestionState
- EmbeddedObjectSuggestionState
- EmbeddedDrawingPropertiesSuggestionState
- ImagePropertiesSuggestionState
- CropPropertiesSuggestionState
- EmbeddedObjectBorderSuggestionState
- LinkedContentReferenceSuggestionState
- SheetsChartReferenceSuggestionState
- PositionedObject
- PositionedObjectProperties
- PositionedObjectPositioning
- PositionedObjectLayout
- SuggestedPositionedObjectProperties
- PositionedObjectPropertiesSuggestionState
- PositionedObjectPositioningSuggestionState
- SuggestionsViewMode
- שיטות
משאב: מסמך
מסמך ב-Google Docs.
ייצוג JSON |
---|
{ "documentId": string, "title": string, "tabs": [ { object ( |
שדות | |
---|---|
documentId |
פלט בלבד. המזהה של המסמך. |
title |
כותרת המסמך. |
tabs[] |
כרטיסיות שהן חלק ממסמך. כרטיסיות יכולות להכיל כרטיסיות צאצא, כרטיסייה שבתוך כרטיסייה אחרת. כרטיסיות צאצא מיוצגות על ידי השדה |
revisionId |
פלט בלבד. מזהה הגרסה של המסמך. אפשר להשתמש בהן בבקשות עדכון כדי לציין על איזו גרסה של מסמך להחיל עדכונים, ואיך הבקשה צריכה להתנהג אם המסמך נערך מאז הגרסה הזו. השדה מאוכלס רק אם למשתמש יש גישת עריכה למסמך. מזהה הגרסה הוא לא מספר רציף, אלא מחרוזת אטומה. הפורמט של מזהה הגרסה עשוי להשתנות עם הזמן. מובטח שמזהה הגרסה שהוחזר יהיה תקף רק ל-24 שעות לאחר החזרתו, ולא ניתן לשתף אותו עם משתמשים. אם מזהה הגרסה לא משתנה בין הקריאות, סימן שהמסמך לא השתנה. לעומת זאת, מזהה שהשתנה (באותו מסמך ובאותו משתמש) בדרך כלל מציין שהמסמך עודכן. עם זאת, שינוי במזהה יכול לנבוע גם מגורמים פנימיים, כמו שינויים בפורמט המזהה. |
suggestionsViewMode |
פלט בלבד. מצב תצוגת ההצעות שהוחל על המסמך. הערה: כשעורכים מסמך, השינויים חייבים להתבסס על מסמך עם |
body |
פלט בלבד. התוכן הראשי של המסמך. השדה 'מדור קודם': במקום זאת, צריך להשתמש ב- |
headers |
פלט בלבד. הכותרות במסמך, עם קידוד לפי מזהה הכותרת. שדה מדור קודם: במקום זאת, משתמשים ב- |
footers |
פלט בלבד. הכותרות התחתונות במסמך, מקודדות לפי מזהה הכותרת התחתונה. שדה מדור קודם: במקום זאת, משתמשים ב- |
footnotes |
פלט בלבד. הערות השוליים במסמך, לפי מזהה הערת השוליים. שדה מדור קודם: במקום זאת, משתמשים ב- |
documentStyle |
פלט בלבד. סגנון המסמך. השדה 'מדור קודם': במקום זאת, צריך להשתמש ב- |
suggestedDocumentStyleChanges |
פלט בלבד. ההצעות לשינויים בסגנון של המסמך, עם מזהה ההצעה. השדה 'מדור קודם': במקום זאת, צריך להשתמש ב- |
namedStyles |
פלט בלבד. הסגנונות של המסמך שצוינו בשם. השדה 'מדור קודם': במקום זאת, צריך להשתמש ב- |
suggestedNamedStylesChanges |
פלט בלבד. השינויים המוצעים בסגנונות השם של המסמך, לפי מזהה ההצעה. שדה מדור קודם: במקום זאת, משתמשים ב- |
lists |
פלט בלבד. הרשימות במסמך, לפי מפתח של מזהה רשימה. השדה 'מדור קודם': במקום זאת, צריך להשתמש ב- |
namedRanges |
פלט בלבד. טווחי התאים בעלי השם במסמך, לפי מפתחות לפי שם. שדה מדור קודם: במקום זאת, משתמשים ב- |
inlineObjects |
פלט בלבד. האובייקטים המוטבעים במסמך, מקודדים לפי מזהה אובייקט. שדה מדור קודם: במקום זאת, משתמשים ב- |
positionedObjects |
פלט בלבד. האובייקטים הממוקמים במסמך, עם קידוד לפי מזהה אובייקט. שדה מדור קודם: במקום זאת, משתמשים ב- |
כרטיסייה
כרטיסייה במסמך.
ייצוג JSON |
---|
{ "tabProperties": { object ( |
שדות | |
---|---|
tabProperties |
המאפיינים של הכרטיסייה, כמו ID ו-title. |
childTabs[] |
הכרטיסיות המשניות שמוטמעות בכרטיסייה הזו. |
שדה איחוד content . התוכן של הכרטיסייה. הערך של content יכול להיות רק אחת מהאפשרויות הבאות: |
|
documentTab |
כרטיסייה עם תוכן המסמך, כמו טקסט ותמונות. |
TabProperties
המאפיינים של כרטיסייה.
ייצוג ב-JSON |
---|
{ "tabId": string, "title": string, "parentTabId": string, "index": integer, "nestingLevel": integer } |
שדות | |
---|---|
tabId |
פלט בלבד. המזהה של הכרטיסייה. אי אפשר לשנות את השדה הזה. |
title |
השם של הכרטיסייה שגלוי למשתמש. |
parentTabId |
זה שינוי אופציונלי. המזהה של כרטיסיית ההורה. ריקה אם הכרטיסייה הנוכחית היא כרטיסייה ברמה הבסיסית (root), כלומר אין לה תבניות הורה. |
index |
האינדקס מבוסס על אפס של הכרטיסייה בתוך תבנית ההורה. |
nestingLevel |
פלט בלבד. עומק הכרטיסייה בתוך המסמך. כרטיסיות ברמה הבסיסית מתחילות ב-0. |
DocumentTab
כרטיסייה עם תוכן המסמך.
ייצוג ב-JSON |
---|
{ "body": { object ( |
שדות | |
---|---|
body |
התוכן הראשי של כרטיסיית המסמך. |
headers |
הכותרות בכרטיסיית המסמך, בקידוד לפי מזהה הכותרת. |
footers |
הכותרות התחתונות בכרטיסיית המסמך, מקובצות לפי מזהה הכותרת התחתונה. |
footnotes |
הערות השוליים בכרטיסיית המסמך, לפי מזהה הערת השוליים. |
documentStyle |
הסגנון של הכרטיסייה של המסמך. |
suggestedDocumentStyleChanges |
ההצעות לשינויים בסגנון של כרטיסיית המסמך, בשיוך לפי מזהה ההצעה. |
namedStyles |
הסגנונות עם השמות בכרטיסיית המסמך. |
suggestedNamedStylesChanges |
השינויים המוצעים בסגנונות עם השמות בכרטיסיית המסמך, לפי מזהה ההצעה. |
lists |
הרשימות בכרטיסיית המסמך, לפי מפתח של מזהה רשימה. |
namedRanges |
טווחי התאים בעלי השם בכרטיסיית המסמך, מקובצים לפי שם. |
inlineObjects |
האובייקטים בשורה בכרטיסיית המסמך, לפי מפתח של מזהה אובייקט. |
positionedObjects |
האובייקטים שממוקמים בכרטיסיית המסמך, מקובצים לפי מזהה אובייקט. |
גוף
גוף המסמך.
בדרך כלל, הגוף מכיל את תוכן המסמך המלא, מלבד headers
, footers
ו-footnotes
.
ייצוג ב-JSON |
---|
{
"content": [
{
object ( |
שדות | |
---|---|
content[] |
תוכן הגוף. האינדקסים של תוכן הגוף מתחילים באפס. |
StructuralElement
רכיב מבנה מתאר תוכן שמספק מבנה למסמך.
ייצוג JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
שדות | |
---|---|
startIndex |
אינדקס ההתחלה שמתחיל באפס של רכיב המבנה הזה, ביחידות קוד UTF-16. |
endIndex |
אינדקס הסיום שמתחיל באפס של רכיב המבנה הזה, לא כולל, ביחידות קוד UTF-16. |
שדה איחוד content . התוכן של הרכיב המבני. הערך של content יכול להיות רק אחת מהאפשרויות הבאות: |
|
paragraph |
אלמנט מבני מסוג פסקאות. |
sectionBreak |
סוג של אלמנט מבני של מעבר בין קטעים. |
table |
סוג טבלה של אלמנט מבני. |
tableOfContents |
סוג תוכן עניינים של רכיב מבני. |
פסקה
StructuralElement
שמייצג פסקה. פסקה היא טווח תוכן שמסתיים בתו של שורה חדשה.
ייצוג ב-JSON |
---|
{ "elements": [ { object ( |
שדות | |
---|---|
elements[] |
תוכן הפסקה בחלוקה לחלקים שמרכיבים אותה. |
paragraphStyle |
הסגנון של הפסקה הזו. |
suggestedParagraphStyleChanges |
סגנון הפסקה המוצע ישתנה לפסקה הזו, כשהוא מקודד לפי מזהה ההצעה. |
bullet |
סמליל הנקודה בפסקה הזו. אם הוא לא מופיע, הפסקה לא שייכת לרשימה. |
suggestedBulletChanges |
ההצעות לשינויים בתבליט של פסקה זו. |
positionedObjectIds[] |
המזהים של האובייקטים הממוקמים, הקשורים לפיסקה זו. |
suggestedPositionedObjectIds |
המזהים של האובייקטים הממוקמים שהוצעו לצירוף לפסקה הזו, עם קידוד לפי מזהה הצעה. |
ParagraphElement
רכיב פסקה מתאר תוכן בתוך Paragraph
.
ייצוג JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
שדות | |
---|---|
startIndex |
אינדקס ההתחלה שמתחיל באפס של רכיב הפיסקה הזה, ביחידות קוד UTF-16. |
endIndex |
אינדקס הסיום של רכיב הפסקה הזה, לא כולל, בבסיס אפס ביחידות קוד UTF-16. |
שדה איחוד content . התוכן של רכיב הפסקה. הערך של content יכול להיות רק אחת מהאפשרויות הבאות: |
|
textRun |
רכיב פסקה של טקסט רצוף. |
autoText |
רכיב של פסקה עם טקסט אוטומטי. |
pageBreak |
רכיב פסקה של מעבר דף. |
columnBreak |
רכיב פסקאות של מעבר עמודה. |
footnoteReference |
רכיב פסקה של הפניה להערת שוליים. |
horizontalRule |
רכיב פסקה של קו אופקי. |
equation |
רכיב של פסקה עם משוואה. |
inlineObjectElement |
רכיב פסקה של אובייקט בתוך שורה. |
person |
רכיב פסקה שמקושר לאדם או לכתובת אימייל. |
richLink |
רכיב פסקה שמקושר למשאב של Google (כמו קובץ ב-Google Drive, סרטון ב-YouTube או אירוע ביומן). |
TextRun
ParagraphElement
שמייצג רצף של טקסט שכולם מתאפיינים באותו סגנון.
ייצוג ב-JSON |
---|
{ "content": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
שדות | |
---|---|
content |
הטקסט של ההרצה הזו. רכיבים שאינם טקסט בהרצה מוחלפים בתו Unicode U+E907. |
suggestedInsertionIds[] |
המזהים המוצעים של המודעות. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקה של התוכן. |
textStyle |
סגנון הטקסט של ההרצה הזו. |
suggestedTextStyleChanges |
סגנון הטקסט שהוצע משתנה בהרצה הזו, עם מפתח לפי מזהה ההצעה. |
TextStyle
הסגנון שאפשר להחיל על טקסט.
סגנונות טקסט שעברו בירושה מיוצגים כשדות לא מוגדרים בהודעה הזו. ההורה של סגנון הטקסט תלוי במיקום שבו הוא מוגדר:
- סגנון הטקסט (TextStyle) של טקסט ב-
Paragraph
עובר בירושה מה-named style type
התואם של הפסקה. - סגנון הטקסט ב-
named style
עובר בירושה מהסגנון בשםnormal text
. - TextStyle של הסגנון בעל השם
normal text
עובר בירושה מסגנון הטקסט שמוגדר כברירת מחדל בעורך Docs. - TextStyle ברכיב
Paragraph
שכלול בטבלה עשוי לרשת את סגנון הטקסט שלו מסגנון הטבלה.
אם סגנון הטקסט לא יורש מהורה, ביטול ההגדרה של שדות יחזיר את הסגנון לערך שתואם לברירות המחדל בעורך Docs.
ייצוג JSON |
---|
{ "bold": boolean, "italic": boolean, "underline": boolean, "strikethrough": boolean, "smallCaps": boolean, "backgroundColor": { object ( |
שדות | |
---|---|
bold |
מציין אם הטקסט מודגש או לא. |
italic |
אם הטקסט נטוי או לא. |
underline |
האם הטקסט מופיע עם קו תחתון או לא. |
strikethrough |
האם הטקסט מסומן בקו חוצה או לא. |
smallCaps |
האם הטקסט מופיע באותיות קטנות. |
backgroundColor |
צבע הרקע של הטקסט. אם האפשרות מוגדרת, הצבע הוא צבע RGB או שקוף, בהתאם לשדה |
foregroundColor |
צבע החזית של הטקסט. אם האפשרות מוגדרת, הצבע הוא צבע RGB או שקוף, בהתאם לשדה |
fontSize |
גודל הגופן של הטקסט. |
weightedFontFamily |
משפחת הגופנים ומשקל הטקסט לאחר עיבוד. אם בבקשת עדכון מצוינים ערכים גם ל- אם לא מגדירים את אם מגדירים את |
baselineOffset |
ההיסט האנכי של הטקסט מהמיקום הרגיל שלו. טקסט עם ההיסט הבסיסי של |
link |
היעד של ההיפר-קישור בטקסט. אם המדיניות לא מוגדרת, אין קישור. הקישורים לא עוברים בירושה מטקסט ההורה. שינוי הקישור בבקשת עדכון גורם לשינויים נוספים בסגנון הטקסט של הטווח:
|
OptionalColor
צבע שיכול להיות אטום לגמרי או שקוף לגמרי.
ייצוג JSON |
---|
{
"color": {
object ( |
שדות | |
---|---|
color |
אם הערך הזה מוגדר, הוא ישמש כצבע אטום. אם השדה לא מוגדר, הוא מייצג צבע שקוף. |
צבע
צבע אחיד.
ייצוג ב-JSON |
---|
{
"rgbColor": {
object ( |
שדות | |
---|---|
rgbColor |
ערך צבע ה-RGB. |
RgbColor
צבע RGB.
ייצוג JSON |
---|
{ "red": number, "green": number, "blue": number } |
שדות | |
---|---|
red |
הרכיב האדום של הצבע, מ-0.0 עד 1.0. |
green |
הרכיב הירוק של הצבע, מ-0.0 עד 1.0. |
blue |
הרכיב הכחול של הצבע, מ-0.0 עד 1.0. |
מאפיין
עוצמת קול בכיוון אחד ביחידות שצוינו.
ייצוג JSON |
---|
{
"magnitude": number,
"unit": enum ( |
שדות | |
---|---|
magnitude |
העוצמה. |
unit |
יחידות העוצמה. |
יחידה
יחידות מידה.
טיפוסים בני מנייה (enum) | |
---|---|
UNIT_UNSPECIFIED |
היחידות לא ידועות. |
PT |
נקודה, 1/72 אינץ'. |
WeightedFontFamily
מייצג את משפחת הגופנים והמשקל של הטקסט.
ייצוג ב-JSON |
---|
{ "fontFamily": string, "weight": integer } |
שדות | |
---|---|
fontFamily |
משפחת הגופנים של הטקסט. משפחת הגופנים יכולה להיות כל גופן מתפריט הגופנים ב-Docs או מ-Google Fonts. אם שם הגופן לא מזוהה, הטקסט מעובד ב- |
weight |
עובי הגופן. השדה הזה יכול להכיל כל ערך שהוא כפולה של ערך ברירת המחדל הוא משקל הגופן הוא רק אחד מהרכיבים של משקל הגופן שעבר רינדור. שילוב של הערך
|
BaselineOffset
הדרכים שבהן ניתן להטות טקסט אנכית מהמיקום הרגיל שלו.
טיפוסים בני מנייה (enum) | |
---|---|
BASELINE_OFFSET_UNSPECIFIED |
ההיסט הבסיסי של הטקסט עובר בירושה מתבנית ההורה. |
NONE |
הטקסט לא קוזז אנכית. |
SUPERSCRIPT |
הטקסט מיסט אנכי למעלה (כתב עילי). |
SUBSCRIPT |
הטקסט מיסט אנכי למטה (כתב תחתי). |
קישור
הפניה לחלק אחר של מסמך או למשאב של כתובת URL חיצונית.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד destination . יעד הקישור. destination יכול להיות רק אחת מהאפשרויות הבאות: |
|
url |
כתובת URL חיצונית. |
tabId |
המזהה של כרטיסייה במסמך הזה. |
bookmark |
סימנייה במסמך הזה. במסמכים שמכילים כרטיסייה יחידה, קישורים לסימניות בכרטיסייה היחידה ממשיכים להחזיר |
heading |
כותרת במסמך הזה. במסמכים שמכילים כרטיסייה יחידה, קישורים לכותרות בכרטיסייה היחידה ממשיכים להחזיר |
bookmarkId |
המזהה של סימנייה במסמך הזה. השדה 'דור קודם': במקום זאת, צריך להגדיר את אם השדה הזה משמש בבקשת כתיבה, הסימנייה נחשבת למזוהה הכרטיסייה שצוין בבקשה. אם לא צוין מזהה כרטיסייה בבקשה, היא נחשבת ככרטיסייה הראשונה במסמך. |
headingId |
המזהה של כותרת במסמך הזה. השדה 'דור קודם': במקום זאת, צריך להגדיר את אם השדה הזה משמש בבקשת כתיבה, הכותרת נחשבת כמגיעה ממזהה הכרטיסייה שצוין בבקשה. אם לא צוין מזהה כרטיסייה בבקשה, היא נחשבת ככרטיסייה הראשונה במסמך. |
BookmarkLink
הפניה לסימנית במסמך הזה.
ייצוג ב-JSON |
---|
{ "id": string, "tabId": string } |
שדות | |
---|---|
id |
המזהה של סימנייה במסמך הזה. |
tabId |
מזהה הכרטיסייה שמכילה את הסימנייה הזו. |
HeadingLink
הפניה לכותרת במסמך הזה.
ייצוג ב-JSON |
---|
{ "id": string, "tabId": string } |
שדות | |
---|---|
id |
המזהה של כותרת במסמך הזה. |
tabId |
מזהה הכרטיסייה שמכילה את הכותרת הזו. |
SuggestedTextStyle
הצעה לשינוי ל-TextStyle
.
ייצוג ב-JSON |
---|
{ "textStyle": { object ( |
שדות | |
---|---|
textStyle |
|
textStyleSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
TextStyleSuggestionState
מסכה שמציינת אילו מהשדות בבסיס TextStyle
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "boldSuggested": boolean, "italicSuggested": boolean, "underlineSuggested": boolean, "strikethroughSuggested": boolean, "smallCapsSuggested": boolean, "backgroundColorSuggested": boolean, "foregroundColorSuggested": boolean, "fontSizeSuggested": boolean, "weightedFontFamilySuggested": boolean, "baselineOffsetSuggested": boolean, "linkSuggested": boolean } |
שדות | |
---|---|
boldSuggested |
מציין אם הייתה הצעה לשינוי ב- |
italicSuggested |
שדה זה מציין אם הוצע שינוי ל- |
underlineSuggested |
שדה זה מציין אם הוצע שינוי ל- |
strikethroughSuggested |
שדה זה מציין אם הוצע שינוי ל- |
smallCapsSuggested |
שדה זה מציין אם הוצע שינוי ל- |
backgroundColorSuggested |
שדה זה מציין אם הוצע שינוי ל- |
foregroundColorSuggested |
מציין אם הייתה הצעה לשינוי ב- |
fontSizeSuggested |
מציין אם הייתה הצעה לשינוי ב- |
weightedFontFamilySuggested |
שדה זה מציין אם הוצע שינוי ל- |
baselineOffsetSuggested |
מציין אם הייתה הצעה לשינוי ב- |
linkSuggested |
מציין אם הייתה הצעה לשינוי ב- |
טקסט אוטומטי
ParagraphElement
שמייצג מקום בטקסט שמוחליף באופן דינמי תוכן שיכול להשתנות עם הזמן, כמו מספר דף.
ייצוג JSON |
---|
{ "type": enum ( |
שדות | |
---|---|
type |
הסוג של טקסט אוטומטי זה. |
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ב- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
textStyle |
סגנון הטקסט של הטקסט האוטומטי הזה. |
suggestedTextStyleChanges |
סגנון הטקסט המוצע ישתנה לטקסט האוטומטי הזה, לפי מפתח של מזהה ההצעה. |
סוג
סוגי הטקסט האוטומטי.
טיפוסים בני מנייה (enum) | |
---|---|
TYPE_UNSPECIFIED |
סוג טקסט אוטומטי שלא צוין. |
PAGE_NUMBER |
הקלדה של טקסט אוטומטי שמייצג את מספר הדף הנוכחי. |
PAGE_COUNT |
טיפוס טקסט אוטומטי שמייצג את מספר הדפים הכולל במסמך. |
PageBreak
ParagraphElement
שמייצג מעבר דף. אם תוסיפו מעבר דף, הטקסט הבא יתחיל בחלק העליון של הדף הבא.
ייצוג ב-JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
שדות | |
---|---|
suggestedInsertionIds[] |
המזהים המוצעים של המודעות. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקה של התוכן. |
textStyle |
סגנון הטקסט של הפס ההפרדה הזה. בדומה לתוכן טקסט, כמו הרצת טקסט והפניות להערות שוליים, סגנון הטקסט של מעבר דף יכול להשפיע על פריסת התוכן ועל עיצוב הטקסט שמוסיפים לצידו. |
suggestedTextStyleChanges |
סגנון הטקסט המוצע ישתנה במעבר הדף הזה, בקידוד לפי מזהה ההצעה. |
ColumnBreak
ParagraphElement
שמייצג מעבר עמודה. אם תוסיפו הפסקה בעמודה, הטקסט הבא יתחיל בחלק העליון של העמודה הבאה.
ייצוג ב-JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
שדות | |
---|---|
suggestedInsertionIds[] |
המזהים המוצעים של המודעות. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקה של התוכן. |
textStyle |
סגנון הטקסט של ה-ColumnBreak הזה. בדומה לתוכן טקסט, כמו רצפי טקסט והפניות להערות שוליים, סגנון הטקסט של הפסקה בין עמודות יכול להשפיע על פריסת התוכן ועל סגנון הטקסט שמוסיפים לידה. |
suggestedTextStyleChanges |
סגנון הטקסט המוצע משתנה ל-ColumnBreak הזה, לפי המפתח של מזהה ההצעה. |
FootnoteReference
ParagraphElement
שמייצג הפניה להערת שוליים. הפניה להערת שוליים היא התוכן שמוצג בשורה עם מספר, והיא משמשת לזיהוי הערת השוליים.
ייצוג JSON |
---|
{ "footnoteId": string, "footnoteNumber": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
שדות | |
---|---|
footnoteId |
המזהה של |
footnoteNumber |
המספר של הערת השוליים הזו לאחר עיבוד. |
suggestedInsertionIds[] |
המזהים המוצעים של המודעות. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה. |
textStyle |
סגנון הטקסט של FootnoteReference הזה. |
suggestedTextStyleChanges |
סגנון הטקסט המוצע ישתנה ב-FootnoteReference, בקידוד לפי מזהה הצעה. |
HorizontalRule
ParagraphElement
שמייצג קו אופקי.
ייצוג ב-JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
שדות | |
---|---|
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה. |
textStyle |
סגנון הטקסט של הכלל האופקי הזה. בדומה לתוכן טקסט, כמו רצפי טקסט והפניות להערות שוליים, סגנון הטקסט של קו אופקי יכול להשפיע על פריסת התוכן וגם על סגנון הטקסט שמוסיפים לידו. |
suggestedTextStyleChanges |
סגנון הטקסט שהוצע ישתנה למכשיר האופקי הזה, עם קידוד לפי מזהה ההצעה. |
משוואה
ParagraphElement
שמייצג משוואה.
ייצוג JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
שדות | |
---|---|
suggestedInsertionIds[] |
המזהים המוצעים של המודעות. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
InlineObjectElement
ParagraphElement
שמכיל InlineObject
.
ייצוג JSON |
---|
{ "inlineObjectId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
שדות | |
---|---|
inlineObjectId |
המזהה של |
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה. |
textStyle |
סגנון הטקסט של InlineObjectElement הזה. בדומה לתוכן טקסט, כמו רצפי טקסט והפניות להערות שוליים, סגנון הטקסט של אלמנט אובייקט בתוך שורה יכול להשפיע על פריסת התוכן ועל סגנון הטקסט שמוסיפים לידו. |
suggestedTextStyleChanges |
סגנון הטקסט המוצע ישתנה ל-InlineObject הזה, עם מפתח לפי מזהה ההצעה. |
אדם
אדם או כתובת אימייל שהוזכרו במסמך. האזכורים האלה מתנהגים כרכיב יחיד שלא ניתן לשינוי, שמכיל את השם או את כתובת האימייל של אותו אדם.
ייצוג JSON |
---|
{ "personId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
שדות | |
---|---|
personId |
פלט בלבד. המזהה הייחודי של הקישור הזה. |
suggestedInsertionIds[] |
מזהים של הצעות להוספת הקישור לאדם הזה למסמך. יכול להיות של- |
suggestedDeletionIds[] |
מזהים של הצעות להסרת הקישור לאדם הזה מהמסמך. ל- |
textStyle |
סגנון הטקסט של |
suggestedTextStyleChanges |
סגנון הטקסט המוצע ישתנה ל- |
personProperties |
פלט בלבד. המאפיינים של |
PersonProperties
מאפיינים ספציפיים לחשבון Person
מקושר.
ייצוג ב-JSON |
---|
{ "name": string, "email": string } |
שדות | |
---|---|
name |
פלט בלבד. השם של האדם, אם הוא מוצג בטקסט של הקישור במקום כתובת האימייל שלו. |
email |
פלט בלבד. כתובת האימייל שמקושרת ל- |
RichLink
קישור למשאב של Google (למשל קובץ ב-Drive, סרטון ב-YouTube או אירוע ביומן Google).
ייצוג JSON |
---|
{ "richLinkId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
שדות | |
---|---|
richLinkId |
פלט בלבד. המזהה של הקישור הזה. |
suggestedInsertionIds[] |
המזהים של ההצעות שמוסיפות את הקישור הזה למסמך. יכול להיות של- |
suggestedDeletionIds[] |
המזהים של ההצעות להסרת הקישור הזה מהמסמך. יכול להיות של- |
textStyle |
סגנון הטקסט של |
suggestedTextStyleChanges |
סגנון הטקסט המוצע ישתנה ל- |
richLinkProperties |
פלט בלבד. המאפיינים של ה- |
RichLinkProperties
מאפיינים ספציפיים ל-RichLink
.
ייצוג JSON |
---|
{ "title": string, "uri": string, "mimeType": string } |
שדות | |
---|---|
title |
פלט בלבד. שם ה- |
uri |
פלט בלבד. ה-URI ל- |
mimeType |
פלט בלבד. סוג ה-MIME של ה- |
ParagraphStyle
סגנונות שחלים על פסקה שלמה.
סגנונות פסקאות שעברו בירושה מיוצגים בהודעה הזו כשדות לא מוגדרים. ההורה של סגנון הפסקה תלוי במקום שבו סגנון הפסקה מוגדר:
- סגנון הפיסקה ב
Paragraph
יורש את ה-named style type
התואם בפסקה. - ה-PagraphStyle ב-
named style
יורש את הסגנון בעל השםnormal text
. - סגנון הפיסקה של הסגנון בעל השם
normal text
יורש את סגנון ברירת המחדל של הפסקה בעורך Docs. - סגנון הפסקה של אלמנט
Paragraph
שנכלל בטבלה עשוי לרשת את סגנון הפסקה מסגנון הטבלה.
אם סגנון הפסקה לא עובר בירושה מהורה, ביטול ההגדרה של השדות יגרום לכך שהסגנון יחזור לערך שתואם לברירות המחדל בכלי העריכה של Docs.
ייצוג ב-JSON |
---|
{ "headingId": string, "namedStyleType": enum ( |
שדות | |
---|---|
headingId |
מזהה הכותרת של הפסקה. אם השדה ריק, הפסקה הזו אינה כותרת. הנכס הזה הוא לקריאה בלבד. |
namedStyleType |
סוג הסגנון של הפסקה, בעל השם. מאחר שעדכון סוג הסגנון המוגדר בשם משפיע על מאפיינים אחרים ב-ParagraphStyle, סוג הסגנון המוגדר בשם מוחל לפני ששאר המאפיינים מתעדכנים. |
alignment |
יישור הטקסט בפסקה הזו. |
lineSpacing |
כמות הרווח בין השורות, כאחוז מהנורמלי, כאשר הערך הרגיל מיוצג באמצעות 100.0. אם הערך לא מוגדר, הוא עובר בירושה מההורה. |
direction |
כיוון הטקסט בפסקה הזו. אם לא מגדירים את הערך, הערך שמוגדר כברירת מחדל הוא |
spacingMode |
מצב הריווח בין הפסקה. |
spaceAbove |
כמות הריווח הנוסף מעל הפיסקה. אם הערך לא מוגדר, הוא עובר בירושה מההורה. |
spaceBelow |
כמות הריווח הנוסף מתחת לפיסקה. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. |
borderBetween |
הגבול בין הפסקה הזו לבין הפסקה הבאה והפסקה הקודמת. אם הערך לא מוגדר, הוא עובר בירושה מההורה. המערכת תיצור את הגבול בין הפסקאות כשלפסקה הסמוכה יהיו אותם מאפייני גבול ותצוגת הפסקה. לא ניתן לעדכן באופן חלקי את גבולות הפסקאות. כשמשנים את גבול הקטע, צריך לציין את הגבול החדש במלואו. |
borderTop |
הגבול בחלק העליון של הפסקה הזו. אם הערך לא מוגדר, הוא עובר בירושה מההורה. הגבול העליון מוצג כאשר לפסקה שלמעלה יש מאפייני גבול וכניסת פסקה שונים. אי אפשר לעדכן באופן חלקי את גבולות הפיסקה. כשמשנים את גבול הקטע, צריך לציין את הגבול החדש במלואו. |
borderBottom |
הגבול שבתחתית הפסקה הזו. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. הגבול התחתון מוצג כאשר לפסקה שלמטה יש מאפייני גבול וכניסת פסקה שונים. אי אפשר לעדכן באופן חלקי את גבולות הפיסקה. כשמשנים את גבול הקטע, צריך לציין את הגבול החדש במלואו. |
borderLeft |
הגבול שמשמאל לפסקה הזו. אם הערך לא מוגדר, הוא עובר בירושה מההורה. לא ניתן לעדכן באופן חלקי את גבולות הפסקאות. כשמשנים את גבול הקטע, צריך לציין את הגבול החדש במלואו. |
borderRight |
הגבול מימין לפיסקה זו. אם הערך לא מוגדר, הוא עובר בירושה מההורה. לא ניתן לעדכן באופן חלקי את גבולות הפסקאות. כשמשנים את גבול הקטע, צריך לציין את הגבול החדש במלואו. |
indentFirstLine |
מידת ההגדלה של הכניסה של השורה הראשונה בפסקה. אם הערך לא מוגדר, הוא עובר בירושה מההורה. |
indentStart |
מידת כניסת הפיסקה בצד ימין שמתאימה לתחילת הטקסט, על סמך כיוון הפסקה הנוכחי. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. |
indentEnd |
מידת כניסת הפיסקה בצד ימין שמתאימה לסוף הטקסט, על סמך כיוון הפסקה הנוכחי. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. |
tabStops[] |
רשימה של עגילי התאמת הטקסט לפסיק בפסקה הזו. הרשימה של עצירות הטאב לא עוברת בירושה. הנכס הזה הוא לקריאה בלבד. |
keepLinesTogether |
האם כל השורות בפסקה צריכות להיות פרוסות באותו דף או באותו עמודה, אם אפשר. אם הערך לא מוגדר, הוא עובר בירושה מההורה. |
keepWithNext |
אם אפשר, אם אפשר, לפרוס לפחות חלק מפסקה זו באותו דף או עמודה כמו בפסקה העוקבת לה. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. |
avoidWidowAndOrphan |
האם להימנע מאלמונים ויתומים בפסקה. אם הערך לא מוגדר, הוא עובר בירושה מההורה. |
shading |
ההצללה של הפסקה. אם הערך לא מוגדר, הוא עובר בירושה מההורה. |
pageBreakBefore |
האם הפיסקה הנוכחית תמיד תתחיל בתחילת הדף. אם הערך לא מוגדר, הוא עובר בירושה מההורה. ניסיון לעדכן את |
NamedStyleType
סוגי הסגנונות עם השם.
טיפוסים בני מנייה (enum) | |
---|---|
NAMED_STYLE_TYPE_UNSPECIFIED |
הסוג של הסגנון המכונה לא צוין. |
NORMAL_TEXT |
טקסט רגיל. |
TITLE |
שם. |
SUBTITLE |
כתובית. |
HEADING_1 |
כותרת 1. |
HEADING_2 |
כותרת 2. |
HEADING_3 |
כותרת 3. |
HEADING_4 |
כותרת 4. |
HEADING_5 |
כותרת 5. |
HEADING_6 |
כותרת 6. |
יישור
סוגי היישור של הטקסט בפסקה.
טיפוסים בני מנייה (enum) | |
---|---|
ALIGNMENT_UNSPECIFIED |
היישור בין הפסקאות עובר בירושה מתבנית ההורה. |
START |
הפסקה מיושרת לתחילת השורה. יישור לשמאל לטקסט LTR, אחרת מיושר לימין. |
CENTER |
הפיסקה ממוקמת במרכז. |
END |
הפסקה מותאמת לסוף השורה. מיושר לימין בטקסט LTR, ומיושר לשמאל במקרים אחרים. |
JUSTIFIED |
הפיסקה ממורכזת. |
ContentDirection
התוכן של המסלול יכול לזרום.
טיפוסים בני מנייה (enum) | |
---|---|
CONTENT_DIRECTION_UNSPECIFIED |
לא צוינה כיוון התוכן. |
LEFT_TO_RIGHT |
התוכן מופיע משמאל לימין. |
RIGHT_TO_LEFT |
התוכן עובר מימין לשמאל. |
SpacingMode
המצבים השונים של ריווח פסקאות.
טיפוסים בני מנייה (enum) | |
---|---|
SPACING_MODE_UNSPECIFIED |
מצב הריווח עובר בירושה מהתבנית הראשית. |
NEVER_COLLAPSE |
הריווח של הפסקאות תמיד מוצג. |
COLLAPSE_LISTS |
הריווח בין הפריטים ברשימה לא חל על הריווח בין הפסקים. |
ParagraphBorder
שוליים סביב פסקה.
ייצוג JSON |
---|
{ "color": { object ( |
שדות | |
---|---|
color |
צבע הגבול. |
width |
רוחב הגבול. |
padding |
המרווח הפנימי של הגבול. |
dashStyle |
סגנון המקף של הגבול. |
DashStyle
סוגי המקפים שאפשר להשתמש בהם כדי ליצור גיאומטריה לינארית. הערכים האלה מבוססים על הסוג הפשוט ST_PresetLineDashVal שמתואר בקטע 20.1.10.48 במאמר 'פורמטים של קובצי Office Open XML – עקרונות בסיסיים ומסמך עזר בנושא שפת ה-Markup', חלק 1 של ECMA-376 מהדורה 4.
טיפוסים בני מנייה (enum) | |
---|---|
DASH_STYLE_UNSPECIFIED |
סגנון המקף לא צוין. |
SOLID |
קו רצוף. תואם לערך 'solid' ב-ECMA-376 ST_PresetLineDashVal. זהו סגנון הקו המקווקו שמוגדר כברירת מחדל. |
DOT |
קו מקווקו. תואם לערך 'dot' של ECMA-376 ST_PresetLineDashVal. |
DASH |
קו מקווקו. תואם לערך 'dash' ב-ECMA-376 ST_PresetLineDashVal. |
TabStop
ערך תצוגה של תצוגת טאב בתוך פסקה.
ייצוג JSON |
---|
{ "offset": { object ( |
שדות | |
---|---|
offset |
ההזזה בין עצור הכרטיסייה הזה לבין שולי ההתחלה. |
alignment |
היישור של עצירת הטאב הזו. אם המדיניות לא מוגדרת, ערך ברירת המחדל הוא |
TabStopAlignment
היישור של עצירת הטאב.
טיפוסים בני מנייה (enum) | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED |
לא צוין יישור לעצירת הטאב. |
START |
עצירת הטאב מיושרת לתחילת הקו. זוהי ברירת המחדל. |
CENTER |
עצירת הטאב מיושרת למרכז הקו. |
END |
עצירת הטאב מיושרת לסוף הקו. |
הצללה
את ההצללה של פסקה.
ייצוג ב-JSON |
---|
{
"backgroundColor": {
object ( |
שדות | |
---|---|
backgroundColor |
צבע הרקע של ההצללה של הפסקה הזו. |
SuggestedParagraphStyle
הצעה לשינוי ל-ParagraphStyle
.
ייצוג JSON |
---|
{ "paragraphStyle": { object ( |
שדות | |
---|---|
paragraphStyle |
קובץ |
paragraphStyleSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
ParagraphStyleSuggestionState
מסכה שמציינת אילו מהשדות בבסיס ParagraphStyle
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{
"headingIdSuggested": boolean,
"namedStyleTypeSuggested": boolean,
"alignmentSuggested": boolean,
"lineSpacingSuggested": boolean,
"directionSuggested": boolean,
"spacingModeSuggested": boolean,
"spaceAboveSuggested": boolean,
"spaceBelowSuggested": boolean,
"borderBetweenSuggested": boolean,
"borderTopSuggested": boolean,
"borderBottomSuggested": boolean,
"borderLeftSuggested": boolean,
"borderRightSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"indentEndSuggested": boolean,
"keepLinesTogetherSuggested": boolean,
"keepWithNextSuggested": boolean,
"avoidWidowAndOrphanSuggested": boolean,
"shadingSuggestionState": {
object ( |
שדות | |
---|---|
headingIdSuggested |
מציין אם הייתה הצעה לשינוי ב- |
namedStyleTypeSuggested |
שדה זה מציין אם הוצע שינוי ל- |
alignmentSuggested |
שדה זה מציין אם הוצע שינוי ל- |
lineSpacingSuggested |
מציין אם הייתה הצעה לשינוי ב- |
directionSuggested |
שדה זה מציין אם הוצע שינוי ל- |
spacingModeSuggested |
שדה זה מציין אם הוצע שינוי ל- |
spaceAboveSuggested |
שדה זה מציין אם הוצע שינוי ל- |
spaceBelowSuggested |
מציין אם הייתה הצעה לשינוי ב- |
borderBetweenSuggested |
מציין אם הייתה הצעה לשינוי ב- |
borderTopSuggested |
מציין אם הייתה הצעה לשינוי ב- |
borderBottomSuggested |
שדה זה מציין אם הוצע שינוי ל- |
borderLeftSuggested |
מציין אם הייתה הצעה לשינוי ב- |
borderRightSuggested |
מציין אם הייתה הצעה לשינוי ב- |
indentFirstLineSuggested |
מציין אם הייתה הצעה לשינוי ב- |
indentStartSuggested |
מציין אם הייתה הצעה לשינוי ב- |
indentEndSuggested |
מציין אם הייתה הצעה לשינוי ב- |
keepLinesTogetherSuggested |
מציין אם הייתה הצעה לשינוי ב- |
keepWithNextSuggested |
שדה זה מציין אם הוצע שינוי ל- |
avoidWidowAndOrphanSuggested |
שדה זה מציין אם הוצע שינוי ל- |
shadingSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
pageBreakBeforeSuggested |
שדה זה מציין אם הוצע שינוי ל- |
ShadingSuggestionState
מסכה שמציינת אילו מהשדות בבסיס Shading
השתנו בשינוי המוצע הזה. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "backgroundColorSuggested": boolean } |
שדות | |
---|---|
backgroundColorSuggested |
מציין אם הייתה הצעה לשינוי ב- |
תבליט
מתאר את פסיק הפסקה של פסקה.
ייצוג JSON |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
שדות | |
---|---|
listId |
המזהה של הרשימה שאליה שייכת הפיסקה הזו. |
nestingLevel |
רמת הסידור הפנימי של הפסקה הזו ברשימה. |
textStyle |
סגנון הטקסט הספציפי לפסקה שהוחל על הנקודה הזו. |
SuggestedBullet
הצעה לשינוי ל-Bullet
.
ייצוג JSON |
---|
{ "bullet": { object ( |
שדות | |
---|---|
bullet |
|
bulletSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
BulletSuggestionState
מסכה שמציינת אילו מהשדות בבסיס Bullet
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{
"listIdSuggested": boolean,
"nestingLevelSuggested": boolean,
"textStyleSuggestionState": {
object ( |
שדות | |
---|---|
listIdSuggested |
שדה זה מציין אם הוצע שינוי ב- |
nestingLevelSuggested |
מציין אם הייתה הצעה לשינוי ב- |
textStyleSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
ObjectReferences
אוסף של מזהי אובייקטים.
ייצוג ב-JSON |
---|
{ "objectIds": [ string ] } |
שדות | |
---|---|
objectIds[] |
מזהי האובייקטים |
SectionBreak
StructuralElement
שמייצג מעבר קטע. מדור הוא מגוון תכנים שיש להם את אותו SectionStyle
. מעבר קטע מייצג את ההתחלה של קטע חדש, וסגנון הקטע חל על הקטע אחרי מעבר הקטע.
גוף המסמך תמיד מתחיל במעבר קטע.
ייצוג JSON |
---|
{
"suggestedInsertionIds": [
string
],
"suggestedDeletionIds": [
string
],
"sectionStyle": {
object ( |
שדות | |
---|---|
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
sectionStyle |
הסגנון של הקטע אחרי ההפסקה הזו. |
SectionStyle
הסגנון שחלה על קטע.
ייצוג JSON |
---|
{ "columnProperties": [ { object ( |
שדות | |
---|---|
columnProperties[] |
מאפייני העמודות של הקטע. אם השדה ריק, הקטע מכיל עמודה אחת עם מאפייני ברירת המחדל בעורך Docs. אפשר לעדכן קטע כך שיכלול עד 3 עמודות. כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
columnSeparatorStyle |
הסגנון של תווי הפרדה בין עמודות. אפשר להגדיר את הסגנון הזה גם אם יש עמודה אחת בקטע. כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 (בקשה שגויה). |
contentDirection |
כיוון התוכן של הקטע הזה. אם לא מגדירים את הערך, ערך ברירת המחדל הוא כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
marginTop |
שוליים העליונים של הדף בקטע. אם לא מוגדר, ערך ברירת המחדל הוא כשמעדכנים את המאפיין הזה, צריך להגדיר ערך ספציפי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
marginBottom |
השוליים התחתונים של הדף בקטע. אם לא מגדירים ערך, הערך שמוגדר כברירת מחדל הוא כשמעדכנים את המאפיין הזה, צריך להגדיר ערך ספציפי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
marginRight |
שוליים הדף הימני של הקטע. אם לא מוגדר, ערך ברירת המחדל הוא כשמעדכנים את המאפיין הזה, צריך להגדיר ערך ספציפי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 (בקשה שגויה). |
marginLeft |
השוליים השמאליים של הדף בקטע. אם לא מוגדר, ערך ברירת המחדל הוא כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
marginHeader |
השוליים של הכותרת העליונה של הקטע. אם לא מוגדר, ערך ברירת המחדל הוא כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
marginFooter |
השוליים של הכותרת התחתונה של הקטע. אם לא מגדירים ערך, הערך שמוגדר כברירת מחדל הוא כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
sectionType |
פלט בלבד. סוג הקטע. |
defaultHeaderId |
המזהה של הכותרת שמוגדרת כברירת מחדל. אם לא מגדירים את הערך, הוא עובר בירושה מה-SectionStyle הקודם של הנכס הזה הוא לקריאה בלבד. |
defaultFooterId |
המזהה של הכותרת התחתונה המוגדרת כברירת המחדל. אם המדיניות לא מוגדרת, הערך עובר בירושה מסגנון המדור הקודם של הנכס הזה הוא לקריאה בלבד. |
firstPageHeaderId |
המזהה של הכותרת שמשמש רק בדף הראשון של הקטע. אם הערך של הנכס הזה הוא לקריאה בלבד. |
firstPageFooterId |
המזהה של הכותרת התחתונה שמיועדת רק לדף הראשון בקטע. אם הערך של הנכס הזה הוא לקריאה בלבד. |
evenPageHeaderId |
מזהה הכותרת שמשמשת רק לדפים זוגיים. אם הערך של הנכס הזה הוא לקריאה בלבד. |
evenPageFooterId |
המזהה של הכותרת התחתונה שמשמש רק בדפים זוגיים. אם הערך של הנכס הזה הוא לקריאה בלבד. |
useFirstPageHeaderFooter |
מציין אם להשתמש במזהים של הכותרת העליונה / הכותרת התחתונה בדף הראשון של הקטע. אם לא מגדירים אותו, הוא עובר בירושה מ- כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 (בקשה שגויה). |
pageNumberStart |
מספר הדף שממנו מתחילים לספור את מספר הדפים בקטע הזה. אם לא מגדירים את הפרמטר, מספור הדפים ממשיך מהקטע הקודם. אם הערך לא מוגדר ב- כשמעדכנים את המאפיין הזה, צריך להגדיר ערך ספציפי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 (בקשה שגויה). |
flipPageOrientation |
זה שינוי אופציונלי. מציינת אם להפוך את המידות של כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
SectionColumnProperties
מאפיינים שחלים על עמודה של מקטע.
ייצוג JSON |
---|
{ "width": { object ( |
שדות | |
---|---|
width |
פלט בלבד. רוחב העמודה. |
paddingEnd |
המרווח הפנימי בסוף העמודה. |
ColumnSeparatorStyle
הסגנון של תווי ההפרדה בין עמודות.
טיפוסים בני מנייה (enum) | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED |
סגנון מפריד עמודות לא צוין. |
NONE |
אין קווים מפרידים בין העמודות. |
BETWEEN_EACH_COLUMN |
הפונקציה יוצרת קו מפריד בין עמודות. |
SectionType
מייצג את המיקום של תחילת הקטע הנוכחי ביחס לקטע הקודם.
טיפוסים בני מנייה (enum) | |
---|---|
SECTION_TYPE_UNSPECIFIED |
סוג הקטע לא צוין. |
CONTINUOUS |
הקטע מתחיל מיד אחרי הפסקה האחרונה בקטע הקודם. |
NEXT_PAGE |
הקטע יתחיל בדף הבא. |
טבלה
StructuralElement
שמייצג טבלה.
ייצוג JSON |
---|
{ "rows": integer, "columns": integer, "tableRows": [ { object ( |
שדות | |
---|---|
rows |
מספר השורות בטבלה. |
columns |
מספר העמודות בטבלה. טבלה יכולה להיות לא מלבנית, ולכן בחלק מהשורות מספר התאים שונה. |
tableRows[] |
התוכן והסגנון של כל שורה. |
suggestedInsertionIds[] |
המזהים המוצעים של המודעות. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה. |
tableStyle |
הסגנון של הטבלה. |
TableRow
התוכן והסגנון של שורה ב-Table
.
ייצוג ב-JSON |
---|
{ "startIndex": integer, "endIndex": integer, "tableCells": [ { object ( |
שדות | |
---|---|
startIndex |
אינדקס ההתחלה של השורה הזו, שמתחיל באפס, ביחידות קוד UTF-16. |
endIndex |
אינדקס הקצה מבוסס אפס של שורה זו, בלעדי, ביחידות קוד UTF-16. |
tableCells[] |
התוכן והסגנון של כל תא בשורה הזו. טבלה יכולה להיות לא מלבנית, לכן בחלק מהשורות עשוי להיות מספר תאים שונה מזה של שורות אחרות באותה טבלה. |
suggestedInsertionIds[] |
המזהים המוצעים של המודעות. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקה של התוכן. |
tableRowStyle |
הסגנון של השורה בטבלה. |
suggestedTableRowStyleChanges |
הסגנון שהוצעה משתנה לשורה הזו, לפי מפתח של מזהה ההצעה. |
TableCell
התוכן והסגנון של תא ב-Table
.
ייצוג ב-JSON |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
שדות | |
---|---|
startIndex |
אינדקס ההתחלה של התא הזה, שמתחיל באפס, ביחידות קוד UTF-16. |
endIndex |
אינדקס הקצה מבוסס אפס של התא הזה, בלעדי, ביחידות קוד UTF-16. |
content[] |
התוכן של התא. |
tableCellStyle |
הסגנון של התא. |
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה. |
suggestedTableCellStyleChanges |
השינויים המוצעים בסגנון של תא הטבלה, לפי מזהה ההצעה. |
TableCellStyle
הסגנון של TableCell
.
סגנונות תאים בטבלה שעברו בירושה מיוצגים כשדות לא מוגדרים בהודעה הזו. סגנון של תא בטבלה יכול לרשת את הסגנון של הטבלה.
ייצוג JSON |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
שדות | |
---|---|
rowSpan |
טווח השורה של התא. הנכס הזה הוא לקריאה בלבד. |
columnSpan |
היקף העמודות של התא. הנכס הזה הוא לקריאה בלבד. |
backgroundColor |
צבע הרקע של התא. |
borderLeft |
הגבול השמאלי של התא. |
borderRight |
הגבול הימני של התא. |
borderTop |
הגבול העליון של התא. |
borderBottom |
הגבול התחתון של התא. |
paddingLeft |
המרווח הפנימי השמאלי של התא. |
paddingRight |
המרווח הפנימי הימני של התא. |
paddingTop |
המרווח הפנימי העליון של התא. |
paddingBottom |
הריווח התחתון של התא. |
contentAlignment |
היישור של התוכן בתא הטבלה. יישור ברירת המחדל תואם ליישור של תאים חדשים בטבלה שנוצרו בעורך Docs. |
TableCellBorder
גבול סביב תא בטבלה.
גבולות התאים בטבלה לא יכולים להיות שקופים. כדי להסתיר את גבול התא בטבלה, צריך להגדיר את הרוחב שלו כ-0.
ייצוג ב-JSON |
---|
{ "color": { object ( |
שדות | |
---|---|
color |
צבע הגבול. הצבע הזה לא יכול להיות שקוף. |
width |
רוחב הגבול. |
dashStyle |
סגנון המקף של הגבול. |
ContentAlignment
סוגי ההתאמה של התוכן.
נגזר מקבוצת משנה של הערכים של הסוג הפשוט ST_TextAnchoringType בקטע 20.1.10.59 במאמר 'פורמטים של קובצי Office Open XML – עקרונות בסיסיים ומסמך עזר לשפת ה-Markup', חלק 1 של ECMA-376 מהדורה רביעית.
טיפוסים בני מנייה (enum) | |
---|---|
CONTENT_ALIGNMENT_UNSPECIFIED |
התאמת תוכן שלא צוינה. התאמת התוכן עוברת בירושה מתבנית ההורה, אם יש כזו. |
CONTENT_ALIGNMENT_UNSUPPORTED |
יישור תוכן שלא נתמך. |
TOP |
התאמה שממקמת את התוכן בחלק העליון של מיקום התוכן. תואם ל-ECMA-376 ST_TextAnchoringType 't'. |
MIDDLE |
יישור שמיישר את התוכן לאמצע התוכן. תואם ל-ECMA-376 ST_TextTextingType 'ctr'. |
BOTTOM |
יישור שמיישר את התוכן לתחתית של בעלי התוכן. תואם ל-ECMA-376 ST_TextAnchoringType 'b'. |
SuggestedTableCellStyle
הצעה לשינוי ל-TableCellStyle
.
ייצוג JSON |
---|
{ "tableCellStyle": { object ( |
שדות | |
---|---|
tableCellStyle |
|
tableCellStyleSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
TableCellStyleSuggestionState
מסכה שמציינת אילו מהשדות בבסיס TableCellStyle
השתנו בהצעה הזו. לכל שדה שמוגדר כ-true יש הצעה לערך חדש.
ייצוג JSON |
---|
{ "rowSpanSuggested": boolean, "columnSpanSuggested": boolean, "backgroundColorSuggested": boolean, "borderLeftSuggested": boolean, "borderRightSuggested": boolean, "borderTopSuggested": boolean, "borderBottomSuggested": boolean, "paddingLeftSuggested": boolean, "paddingRightSuggested": boolean, "paddingTopSuggested": boolean, "paddingBottomSuggested": boolean, "contentAlignmentSuggested": boolean } |
שדות | |
---|---|
rowSpanSuggested |
שדה זה מציין אם הוצע שינוי ל- |
columnSpanSuggested |
מציין אם הייתה הצעה לשינוי ב- |
backgroundColorSuggested |
שדה זה מציין אם הוצע שינוי ל- |
borderLeftSuggested |
מציין אם הייתה הצעה לשינוי ב- |
borderRightSuggested |
מציין אם הייתה הצעה לשינוי ב- |
borderTopSuggested |
מציין אם הייתה הצעה לשינוי ב- |
borderBottomSuggested |
מציין אם הייתה הצעה לשינוי ב- |
paddingLeftSuggested |
שדה זה מציין אם הוצע שינוי ל- |
paddingRightSuggested |
מציין אם הייתה הצעה לשינוי ב- |
paddingTopSuggested |
שדה זה מציין אם הוצע שינוי ל- |
paddingBottomSuggested |
שדה זה מציין אם הוצע שינוי ל- |
contentAlignmentSuggested |
מציין אם הייתה הצעה לשינוי ב- |
TableRowStyle
סגנונות שחלים על שורה בטבלה.
ייצוג ב-JSON |
---|
{
"minRowHeight": {
object ( |
שדות | |
---|---|
minRowHeight |
הגובה המינימלי של השורה. השורה תומרן בעורך של Docs בגובה שווה לערך הזה או גבוה ממנו, כדי להציג את כל התוכן בתאים של השורה. |
tableHeader |
האם השורה היא כותרת של טבלה. |
preventOverflow |
אם השורה לא יכולה לגלוש מעבר לגבולות הדף או העמודה. |
SuggestedTableRowStyle
הצעה לשינוי ב-TableRowStyle
.
ייצוג ב-JSON |
---|
{ "tableRowStyle": { object ( |
שדות | |
---|---|
tableRowStyle |
קובץ |
tableRowStyleSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
TableRowStyleSuggestionState
מסכה שמציינת אילו מהשדות בבסיס TableRowStyle
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "minRowHeightSuggested": boolean } |
שדות | |
---|---|
minRowHeightSuggested |
מציין אם הייתה הצעה לשינוי ב- |
TableStyle
סגנונות שחלים על טבלה.
ייצוג JSON |
---|
{
"tableColumnProperties": [
{
object ( |
שדות | |
---|---|
tableColumnProperties[] |
המאפיינים של כל עמודה. שימו לב שב-Docs, טבלאות מכילות שורות ושורות מכילות תאים, בדומה ל-HTML. לכן, המאפיינים של שורה נמצאים ב- |
TableColumnProperties
המאפיינים של עמודה בטבלה.
ייצוג ב-JSON |
---|
{ "widthType": enum ( |
שדות | |
---|---|
widthType |
סוג רוחב העמודה. |
width |
רוחב העמודה. מגדירים מתי הערך של |
WidthType
סוג רוחב העמודה.
טיפוסים בני מנייה (enum) | |
---|---|
WIDTH_TYPE_UNSPECIFIED |
סוג הרוחב של העמודה לא צוין. |
EVENLY_DISTRIBUTED |
רוחב העמודה מחולק באופן שווה בין העמודות האחרות המפוזרות באופן שווה. רוחב העמודה נקבע באופן אוטומטי, וחלק מהרוחב שנותר לטבלה יהיה שווה, אחרי התייחסות לכל העמודות במידות הרוחב שצוינו. |
FIXED_WIDTH |
רוחב עמודה קבוע. המאפיין [width][google.apps.docs.v1.TableColumnProperties.width מכיל את רוחב העמודה. |
TableOfContents
StructuralElement
שמייצג תוכן עניינים.
ייצוג JSON |
---|
{
"content": [
{
object ( |
שדות | |
---|---|
content[] |
התוכן של תוכן העניינים. |
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקה של התוכן. |
שם
כותרת של מסמך.
ייצוג JSON |
---|
{
"headerId": string,
"content": [
{
object ( |
שדות | |
---|---|
headerId |
המזהה של הכותרת. |
content[] |
תוכן הכותרת. האינדקסים של תוכן הכותרת מתחילים באפס. |
הערת שוליים
הערת שוליים של מסמך.
ייצוג ב-JSON |
---|
{
"footnoteId": string,
"content": [
{
object ( |
שדות | |
---|---|
footnoteId |
המזהה של הערת השוליים. |
content[] |
התוכן של הערת השוליים. האינדקסים של תוכן הערת השוליים מתחילים באפס. |
DocumentStyle
סגנון המסמך.
ייצוג JSON |
---|
{ "background": { object ( |
שדות | |
---|---|
background |
הרקע של המסמך. לא ניתן להשתמש בצבע רקע שקוף במסמכים. |
defaultHeaderId |
המזהה של כותרת ברירת המחדל. אם המדיניות לא מוגדרת, אין כותרת ברירת מחדל. הנכס הזה הוא לקריאה בלבד. |
defaultFooterId |
המזהה של הכותרת התחתונה המוגדרת כברירת המחדל. אם המדיניות לא מוגדרת, אין כותרת תחתונה שתשמש כברירת מחדל. הנכס הזה הוא לקריאה בלבד. |
evenPageHeaderId |
המזהה של הכותרת העליונה שמשמש רק בדפים זוגיים. הערך של הנכס הזה הוא לקריאה בלבד. |
evenPageFooterId |
המזהה של הכותרת התחתונה משמש רק לדפים זוגיים. הערך של הנכס הזה הוא לקריאה בלבד. |
firstPageHeaderId |
המזהה של הכותרת שמשמש רק לדף הראשון. אם לא תגדירו את השדה, לא תהיה כותרת ייחודית לדף הראשון. הערך של הנכס הזה הוא לקריאה בלבד. |
firstPageFooterId |
המזהה של הכותרת התחתונה המשמש רק לדף הראשון. אם המדיניות לא מוגדרת, לא קיימת כותרת תחתונה ייחודית לדף הראשון. הערך של הנכס הזה הוא לקריאה בלבד. |
useFirstPageHeaderFooter |
מציין אם להשתמש במזהי הכותרת העליונה או התחתונה של הדף הראשון בדף הראשון. |
useEvenPageHeaderFooter |
מציין אם להשתמש במזהים של כותרות / תחתונות בדפים זוגיים. |
pageNumberStart |
מספר הדף שממנו יש להתחיל בספירת הדפים. |
marginTop |
השוליים העליונים של הדף. עדכון שולי הדף העליונים בסגנון המסמך גורם למחיקת שולי הדף העליונים בכל סגנונות הקטע. |
marginBottom |
השוליים התחתונים של הדף. עדכון השוליים התחתוניים של סגנון המסמך מנקה את השוליים התחתונים של הדף בכל סגנונות הקטעים. |
marginRight |
שולי הדף הימני. עדכון השוליים השמאליים בסגנון המסמך מנקה את השוליים הימניים בכל סגנונות הקטעים. היא עלולה גם לגרום לשינוי גודל של עמודות בכל הקטעים. |
marginLeft |
השוליים השמאליים של הדף. עדכון השוליים השמאליים בסגנון המסמך מנקה את השוליים השמאליים של כל סגנונות הקטעים. היא עלולה גם לגרום לשינוי גודל של עמודות בכל הקטעים. |
pageSize |
גודל הדף במסמך. |
marginHeader |
הרווח בין החלק העליון של הדף לתוכן של הכותרת. |
marginFooter |
הרווח בין החלק התחתון של הדף לתוכן של הכותרת התחתונה. |
useCustomHeaderFooterMargins |
מציין אם נעשה שימוש ב-DocumentStyle הנכס הזה הוא לקריאה בלבד. |
flipPageOrientation |
זה שינוי אופציונלי. האפשרות הזו קובעת אם להפוך את המימדים של |
רקע
מייצג את הרקע של מסמך.
ייצוג JSON |
---|
{
"color": {
object ( |
שדות | |
---|---|
color |
צבע הרקע. |
גודל
רוחב וגובה.
ייצוג JSON |
---|
{ "height": { object ( |
שדות | |
---|---|
height |
גובה האובייקט. |
width |
רוחב האובייקט. |
SuggestedDocumentStyle
הצעה לשינוי ב-DocumentStyle
.
ייצוג ב-JSON |
---|
{ "documentStyle": { object ( |
שדות | |
---|---|
documentStyle |
|
documentStyleSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
DocumentStyleSuggestionState
מסכה שמציינת אילו מהשדות בבסיס DocumentStyle
השתנו בהצעה הזו. לכל שדה שמוגדר כ-true יש הצעה לערך חדש.
ייצוג JSON |
---|
{ "backgroundSuggestionState": { object ( |
שדות | |
---|---|
backgroundSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
defaultHeaderIdSuggested |
מציין אם הייתה הצעה לשינוי ב- |
defaultFooterIdSuggested |
מציין אם הייתה הצעה לשינוי ב- |
evenPageHeaderIdSuggested |
שדה זה מציין אם הוצע שינוי ל- |
evenPageFooterIdSuggested |
שדה זה מציין אם הוצע שינוי ל- |
firstPageHeaderIdSuggested |
שדה זה מציין אם הוצע שינוי ל- |
firstPageFooterIdSuggested |
שדה זה מציין אם הוצע שינוי ל- |
useFirstPageHeaderFooterSuggested |
מציין אם הייתה הצעה לשינוי ב- |
useEvenPageHeaderFooterSuggested |
שדה זה מציין אם הוצע שינוי ל- |
pageNumberStartSuggested |
שדה זה מציין אם הוצע שינוי ל- |
marginTopSuggested |
מציין אם הייתה הצעה לשינוי ב- |
marginBottomSuggested |
מציין אם הייתה הצעה לשינוי ב- |
marginRightSuggested |
מציין אם הייתה הצעה לשינוי ב- |
marginLeftSuggested |
שדה זה מציין אם הוצע שינוי ל- |
pageSizeSuggestionState |
מסכה שמציינת אילו מהשדות ב-[size] [google.apps.docs.v1.DocumentStyle.size] השתנו בהצעה הזו. |
marginHeaderSuggested |
שדה זה מציין אם הוצע שינוי ל- |
marginFooterSuggested |
מציין אם הייתה הצעה לשינוי ב- |
useCustomHeaderFooterMarginsSuggested |
שדה זה מציין אם הוצע שינוי ל- |
flipPageOrientationSuggested |
זה שינוי אופציונלי. שדה זה מציין אם הוצע שינוי ל- |
BackgroundSuggestionState
מסכה שמציינת אילו מהשדות בבסיס Background
השתנו בהצעה הזו. לכל שדה שהוגדר כ-true, ל-Backgound
יש הצעה לערך חדש.
ייצוג ב-JSON |
---|
{ "backgroundColorSuggested": boolean } |
שדות | |
---|---|
backgroundColorSuggested |
מציין אם צבע הרקע הנוכחי השתנה בהצעה הזו. |
SizeSuggestionState
מסכה שמציינת אילו מהשדות בבסיס Size
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True, יש ל-Size
ערך מוצע חדש.
ייצוג JSON |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
שדות | |
---|---|
heightSuggested |
שדה זה מציין אם הוצע שינוי ל- |
widthSuggested |
שדה זה מציין אם הוצע שינוי ל- |
NamedStyles
הסגנונות עם השמות. פסקאות במסמך יכולות לרשת את הTextStyle
והParagraphStyle
שלהן מהסגנונות האלה עם השמות.
ייצוג JSON |
---|
{
"styles": [
{
object ( |
שדות | |
---|---|
styles[] |
הסגנונות עם השמות. יש רשומה לכל אחת מהאפשרויות של |
NamedStyle
סגנון בעל שם. אם לקטעים במסמך יש את אותו סוג של סגנון בעל שם, הם יכולים לרשת את הערכים של TextStyle
ו-ParagraphStyle
מהסגנון הזה.
ייצוג JSON |
---|
{ "namedStyleType": enum ( |
שדות | |
---|---|
namedStyleType |
הסוג של הסגנון בעל השם. |
textStyle |
סגנון הטקסט של הסגנון המוגדר. |
paragraphStyle |
סגנון הפסקה של הסגנון הזה. |
SuggestedNamedStyles
הצעה לשינוי ב-NamedStyles
.
ייצוג JSON |
---|
{ "namedStyles": { object ( |
שדות | |
---|---|
namedStyles |
|
namedStylesSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
NamedStylesSuggestionState
סטטוס ההצעה של הודעת NamedStyles
.
ייצוג JSON |
---|
{
"stylesSuggestionStates": [
{
object ( |
שדות | |
---|---|
stylesSuggestionStates[] |
מסכה שמציינת אילו מהשדות ב- הסדר של מצבי ההצעה לסגנון בעל שם תואם לסדר של הסגנון בעל השם התואם בהצעה |
NamedStyleSuggestionState
מצב ההצעה של הודעת NamedStyle
.
ייצוג ב-JSON |
---|
{ "namedStyleType": enum ( |
שדות | |
---|---|
namedStyleType |
סוג הסגנון בעל השם שמצב ההצעה הזה תואם לו. השדה הזה זמין לנוחותך כדי להתאים בין NamedStyleSuggestionState לבין |
textStyleSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
paragraphStyleSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
רשימה
הרכיב List מייצג את מאפייני הרשימה של קבוצת פסקאות שכולן שייכות לאותה רשימה. בפסקה שמופיעה ברשימה יש הפניה למזהה הרשימה ב-bullet
.
ייצוג ב-JSON |
---|
{ "listProperties": { object ( |
שדות | |
---|---|
listProperties |
המאפיינים של הרשימה. |
suggestedListPropertiesChanges |
ההצעות לשינויים במאפייני הרשימה, עם המפתחות לפי מזהה ההצעה. |
suggestedInsertionId |
מזהה ההכנסה המוצע. אם השדה ריק, לא ניתן להשתמש בהצעה להזנה. |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם הרשימה ריקה, אין הצעות למחיקות מהרשימה הזו. |
ListProperties
המאפיינים של list
שמתארים את המראה והתחושה של תבליטים ששייכים לפסקאות שמשויכות לרשימה.
ייצוג JSON |
---|
{
"nestingLevels": [
{
object ( |
שדות | |
---|---|
nestingLevels[] |
תיאור המאפיינים של התבליטים ברמה המשויכת. רשימה כוללת 9 רמות של קינון לכל היותר. רמת הסידור הפנימי 0 שתואמת לרמה העליונה ביותר ורמת הסידור הפנימי 8 המתאימה ביותר לרמה המקוננת ביותר. רמות ההטמעה מוחזרות בסדר עולה, והרמה עם הכי פחות הטמעות מוחזרת קודם. |
NestingLevel
מכיל מאפיינים שמתארים את המראה והתחושה של פסיק ברשימה ברמת עיטוף נתונה.
ייצוג ב-JSON |
---|
{ "bulletAlignment": enum ( |
שדות | |
---|---|
bulletAlignment |
היישור של התג בתוך המרחב שהוקצה לצורך רינדור התג. |
glyphFormat |
מחרוזת הפורמט שבה נעשה שימוש בתבליטים ברמה הזו של עיטוף. פורמט הגליף מכיל placeholder אחד או יותר, וה-placeholders האלה מוחלפים בערכים המתאימים בהתאם ל- לדוגמה, פורמט הגליף
פורמט הגליף יכול להכיל placeholders לרמת הסידור הנוכחי וגם placeholders לרמות הקינון ברמת ההורה. לדוגמה, רשימה יכולה להיות בפורמט glyp של
ברמות סידור פנימי, המחרוזת שמחליפה placeholder בפורמט גליף בפסקה מסוימת תלויה בסדר הפסקה ברשימה. |
indentFirstLine |
כמות כניסת הפיסקה בשורה הראשונה של פסקאות ברמת הקינון הזו. |
indentStart |
עומק ההכנסה של הפסקה ברמת ההטמעה הזו. מוחל בצד שמתאים לתחילת הטקסט, על סמך כיוון התוכן של הפסקה. |
textStyle |
סגנון הטקסט של תבליטים ברמת קינון זו. |
startNumber |
המספר של פריט הרשימה הראשון ברמת ההטמעה הזו. המערכת מתייחסת לערך 0 כערך של 1 לרשימות עם אותיות ולרשימות של ספרות רומיות. לערכים של 0 וגם 1, רשימות ספרות עם אותיות וספרות רומיות יתחילו ב- רמות בתוך ערכים עם גליפים לא מסודרים לא נלקחות בחשבון בערך הזה. |
שדה האיחוד glyph_kind . סוג הגליף שמשמש את הנקודות. ההגדרה הזו מגדירה את הגליף של התבליט שמחליף את מצייני ה-placeholder ב-glyph_format . הערך של glyph_kind יכול להיות רק אחת מהאפשרויות הבאות: |
|
glyphType |
סוג הגליף שבו נעשה שימוש בתבליטים כשפסקאות ברמת ההטמעה הזו מסודרות. סוג הגליף קובע את סוג הגליף שישמש להחלפת placeholders בתוך |
glyphSymbol |
סמל גליפ מותאם אישית שמשמש את הנקודות כשהפסקאות ברמת ההטמעה הזו לא מסודרות. סמל הגליף מחליף את placeholders בתוך |
BulletAlignment
סוגי היישור של תבליט.
טיפוסים בני מנייה (enum) | |
---|---|
BULLET_ALIGNMENT_UNSPECIFIED |
לא צוין יישור של הנקודות. |
START |
התבליט מיושר לתחילת השטח שהוקצה לעיבוד התבליט. יישור לשמאל לטקסט LTR, אחרת מיושר לימין. |
CENTER |
התבליט מיושר למרכז השטח שהוקצה לעיבוד התבליט. |
END |
התבליט מיושר לסוף השטח שהוקצה לעיבוד התבליט. יישור לימין לטקסט LTR, אחרת מיושר לשמאל. |
GlyphType
סוגי הגליפים שבהם משתמשים תבליטים כאשר פסקאות ברמת קינון זו מסודרות בצורה כזו.
טיפוסים בני מנייה (enum) | |
---|---|
GLYPH_TYPE_UNSPECIFIED |
סוג הגליף לא צוין או שאין בו תמיכה. |
NONE |
מחרוזת ריקה. |
DECIMAL |
מספר, למשל 1 , 2 או 3 . |
ZERO_DECIMAL |
מספר שבו ספרות בודדות מתחילות באפס, כמו 01 , 02 או 03 . מספרים עם יותר מספרה אחת לא מתחילים בספרה אפס. |
UPPER_ALPHA |
אות גדולה, כמו A , B או C . |
ALPHA |
אות קטנה, כמו a , b או c . |
UPPER_ROMAN |
ספרה רומית באותיות גדולות, כמו I , II או III . |
ROMAN |
ספרה רומית קטנה, כמו i , ii או iii . |
SuggestedListProperties
הצעה לשינוי ב-ListProperties
.
ייצוג JSON |
---|
{ "listProperties": { object ( |
שדות | |
---|---|
listProperties |
|
listPropertiesSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
ListPropertiesSuggestionState
מסכה שמציינת אילו מהשדות בבסיס ListProperties
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{
"nestingLevelsSuggestionStates": [
{
object ( |
שדות | |
---|---|
nestingLevelsSuggestionStates[] |
מסכה שמציינת אילו מהשדות ב- מצבי ההצעה של רמת הסידור הפנימי מוחזרים בסדר עולה של רמת הסידור הפנימי, והרמה הנמוכה ביותר מוחזרת קודם. |
NestingLevelSuggestionState
מסכה שמציינת אילו מהשדות בבסיס NestingLevel
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{
"bulletAlignmentSuggested": boolean,
"glyphTypeSuggested": boolean,
"glyphFormatSuggested": boolean,
"glyphSymbolSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"textStyleSuggestionState": {
object ( |
שדות | |
---|---|
bulletAlignmentSuggested |
שדה זה מציין אם הוצע שינוי ל- |
glyphTypeSuggested |
שדה זה מציין אם הוצע שינוי ל- |
glyphFormatSuggested |
שדה זה מציין אם הוצע שינוי ל- |
glyphSymbolSuggested |
שדה זה מציין אם הוצע שינוי ל- |
indentFirstLineSuggested |
שדה זה מציין אם הוצע שינוי ל- |
indentStartSuggested |
שדה זה מציין אם הוצע שינוי ל- |
textStyleSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
startNumberSuggested |
שדה זה מציין אם הוצע שינוי ל- |
NamedRanges
אוסף של כל ה-NamedRange
במסמך שיש להם שם זהה.
ייצוג ב-JSON |
---|
{
"name": string,
"namedRanges": [
{
object ( |
שדות | |
---|---|
name |
השם הזה משותף לכל |
namedRanges[] |
פריטי |
NamedRange
אוסף של Range
עם אותו מזהה של טווח תאים בעל שם.
טווחי תאים בעלי שם מאפשרים למפתחים לשייך חלקים ממסמך לתווית שרירותית שהוגדרה על ידי המשתמש, כדי שניתן יהיה לקרוא או לערוך את התוכן שלהם באופן פרוגרמטי מאוחר יותר. מסמך יכול להכיל כמה טווחי תאים בעלי שם זהה, אבל לכל טווח בעל שם יש מזהה ייחודי.
טווח תאים בעל שם נוצר באמצעות פונקציית Range
אחת, ובדרך כלל התוכן שמוסיפים לטווח תאים בעל שם מרחיב את הטווח הזה. עם זאת, שינויים מסוימים במסמך עלולים לגרום לפיצול הטווח למספר טווחים.
טווחי תאים בעלי שם אינם פרטיים. כל האפליקציות ושותפי העריכה שיש להם גישה למסמך יכולים לראות את טווחי השמות שלו.
ייצוג ב-JSON |
---|
{
"namedRangeId": string,
"name": string,
"ranges": [
{
object ( |
שדות | |
---|---|
namedRangeId |
המזהה של טווח התאים בעל השם. |
name |
השם של טווח התאים בעל השם. |
ranges[] |
הטווחים ששייכים לטווח בעל השם הזה. |
טווח
מציינת טווח מתמשך של טקסט.
ייצוג JSON |
---|
{ "segmentId": string, "startIndex": integer, "endIndex": integer, "tabId": string } |
שדות | |
---|---|
segmentId |
המזהה של הכותרת העליונה, הכותרת התחתונה או הערת השוליים שהטווח הזה נכלל בהם. מזהה מקטע ריק מציין את גוף המסמך. |
startIndex |
אינדקס ההתחלה של הטווח הזה, שמתחיל באפס, ביחידות קוד UTF-16. עבור כל השימושים הנוכחיים, יש לספק אינדקס התחלה. השדה הזה הוא Int32Value כדי להתאים לתרחישים לדוגמה עתידיים עם טווחים פתוחים. |
endIndex |
אינדקס הסיום של הטווח הזה, שמתחיל באפס, לא כולל, ביחידות קוד UTF-16. בכל השימושים הנוכחיים, צריך לספק אינדקס סופי. השדה הזה הוא Int32Value כדי להתאים לתרחישי שימוש עתידיים עם טווחים פתוחים. |
tabId |
הכרטיסייה שמכילה את הטווח הזה. אם השדה הזה לא יצוין, הבקשה תחול על הכרטיסייה הראשונה. במסמך שמכיל כרטיסייה אחת:
במסמך שמכיל כמה כרטיסיות:
|
InlineObject
אובייקט שמופיע בתוך השורה עם טקסט. InlineObject מכיל EmbeddedObject
כמו תמונה.
ייצוג ב-JSON |
---|
{ "objectId": string, "inlineObjectProperties": { object ( |
שדות | |
---|---|
objectId |
המזהה של האובייקט הזה בשורה. אפשר להשתמש בה כדי לעדכן מאפיינים של אובייקט. |
inlineObjectProperties |
המאפיינים של האובייקט המוטבע הזה. |
suggestedInlineObjectPropertiesChanges |
השינויים המוצעים במאפייני האובייקט בשורה, לפי מפתח של מזהה ההצעה. |
suggestedInsertionId |
מזהה ההכנסה המוצע. אם השדה ריק, לא ניתן להשתמש בהצעה להזנה. |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקה של התוכן. |
InlineObjectProperties
המאפיינים של InlineObject
.
ייצוג JSON |
---|
{
"embeddedObject": {
object ( |
שדות | |
---|---|
embeddedObject |
האובייקט המוטמע של האובייקט המוטבע הזה. |
EmbeddedObject
אובייקט מוטמע במסמך.
ייצוג JSON |
---|
{ "title": string, "description": string, "embeddedObjectBorder": { object ( |
שדות | |
---|---|
title |
שם האובייקט המוטמע. גם |
description |
תיאור האובייקט המוטמע. ה- |
embeddedObjectBorder |
הגבול של האובייקט המוטמע. |
size |
הגודל הגלוי של התמונה לאחר החיתוך. |
marginTop |
השוליים העליונים של האובייקט המוטמע. |
marginBottom |
השוליים התחתוניים של האובייקט המוטמע. |
marginRight |
השוליים הימניים של האובייקט המוטמע. |
marginLeft |
השוליים השמאליים של האובייקט המוטמע. |
linkedContentReference |
הפניה לתוכן המקור המקושר החיצוני. לדוגמה, היא מכילה הפניה לתרשים המקור ב-Google Sheets כשהאובייקט המוטמע הוא תרשים מקושר. אם השדה לא מוגדר, האובייקט המוטמע לא מקושר. |
שדה איחוד properties . המאפיינים שספציפיים לכל סוג של אובייקט מוטמע. הערך של properties יכול להיות רק אחת מהאפשרויות הבאות: |
|
embeddedDrawingProperties |
המאפיינים של שרטוט מוטמע. |
imageProperties |
המאפיינים של תמונה. |
EmbeddedDrawingProperties
אין שדות בסוג הזה.
המאפיינים של שרטוט מוטמע ומשמשים להבחנה בין סוג האובייקט. שרטוט מוטמע הוא שרטוט שנוצר וערוך בתוך מסמך. לתשומת ליבכם: אין תמיכה בפרטים מקיפים.
ImageProperties
המאפיינים של תמונה.
ייצוג ב-JSON |
---|
{
"contentUri": string,
"sourceUri": string,
"brightness": number,
"contrast": number,
"transparency": number,
"cropProperties": {
object ( |
שדות | |
---|---|
contentUri |
URI של התמונה עם משך חיים של 30 דקות כברירת מחדל. ה-URI הזה מתויג עם החשבון של מבקש הגישה. כל מי שיש לו את ה-URI יכול לגשת לתמונה כאילו הוא מבצע את הבקשה המקורית. אם הגדרות השיתוף של המסמך ישתנו, ייתכן שהגישה לתמונה תאבד. |
sourceUri |
ה-URI של המקור הוא ה-URI המשמש להוספת התמונה. ה-URI של המקור יכול להיות ריק. |
brightness |
אפקט הבהירות של התמונה. הערך צריך להיות במרווח הזמן [-1.0, 1.0], כאשר 0 פירושו שאין השפעה. |
contrast |
אפקט הניגודיות של התמונה. הערך צריך להיות בטווח [-1.0, 1.0], כאשר 0 מציין שאין השפעה. |
transparency |
אפקט השקיפות של התמונה. הערך צריך להופיע במרווח הזמן [0.0, 1.0], שבו 0 פירושו שאין השפעה ו-1 פירושו שקיפות. |
cropProperties |
מאפייני החיתוך של התמונה. |
angle |
זווית הסיבוב בכיוון השעון של התמונה, ברדיאנים. |
CropProperties
מאפייני החיתוך של תמונה.
מלבן החיתוך מיוצג באמצעות קיזוזים שברים מ-4 הקצוות של התוכן המקורי.
- אם ההיסט הוא במרווחים (0, 1), הקצה המתאים של מלבן החיתוך ימוקם בתוך המלבן התוחם המקורי של התמונה.
- אם ההיסט הוא שלילי או גדול מ-1, הקצה המתאים של מלבן החיתוך ימוקם מחוץ למלבן הגבולות המקורי של התמונה.
- אם כל ההיסטים וזווית הסיבוב הם 0, התמונה לא תיחתך.
ייצוג ב-JSON |
---|
{ "offsetLeft": number, "offsetRight": number, "offsetTop": number, "offsetBottom": number, "angle": number } |
שדות | |
---|---|
offsetLeft |
ההיסט מציין את המרחק פנימה של הקצה הימני של מלבן החיתוך מהקצה הימני של התוכן המקורי, כחלק מרוחב התוכן המקורי. |
offsetRight |
ההיסט מציין את המרחק פנימה של הקצה הימני של מלבן החיתוך מהקצה הימני של התוכן המקורי, כחלק מרוחב התוכן המקורי. |
offsetTop |
ההיסט מציין את המרחק מהקצה העליון של מלבן החיתוך מהקצה העליון של התוכן המקורי, כחלק מגובה התוכן המקורי. |
offsetBottom |
ההיסט מציין את המרחק פנימה של הקצה התחתון של מלבן החיתוך מהקצה התחתון של התוכן המקורי, כחלק מגובה התוכן המקורי. |
angle |
הזווית של הסיבוב בכיוון השעון של מלבן החיתוך סביב המרכז, ברדיאנים. הסיבוב מופעל אחרי ההיסט. |
EmbeddedObjectBorder
גבול סביב EmbeddedObject
.
ייצוג JSON |
---|
{ "color": { object ( |
שדות | |
---|---|
color |
צבע הגבול. |
width |
רוחב הגבול. |
dashStyle |
סגנון המקף של הגבול. |
propertyState |
מצב המאפיין של מאפיין הגבול. |
PropertyState
המצבים האפשריים של נכס.
טיפוסים בני מנייה (enum) | |
---|---|
RENDERED |
אם מצב הנכס הוא RENDERED, אז לרכיב יש את המאפיין התואם בזמן העיבוד במסמך. זהו ערך ברירת המחדל. |
NOT_RENDERED |
אם המצב של מאפיין הוא NOT_RENDERED, לרכיב לא יהיה את המאפיין התואם כשהוא יוצג במסמך. |
LinkedContentReference
הפניה לתוכן המקור המקושר החיצוני.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד reference . ההפניה הספציפית לסוג התוכן המקושר. הערך של reference יכול להיות רק אחת מהאפשרויות הבאות: |
|
sheetsChartReference |
הפניה לתרשים המקושר. |
SheetsChartReference
הפניה לתרשים מקושר שמוטמע מ-Google Sheets.
ייצוג JSON |
---|
{ "spreadsheetId": string, "chartId": integer } |
שדות | |
---|---|
spreadsheetId |
המזהה של הגיליון האלקטרוני ב-Google Sheets שמכיל את תרשים המקור. |
chartId |
המזהה של התרשים הספציפי בגיליון האלקטרוני של Google Sheets שמוטמע. |
SuggestedInlineObjectProperties
הצעה לשינוי ב-InlineObjectProperties
.
ייצוג JSON |
---|
{ "inlineObjectProperties": { object ( |
שדות | |
---|---|
inlineObjectProperties |
|
inlineObjectPropertiesSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
InlineObjectPropertiesSuggestionState
מסכה שמציינת אילו מהשדות בבסיס InlineObjectProperties
השתנו בהצעה הזו. לכל שדה שמוגדר כ-true יש הצעה לערך חדש.
ייצוג JSON |
---|
{
"embeddedObjectSuggestionState": {
object ( |
שדות | |
---|---|
embeddedObjectSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
EmbeddedObjectSuggestionState
מסכה שמציינת אילו מהשדות בבסיס EmbeddedObject
השתנו בהצעה הזו. לכל שדה שמוגדר כ-true יש הצעה לערך חדש.
ייצוג JSON |
---|
{ "embeddedDrawingPropertiesSuggestionState": { object ( |
שדות | |
---|---|
embeddedDrawingPropertiesSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
imagePropertiesSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
titleSuggested |
שדה זה מציין אם הוצע שינוי ל- |
descriptionSuggested |
מציין אם הייתה הצעה לשינוי ב- |
embeddedObjectBorderSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
sizeSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
marginLeftSuggested |
מציין אם הייתה הצעה לשינוי ב- |
marginRightSuggested |
מציין אם הייתה הצעה לשינוי ב- |
marginTopSuggested |
שדה זה מציין אם הוצע שינוי ל- |
marginBottomSuggested |
מציין אם הייתה הצעה לשינוי ב- |
linkedContentReferenceSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
EmbeddedDrawingPropertiesSuggestionState
אין שדות בסוג הזה.
מסכה שמציינת אילו מהשדות בבסיס EmbeddedDrawingProperties
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ImagePropertiesSuggestionState
מסכה שמציינת אילו מהשדות בבסיס ImageProperties
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{
"contentUriSuggested": boolean,
"sourceUriSuggested": boolean,
"brightnessSuggested": boolean,
"contrastSuggested": boolean,
"transparencySuggested": boolean,
"cropPropertiesSuggestionState": {
object ( |
שדות | |
---|---|
contentUriSuggested |
שדה זה מציין אם הוצע שינוי ל- |
sourceUriSuggested |
שדה זה מציין אם הייתה הצעה לשינוי ל-[sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri]. |
brightnessSuggested |
מציין אם הייתה הצעה לשינוי של [brightness] [google.apps.docs.v1.EmbeddedObject.brightness]. |
contrastSuggested |
שדה זה מציין אם היה הצעה לשינוי של [ניגודיות] [google.apps.docs.v1.EmbeddedObject.contrast]. |
transparencySuggested |
מציין אם הייתה הצעה לשינוי של [transparency] [google.apps.docs.v1.EmbeddedObject.transparency]. |
cropPropertiesSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
angleSuggested |
שדה זה מציין אם היה שינוי מוצע ל-[angle] [google.apps.docs.v1.EmbeddedObject.angle]. |
CropPropertiesSuggestionState
מסכה שמציינת אילו מהשדות בבסיס CropProperties
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "offsetLeftSuggested": boolean, "offsetRightSuggested": boolean, "offsetTopSuggested": boolean, "offsetBottomSuggested": boolean, "angleSuggested": boolean } |
שדות | |
---|---|
offsetLeftSuggested |
שדה זה מציין אם הוצע שינוי ל- |
offsetRightSuggested |
מציין אם הייתה הצעה לשינוי ב- |
offsetTopSuggested |
מציין אם הייתה הצעה לשינוי ב- |
offsetBottomSuggested |
שדה זה מציין אם הוצע שינוי ל- |
angleSuggested |
שדה זה מציין אם הוצע שינוי ל- |
EmbeddedObjectBorderSuggestionState
מסכה שמציינת אילו מהשדות בבסיס EmbeddedObjectBorder
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "colorSuggested": boolean, "widthSuggested": boolean, "dashStyleSuggested": boolean, "propertyStateSuggested": boolean } |
שדות | |
---|---|
colorSuggested |
שדה זה מציין אם הייתה הצעה לשינוי ב-[color] [google.apps.docs.v1.EmbeddedBorderObject.color]. |
widthSuggested |
שדה זה מציין אם הוצע שינוי ב-[width] [google.apps.docs.v1.EmbeddedBorderObject.width]. |
dashStyleSuggested |
מציין אם הייתה הצעה לשינוי של [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style]. |
propertyStateSuggested |
שדה זה מציין אם היה הצעה לשינוי ב-[propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state]. |
LinkedContentReferenceSuggestionState
מסכה שמציינת אילו מהשדות בבסיס LinkedContentReference
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
שדות | |
---|---|
sheetsChartReferenceSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
SheetsChartReferenceSuggestionState
מסכה שמציינת אילו מהשדות בבסיס SheetsChartReference
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "spreadsheetIdSuggested": boolean, "chartIdSuggested": boolean } |
שדות | |
---|---|
spreadsheetIdSuggested |
שדה זה מציין אם הוצע שינוי ל- |
chartIdSuggested |
שדה זה מציין אם הוצע שינוי ל- |
PositionedObject
אובייקט שמקושר ל-Paragraph
וממוקם ביחס לתחילת הפסקה. אובייקט מיקום מכיל EmbeddedObject
, כמו תמונה.
ייצוג JSON |
---|
{ "objectId": string, "positionedObjectProperties": { object ( |
שדות | |
---|---|
objectId |
המזהה של האובייקט המוצב הזה. |
positionedObjectProperties |
המאפיינים של האובייקט המוצב הזה. |
suggestedPositionedObjectPropertiesChanges |
השינויים המוצעים במאפייני האובייקט הממוקם, לפי מפתח של מזהה ההצעה. |
suggestedInsertionId |
מזהה ההכנסה המוצע. אם השדה ריק, זו לא הצעה להוספה. |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקה של התוכן. |
PositionedObjectProperties
המאפיינים של PositionedObject
.
ייצוג JSON |
---|
{ "positioning": { object ( |
שדות | |
---|---|
positioning |
המיקום של האובייקט המוצב ביחס לשורה החדשה של |
embeddedObject |
האובייקט המוטמע של האובייקט המוצב הזה. |
PositionedObjectPositioning
המיקום של PositionedObject
. האובייקט הממוקם ממוקם ביחס לתחילת ה-Paragraph
שאליו הוא מקושר.
ייצוג JSON |
---|
{ "layout": enum ( |
שדות | |
---|---|
layout |
הפריסה של האובייקט המוצב הזה. |
leftOffset |
ההיסט של הקצה השמאלי של האובייקט הממוקם ביחס לתחילת ה- |
topOffset |
ההיסט של הקצה העליון של האובייקט המוצב ביחס לתחילת ה- |
PositionedObjectLayout
הפריסות האפשריות של [PositionedObject][google.aps.docs.v1.PositionedObject].
טיפוסים בני מנייה (enum) | |
---|---|
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED |
הפריסה לא צוינה. |
WRAP_TEXT |
הטקסט גולש מסביב לאובייקט שממוקם. |
BREAK_LEFT |
שבירת הטקסט היא שהאובייקט שממוקם בצד שמאל והטקסט בצד ימין. |
BREAK_RIGHT |
שבירת הטקסט היא שהאובייקט שממוקם בצד ימין והטקסט נמצא בצד שמאל. |
BREAK_LEFT_RIGHT |
שבירה את הטקסט כך שאין טקסט בצד שמאל או מימין לאובייקט שממוקם. |
IN_FRONT_OF_TEXT |
האובייקט הממוקם נמצא לפני הטקסט. |
BEHIND_TEXT |
האובייקט המוצב נמצא מאחורי הטקסט. |
SuggestedPositionedObjectProperties
הצעה לשינוי ב-PositionedObjectProperties
.
ייצוג ב-JSON |
---|
{ "positionedObjectProperties": { object ( |
שדות | |
---|---|
positionedObjectProperties |
|
positionedObjectPropertiesSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
PositionedObjectPropertiesSuggestionState
מסכה שמציינת אילו מהשדות בבסיס PositionedObjectProperties
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "positioningSuggestionState": { object ( |
שדות | |
---|---|
positioningSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
embeddedObjectSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
PositionedObjectPositioningSuggestionState
מסכה שמציינת אילו מהשדות בבסיס PositionedObjectPositioning
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "layoutSuggested": boolean, "leftOffsetSuggested": boolean, "topOffsetSuggested": boolean } |
שדות | |
---|---|
layoutSuggested |
שדה זה מציין אם הוצע שינוי ל- |
leftOffsetSuggested |
מציין אם הייתה הצעה לשינוי ב- |
topOffsetSuggested |
שדה זה מציין אם הוצע שינוי ל- |
SuggestionsViewMode
מצב תצוגת ההצעות שהוחל על המסמך מציין את האופן שבו מיוצגים שינויים מוצעים. הוא מספק אפשרויות לקריאת המסמך כאשר כל ההצעות מופיעות בתוך השורה, אישור או דחייה.
טיפוסים בני מנייה (enum) | |
---|---|
DEFAULT_FOR_CURRENT_ACCESS |
הערך SuggestedViewMode שהוחל על המסמך שמוחזר תלוי ברמת הגישה הנוכחית של המשתמש. אם למשתמש יש רק הרשאת צפייה, המערכת מחילה את PREVIEW_WITHOUT_SUGGESTIONS . אחרת, תופעל SUGGESTIONS_INLINE . זהו מצב התצוגה המוגדר כברירת מחדל של ההצעות. |
SUGGESTIONS_INLINE |
המסמך שמוחזר כולל הצעות בתוך השורה. הצעות לשינויים יהיו שונות מתוכן הבסיס במסמך. בקשות לאחזור מסמך באמצעות מצב זה יחזירו שגיאת 403 אם למשתמש אין הרשאה להציג את השינויים המוצעים. |
PREVIEW_SUGGESTIONS_ACCEPTED |
המסמך שמוחזר הוא תצוגה מקדימה עם כל ההצעות לשינויים שאושרו. בקשות לאחזור מסמך באמצעות מצב זה יחזירו שגיאת 403 אם למשתמש אין הרשאה להציג את השינויים המוצעים. |
PREVIEW_WITHOUT_SUGGESTIONS |
המסמך שיוחזר הוא תצוגה מקדימה שבה כל השינויים המוצעים נדחו, אם יש כאלה במסמך. |
שיטות |
|
---|---|
|
החלת עדכון אחד או יותר על המסמך. |
|
יצירת מסמך ריק לפי הכותרת שמופיעה בבקשה. |
|
קבלת הגרסה האחרונה של המסמך שצוין. |