REST Resource: documents

משאב: מסמך

מסמך ב-Google Docs.

ייצוג ב-JSON 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
שדות
documentId

string

פלט בלבד. המזהה של המסמך.
title

string

כותרת המסמך.
tabs[]

object (Tab)

כרטיסיות שהן חלק ממסמך.

כרטיסיות יכולות להכיל כרטיסיות צאצא, כרטיסייה שמוטמעת בכרטיסייה אחרת. כרטיסיות צאצא מיוצגות על ידי השדה Tab.childTabs.
revisionId

string

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

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

enum (SuggestionsViewMode)

פלט בלבד. מצב תצוגת ההצעות שהוחל על המסמך.

הערה: כשעורכים מסמך, השינויים חייבים להתבסס על מסמך עם SUGGESTIONS_INLINE.
body

object (Body)

פלט בלבד. גוף המסמך הראשי.

שדה מדור קודם: במקום זאת, משתמשים ב-Document.tabs.documentTab.body, שמציג את תוכן המסמך בפועל מכל הכרטיסיות כשהפרמטר includeTabsContent מוגדר כ-true. אם השדה מוגדר כ-false או לא מוגדר, הוא מכיל מידע על הכרטיסייה הראשונה במסמך.
headers

map (key: string, value: object (Header))

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

שדה מדור קודם: במקום זאת, משתמשים ב-Document.tabs.documentTab.headers, שמציג את תוכן המסמך בפועל מכל הכרטיסיות כשהפרמטר includeTabsContent מוגדר כ-true. אם המדיניות false או לא מוגדרת, השדה הזה מכיל מידע על הכרטיסייה הראשונה במסמך.
footers

map (key: string, value: object (Footer))

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

שדה מדור קודם: במקום זאת, משתמשים ב-Document.tabs.documentTab.footers, שמציג את תוכן המסמך בפועל מכל הכרטיסיות כשהפרמטר includeTabsContent מוגדר כ-true. אם השדה מוגדר כ-false או לא מוגדר, הוא מכיל מידע על הכרטיסייה הראשונה במסמך.
footnotes

map (key: string, value: object (Footnote))

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

שדה מדור קודם: במקום זאת, משתמשים ב-Document.tabs.documentTab.footnotes, שמציג את תוכן המסמך בפועל מכל הכרטיסיות כשהפרמטר includeTabsContent מוגדר כ-true. אם השדה מוגדר כ-false או לא מוגדר, הוא מכיל מידע על הכרטיסייה הראשונה במסמך.
documentStyle

object (DocumentStyle)

פלט בלבד. סגנון המסמך.

שדה מדור קודם: במקום זאת, משתמשים ב-Document.tabs.documentTab.documentStyle, שמציג את תוכן המסמך בפועל מכל הכרטיסיות כשהפרמטר includeTabsContent מוגדר כ-true. אם השדה מוגדר כ-false או לא מוגדר, הוא מכיל מידע על הכרטיסייה הראשונה במסמך.
suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

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

שדה מדור קודם: במקום זאת, משתמשים ב-Document.tabs.documentTab.suggestedDocumentStyleChanges, שמציג את תוכן המסמך בפועל מכל הכרטיסיות כשהפרמטר includeTabsContent מוגדר כ-true. אם השדה מוגדר כ-false או לא מוגדר, הוא מכיל מידע על הכרטיסייה הראשונה במסמך.
namedStyles

object (NamedStyles)

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

שדה מדור קודם: במקום זאת, משתמשים ב-Document.tabs.documentTab.namedStyles, שמציג את תוכן המסמך בפועל מכל הכרטיסיות כשהפרמטר includeTabsContent מוגדר כ-true. אם השדה מוגדר כ-false או לא מוגדר, הוא מכיל מידע על הכרטיסייה הראשונה במסמך.
suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

פלט בלבד. השינויים המוצעים בסגנונות השם של המסמך, לפי מזהה ההצעה.

שדה מדור קודם: במקום זאת, משתמשים ב-Document.tabs.documentTab.suggestedNamedStylesChanges, שמציג את תוכן המסמך בפועל מכל הכרטיסיות כשהפרמטר includeTabsContent מוגדר כ-true. אם המדיניות false או לא מוגדרת, השדה הזה מכיל מידע על הכרטיסייה הראשונה במסמך.
lists

map (key: string, value: object (List))

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

שדה מדור קודם: במקום זאת, משתמשים ב-Document.tabs.documentTab.lists, שמציג את תוכן המסמך בפועל מכל הכרטיסיות כשהפרמטר includeTabsContent מוגדר כ-true. אם השדה מוגדר כ-false או לא מוגדר, הוא מכיל מידע על הכרטיסייה הראשונה במסמך.
namedRanges

map (key: string, value: object (NamedRanges))

פלט בלבד. טווחי השמות במסמך, עם קידוד לפי שם.

שדה מדור קודם: במקום זאת, משתמשים ב-Document.tabs.documentTab.namedRanges, שמציג את תוכן המסמך בפועל מכל הכרטיסיות כשהפרמטר includeTabsContent מוגדר כ-true. אם השדה מוגדר כ-false או לא מוגדר, הוא מכיל מידע על הכרטיסייה הראשונה במסמך.
inlineObjects

map (key: string, value: object (InlineObject))

פלט בלבד. האובייקטים שמוצגים בשורה במסמך, לפי מפתח של מזהה אובייקט.

שדה מדור קודם: במקום זאת, משתמשים ב-Document.tabs.documentTab.inlineObjects, שמציג את תוכן המסמך בפועל מכל הכרטיסיות כשהפרמטר includeTabsContent מוגדר כ-true. אם המדיניות false או לא מוגדרת, השדה הזה מכיל מידע על הכרטיסייה הראשונה במסמך.
positionedObjects

map (key: string, value: object (PositionedObject))

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

שדה מדור קודם: במקום זאת, משתמשים ב-Document.tabs.documentTab.positionedObjects, שמציג את תוכן המסמך בפועל מכל הכרטיסיות כשהפרמטר includeTabsContent מוגדר כ-true. אם המדיניות false או לא מוגדרת, השדה הזה מכיל מידע על הכרטיסייה הראשונה במסמך.

כרטיסייה

כרטיסייה במסמך.

ייצוג ב-JSON 
{
  "tabProperties": {
    object (TabProperties)
  },
  "childTabs": [
    {
      object (Tab)
    }
  ],

  // Union field content can be only one of the following:
  "documentTab": {
    object (DocumentTab)
  }
  // End of list of possible types for union field content.
}
שדות
tabProperties

object (TabProperties)

המאפיינים של הכרטיסייה, כמו מזהה וכותרת.
childTabs[]

object (Tab)

הכרטיסיות הצאצאות שמוטמעות בכרטיסייה הזו.
שדה האיחוד content. התוכן של הכרטיסייה. הערך של content יכול להיות רק אחת מהאפשרויות הבאות:
documentTab

object (DocumentTab)

כרטיסייה עם תוכן המסמך, כמו טקסט ותמונות.

TabProperties

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

ייצוג ב-JSON 
{
  "tabId": string,
  "title": string,
  "parentTabId": string,
  "index": integer,
  "nestingLevel": integer
}
שדות
tabId

string

פלט בלבד. המזהה של הכרטיסייה. לא ניתן לשנות את השדה הזה.
title

string

שם הכרטיסייה הגלוי למשתמש.
parentTabId

string

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

integer

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

integer

פלט בלבד. עומק הכרטיסייה במסמך. כרטיסיות ברמת הבסיס מתחילות ב-0.

DocumentTab

כרטיסייה עם תוכן המסמך.

ייצוג ב-JSON 
{
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
שדות
body

object (Body)

התוכן הראשי של כרטיסיית המסמך.
headers

map (key: string, value: object (Header))

הכותרות בכרטיסיית המסמך, לפי מפתח של מזהה כותרת.
footers

map (key: string, value: object (Footer))

כותרות התחתונות בכרטיסיית המסמך, לפי מפתח של מזהה כותרת תחתונה.
footnotes

map (key: string, value: object (Footnote))

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

object (DocumentStyle)

הסגנון של כרטיסיית המסמך.
suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

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

object (NamedStyles)

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

map (key: string, value: object (SuggestedNamedStyles))

השינויים המוצעים בסגנונות עם השמות בכרטיסיית המסמך, לפי מזהה ההצעה.
lists

map (key: string, value: object (List))

הרשימות בכרטיסיית המסמך, לפי מפתח של מזהה רשימה.
namedRanges

map (key: string, value: object (NamedRanges))

טווחי התאים בעלי השם בכרטיסיית המסמך, לפי מפתחות לפי שם.
inlineObjects

map (key: string, value: object (InlineObject))

האובייקטים המוטבעים בכרטיסיית המסמך, מקובצים לפי מזהה אובייקט.
positionedObjects

map (key: string, value: object (PositionedObject))

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

גוף

גוף המסמך.

בדרך כלל, הגוף מכיל את תוכן המסמך המלא, מלבד headers,‏ footers ו-footnotes.

ייצוג ב-JSON 
{
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
שדות
content[]

object (StructuralElement)

תוכן הגוף.

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

StructuralElement

רכיב מבנה מתאר תוכן שמספק מבנה למסמך.

ייצוג ב-JSON 
{
  "startIndex": integer,
  "endIndex": integer,

  // Union field content can be only one of the following:
  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
  // End of list of possible types for union field content.
}
שדות
startIndex

integer

אינדקס ההתחלה שמתחיל באפס של רכיב המבנה הזה, ביחידות קוד UTF-16.
endIndex

integer

אינדקס הקצה מבוסס אפס של הרכיב המבני הזה, בלעדי, ביחידות קוד UTF-16.
שדה האיחוד content. התוכן של הרכיב המבני. content יכול להיות רק אחת מהאפשרויות הבאות:
paragraph

object (Paragraph)

אלמנט מבני מסוג פסקאות.
sectionBreak

object (SectionBreak)

סוג של אלמנט מבני של מעבר בין קטעים.
table

object (Table)

סוג טבלה של אלמנט מבני.
tableOfContents

object (TableOfContents)

סוג תוכן עניינים של רכיב מבני.

פסקה

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

ייצוג ב-JSON 
{
  "elements": [
    {
      object (ParagraphElement)
    }
  ],
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "suggestedParagraphStyleChanges": {
    string: {
      object (SuggestedParagraphStyle)
    },
    ...
  },
  "bullet": {
    object (Bullet)
  },
  "suggestedBulletChanges": {
    string: {
      object (SuggestedBullet)
    },
    ...
  },
  "positionedObjectIds": [
    string
  ],
  "suggestedPositionedObjectIds": {
    string: {
      object (ObjectReferences)
    },
    ...
  }
}
שדות
elements[]

object (ParagraphElement)

תוכן הפסקה, מפורט לפי החלקים שלה.
paragraphStyle

object (ParagraphStyle)

הסגנון של הפסקה הזו.
suggestedParagraphStyleChanges

map (key: string, value: object (SuggestedParagraphStyle))

סגנון הפסקה שהוצעה ישתנה לפסקה הזו, לפי מפתח של מזהה ההצעה.
bullet

object (Bullet)

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

map (key: string, value: object (SuggestedBullet))

ההצעות לשינויים בתבליט של הפסקה הזו.
positionedObjectIds[]

string

המזהים של האובייקטים הממוקמים שמקושרים לפסקה הזו.
suggestedPositionedObjectIds

map (key: string, value: object (ObjectReferences))

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

ParagraphElement

הרכיב ParagraphElement מתאר תוכן בתוך Paragraph.

ייצוג ב-JSON 
{
  "startIndex": integer,
  "endIndex": integer,

  // Union field content can be only one of the following:
  "textRun": {
    object (TextRun)
  },
  "autoText": {
    object (AutoText)
  },
  "pageBreak": {
    object (PageBreak)
  },
  "columnBreak": {
    object (ColumnBreak)
  },
  "footnoteReference": {
    object (FootnoteReference)
  },
  "horizontalRule": {
    object (HorizontalRule)
  },
  "equation": {
    object (Equation)
  },
  "inlineObjectElement": {
    object (InlineObjectElement)
  },
  "person": {
    object (Person)
  },
  "richLink": {
    object (RichLink)
  }
  // End of list of possible types for union field content.
}
שדות
startIndex

integer

אינדקס ההתחלה מבוסס אפס של רכיב פסקה זה, ביחידות קוד UTF-16.
endIndex

integer

אינדקס הסיום של רכיב הפסקה הזה, לא כולל, בבסיס אפס ביחידות קוד UTF-16.
שדה האיחוד content. התוכן של רכיב הפיסקה. content יכול להיות רק אחת מהאפשרויות הבאות:
textRun

object (TextRun)

רכיב פסקה של הרצת טקסט.
autoText

object (AutoText)

רכיב של פסקה עם טקסט אוטומטי.
pageBreak

object (PageBreak)

רכיב פסקה של מעבר דף.
columnBreak

object (ColumnBreak)

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

object (FootnoteReference)

רכיב פסקה של הפניה להערת שוליים.
horizontalRule

object (HorizontalRule)

רכיב פסקה בכלל אופקי.
equation

object (Equation)

רכיב של פסקה של משוואה.
inlineObjectElement

object (InlineObjectElement)

רכיב פיסקה של אובייקט בתוך שורה.
person

object (Person)

רכיב פסקה שמקושר לאדם או לכתובת אימייל.

TextRun

ParagraphElement שמייצג קטע טקסט שיש לו סגנון אחיד.

ייצוג ב-JSON 
{
  "content": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
שדות
content

string

הטקסט של ההרצה הזו.

כל הרכיבים שאינם טקסט ברצף מוחלפים בתו Unicode‏ U+E907.
suggestedInsertionIds[]

string

המזהים המוצעים של המודעות. ל-TextRun יכולים להיות מספר מזהי הטמעה אם מדובר בהצעת שינוי בתצוגת עץ. אם השדה ריק, זו לא הצעה להוספה.
suggestedDeletionIds[]

string

מזהי ההצעות למחיקה. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה.
textStyle

object (TextStyle)

סגנון הטקסט של ההרצה הזו.
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

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

TextStyle

הסגנון שאפשר להחיל על טקסט.

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

  • סגנון הטקסט (TextStyle) של טקסט ב-Paragraph עובר בירושה מה-named style type התואם של הפסקה.
  • TextStyle ב-named style יורש מהסגנון normal text בעל השם.
  • סגנון הטקסט TextStyle של הסגנון בעל השם normal text עובר בירושה מסגנון ברירת המחדל של הטקסט בכלי לעריכת מסמכים ב-Docs.
  • סגנון הטקסט של אלמנט Paragraph שנכלל בטבלה עשוי לרשת את סגנון הטקסט מסגנון הטבלה.

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

ייצוג ב-JSON 
{
  "bold": boolean,
  "italic": boolean,
  "underline": boolean,
  "strikethrough": boolean,
  "smallCaps": boolean,
  "backgroundColor": {
    object (OptionalColor)
  },
  "foregroundColor": {
    object (OptionalColor)
  },
  "fontSize": {
    object (Dimension)
  },
  "weightedFontFamily": {
    object (WeightedFontFamily)
  },
  "baselineOffset": enum (BaselineOffset),
  "link": {
    object (Link)
  }
}
שדות
bold

boolean

האם הטקסט מוצג כמודגש.
italic

boolean

האם הטקסט נטוי או לא.
underline

boolean

אם הטקסט מודגש קו תחתון או לא.
strikethrough

boolean

האם יש קו חוצה בטקסט.
smallCaps

boolean

אם הטקסט כתוב באותיות קטנות או באותיות גדולות.
backgroundColor

object (OptionalColor)

צבע הרקע של הטקסט. אם הוא מוגדר, הצבע הוא צבע RGB או שקוף, בהתאם לשדה color.
foregroundColor

object (OptionalColor)

צבע החזית של הטקסט. אם הוא מוגדר, הצבע הוא צבע RGB או שקוף, בהתאם לשדה color.
fontSize

object (Dimension)

גודל הגופן של הטקסט.
weightedFontFamily

object (WeightedFontFamily)

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

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

אם weightedFontFamily#weight לא מוגדר, ברירת המחדל שלו היא 400.

אם מגדירים את weightedFontFamily, צריך להגדיר גם את weightedFontFamily#fontFamily עם ערך שאינו ריק. אחרת, תוחזר שגיאה 400 (בקשה שגויה).
baselineOffset

enum (BaselineOffset)

ההזזה האנכית של הטקסט מהמיקום הרגיל שלו.

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

OptionalColor

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

ייצוג JSON 
{
  "color": {
    object (Color)
  }
}
שדות
color

object (Color)

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

צבע

צבע אחיד.

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

object (RgbColor)

ערך הצבע ב-RGB.

RgbColor

צבע RGB.

ייצוג ב-JSON 
{
  "red": number,
  "green": number,
  "blue": number
}
שדות
red

number

הרכיב האדום של הצבע, מ-0.0 עד 1.0.
green

number

רכיב הצבע הירוק, מ-0.0 עד 1.0.
blue

number

הרכיב הכחול של הצבע, מ-0.0 עד 1.0.

מאפיין

עוצמה בכיוון יחיד ביחידות שצוינו.

ייצוג ב-JSON 
{
  "magnitude": number,
  "unit": enum (Unit)
}
שדות
magnitude

number

העוצמה.
unit

enum (Unit)

היחידות של עוצמה.

יחידה

יחידות מידה.

טיפוסים בני מנייה (enum)
UNIT_UNSPECIFIED היחידות לא ידועות.
PT נקודה, 1/72 אינץ'.

WeightedFontFamily

מייצג משפחת גופנים ועובי גופן של טקסט.

ייצוג ב-JSON 
{
  "fontFamily": string,
  "weight": integer
}
שדות
fontFamily

string

משפחת הגופנים של הטקסט.

משפחת הגופנים יכולה להיות כל גופן מתפריט הגופנים ב-Docs או מ-Google Fonts. אם שם הגופן לא מזוהה, הטקסט יומר לגופן Arial.
weight

integer

משקל הגופן. השדה הזה יכול להכיל כל ערך שהוא מכפיל של 100 בין 100 ל-900, כולל. הטווח הזה תואם לערכים המספריים שמתוארים במפרט של CSS 2.1, סעיף 15.6, שבהם אסור להשתמש בערכים לא מספריים.

ערך ברירת המחדל הוא 400 ('רגיל').

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

  • אם הטקסט מודגש והמשקל קטן מ-400, המשקל לאחר עיבוד הוא 400.
  • אם הטקסט מודגש והעובי גדול מ-400 או שווה לו אבל קטן מ-700, העובי שיוצג יהיה 700.
  • אם המשקל גדול מ-700 או שווה לו, המשקל לאחר עיבוד שווה למשקל.
  • אם הטקסט לא מודגש, המשקל לאחר עיבוד שווה למשקל.

BaselineOffset

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

טיפוסים בני מנייה (enum)
BASELINE_OFFSET_UNSPECIFIED ההיסט הבסיסי של הטקסט עובר בירושה מתבנית ההורה.
NONE הטקסט לא קוזז אנכית.
SUPERSCRIPT הטקסט מוסט כלפי מעלה (כתב עילי).
SUBSCRIPT הטקסט מוסט כלפי מטה (כתב תחתי).

SuggestedTextStyle

הצעה לשינוי ל-TextStyle.

ייצוג ב-JSON 
{
  "textStyle": {
    object (TextStyle)
  },
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
שדות
textStyle

object (TextStyle)

קובץ TextStyle שכולל רק את השינויים שבוצעו בהצעה הזו. אפשר להשתמש באפשרות הזו יחד עם textStyleSuggestionState כדי לראות אילו שדות השתנו ואת הערכים החדשים שלהם.
textStyleSuggestionState

object (TextStyleSuggestionState)

מסכה שמציינת אילו מהשדות בבסיס TextStyle השתנו בהצעה הזו.

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

boolean

מציין אם הייתה הצעה לשינוי ב-bold.
italicSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-italic.
underlineSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-underline.
strikethroughSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-strikethrough.
smallCapsSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-smallCaps.
backgroundColorSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-backgroundColor.
foregroundColorSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-foregroundColor.
fontSizeSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-fontSize.
weightedFontFamilySuggested

boolean

מציין אם הייתה הצעה לשינוי ב-weightedFontFamily.
baselineOffsetSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-baselineOffset.

AutoText

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

ייצוג ב-JSON 
{
  "type": enum (Type),
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
שדות
type

enum (Type)

הסוג של טקסט אוטומטי זה.
suggestedInsertionIds[]

string

המזהים המוצעים של המודעות. ל-AutoText יכולים להיות מספר מזהי הטמעה אם מדובר בהצעת שינוי בתצוגת עץ. אם השדה ריק, זו לא הצעה להוספה.
suggestedDeletionIds[]

string

מזהי ההצעות למחיקה. אם השדה ריק, אין הצעות למחיקת התוכן.
textStyle

object (TextStyle)

סגנון הטקסט של הטקסט האוטומטי הזה.
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

סגנון הטקסט המוצע ישתנה ל-AutoText הזה, עם מזהה הצעה.

סוג

סוגי הטקסט האוטומטי.

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

PageBreak

ParagraphElement שמייצג מעבר דף. בעקבות מעבר דף, הטקסט הבא יתחיל בחלק העליון של הדף הבא.

ייצוג ב-JSON 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
שדות
suggestedInsertionIds[]

string

המזהים המוצעים של המודעות. ל-PageBreak יכולים להיות מספר מזהי הטמעה אם מדובר בהצעת שינוי בתצוגת עץ. אם השדה ריק, לא ניתן להשתמש בהצעה להזנה.
suggestedDeletionIds[]

string

מזהי ההצעות למחיקה. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה.
textStyle

object (TextStyle)

סגנון הטקסט של הפס ההפרדה הזה.

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

map (key: string, value: object (SuggestedTextStyle))

סגנון הטקסט המוצע משתנה ל-PageBreak הזה, לפי מפתח של מזהה ההצעה.

ColumnBreak

ParagraphElement שמייצג מעבר עמודה. מעבר עמודה גורם לטקסט הבא להתחיל בחלק העליון של העמודה הבאה.

ייצוג ב-JSON 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
שדות
suggestedInsertionIds[]

string

המזהים המוצעים של המודעות. ל-ColumnBreak יכולים להיות מספר מזהי הטמעה אם מדובר בהצעת שינוי בתצוגת עץ. אם השדה ריק, זו לא הצעה להוספה.
suggestedDeletionIds[]

string

מזהי ההצעות למחיקה. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה.
textStyle

object (TextStyle)

סגנון הטקסט של ה-ColumnBreak הזה.

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

map (key: string, value: object (SuggestedTextStyle))

סגנון הטקסט המוצע משתנה ל-ColumnBreak הזה, לפי המפתח של מזהה ההצעה.

FootnoteReference

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

ייצוג ב-JSON 
{
  "footnoteId": string,
  "footnoteNumber": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
שדות
footnoteId

string

המזהה של ה-footnote שמכיל את התוכן של ההפניה הזו להערת שוליים.
footnoteNumber

string

המספר שעבר רינדור של הערת השוליים הזו.
suggestedInsertionIds[]

string

המזהים המוצעים של המודעות. ל-FootnoteReference יכולים להיות כמה מזהי הוספה, אם מדובר בהצעה לשינוי מקונן. אם השדה ריק, זו לא הצעה להוספה.
suggestedDeletionIds[]

string

מזהי ההצעות למחיקה. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה.
textStyle

object (TextStyle)

סגנון הטקסט של FootnoteReference הזה.
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

סגנון הטקסט המוצע ישתנה ל-FootnoteReference הזה, לפי המפתח של מזהה ההצעה.

HorizontalRule

ParagraphElement שמייצג קו אופקי.

ייצוג ב-JSON 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
שדות
suggestedInsertionIds[]

string

מזהי ההוספה המוצעים. ל-HorizontalRule יכולים להיות מספר מזהי הטמעה אם מדובר בהצעת שינוי בתצוגת עץ. אם השדה ריק, זו לא הצעה להוספה.
suggestedDeletionIds[]

string

מזהי ההצעות למחיקה. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה.
textStyle

object (TextStyle)

סגנון הטקסט של HorizontalRule הזה.

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

map (key: string, value: object (SuggestedTextStyle))

סגנון הטקסט המוצע ישתנה ל-HorizontalRule הזה, לפי מפתח של מזהה ההצעה.

משוואה

ParagraphElement שמייצג משוואה.

ייצוג JSON 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
שדות
suggestedInsertionIds[]

string

מזהי ההוספה המוצעים. ל-Equation יכולים להיות מספר מזהי הטמעה אם מדובר בהצעת שינוי בתצוגת עץ. אם השדה ריק, לא ניתן להשתמש בהצעה להזנה.
suggestedDeletionIds[]

string

מזהי ההצעות למחיקה. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה.

InlineObjectElement

ParagraphElement שמכיל InlineObject.

ייצוג JSON 
{
  "inlineObjectId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
שדות
inlineObjectId

string

המזהה של InlineObject שהרכיב הזה מכיל.
suggestedInsertionIds[]

string

המזהים המוצעים של המודעות. ל-InlineObjectElement יכולים להיות מספר מזהי הטמעה אם מדובר בהצעת שינוי בתצוגת עץ. אם השדה ריק, זו לא הצעה להוספה.
suggestedDeletionIds[]

string

מזהי ההצעות למחיקה. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה.
textStyle

object (TextStyle)

סגנון הטקסט של InlineObjectElement הזה.

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

map (key: string, value: object (SuggestedTextStyle))

סגנון הטקסט המוצע ישתנה ל-InlineObject הזה, לפי המפתח של מזהה ההצעה.

אדם

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

ייצוג ב-JSON 
{
  "personId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "personProperties": {
    object (PersonProperties)
  }
}
שדות
personId

string

פלט בלבד. המזהה הייחודי של הקישור הזה.
suggestedInsertionIds[]

string

המזהים של הצעות שמוסיפות את הקישור לאדם הזה למסמך. ל-Person יכולים להיות כמה מזהי הזנה, אם מדובר בהצעה לשינוי מקונן (לדוגמה, הצעה מתוך הצעה של משתמש אחר). אם השדה ריק, הקישור למשתמש הזה לא מהווה הצעה להוספה.
suggestedDeletionIds[]

string

מזהי הצעות להסרת הקישור של האדם הזה מהמסמך. ל-Person יכולים להיות כמה מזהי מחיקה, אם, לדוגמה, כמה משתמשים מציעים למחוק אותו. אם השדה ריק, המערכת לא תציע למחוק את הקישור לאותו אדם.
textStyle

object (TextStyle)

סגנון הטקסט של Person הזה.
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

סגנון הטקסט המוצע ישתנה ל-Person הזה, לפי מפתח של מזהה ההצעה.
personProperties

object (PersonProperties)

פלט בלבד. המאפיינים של Person. השדה הזה תמיד קיים.

PersonProperties

מאפיינים ספציפיים לחשבון Person מקושר.

ייצוג ב-JSON 
{
  "name": string,
  "email": string
}
שדות
name

string

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

string

פלט בלבד. כתובת האימייל שמקושרת ל-Person הזה. השדה הזה תמיד קיים.

RichLinkProperties

מאפיינים ספציפיים ל-RichLink.

ייצוג ב-JSON 
{
  "title": string,
  "uri": string,
  "mimeType": string
}
שדות
title

string

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

string

פלט בלבד. ה-URI של RichLink. הסמל הזה תמיד מופיע.
mimeType

string

פלט בלבד. סוג ה-MIME של ה-RichLink, אם יש כזה (לדוגמה, כשמדובר בקובץ ב-Drive).

ParagraphStyle

סגנונות שחלים על פסקה שלמה.

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

  • סגנון הפסקה ב-Paragraph עובר בירושה מ-named style type התואם של הפסקה.
  • ה-ParagraphStyle ב-named style עובר בירושה מהסגנון המוגדר בשם normal text.
  • סגנון הפיסקה של הסגנון בעל השם normal text יורש את סגנון ברירת המחדל של הפסקה בעורך Docs.
  • סגנון הפסקה של אלמנט Paragraph שנכלל בטבלה עשוי לרשת את סגנון הפסקה מסגנון הטבלה.

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

ייצוג ב-JSON 
{
  "headingId": string,
  "namedStyleType": enum (NamedStyleType),
  "alignment": enum (Alignment),
  "lineSpacing": number,
  "direction": enum (ContentDirection),
  "spacingMode": enum (SpacingMode),
  "spaceAbove": {
    object (Dimension)
  },
  "spaceBelow": {
    object (Dimension)
  },
  "borderBetween": {
    object (ParagraphBorder)
  },
  "borderTop": {
    object (ParagraphBorder)
  },
  "borderBottom": {
    object (ParagraphBorder)
  },
  "borderLeft": {
    object (ParagraphBorder)
  },
  "borderRight": {
    object (ParagraphBorder)
  },
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "indentEnd": {
    object (Dimension)
  },
  "tabStops": [
    {
      object (TabStop)
    }
  ],
  "keepLinesTogether": boolean,
  "keepWithNext": boolean,
  "avoidWidowAndOrphan": boolean,
  "shading": {
    object (Shading)
  },
  "pageBreakBefore": boolean
}
שדות
headingId

string

מזהה הכותרת של הפסקה. אם השדה ריק, הפסקה הזו היא לא כותרת.

הנכס הזה הוא לקריאה בלבד.
namedStyleType

enum (NamedStyleType)

סוג הסגנון של הפסקה, בעל השם.

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

enum (Alignment)

יישור הטקסט בפסקה הזו.
lineSpacing

number

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

enum (ContentDirection)

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

enum (SpacingMode)

מצב הריווח של הפסקה.
spaceAbove

object (Dimension)

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

object (Dimension)

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

object (ParagraphBorder)

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

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

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

object (ParagraphBorder)

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

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

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

object (ParagraphBorder)

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

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

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

object (ParagraphBorder)

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

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

object (ParagraphBorder)

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

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

object (Dimension)

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

object (Dimension)

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

object (Dimension)

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

object (TabStop)

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

הנכס הזה הוא לקריאה בלבד.
keepLinesTogether

boolean

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

boolean

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

boolean

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

object (Shading)

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

boolean

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

ניסיון לעדכן את pageBreakBefore בקטעים באזורים שלא נתמכים, כולל Table, ‏ Header, ‏ Footer ו-Footnote, עלול לגרום למצב מסמך לא חוקי שיגרום להצגת השגיאה 400 Bad Request.

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 (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "padding": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
שדות
color

object (OptionalColor)

צבע הגבול.
width

object (Dimension)

רוחב הגבול.
padding

object (Dimension)

המרווח הפנימי של הגבול.
dashStyle

enum (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 (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}
שדות
offset

object (Dimension)

ההזזה בין עצור הכרטיסייה הזה לבין שולי ההתחלה.
alignment

enum (TabStopAlignment)

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

TabStopAlignment

היישור של עצירת Tab.

טיפוסים בני מנייה (enum)
TAB_STOP_ALIGNMENT_UNSPECIFIED לא צוין היישור של תווית הפסקה.
START תפס הכרטיסייה מיושר לתחילת השורה. (זוהי ברירת המחדל)
CENTER עצירת הטאב מיושרת למרכז הקו.
END תצוגת הטאב מותאמת לסוף השורה.

הצללה

הצללת פסקה.

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

object (OptionalColor)

צבע הרקע של ההצללה של הפסקה הזו.

SuggestedParagraphStyle

הצעה לשינוי ב-ParagraphStyle.

ייצוג ב-JSON 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
שדות
paragraphStyle

object (ParagraphStyle)

ParagraphStyle שכולל רק את השינויים שבוצעו בהצעה הזו. אפשר להשתמש באפשרות הזו יחד עם paragraphStyleSuggestionState כדי לראות אילו שדות השתנו ואת הערכים החדשים שלהם.
paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

מסכה שמציינת אילו מהשדות בבסיס ParagraphStyle השתנו בהצעה הזו.

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 (ShadingSuggestionState)
  },
  "pageBreakBeforeSuggested": boolean
}
שדות
headingIdSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-headingId.
namedStyleTypeSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-namedStyleType.
alignmentSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-alignment.
lineSpacingSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-lineSpacing.
directionSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-direction.
spacingModeSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-spacingMode.
spaceAboveSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-spaceAbove.
spaceBelowSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-spaceBelow.
borderBetweenSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-borderBetween.
borderTopSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-borderTop.
borderBottomSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-borderBottom.
borderLeftSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-borderLeft.
borderRightSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-borderRight.
indentFirstLineSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-indentFirstLine.
indentStartSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-indentStart.
indentEndSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-indentEnd.
keepLinesTogetherSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-keepLinesTogether.
keepWithNextSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-keepWithNext.
avoidWidowAndOrphanSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-avoidWidowAndOrphan.
shadingSuggestionState

object (ShadingSuggestionState)

מסכה שמציינת אילו מהשדות ב-shading השתנו בהצעה הזו.
pageBreakBeforeSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-pageBreakBefore.

ShadingSuggestionState

מסכה שמציינת אילו מהשדות בבסיס Shading השתנו בשינוי המוצע הזה. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.

ייצוג ב-JSON 
{
  "backgroundColorSuggested": boolean
}
שדות
backgroundColorSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-Shading.

תבליט

מתאר את פסיק הפסקה של פסקה.

ייצוג ב-JSON 
{
  "listId": string,
  "nestingLevel": integer,
  "textStyle": {
    object (TextStyle)
  }
}
שדות
listId

string

המזהה של הרשימה שאליה שייך הפסקה.
nestingLevel

integer

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

object (TextStyle)

סגנון הטקסט הספציפי לפסקה שהוחל על הנקודה הזו.

SuggestedBullet

הצעה לשינוי ב-Bullet.

ייצוג JSON 
{
  "bullet": {
    object (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}
שדות
bullet

object (Bullet)

קובץ Bullet שכולל רק את השינויים שבוצעו בהצעה הזו. אפשר להשתמש בנתונים האלה ביחד עם bulletSuggestionState כדי לראות אילו שדות השתנו והערכים החדשים שלהם.
bulletSuggestionState

object (BulletSuggestionState)

מסכה שמציינת אילו מהשדות בבסיס Bullet השתנו בהצעה הזו.

BulletSuggestionState

מסכה שמציינת אילו מהשדות בבסיס Bullet השתנו בהצעה הזו. לכל שדה שהוגדר כ-true, יש הצעה לערך חדש.

ייצוג ב-JSON 
{
  "listIdSuggested": boolean,
  "nestingLevelSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
שדות
listIdSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-listId.
nestingLevelSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-nestingLevel.
textStyleSuggestionState

object (TextStyleSuggestionState)

מסכה שמציינת אילו מהשדות ב-text style השתנו בהצעה הזו.

ObjectReferences

אוסף של מזהי אובייקטים.

ייצוג JSON 
{
  "objectIds": [
    string
  ]
}
שדות
objectIds[]

string

מזהי האובייקטים.

SectionBreak

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

גוף המסמך תמיד מתחיל במעבר קטע.

ייצוג JSON 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "sectionStyle": {
    object (SectionStyle)
  }
}
שדות
suggestedInsertionIds[]

string

המזהים המוצעים של המודעות. ל-SectionBreak יכולים להיות כמה מזהי הוספה, אם מדובר בהצעה לשינוי מקונן. אם השדה ריק, זו לא הצעה להוספה.
suggestedDeletionIds[]

string

מזהי המחיקה המוצעים. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה.
sectionStyle

object (SectionStyle)

הסגנון של הקטע אחרי מעבר הקטע הזה.

SectionStyle

הסגנון שחלה על קטע.

ייצוג ב-JSON 
{
  "columnProperties": [
    {
      object (SectionColumnProperties)
    }
  ],
  "columnSeparatorStyle": enum (ColumnSeparatorStyle),
  "contentDirection": enum (ContentDirection),
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "sectionType": enum (SectionType),
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "flipPageOrientation": boolean
}
שדות
columnProperties[]

object (SectionColumnProperties)

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

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

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

enum (ColumnSeparatorStyle)

הסגנון של מפרידי העמודות.

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

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

enum (ContentDirection)

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

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

object (Dimension)

שוליים העליונים של הדף בקטע. אם לא מגדירים ערך, הערך שמוגדר כברירת מחדל הוא marginTop מ-DocumentStyle.

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

object (Dimension)

השוליים התחתוניים של הקטע. אם לא מגדירים ערך, הערך שמוגדר כברירת מחדל הוא marginBottom מ-DocumentStyle.

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

השוליים של הכותרת העליונה של הקטע. אם לא מוגדר, ערך ברירת המחדל הוא marginHeader מ-DocumentStyle. אם המאפיין עודכן, הערך של useCustomHeaderFooterMargins מוגדר כ-true ב-DocumentStyle. הערך של useCustomHeaderFooterMargins ב-DocumentStyle מציין אם המערכת מתייחסת לשוליים של הכותרת בקטע הזה.

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

enum (SectionType)

פלט בלבד. סוג הקטע.
defaultHeaderId

string

המזהה של הכותרת שמוגדרת כברירת מחדל. אם המדיניות לא מוגדרת, הערך עובר בירושה מסגנון המדור הקודם של SectionBreak's. אם הערך לא מוגדר בקטע ה-sectionBreak הראשון, הוא יורש את המאפיין defaultHeaderId של DocumentStyle.

הנכס הזה הוא לקריאה בלבד.
firstPageHeaderId

string

המזהה של הכותרת שמשמש רק לדף הראשון של הקטע. אם הערך של useFirstPageHeaderFooter הוא True, הערך הזה משמש לכותרת של הדף הראשון של הקטע. אם הערך הוא false, הכותרת בדף הראשון של הקטע תשתמש ב-defaultHeaderId. אם הערך לא מוגדר, הוא עובר בירושה מה-SectionStyle הקודם של SectionBreak's. אם הערך לא מוגדר ב-SectionBreak הראשון, הוא עובר בירושה מ-firstPageHeaderId של DocumentStyle.

הנכס הזה הוא לקריאה בלבד.
firstPageFooterId

string

המזהה של הכותרת התחתונה שמשמש רק בדף הראשון של הקטע. אם הערך של useFirstPageHeaderFooter הוא true, המערכת תשתמש בערך הזה בכותרת התחתונה בדף הראשון של הקטע. אם הערך הוא false, הכותרת התחתונה בדף הראשון של הקטע תשתמש ב-defaultFooterId. אם המדיניות לא מוגדרת, הערך עובר בירושה מסגנון המדור הקודם של SectionBreak's. אם הערך לא מוגדר ב-SectionBreak הראשון, הוא עובר בירושה מ-firstPageFooterId של DocumentStyle.

הנכס הזה הוא לקריאה בלבד.
evenPageHeaderId

string

המזהה של הכותרת העליונה שמשמש רק בדפים זוגיים. אם הערך של useEvenPageHeaderFooter של DocumentStyle הוא true, הערך הזה ישמש לכותרות בדפים הזוגיים בקטע. אם הערך הוא false, הכותרות בדפים זוגיים ישתמשו ב-defaultHeaderId. אם הערך לא מוגדר, הוא עובר בירושה מה-SectionStyle הקודם של SectionBreak's. אם הערך לא מוגדר ב-SectionBreak הראשון, הוא עובר בירושה מ-evenPageHeaderId של DocumentStyle.

הנכס הזה הוא לקריאה בלבד.
evenPageFooterId

string

המזהה של הכותרת התחתונה שמשמש רק לדפים זוגיים. אם הערך של useEvenPageHeaderFooter של DocumentStyle הוא True, ערך זה משמש לכותרות תחתונות בדפים זוגיים בקטע. אם הוא מוגדר כ-False, הכותרות התחתונות בדפים זוגיים משתמשים בסימן defaultFooterId. אם הערך לא מוגדר, הוא עובר בירושה מה-SectionStyle הקודם של SectionBreak's. אם הערך לא מוגדר בקטע ה-sectionBreak הראשון, הוא יורש את המאפיין evenPageFooterId של DocumentStyle.

הנכס הזה הוא לקריאה בלבד.
useFirstPageHeaderFooter

boolean

מציין אם להשתמש במזהים של הכותרת העליונה / הכותרת התחתונה בדף הראשון של הקטע. אם היא לא מוגדרת, היא עוברת בירושה מהuseFirstPageHeaderFooter של DocumentStyle עבור הקטע הראשון. אם הערך לא מוגדר בקטעים הבאים, צריך לפרש אותו כ-false.

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

integer

מספר הדף שממנו מתחילים לספור את מספר הדפים בקטע הזה. אם לא מגדירים את הפרמטר, מספור הדפים ממשיך מהקטע הקודם. אם הערך לא מוגדר ב-SectionBreak הראשונים, יש לעיין ב-pageNumberStart של DocumentStyle.

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

boolean

זה שינוי אופציונלי. מציין אם להפוך את המאפיינים של pageSize של DocumentStyle בקטע הזה, כדי לשנות את כיוון הדף לרוחב או לאורך. אם לא מוגדר, הערך עובר בירושה מהflipPageOrientation של DocumentStyle.

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

SectionColumnProperties

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

ייצוג ב-JSON 
{
  "width": {
    object (Dimension)
  },
  "paddingEnd": {
    object (Dimension)
  }
}
שדות
width

object (Dimension)

פלט בלבד. רוחב העמודה.
paddingEnd

object (Dimension)

המילוי בסוף העמודה.

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 (TableRow)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableStyle": {
    object (TableStyle)
  }
}
שדות
rows

integer

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

integer

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

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

object (TableRow)

התוכן והסגנון של כל שורה.
suggestedInsertionIds[]

string

המזהים המוצעים של המודעות. ל-Table יכולים להיות מספר מזהי הטמעה אם מדובר בהצעת שינוי בתצוגת עץ. אם השדה ריק, לא ניתן להשתמש בהצעה להזנה.
suggestedDeletionIds[]

string

מזהי ההצעות למחיקה. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה.
tableStyle

object (TableStyle)

הסגנון של הטבלה.

TableRow

התוכן והסגנון של שורה ב-Table.

ייצוג ב-JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "tableCells": [
    {
      object (TableCell)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "suggestedTableRowStyleChanges": {
    string: {
      object (SuggestedTableRowStyle)
    },
    ...
  }
}
שדות
startIndex

integer

אינדקס ההתחלה של השורה הזו, שמתחיל באפס, ביחידות קוד UTF-16.
endIndex

integer

אינדקס הקצה מבוסס אפס של שורה זו, בלעדי, ביחידות קוד UTF-16.
tableCells[]

object (TableCell)

התוכן והסגנון של כל תא בשורה הזו.

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

string

המזהים המוצעים של המודעות. ל-TableRow יכולים להיות מספר מזהי הטמעה אם מדובר בהצעת שינוי בתצוגת עץ. אם השדה ריק, זו לא הצעה להוספה.
suggestedDeletionIds[]

string

מזהי ההצעות למחיקה. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה.
tableRowStyle

object (TableRowStyle)

הסגנון של השורה בטבלה.
suggestedTableRowStyleChanges

map (key: string, value: object (SuggestedTableRowStyle))

הסגנון שהוצעה משתנה לשורה הזו, לפי מפתח של מזהה ההצעה.

TableCell

התוכן והסגנון של תא ב-Table.

ייצוג JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "suggestedTableCellStyleChanges": {
    string: {
      object (SuggestedTableCellStyle)
    },
    ...
  }
}
שדות
startIndex

integer

אינדקס ההתחלה אפס של התא הזה, ביחידות קוד מסוג UTF-16.
endIndex

integer

אינדקס הסיום של התא הזה, שמתחיל באפס, לא כולל, ביחידות קוד UTF-16.
content[]

object (StructuralElement)

התוכן של התא.
tableCellStyle

object (TableCellStyle)

הסגנון של התא.
suggestedInsertionIds[]

string

המזהים המוצעים של המודעות. ל-TableCell יכולים להיות מספר מזהי הטמעה אם מדובר בהצעת שינוי בתצוגת עץ. אם השדה ריק, זו לא הצעה להוספה.
suggestedDeletionIds[]

string

מזהי ההצעות למחיקה. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה.
suggestedTableCellStyleChanges

map (key: string, value: object (SuggestedTableCellStyle))

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

TableCellStyle

הסגנון של TableCell.

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

ייצוג ב-JSON 
{
  "rowSpan": integer,
  "columnSpan": integer,
  "backgroundColor": {
    object (OptionalColor)
  },
  "borderLeft": {
    object (TableCellBorder)
  },
  "borderRight": {
    object (TableCellBorder)
  },
  "borderTop": {
    object (TableCellBorder)
  },
  "borderBottom": {
    object (TableCellBorder)
  },
  "paddingLeft": {
    object (Dimension)
  },
  "paddingRight": {
    object (Dimension)
  },
  "paddingTop": {
    object (Dimension)
  },
  "paddingBottom": {
    object (Dimension)
  },
  "contentAlignment": enum (ContentAlignment)
}
שדות
rowSpan

integer

היקף השורות של התא.

הנכס הזה הוא לקריאה בלבד.
columnSpan

integer

טווח העמודה של התא.

הנכס הזה הוא לקריאה בלבד.
backgroundColor

object (OptionalColor)

צבע הרקע של התא.
borderLeft

object (TableCellBorder)

הגבול השמאלי של התא.
borderRight

object (TableCellBorder)

הגבול הימני של התא.
borderTop

object (TableCellBorder)

הגבול העליון של התא.
borderBottom

object (TableCellBorder)

הגבול התחתון של התא.
paddingLeft

object (Dimension)

המרווח הפנימי השמאלי של התא.
paddingRight

object (Dimension)

המרווח הפנימי הימני של התא.
paddingTop

object (Dimension)

המרווח הפנימי העליון של התא.
paddingBottom

object (Dimension)

הריווח התחתון של התא.
contentAlignment

enum (ContentAlignment)

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

TableCellBorder

גבול סביב תא בטבלה.

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

ייצוג ב-JSON 
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
שדות
color

object (OptionalColor)

צבע הגבול.

הצבע הזה לא יכול להיות שקוף.
width

object (Dimension)

רוחב הגבול.
dashStyle

enum (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_TextAnchoringType 'ctr'.
BOTTOM התאמה שמציבה את התוכן בחלק התחתון של מארז התוכן. תואם ל-ECMA-376 ST_TextAnchoringType 'b'.

SuggestedTableCellStyle

הצעה לשינוי ב-TableCellStyle.

ייצוג ב-JSON 
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "tableCellStyleSuggestionState": {
    object (TableCellStyleSuggestionState)
  }
}
שדות
tableCellStyle

object (TableCellStyle)

TableCellStyle שכולל רק את השינויים שבוצעו בהצעה הזו. אפשר להשתמש בנתונים האלה ביחד עם tableCellStyleSuggestionState כדי לראות אילו שדות השתנו והערכים החדשים שלהם.
tableCellStyleSuggestionState

object (TableCellStyleSuggestionState)

מסכה שמציינת אילו מהשדות בבסיס TableCellStyle השתנו בהצעה הזו.

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

boolean

שדה זה מציין אם הוצע שינוי ל-rowSpan.
columnSpanSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-columnSpan.
backgroundColorSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-backgroundColor.
borderLeftSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-borderLeft.
borderRightSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-borderRight.
borderTopSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-borderTop.
borderBottomSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-borderBottom.
paddingLeftSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-paddingLeft.
paddingRightSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-paddingRight.
paddingTopSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-paddingTop.
paddingBottomSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-paddingBottom.
contentAlignmentSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-contentAlignment.

TableRowStyle

סגנונות שחלים על שורה בטבלה.

ייצוג ב-JSON 
{
  "minRowHeight": {
    object (Dimension)
  },
  "tableHeader": boolean,
  "preventOverflow": boolean
}
שדות
minRowHeight

object (Dimension)

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

boolean

האם השורה היא כותרת של טבלה.
preventOverflow

boolean

אם השורה לא יכולה לגלוש מעבר לגבולות הדף או העמודה.

SuggestedTableRowStyle

הצעה לשינוי ל-TableRowStyle.

ייצוג ב-JSON 
{
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}
שדות
tableRowStyle

object (TableRowStyle)

TableRowStyle שכולל רק את השינויים שבוצעו בהצעה הזו. אפשר להשתמש בנתונים האלה ביחד עם tableRowStyleSuggestionState כדי לראות אילו שדות השתנו והערכים החדשים שלהם.
tableRowStyleSuggestionState

object (TableRowStyleSuggestionState)

מסכה שמציינת אילו מהשדות בבסיס TableRowStyle השתנו בהצעה הזו.

TableRowStyleSuggestionState

מסכה שמציינת אילו מהשדות בבסיס TableRowStyle השתנו בהצעה הזו. לכל שדה שהוגדר כ-true, יש הצעה לערך חדש.

ייצוג ב-JSON 
{
  "minRowHeightSuggested": boolean
}
שדות
minRowHeightSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-minRowHeight.

TableStyle

סגנונות שחלים על טבלה.

ייצוג ב-JSON 
{
  "tableColumnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
שדות
tableColumnProperties[]

object (TableColumnProperties)

המאפיינים של כל עמודה.

חשוב לזכור שב-Docs, טבלאות מכילות שורות ושורות מכילות תאים, בדומה ל-HTML. לכן, המאפיינים של שורה מסוימת נמצאים ב-tableRowStyle של השורה.

TableColumnProperties

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

ייצוג ב-JSON 
{
  "widthType": enum (WidthType),
  "width": {
    object (Dimension)
  }
}
שדות
widthType

enum (WidthType)

סוג הרוחב של העמודה.
width

object (Dimension)

רוחב העמודה. מגדירים מתי הערך של widthType בעמודה הוא FIXED_WIDTH.

WidthType

סוג רוחב העמודה.

טיפוסים בני מנייה (enum)
WIDTH_TYPE_UNSPECIFIED לא צוין סוג רוחב העמודה.
EVENLY_DISTRIBUTED

רוחב העמודה מחולק באופן שווה בין שאר העמודות שמחולקות באופן שווה.

רוחב העמודה נקבע באופן אוטומטי, והוא יהיה חלק שווה מהרוחב שנותר לטבלה אחרי שמביאים בחשבון את כל העמודות עם רוחבים שצוינו.
FIXED_WIDTH רוחב עמודה קבוע. המאפיין [width][google.apps.docs.v1.TableColumnProperties.width מכיל את רוחב העמודה.

TableOfContents

StructuralElement שמייצג תוכן עניינים.

ייצוג ב-JSON 
{
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
שדות
content[]

object (StructuralElement)

תוכן תוכן העניינים.
suggestedInsertionIds[]

string

המזהים המוצעים של המודעות. ל-TableOfContents יכולים להיות מספר מזהי הטמעה אם מדובר בהצעת שינוי בתצוגת עץ. אם השדה ריק, זו לא הצעה להוספה.
suggestedDeletionIds[]

string

מזהי ההצעות למחיקה. אם השדה ריק, אין הצעות למחיקה של התוכן.

הערת שוליים

הערת שוליים במסמך.

ייצוג ב-JSON 
{
  "footnoteId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
שדות
footnoteId

string

המזהה של הערת השוליים.
content[]

object (StructuralElement)

התוכן של הערת השוליים.

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

DocumentStyle

סגנון המסמך.

ייצוג ב-JSON 
{
  "background": {
    object (Background)
  },
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "useEvenPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "pageSize": {
    object (Size)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "useCustomHeaderFooterMargins": boolean,
  "flipPageOrientation": boolean
}
שדות
background

object (Background)

הרקע של המסמך. צבע הרקע של המסמכים לא יכול להיות שקוף.
defaultHeaderId

string

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

הנכס הזה הוא לקריאה בלבד.
evenPageHeaderId

string

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

הנכס הזה הוא לקריאה בלבד.
evenPageFooterId

string

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

הנכס הזה הוא לקריאה בלבד.
firstPageHeaderId

string

המזהה של הכותרת שמשמש רק לדף הראשון. אם לא תגדירו את השדה, לא תהיה כותרת ייחודית לדף הראשון. הערך של useFirstPageHeaderFooter קובע אם להשתמש ב-defaultHeaderId או בערך הזה לכותרת בדף הראשון. אם לא תגדירו את הפרמטר, לא תופיע כותרת בדף הראשון.

הנכס הזה הוא לקריאה בלבד.
firstPageFooterId

string

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

הנכס הזה הוא לקריאה בלבד.
useFirstPageHeaderFooter

boolean

מציין אם להשתמש במזהים של הכותרת העליונה / הכותרת התחתונה בדף הראשון.
useEvenPageHeaderFooter

boolean

מציין אם להשתמש במזהים של כותרות / תחתונות בדפים זוגיים.
pageNumberStart

integer

מספר העמוד שממנו מתחילים לספור את מספר הדפים.
marginTop

object (Dimension)

השוליים העליונים של הדף.

עדכון שולי הדף העליונים בסגנון המסמך גורם למחיקת שולי הדף העליונים בכל סגנונות הקטע.
marginBottom

object (Dimension)

השוליים התחתונים של הדף.

עדכון שול הדף התחתון בסגנון המסמך גורם למחיקת שול הדף התחתון בכל סגנונות הקטע.
marginRight

object (Dimension)

שולי הדף הימני.

עדכון שול הדף הימני בסגנון המסמך מנקה את שול הדף הימני בכל סגנונות הקטע. יכול להיות גם שגודל העמודות ישתנה בכל הקטעים.
marginLeft

object (Dimension)

השוליים השמאליים של הדף.

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

object (Size)

גודל הדף במסמך.
marginHeader

object (Dimension)

כמות המרווח בין החלק העליון של הדף לבין תוכן הכותרת.
flipPageOrientation

boolean

זה שינוי אופציונלי. מאפיין זה מציין אם להפוך את המידות של pageSize, וכך אפשר לשנות את כיוון הדף בין תצוגה לאורך לבין תצוגה לרוחב.

רקע

מייצג את הרקע של מסמך.

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

object (OptionalColor)

צבע הרקע.

גודל

רוחב וגובה.

ייצוג JSON 
{
  "height": {
    object (Dimension)
  },
  "width": {
    object (Dimension)
  }
}
שדות
height

object (Dimension)

גובה האובייקט.
width

object (Dimension)

רוחב האובייקט.

SuggestedDocumentStyle

הצעה לשינוי ב-DocumentStyle.

ייצוג ב-JSON 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "documentStyleSuggestionState": {
    object (DocumentStyleSuggestionState)
  }
}
שדות
documentStyle

object (DocumentStyle)

קובץ DocumentStyle שכולל רק את השינויים שבוצעו בהצעה הזו. אפשר להשתמש באפשרות הזו יחד עם documentStyleSuggestionState כדי לראות אילו שדות השתנו ואת הערכים החדשים שלהם.
documentStyleSuggestionState

object (DocumentStyleSuggestionState)

מסכה שמציינת אילו מהשדות בבסיס DocumentStyle השתנו בהצעה הזו.

DocumentStyleSuggestionState

מסכה שמציינת אילו מהשדות בבסיס DocumentStyle השתנו בהצעה הזו. לכל שדה שהוגדר כ-true, יש הצעה לערך חדש.

ייצוג ב-JSON 
{
  "backgroundSuggestionState": {
    object (BackgroundSuggestionState)
  },
  "defaultHeaderIdSuggested": boolean,
  "defaultFooterIdSuggested": boolean,
  "evenPageHeaderIdSuggested": boolean,
  "evenPageFooterIdSuggested": boolean,
  "firstPageHeaderIdSuggested": boolean,
  "firstPageFooterIdSuggested": boolean,
  "useFirstPageHeaderFooterSuggested": boolean,
  "useEvenPageHeaderFooterSuggested": boolean,
  "pageNumberStartSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginLeftSuggested": boolean,
  "pageSizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginHeaderSuggested": boolean,
  "marginFooterSuggested": boolean,
  "useCustomHeaderFooterMarginsSuggested": boolean,
  "flipPageOrientationSuggested": boolean
}
שדות
backgroundSuggestionState

object (BackgroundSuggestionState)

מסכה שמציינת אילו מהשדות ב-background השתנו בהצעה הזו.
defaultHeaderIdSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-defaultHeaderId.
evenPageHeaderIdSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-evenPageHeaderId.
evenPageFooterIdSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-evenPageFooterId.
firstPageHeaderIdSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-firstPageHeaderId.
firstPageFooterIdSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-firstPageFooterId.
useFirstPageHeaderFooterSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-useFirstPageHeaderFooter.
useEvenPageHeaderFooterSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-useEvenPageHeaderFooter.
pageNumberStartSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-pageNumberStart.
marginTopSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-marginTop.
marginBottomSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-marginBottom.
marginRightSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-marginRight.
marginLeftSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-marginLeft.
pageSizeSuggestionState

object (SizeSuggestionState)

מסכה שמציינת אילו מהשדות ב-[size] [google.apps.docs.v1.DocumentStyle.size] השתנו בהצעה הזו.
marginHeaderSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-marginHeader.
flipPageOrientationSuggested

boolean

זה שינוי אופציונלי. שדה זה מציין אם הוצע שינוי ל-flipPageOrientation.

BackgroundSuggestionState

מסכה שמציינת אילו מהשדות בבסיס Background השתנו בהצעה הזו. לכל שדה שהוגדר כ-true, יש ערך חדש מוציע ב-Backgound.

ייצוג ב-JSON 
{
  "backgroundColorSuggested": boolean
}
שדות
backgroundColorSuggested

boolean

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

SizeSuggestionState

מסכה שמציינת אילו מהשדות בבסיס Size השתנו בהצעה הזו. לכל שדה שהוגדר כ-true, יש ערך חדש מוציע ב-Size.

ייצוג ב-JSON 
{
  "heightSuggested": boolean,
  "widthSuggested": boolean
}
שדות
heightSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-height.
widthSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-width.

NamedStyles

הסגנונות עם השמות. האפשרות להוריש את הערכים של TextStyle ו-ParagraphStyle מהסגנונות האלה קיימת בפסקה במסמך.

ייצוג JSON 
{
  "styles": [
    {
      object (NamedStyle)
    }
  ]
}
שדות
styles[]

object (NamedStyle)

הסגנונות עם השמות.

יש רשומה לכל אחת מהאפשרויות של named style types.

NamedStyle

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

ייצוג ב-JSON 
{
  "namedStyleType": enum (NamedStyleType),
  "textStyle": {
    object (TextStyle)
  },
  "paragraphStyle": {
    object (ParagraphStyle)
  }
}
שדות
namedStyleType

enum (NamedStyleType)

הסוג של הסגנון בעל השם הזה.
textStyle

object (TextStyle)

סגנון הטקסט של הסגנון המוגדר.
paragraphStyle

object (ParagraphStyle)

סגנון הפסקה של הסגנון בעל השם הזה.

SuggestedNamedStyles

הצעה לשינוי ב-NamedStyles.

ייצוג JSON 
{
  "namedStyles": {
    object (NamedStyles)
  },
  "namedStylesSuggestionState": {
    object (NamedStylesSuggestionState)
  }
}
שדות
namedStyles

object (NamedStyles)

קובץ NamedStyles שכולל רק את השינויים שבוצעו בהצעה הזו. אפשר להשתמש בנתונים האלה ביחד עם namedStylesSuggestionState כדי לראות אילו שדות השתנו והערכים החדשים שלהם.
namedStylesSuggestionState

object (NamedStylesSuggestionState)

מסכה שמציינת אילו מהשדות בבסיס NamedStyles השתנו בהצעה הזו.

NamedStylesSuggestionState

סטטוס ההצעה של הודעת NamedStyles.

ייצוג ב-JSON 
{
  "stylesSuggestionStates": [
    {
      object (NamedStyleSuggestionState)
    }
  ]
}
שדות
stylesSuggestionStates[]

object (NamedStyleSuggestionState)

מסכה שמציינת אילו מהשדות ב-NamedStyle התואם ב-styles השתנו בהצעה הזו.

הסדר של מצבי ההצעה לסגנון בעל שם תואם לסדר של הסגנון בעל השם התואם בהצעה named styles.

NamedStyleSuggestionState

מצב ההצעה של הודעת NamedStyle.

ייצוג ב-JSON 
{
  "namedStyleType": enum (NamedStyleType),
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
שדות
namedStyleType

enum (NamedStyleType)

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

השדה הזה זמין לנוחותך כדי להתאים בין NamedStyleOfferionState לבין NamedStyle התואם.
textStyleSuggestionState

object (TextStyleSuggestionState)

מסכה שמציינת אילו מהשדות ב-text style השתנו בהצעה הזו.
paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

מסכה שמציינת אילו מהשדות ב-paragraph style השתנו בהצעה הזו.

רשימה

הרכיב List מייצג את מאפייני הרשימה של קבוצת פסקאות שכולן שייכות לאותה רשימה. לקטע טקסט ששייך לרשימה יש הפניה למזהה הרשימה ב-bullet שלו.

ייצוג ב-JSON 
{
  "listProperties": {
    object (ListProperties)
  },
  "suggestedListPropertiesChanges": {
    string: {
      object (SuggestedListProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
שדות
listProperties

object (ListProperties)

המאפיינים של הרשימה.
suggestedListPropertiesChanges

map (key: string, value: object (SuggestedListProperties))

השינויים המוצעים במאפייני הרשימה, לפי מזהה ההצעה.
suggestedInsertionId

string

מזהה ההוספה שהוצע. אם השדה ריק, לא ניתן להשתמש בהצעה להזנה.
suggestedDeletionIds[]

string

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

ListProperties

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

ייצוג ב-JSON 
{
  "nestingLevels": [
    {
      object (NestingLevel)
    }
  ]
}
שדות
nestingLevels[]

object (NestingLevel)

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

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

NestingLevel

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

ייצוג ב-JSON 
{
  "bulletAlignment": enum (BulletAlignment),
  "glyphFormat": string,
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "textStyle": {
    object (TextStyle)
  },
  "startNumber": integer,

  // Union field glyph_kind can be only one of the following:
  "glyphType": enum (GlyphType),
  "glyphSymbol": string
  // End of list of possible types for union field glyph_kind.
}
שדות
bulletAlignment

enum (BulletAlignment)

יישור התבליט בתוך השטח שהוקצה לעיבוד התבליט.
glyphFormat

string

מחרוזת הפורמט שבה נעשה שימוש בתבליטים ברמה הזו של עיטורים.

פורמט הגליף מכיל placeholder אחד או יותר, וה-placeholders האלה מוחלפים בערכים המתאימים בהתאם ל-glyphType או ל-glyphSymbol. ה-placeholders פועלים לפי התבנית %[nestingLevel]. בנוסף, ל-placeholders יכולים להיות תחיליות וסיומת. לכן, פורמט הגליף עוקב אחרי התבנית <prefix>%[nestingLevel]<suffix>. לתשומת ליבכם: הקידומת והסיומת הן אופציונליות ויכולות להיות מחרוזות שרירותיות.

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

A.

B.

C.

פורמט הגליף יכול להכיל placeholders לרמת הסידור הנוכחי או placeholders לרמות הקינון ברמת ההורה. לדוגמה, רשימה יכולה להיות בפורמט glyp של %0. ברמת הדירוג 0 ובפורמט glyp של %0.%1. ברמת הדירוג 1. בהנחה שלשני רמות ההטמעה יש DECIMAL סוגי גליפים, התוצאה תהיה רשימה עם גליפים שעברו רינדור

1.

2.

2.1.

2.2.

3.

ברמות עיטוף שמסודרות, המחרוזת שמחליפה את placeholder בפורמט הגליף של פסקה מסוימת תלויה בסדר של הפסקה ברשימה.
indentFirstLine

object (Dimension)

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

object (Dimension)

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

object (TextStyle)

סגנון הטקסט של תבליטים ברמת קינון זו.
startNumber

integer

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

המערכת מתייחסת לערך 0 כערך של 1 לרשימות עם אותיות ולרשימות של ספרות רומיות. עבור ערכים של 0 ו-1, הרשימות של האותיות והמספרים הרומיים יתחילו ב-a וב-i, בהתאמה.

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

enum (GlyphType)

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

סוג הגליף קובע את סוג הגליף שמשמש להחלפת ערכי placeholder ב-glyphFormat כשמסודרים פסקאות ברמת ההטמעה הזו. לדוגמה, אם רמת ההטמעה היא 0, הערך של glyphFormat הוא %0. וסוג הגליף הוא DECIMAL, הגליף שעבר רינדור יחליף את התו המשתנה %0 בפורמט הגליף במספר שתואם לסדר של פריט הרשימה בתוך הרשימה.
glyphSymbol

string

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

סמל הגליף מחליף את ה-placeholders ב-glyphFormat. לדוגמה, אם glyphSymbol הוא העיגול המוצק שתואם לנקודת הקוד Unicode U+25cf ו-glyphFormat הוא %0, הגליף שעבר רינדור יהיה העיגול המוצק.

BulletAlignment

סוגי ההתאמה של תווית.

טיפוסים בני מנייה (enum)
BULLET_ALIGNMENT_UNSPECIFIED יישור התבליטים לא צוין.
START התג של הת bullet מיושר לתחילת המרחב שהוקצה לעיבוד התג. מיושר לשמאל בטקסט 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": {
    object (ListPropertiesSuggestionState)
  }
}
שדות
listProperties

object (ListProperties)

ListProperties שכולל רק את השינויים שבוצעו בהצעה הזו. אפשר להשתמש באפשרות הזו יחד עם listPropertiesSuggestionState כדי לראות אילו שדות השתנו ואת הערכים החדשים שלהם.
listPropertiesSuggestionState

object (ListPropertiesSuggestionState)

מסכה שמציינת אילו מהשדות בבסיס ListProperties השתנו בהצעה הזו.

ListPropertiesSuggestionState

מסכה שמציינת אילו מהשדות בבסיס ListProperties השתנו בהצעה הזו. לכל שדה שהוגדר כ-true, יש הצעה לערך חדש.

ייצוג ב-JSON 
{
  "nestingLevelsSuggestionStates": [
    {
      object (NestingLevelSuggestionState)
    }
  ]
}
שדות
nestingLevelsSuggestionStates[]

object (NestingLevelSuggestionState)

מסכה שמציינת אילו מהשדות ב-NestingLevel התואם ב-nestingLevels השתנו בהצעה הזו.

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

NestingLevelSuggestionState

מסכה שמציינת אילו מהשדות בבסיס NestingLevel השתנו בהצעה הזו. לכל שדה שהוגדר כ-true, יש הצעה לערך חדש.

ייצוג ב-JSON 
{
  "bulletAlignmentSuggested": boolean,
  "glyphTypeSuggested": boolean,
  "glyphFormatSuggested": boolean,
  "glyphSymbolSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "startNumberSuggested": boolean
}
שדות
bulletAlignmentSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-bulletAlignment.
glyphTypeSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-glyphType.
glyphFormatSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-glyphFormat.
glyphSymbolSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-glyphSymbol.
indentFirstLineSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-indentFirstLine.
indentStartSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-indentStart.
textStyleSuggestionState

object (TextStyleSuggestionState)

מסכה שמציינת אילו מהשדות ב-text style השתנו בהצעה הזו.
startNumberSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-startNumber.

NamedRanges

אוסף של כל ה-NamedRange במסמך שיש להם שם זהה.

ייצוג ב-JSON 
{
  "name": string,
  "namedRanges": [
    {
      object (NamedRange)
    }
  ]
}
שדות
name

string

השם שכל ה-named ranges משתפים.
namedRanges[]

object (NamedRange)

פריטי NamedRange שיש להם את אותו שם.

NamedRange

אוסף של Range עם אותו מזהה של טווח תאים בעל שם.

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

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

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

ייצוג ב-JSON 
{
  "namedRangeId": string,
  "name": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
שדות
namedRangeId

string

המזהה של טווח התאים בעל השם.
name

string

השם של טווח התאים בעל השם.
ranges[]

object (Range)

הטווחים ששייכים לטווח בעל השם הזה.

טווח

מציינת טווח מתמשך של טקסט.

ייצוג ב-JSON 
{
  "segmentId": string,
  "startIndex": integer,
  "endIndex": integer,
  "tabId": string
}
שדות
segmentId

string

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

integer

אינדקס ההתחלה של הטווח הזה, שמתחיל באפס, ביחידות קוד UTF-16.

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

integer

אינדקס הסיום של הטווח הזה, שמתחיל באפס, לא כולל, ביחידות קוד UTF-16.

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

string

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

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

  • אם צוין, חייב להתאים למזהה הכרטיסייה היחידה.

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

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

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

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

InlineObject

אובייקט שמופיע בתוך השורה עם טקסט. InlineObject מכיל EmbeddedObject כמו תמונה.

ייצוג JSON 
{
  "objectId": string,
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "suggestedInlineObjectPropertiesChanges": {
    string: {
      object (SuggestedInlineObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
שדות
objectId

string

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

object (InlineObjectProperties)

המאפיינים של האובייקט הזה בשורה.
suggestedInlineObjectPropertiesChanges

map (key: string, value: object (SuggestedInlineObjectProperties))

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

string

מזהה ההוספה שהוצע. אם השדה ריק, זו לא הצעה להוספה.
suggestedDeletionIds[]

string

מזהי המחיקה המוצעים. אם השדה הזה ריק, אין הצעות למחיקת התוכן הזה.

InlineObjectProperties

המאפיינים של InlineObject.

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

object (EmbeddedObject)

האובייקט המוטמע של האובייקט הזה בתוך שורת הטקסט.

EmbeddedObject

אובייקט מוטמע במסמך.

ייצוג ב-JSON 
{
  "title": string,
  "description": string,
  "embeddedObjectBorder": {
    object (EmbeddedObjectBorder)
  },
  "size": {
    object (Size)
  },
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "linkedContentReference": {
    object (LinkedContentReference)
  },

  // Union field properties can be only one of the following:
  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
  // End of list of possible types for union field properties.
}
שדות
title

string

שם האובייקט המוטמע. ה-title וה-description משולבים כדי להציג טקסט חלופי.
description

string

התיאור של האובייקט המוטמע. הערכים של title ו-description משולבים כדי להציג טקסט חלופי.
embeddedObjectBorder

object (EmbeddedObjectBorder)

הגבול של האובייקט המוטמע.
size

object (Size)

הגודל הגלוי של התמונה אחרי החיתוך.
marginTop

object (Dimension)

השוליים העליונים של האובייקט המוטמע.
marginBottom

object (Dimension)

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

object (Dimension)

השוליים הימניים של האובייקט המוטמע.
marginLeft

object (Dimension)

השוליים השמאליים של האובייקט המוטמע.
linkedContentReference

object (LinkedContentReference)

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

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

object (EmbeddedDrawingProperties)

המאפיינים של שרטוט מוטמע.
imageProperties

object (ImageProperties)

המאפיינים של תמונה.

EmbeddedDrawingProperties

אין שדות לסוג הזה.

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

ImageProperties

המאפיינים של תמונה.

ייצוג JSON 
{
  "contentUri": string,
  "sourceUri": string,
  "brightness": number,
  "contrast": number,
  "transparency": number,
  "cropProperties": {
    object (CropProperties)
  },
  "angle": number
}
שדות
contentUri

string

URI לתמונה עם משך חיים שמוגדר כברירת מחדל ל-30 דקות. ה-URI הזה מתויג עם החשבון של מבקש הגישה. כל מי שיש לו את ה-URI יכול לגשת לתמונה כאילו הוא מבצע את הבקשה המקורית. יכול להיות שתאבדו את הגישה לתמונה אם הרשאות השיתוף של המסמך ישתנו.
sourceUri

string

ה-URI של המקור הוא ה-URI שמשמש להוספת התמונה. ה-URI של המקור יכול להיות ריק.
brightness

number

אפקט הבהירות של התמונה. הערך צריך להיות בטווח [-1.0, 1.0], כאשר 0 מציין שאין השפעה.
contrast

number

אפקט הניגודיות של התמונה. הערך צריך להיות בטווח [-1.0, 1.0], כאשר 0 מציין שאין השפעה.
transparency

number

אפקט השקיפות של התמונה. הערך צריך להיות בטווח [0.0, 1.0], כאשר 0 מציין שאין אפקט ו-1 מציין שקיפות.
cropProperties

object (CropProperties)

מאפייני החיתוך של התמונה.
angle

number

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

CropProperties

מאפייני החיתוך של תמונה.

ריבוע החיתוך מיוצג באמצעות סטיות חלקיות מ-4 הקצוות של התוכן המקורי.

  • אם ההיסט נמצא בטווח (0, 1), הקצה התואם של מלבן החיתוך ממוקם בתוך מלבן הגבול המקורי של התמונה.
  • אם ההיסט הוא שלילי או גדול מ-1, הקצה התואם של מלבן החיתוך ממוקם מחוץ למלבן המקורי של התמונה.
  • אם כל הזזות הזווית והזווית הסיבוב הן 0, התמונה לא חתוכה.
ייצוג ב-JSON 
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
שדות
offsetLeft

number

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

number

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

number

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

number

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

number

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

EmbeddedObjectBorder

גבול סביב EmbeddedObject.

ייצוג ב-JSON 
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle),
  "propertyState": enum (PropertyState)
}
שדות
color

object (OptionalColor)

צבע הגבול.
width

object (Dimension)

רוחב הגבול.
dashStyle

enum (DashStyle)

סגנון הקו המקווקו של הגבול.
propertyState

enum (PropertyState)

מצב המאפיין של מאפיין הגבול.

PropertyState

המצבים האפשריים של נכס.

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

LinkedContentReference

הפניה לתוכן של המקור החיצוני שמקושר.

ייצוג ב-JSON 
{

  // Union field reference can be only one of the following:
  "sheetsChartReference": {
    object (SheetsChartReference)
  }
  // End of list of possible types for union field reference.
}
שדות
שדה האיחוד reference. ההפניה הספציפית לסוג התוכן המקושר. הערך של reference יכול להיות רק אחת מהאפשרויות הבאות:
sheetsChartReference

object (SheetsChartReference)

הפניה לתרשים המקושר.

SheetsChartReference

הפניה לתרשים מקושר שמוטמע מ-Google Sheets.

ייצוג ב-JSON 
{
  "spreadsheetId": string,
  "chartId": integer
}
שדות
spreadsheetId

string

המזהה של הגיליון האלקטרוני ב-Google Sheets שמכיל את התרשים המקור.
chartId

integer

המזהה של התרשים הספציפי בגיליון האלקטרוני של Google Sheets שמוטמע.

SuggestedInlineObjectProperties

הצעה לשינוי ב-InlineObjectProperties.

ייצוג ב-JSON 
{
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "inlineObjectPropertiesSuggestionState": {
    object (InlineObjectPropertiesSuggestionState)
  }
}
שדות
inlineObjectProperties

object (InlineObjectProperties)

קובץ InlineObjectProperties שכולל רק את השינויים שבוצעו בהצעה הזו. אפשר להשתמש באפשרות הזו יחד עם inlineObjectPropertiesSuggestionState כדי לראות אילו שדות השתנו ואת הערכים החדשים שלהם.
inlineObjectPropertiesSuggestionState

object (InlineObjectPropertiesSuggestionState)

מסכה שמציינת אילו מהשדות בבסיס InlineObjectProperties השתנו בהצעה הזו.

InlineObjectPropertiesSuggestionState

מסכה שמציינת אילו מהשדות בבסיס InlineObjectProperties השתנו בהצעה הזו. לכל שדה שהוגדר כ-true, יש הצעה לערך חדש.

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

object (EmbeddedObjectSuggestionState)

מסכה שמציינת אילו מהשדות ב-embeddedObject השתנו בהצעה הזו.

EmbeddedObjectSuggestionState

מסכה שמציינת אילו מהשדות בבסיס EmbeddedObject השתנו בהצעה הזו. לכל שדה שהוגדר כ-true, יש הצעה לערך חדש.

ייצוג ב-JSON 
{
  "embeddedDrawingPropertiesSuggestionState": {
    object (EmbeddedDrawingPropertiesSuggestionState)
  },
  "imagePropertiesSuggestionState": {
    object (ImagePropertiesSuggestionState)
  },
  "titleSuggested": boolean,
  "descriptionSuggested": boolean,
  "embeddedObjectBorderSuggestionState": {
    object (EmbeddedObjectBorderSuggestionState)
  },
  "sizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginLeftSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "linkedContentReferenceSuggestionState": {
    object (LinkedContentReferenceSuggestionState)
  }
}
שדות
embeddedDrawingPropertiesSuggestionState

object (EmbeddedDrawingPropertiesSuggestionState)

מסכה שמציינת אילו מהשדות ב-embeddedDrawingProperties השתנו בהצעה הזו.
imagePropertiesSuggestionState

object (ImagePropertiesSuggestionState)

מסכה שמציינת אילו מהשדות ב-imageProperties השתנו בהצעה הזו.
titleSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-title.
descriptionSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-description.
embeddedObjectBorderSuggestionState

object (EmbeddedObjectBorderSuggestionState)

מסכה שמציינת אילו מהשדות ב-embeddedObjectBorder השתנו בהצעה הזו.
sizeSuggestionState

object (SizeSuggestionState)

מסכה שמציינת אילו מהשדות ב-size השתנו בהצעה הזו.
marginLeftSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-marginLeft.
marginRightSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-marginRight.
marginTopSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-marginTop.
marginBottomSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-marginBottom.
linkedContentReferenceSuggestionState

object (LinkedContentReferenceSuggestionState)

מסכה שמציינת אילו מהשדות ב-linkedContentReference השתנו בהצעה הזו.

EmbeddedDrawingPropertiesSuggestionState

אין שדות לסוג הזה.

מסכה שמציינת אילו מהשדות בבסיס EmbeddedDrawingProperties השתנו בהצעה הזו. לכל שדה שהוגדר כ-true, יש הצעה לערך חדש.

ImagePropertiesSuggestionState

מסכה שמציינת אילו מהשדות בבסיס ImageProperties השתנו בהצעה הזו. לכל שדה שהוגדר כ-true, יש הצעה לערך חדש.

ייצוג ב-JSON 
{
  "contentUriSuggested": boolean,
  "sourceUriSuggested": boolean,
  "brightnessSuggested": boolean,
  "contrastSuggested": boolean,
  "transparencySuggested": boolean,
  "cropPropertiesSuggestionState": {
    object (CropPropertiesSuggestionState)
  },
  "angleSuggested": boolean
}
שדות
contentUriSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-contentUri.
sourceUriSuggested

boolean

מציין אם הייתה הצעה לשינוי של [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri].
brightnessSuggested

boolean

מציין אם הוצע שינוי ב-[brightness] [google.apps.docs.v1.EmbeddedObject.brightness].
contrastSuggested

boolean

מציין אם הייתה הצעה לשינוי של [contrast] [google.apps.docs.v1.EmbeddedObject.contrast].
transparencySuggested

boolean

מציין אם הייתה הצעה לשינוי ב-[transparency] [google.apps.docs.v1.EmbeddedObject.transparency].
cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

מסכה שמציינת אילו מהשדות ב-cropProperties השתנו בהצעה הזו.
angleSuggested

boolean

מציין אם הייתה הצעה לשינוי של [angle] [google.apps.docs.v1.EmbeddedObject.angle].

CropPropertiesSuggestionState

מסכה שמציינת אילו מהשדות בבסיס CropProperties השתנו בהצעה הזו. לכל שדה שהוגדר כ-true, יש הצעה לערך חדש.

ייצוג ב-JSON 
{
  "offsetLeftSuggested": boolean,
  "offsetRightSuggested": boolean,
  "offsetTopSuggested": boolean,
  "offsetBottomSuggested": boolean,
  "angleSuggested": boolean
}
שדות
offsetLeftSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-offsetLeft.
offsetRightSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-offsetRight.
offsetTopSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-offsetTop.
offsetBottomSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-offsetBottom.
angleSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-angle.

EmbeddedObjectBorderSuggestionState

מסכה שמציינת אילו מהשדות בבסיס EmbeddedObjectBorder השתנו בהצעה הזו. לכל שדה שהוגדר כ-true, יש הצעה לערך חדש.

ייצוג ב-JSON 
{
  "colorSuggested": boolean,
  "widthSuggested": boolean,
  "dashStyleSuggested": boolean,
  "propertyStateSuggested": boolean
}
שדות
colorSuggested

boolean

מציין אם הייתה הצעה לשינוי של [color] [google.apps.docs.v1.EmbeddedBorderObject.color].
widthSuggested

boolean

מציין אם הייתה הצעה לשינוי של [width] [google.apps.docs.v1.EmbeddedBorderObject.width].
dashStyleSuggested

boolean

מציין אם הייתה הצעה לשינוי של [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style].
propertyStateSuggested

boolean

מציין אם הוצע שינוי ב-[propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state].

LinkedContentReferenceSuggestionState

מסכה שמציינת אילו מהשדות בבסיס LinkedContentReference השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.

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

object (SheetsChartReferenceSuggestionState)

מסכה שמציינת אילו מהשדות ב-sheetsChartReference השתנו בהצעה הזו.

SheetsChartReferenceSuggestionState

מסכה שמציינת אילו מהשדות בבסיס SheetsChartReference השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.

ייצוג ב-JSON 
{
  "spreadsheetIdSuggested": boolean,
  "chartIdSuggested": boolean
}
שדות
spreadsheetIdSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-spreadsheetId.
chartIdSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-chartId.

PositionedObject

אובייקט שמקושר ל-Paragraph וממוקם ביחס לתחילת הפיסקה. אובייקט מיקום מכיל EmbeddedObject, כמו תמונה.

ייצוג ב-JSON 
{
  "objectId": string,
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "suggestedPositionedObjectPropertiesChanges": {
    string: {
      object (SuggestedPositionedObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
שדות
objectId

string

המזהה של האובייקט הממוקם.
positionedObjectProperties

object (PositionedObjectProperties)

המאפיינים של האובייקט הממוקם.
suggestedPositionedObjectPropertiesChanges

map (key: string, value: object (SuggestedPositionedObjectProperties))

השינויים המוצעים במאפייני האובייקט הממוקם, לפי מפתח של מזהה ההצעה.
suggestedInsertionId

string

מזהה ההוספה שהוצע. אם השדה ריק, זו לא הצעה להוספה.
suggestedDeletionIds[]

string

מזהי ההצעות למחיקה. אם השדה ריק, אין הצעות למחיקה של התוכן.

PositionedObjectProperties

המאפיינים של PositionedObject.

ייצוג ב-JSON 
{
  "positioning": {
    object (PositionedObjectPositioning)
  },
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
שדות
positioning

object (PositionedObjectPositioning)

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

object (EmbeddedObject)

האובייקט המוטמע של האובייקט הממוקם הזה.

PositionedObjectPositioning

המיקום של PositionedObject. האובייקט הממוקם ממוקם ביחס לתחילת ה-Paragraph שהוא קשור אליו.

ייצוג JSON 
{
  "layout": enum (PositionedObjectLayout),
  "leftOffset": {
    object (Dimension)
  },
  "topOffset": {
    object (Dimension)
  }
}
שדות
layout

enum (PositionedObjectLayout)

הפריסה של האובייקט הממוקם.
leftOffset

object (Dimension)

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

object (Dimension)

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

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": {
    object (PositionedObjectPropertiesSuggestionState)
  }
}
שדות
positionedObjectProperties

object (PositionedObjectProperties)

PositionedObjectProperties שכולל רק את השינויים שבוצעו בהצעה הזו. אפשר להשתמש בנתונים האלה ביחד עם positionedObjectPropertiesSuggestionState כדי לראות אילו שדות השתנו והערכים החדשים שלהם.
positionedObjectPropertiesSuggestionState

object (PositionedObjectPropertiesSuggestionState)

מסכה שמציינת אילו מהשדות בבסיס PositionedObjectProperties השתנו בהצעה הזו.

PositionedObjectPropertiesSuggestionState

מסכה שמציינת אילו מהשדות בבסיס PositionedObjectProperties השתנו בהצעה הזו. לכל שדה שהוגדר כ-true, יש הצעה לערך חדש.

ייצוג ב-JSON 
{
  "positioningSuggestionState": {
    object (PositionedObjectPositioningSuggestionState)
  },
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
שדות
positioningSuggestionState

object (PositionedObjectPositioningSuggestionState)

מסכה שמציינת אילו מהשדות ב-positioning השתנו בהצעה הזו.
embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

מסכה שמציינת אילו מהשדות ב-embeddedObject השתנו בהצעה הזו.

PositionedObjectPositioningSuggestionState

מסכה שמציינת אילו מהשדות בבסיס PositionedObjectPositioning השתנו בהצעה הזו. לכל שדה שהוגדר כ-true, יש הצעה לערך חדש.

ייצוג ב-JSON 
{
  "layoutSuggested": boolean,
  "leftOffsetSuggested": boolean,
  "topOffsetSuggested": boolean
}
שדות
layoutSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-layout.
leftOffsetSuggested

boolean

מציין אם הייתה הצעה לשינוי ב-leftOffset.
topOffsetSuggested

boolean

שדה זה מציין אם הוצע שינוי ל-topOffset.

SuggestionsViewMode

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

טיפוסים בני מנייה (enum)
DEFAULT_FOR_CURRENT_ACCESS האפשרות SuggestionsViewMode שחלה על המסמך המוחזר תלויה ברמת הגישה הנוכחית של המשתמש. אם למשתמש יש רק הרשאת צפייה, המערכת מחילה את PREVIEW_WITHOUT_SUGGESTIONS. אחרת, מוחלת הערך SUGGESTIONS_INLINE. זהו מצב ברירת המחדל של תצוגת הצעות.
SUGGESTIONS_INLINE

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

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

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

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

שיטות

batchUpdate

 החלת עדכון אחד או יותר על המסמך.

create

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

get

 קבלת הגרסה האחרונה של המסמך שצוין.