REST Resource: documents

משאב: מסמך

מסמך ב-Google Docs.

ייצוג ב-JSON 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "commentsViewMode": enum (CommentsViewMode),
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "suggestions": [
    {
      object (SuggestionThread)
    }
  ],
  "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.
commentsViewMode

enum (CommentsViewMode)

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

object (CommentThread)

פלט בלבד. התגובות שמשויכות למסמך. הפרמטר הזה מאוכלס רק אם הפרמטר commentsViewMode מוגדר לדרוש תגובות (למשל COMMENTS_VIEW_MODE_INCLUDED).
suggestions[]

object (SuggestionThread)

פלט בלבד. ההצעות שמשויכות למסמך. הפרמטר הזה מאוכלס רק אם הפרמטר commentsViewMode מוגדר לדרוש תגובות (למשל COMMENTS_VIEW_MODE_INCLUDED).
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)
    }
  ],

  "documentTab": {
    object (DocumentTab)
  }
}
שדות
tabProperties

object (TabProperties)

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

object (Tab)

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

האינדקס של הכרטיסייה בתוך רכיב ההורה, כשהספירה מתחילה מ-0.
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)
    },
    ...
  },
  "commentAnchors": {
    string: {
      object (CommentAnchor)
    },
    ...
  }
}
שדות
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))

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

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

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

גוף

גוף המסמך.

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

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

object (StructuralElement)

התוכן של גוף ההודעה.

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

StructuralElement

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

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

  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
}
שדות
startIndex

integer

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

integer

אינדקס הסיום של הרכיב המבני הזה, לא כולל, ביחידות קוד UTF-16.
התוכן של רכיב המבנה. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
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,

  "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)
  },
  "dateElement": {
    object (DateElement)
  }
}
שדות
startIndex

integer

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

integer

אינדקס הסיום של רכיב הפסקה הזה, לא כולל, ביחידות קוד UTF-16.
התוכן של רכיב הפיסקה. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
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)

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

object (DateElement)

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

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

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

ייצוג ב-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)

סגנון הטקסט של ההפניה להערת השוליים.
suggestedTextStyleChanges

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

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

HorizontalRule

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

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

string

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

string

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

object (TextStyle)

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

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

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

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

משוואה

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

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

string

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

string

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

InlineObjectElement

ParagraphElement שמכיל InlineObject.

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

string

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

string

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

string

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

object (TextStyle)

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

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

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

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

אדם

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

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

string

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

string

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

string

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

object (TextStyle)

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

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

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

object (PersonProperties)

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

PersonProperties

מאפיינים שספציפיים ל-Person מקושר.

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

string

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

string

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

RichLinkProperties

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

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

string

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

string

ה-URI של RichLink. היא תמיד קיימת.
mimeType

string

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

DateElement

מופע של תאריך שמוזכר במסמך.

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

string

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

string

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

string

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

object (TextStyle)

סגנון הטקסט של רכיב התאריך הזה.
suggestedTextStyleChanges

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

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

object (DateElementProperties)

המאפיינים של DateElement הזה.
suggestedDateElementPropertiesChanges

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

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

DateElementProperties

מאפיינים של DateElement.

ייצוג ב-JSON 
{
  "timestamp": string,
  "timeZoneId": string,
  "locale": string,
  "dateFormat": enum (DateFormat),
  "timeFormat": enum (TimeFormat),
  "displayText": string
}
שדות
timestamp

string (Timestamp format)

הנקודה בזמן שרוצים לייצג, בשניות ובננו-שניות מאז ראשית זמן יוניקס: 1 בינואר 1970 בחצות לפי שעון UTC.

חותמת הזמן צריכה להיות לפי שעון UTC. אם המאפיין timeZoneId מוגדר, חותמת הזמן מותאמת לפי אזור הזמן. לדוגמה, חותמת זמן 18000 עם פורמט תאריך DATE_FORMAT_ISO8601 ופורמט שעה TIME_FORMAT_HOUR_MINUTE תוצג כ-1970-01-01 5:00 AM. חותמת זמן של 18000 עם פורמט תאריך של DATE_FORMAT_ISO8601, פורמט שעה של TIME_FORMAT_HOUR_MINUTE ואזור זמן שמוגדר ל-America/New_York תהיה במקום זאת 1970-01-01 12:00 AM.
timeZoneId

string

אזור הזמן של DateElement, כפי שמוגדר בפרויקט Unicode Common Locale Data Repository‏ (CLDR). לדוגמה, America/New_York. אם לא מוגדר אזור זמן, ברירת המחדל היא etc/UTC.
locale

string

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

מוגבל לאזורים הבאים: af, am, ar, as, az, be, bg, bn, ca, cs, da, de, el, en, en-CA, en-GB, es, es-419, et, eu, fa, fi, fil, fr, fr-CA, gl, gu, hi, hr, hu, hy, id, is, it, iw, ja, ka, kk, km, kn, ko, lo, lt, lv, mk, ml, mn, mr, ms, ne, nl, no, or, pa, pl, pt-BR, pt-PT, ro, ru, si, sk, sl, sq, sr, sv, sw, ta, te, th, tr, uk, ur, uz, vi, zh-CN, zh-HK, zh-TW, zu, cy, my.
dateFormat

enum (DateFormat)

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

אם לא מציינים ערך, ערך ברירת המחדל הוא DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, כלומר DateElement יפורמט כ-MMM d, y בחודש en, או כערך מקביל בהתאם ללוקאל.
timeFormat

enum (TimeFormat)

קובע איך חלק השעה של DateElement יוצג במסמך.

אם לא מגדירים את הערך, ברירת המחדל היא TIME_FORMAT_DISABLED, כלומר לא יוצג זמן.
displayText

string

פלט בלבד. מציין איך רכיב DateElement מוצג במסמך.

DateFormat

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

טיפוסים בני מנייה (enum)
DATE_FORMAT_UNSPECIFIED פורמט התאריך לא צוין.
DATE_FORMAT_CUSTOM פלט בלבד. פורמט התאריך מיובא ממקור חיצוני.
DATE_FORMAT_MONTH_DAY_ABBREVIATED פורמט התאריך הוא חודש מקוצר ואחריו היום. לדוגמה, 'Jan 1'.
DATE_FORMAT_MONTH_DAY_FULL פורמט התאריך הוא חודש ואחריו היום. לדוגמה, 'ינואר 01'.
DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED פורמט התאריך הוא חודש מקוצר, ואחריו היום והשנה. לדוגמה, '1 בינואר 1970'.
DATE_FORMAT_ISO8601 פורמט התאריך הוא ISO 8601. לדוגמה, '1970-01-01'.

TimeFormat

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

טיפוסים בני מנייה (enum)
TIME_FORMAT_UNSPECIFIED פורמט השעה לא צוין.
TIME_FORMAT_DISABLED מציין שלתאריך אין שעה.
TIME_FORMAT_HOUR_MINUTE פורמט הזמן מראה את השעה והדקה. לדוגמה, ‎'Jan 1, 1970 12:00 PM'.
TIME_FORMAT_HOUR_MINUTE_TIMEZONE פורמט הזמן מציג את השעה, הדקה ואזור הזמן. לדוגמה, ‎"Jan 1, 1970 12:00 PM UTC"‎.

SuggestedDateElementProperties

הצעה לשינוי בDateElementProperties.

ייצוג ב-JSON 
{
  "dateElementProperties": {
    object (DateElementProperties)
  },
  "dateElementPropertiesSuggestionState": {
    object (DateElementPropertiesSuggestionState)
  }
}
שדות
dateElementProperties

object (DateElementProperties)

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

object (DateElementPropertiesSuggestionState)

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

DateElementPropertiesSuggestionState

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

ייצוג ב-JSON 
{
  "timestampSuggested": boolean,
  "timeZoneIdSuggested": boolean,
  "localeSuggested": boolean,
  "dateFormatSuggested": boolean,
  "timeFormatSuggested": boolean
}
שדות
timestampSuggested

boolean

מציין אם הוצע שינוי ב-timestamp.
timeZoneIdSuggested

boolean

מציין אם הוצע שינוי ב-timeZoneId.
localeSuggested

boolean

מציין אם הוצע שינוי ב-locale.
dateFormatSuggested

boolean

מציין אם הוצע שינוי ב-dateFormat.
timeFormatSuggested

boolean

מציין אם הוצע שינוי ב-timeFormat.

ParagraphStyle

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

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

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

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

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

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

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

enum (SectionType)

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

string

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

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

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

string

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

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

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

string

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

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

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

string

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

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

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

string

המזהה של הכותרת התחתונה שמשמשת רק בדפים זוגיים. אם הערך של useEvenPageHeaderFooter ב-DocumentStyle הוא true, הערך הזה משמש לכותרות התחתונות בדפים הזוגיים בקטע. אם הערך הוא false, הכותרות התחתונות בדפים הזוגיים משתמשות ב-defaultFooterId. אם לא מציינים ערך, הערך עובר בירושה מ-SectionBreak's SectionStyle הקודם. אם הערך לא מוגדר ב-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)

מסכה שמציינת אילו מהשדות ב[גודל] [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,

  "glyphType": enum (GlyphType),
  "glyphSymbol": string
}
שדות
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 בהתאמה.

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

enum (GlyphType)

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

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

string

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

סמל הגליף מחליף את ה-placeholders בתוך 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

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

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

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

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

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

string

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

string

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

object (Range)

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

טווח

מציין טווח רציף של טקסט.

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

string

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

integer

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

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

integer

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

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

string

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

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

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

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

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

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

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

InlineObject

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

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

string

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

object (InlineObjectProperties)

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

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

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

string

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

string

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

InlineObjectProperties

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

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

object (EmbeddedObject)

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

EmbeddedObject

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

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

  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
}
שדות
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.

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

  "sheetsChartReference": {
    object (SheetsChartReference)
  }
}
שדות
קובץ העזר שספציפי לסוג התוכן המקושר. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
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

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

boolean

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

boolean

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

LinkedContentReferenceSuggestionState

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

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

object (SheetsChartReferenceSuggestionState)

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

SheetsChartReferenceSuggestionState

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

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

boolean

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

boolean

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

PositionedObject

אובייקט שמחובר ל-Paragraph וממוקם ביחס לתחילת הפסקה. ‫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.

CommentAnchor

מיקום אחד או יותר במסמך מקושרים ל-CommentThreads עם אותו anchorId. הערה: יכול להיות שכמה עוגנים יפנו לאותו מיקום.

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

string

המזהה של נקודת העיגון של התגובה.
ranges[]

object (Range)

אוסף של Ranges במסמך שמקושרים לעוגן הזה.

SuggestionsViewMode

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

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

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

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

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

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

CommentsViewMode

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

אם מגדירים ל-commentsViewMode ערך כלשהו, צריך להגדיר ל-includeTabsContent גם את הערך true או להשתמש במסכת שדות שמפנה לשדה Document.tabs (או לכל שדה משנה).

אפשר להחזיר תגובות רק אם ההצעות מוחזרות בתוך השורה. אם מגדירים את commentsViewMode לערך COMMENTS_VIEW_MODE_INCLUDED או COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS, אפשר להגדיר את suggestionsViewMode רק לערך PREVIEW_WITHOUT_SUGGESTIONS או PREVIEW_SUGGESTIONS_ACCEPTED.

טיפוסים בני מנייה (enum)
COMMENTS_VIEW_MODE_UNSPECIFIED המאפיין CommentsViewMode לא מוגדר. תופעל רזולוציה של COMMENTS_VIEW_MODE_OMITTED.
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS הערך של CommentsViewMode שמוחל על המסמך שמוחזר תלוי ברמת הגישה הנוכחית של המשתמש. אם למשתמש יש גישת צפייה בלבד, התוצאה היא COMMENTS_VIEW_MODE_OMITTED. אחרת, תופעל רזולוציה של COMMENTS_VIEW_MODE_INCLUDED.
COMMENTS_VIEW_MODE_OMITTED המסמך שמוחזר לא כולל תגובות.
COMMENTS_VIEW_MODE_INCLUDED

המסמך שמוחזר כולל תגובות.

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

אם מגדירים את המדיניות הזו, חובה להגדיר גם את suggestionsViewMode לערך SUGGESTIONS_INLINE. אחרת, מחזירה שגיאת בקשה שגויה (400).

CommentThread

מייצג שרשור תגובות יחיד.

ייצוג ב-JSON 
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
שדות
commentId

string

המזהה הייחודי של שרשור התגובות.
anchorId

string

המזהה של CommentAnchor במסמך שהשרשור הזה קשור אליו. יכול להיות שכמה שרשורי תגובות יהיו מקושרים לאותו CommentAnchor.
headPost

object (Post)

הפוסט הראשון בשרשור.
replies[]

object (Post)

תשובות לפוסט הראשי.
status

enum (Status)

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

string

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

פרסום

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

ייצוג ב-JSON 
{
  "postId": string,
  "content": string,
  "contentHtml": string,
  "author": {
    object (PostAuthor)
  },
  "createTime": string,
  "updateTime": string,
  "deleted": boolean,
  "fromImportedDocument": boolean,
  "fromCopiedDocument": boolean,
  "fromDocumentComparison": boolean,
  "assigneeEmail": string,

  "commentAction": enum (CommentActionType),
  "suggestionAction": enum (SuggestionActionType)
}
שדות
postId

string

פלט בלבד. המזהה הייחודי של הפוסט.
content

string

תוכן הפוסט.

חובה להזין ערך אם הערך של commentAction הוא לא RESOLVE או REOPEN.

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

הערך לא יכול לכלול יותר מ-2,048 יחידות קוד UTF-8.
contentHtml

string

פלט בלבד. התוכן של הפוסט בפורמט HTML.
author

object (PostAuthor)

פלט בלבד. המשתמש שיצר את הפוסט.
createTime

string (Timestamp format)

פלט בלבד. השעה שבה נוצר הפוסט.
updateTime

string (Timestamp format)

פלט בלבד. השעה שבה הפוסט עודכן לאחרונה.
deleted

boolean

פלט בלבד. אם הפוסט נמחק. אם השדות true, content ו-author יהיו ריקים.
fromImportedDocument

boolean

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

boolean

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

boolean

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

string

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

הפונקציה מחזירה שגיאת בקשה שגויה (400) אם:

  • השרשור הראשי הוא CommentThread של headPost שלא הוקצה לו אחראי.

  • השרשור הראשי הוא SuggestionThread.

  • ‫commentAction מצוין כ-RESOLVE או כ-REOPEN.

  • הערך assigneeEmail חורג מ-2,048 יחידות קוד UTF-8.
פעולה שבוצעה כחלק מיצירת הפוסט. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
commentAction

enum (CommentActionType)

אופציונלי. סוג הפעולה של פרסום תגובה.
suggestionAction

enum (SuggestionActionType)

פלט בלבד. סוג הפעולה של פוסטים עם הצעות.
סוף השדות הבלעדיים.

PostAuthor

מייצג משתמש שכתב תגובה או פוסט עם הצעה.

ייצוג ב-JSON 
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
שדות
displayName

string

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

boolean

האם המשתמש הוא המשתמש המאומת שמגיש את הבקשה.
anonymous

boolean

האם המשתמש אנונימי.
user

string

שם המשאב של המשתמש שכתב את הפוסט, שאפשר להשתמש בו גם כדי לזהות את המשתמש ב-Google People API. פורמט: users/{user} השדה לא יאוכלס אם השדה anonymous הוא true או אם הפוסט הוא ממסמך מיובא.

CommentActionType

הפעולה שבוצעה בתשובה הזו לשרשור תגובות.

טיפוסים בני מנייה (enum)
COMMENT_ACTION_TYPE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
NO_COMMENT_ACTION_CHANGE אין שינוי בפעולה בפוסט הזה.
RESOLVE הפוסט הזה פותר את הבעיה שמופיעה בשרשור.
REOPEN הפוסט הזה פותח מחדש את השרשור.

SuggestionActionType

הפעולה שננקטה בתשובה הזו לשרשור של הצעות.

טיפוסים בני מנייה (enum)
SUGGESTION_ACTION_TYPE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
NO_SUGGESTION_ACTION_CHANGE אין שינוי בפעולה בפוסט הזה.
ACCEPT הפוסט הזה מאשר את ההצעה.
REJECT הפוסט הזה דוחה את ההצעה.

סטטוס

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

טיפוסים בני מנייה (enum)
STATUS_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
OPEN שרשור התגובות פתוח.
RESOLVED הבעיה בשרשור התגובות נפתרה.

SuggestionThread

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

ייצוג ב-JSON 
{
  "suggestionId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),
  "summaryText": string,
  "summaryHtml": string
}
שדות
suggestionId

string

המזהה הייחודי של ההצעה.
headPost

object (Post)

הפוסט הראשון בשרשור.
replies[]

object (Post)

תשובות לפוסט הראשי.
status

enum (Status)

האם השרשור פתוח, אושר או נדחה.
summaryText

string

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

string

סיכום של ההבדלים המוצעים במסמך, ב-HTML. יכול להיות ריק.

סטטוס

אפשרויות הסטטוס של שרשור ההצעה.

טיפוסים בני מנייה (enum)
STATUS_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
OPEN שרשור ההצעות פתוח.
ACCEPTED ההצעה אושרה.
REJECTED ההצעה נדחתה.

Methods

batchUpdate

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

create

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

get

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