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 או לא מוגדר, השדה הזה מכיל מידע על הכרטיסייה הראשונה במסמך.

Tab

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

ייצוג ב-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,
  "iconEmoji": string
}
שדות
tabId

string

המזהה הקבוע של הכרטיסייה.
title

string

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

string

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

integer

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

integer

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

string

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

אם האמוג'י לא תקין, מוחזרת שגיאת בקשה שגויה (400).

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

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

רכיב 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.
  • הסגנון של הטקסט normal text שנקרא סגנון יורש את סגנון ברירת המחדל של הטקסט בכלי לעריכת מסמכים.
  • ה-TextStyle ברכיב 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))

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

סוג

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

טיפוסים בני מנייה (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)

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

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

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

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

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

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 הפסקה מיושרת לתחילת השורה. מיושר לשמאל לטקסט משמאל לימין, מיושר לימין לכל שאר הטקסטים.
CENTER הפסקה מיושרת למרכז.
END הפסקה מיושרת לסוף השורה. מיושר לימין לטקסט משמאל לימין, מיושר לשמאל בכל מקרה אחר.
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.49 של Office Open XML File Formats - Fundamentals and Markup Language Reference, חלק 1 של ECMA-376 מהדורה 5.

טיפוסים בני מנייה (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.

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

object (Dimension)

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

object (Dimension)

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

object (Dimension)

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

object (Dimension)

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

enum (SectionType)

פלט בלבד. סוג האוסף.
defaultHeaderId

string

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

string

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

string

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

string

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

string

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

boolean

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

integer

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

boolean

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

כשמעדכנים את המאפיין הזה, צריך להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 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.60 של Office Open XML File Formats - Fundamentals and Markup Language Reference, חלק 1 של ECMA-376 מהדורה 5.

טיפוסים בני מנייה (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)

הגובה המינימלי של השורה. השורה תוצג בכלי לעריכת מסמכים בגובה ששווה לערך הזה או גדול ממנו, כדי שכל התוכן בתאי השורה יוצג.
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,
  "documentFormat": {
    object (DocumentFormat)
  }
}
שדות
background

object (Background)

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

string

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

string

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

string

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

string

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

string

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.

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

boolean

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.
useEvenPageHeaderFooter

boolean

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.
pageNumberStart

integer

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.
marginTop

object (Dimension)

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

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.
marginBottom

object (Dimension)

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

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.
marginRight

object (Dimension)

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

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.
marginLeft

object (Dimension)

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

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.
pageSize

object (Size)

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.
marginHeader

object (Dimension)

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.
flipPageOrientation

boolean

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

אם [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] הוא PAGELESS, המאפיין הזה לא יעבור עיבוד.
documentFormat

object (DocumentFormat)

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

רקע

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

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

object (OptionalColor)

צבע הרקע.

גודל

רוחב וגובה.

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

object (Dimension)

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

object (Dimension)

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

DocumentFormat

מייצג הגדרות פורמט ברמת המסמך.

ייצוג ב-JSON 
{
  "documentMode": enum (DocumentMode)
}
שדות
documentMode

enum (DocumentMode)

האם המסמך הוא עם דפים או ללא דפים.

DocumentMode

האם המסמך הוא עם דפים או ללא דפים.

טיפוסים בני מנייה (enum)
DOCUMENT_MODE_UNSPECIFIED מצב המסמך לא מוגדר.
PAGES למסמך יש דפים.
PAGELESS המסמך הוא ללא דפים.

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)

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

השדה הזה מסופק כדי להתאים את NamedStyleSuggestionState ל-NamedStyle המתאים.
textStyleSuggestionState

object (TextStyleSuggestionState)

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

object (ParagraphStyleSuggestionState)

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

רשימה

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

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

A.

B.

C.

פורמט הגליף יכול להכיל placeholders לרמת הקינון הנוכחית וגם placeholders לרמות הקינון של ההורה. לדוגמה, ברשימה יכול להיות גליף בפורמט %0. ברמת הקינון 0 וגליף בפורמט %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. סוג הגליף שמשמש לתבליטים. המאפיין הזה מגדיר את הגליף של התבליט שמחליף את ה-placeholder ב-glyph_format. הערך glyph_kind יכול להיות רק אחד מהבאים:
glyphType

enum (GlyphType)

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

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

string

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

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

BulletAlignment

סוגי היישור של תבליט.

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

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)

NamedRanges עם אותו שם.

NamedRange

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

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

טווח תאים בעל שם נוצר עם 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

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

boolean

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

boolean

מציין אם הייתה הצעה לשינוי של [שקיפות] [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

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

boolean

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

Methods

batchUpdate

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

create

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

get

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