REST Resource: documents

משאב: מסמך

מסמך ב-Google Docs.

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

string

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

string

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

object (Tab)

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

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

string

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

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

enum (SuggestionsViewMode)

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

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

object (Body)

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

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

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

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

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

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

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

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

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

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

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

object (DocumentStyle)

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

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

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

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

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

object (NamedStyles)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

כרטיסייה

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

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

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

object (TabProperties)

המאפיינים של הכרטיסייה, כמו ID ו-title.
childTabs[]

object (Tab)

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

object (DocumentTab)

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

TabProperties

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

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

string

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

string

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

string

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

integer

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

integer

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

DocumentTab

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

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

object (Body)

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

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

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

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

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

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

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

object (DocumentStyle)

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

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

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

object (NamedStyles)

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

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

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

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

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

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

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

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

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

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

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

גוף

גוף המסמך.

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

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

object (StructuralElement)

תוכן הגוף.

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

StructuralElement

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

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

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

integer

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

integer

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

object (Paragraph)

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

object (SectionBreak)

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

object (Table)

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

object (TableOfContents)

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

פסקה

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

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

object (ParagraphElement)

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

object (ParagraphStyle)

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

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

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

object (Bullet)

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

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

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

string

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

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

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

ParagraphElement

רכיב פסקה מתאר תוכן בתוך Paragraph.

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

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

integer

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

integer

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

object (TextRun)

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

object (AutoText)

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

object (PageBreak)

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

object (ColumnBreak)

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

object (FootnoteReference)

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

object (HorizontalRule)

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

object (Equation)

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

object (InlineObjectElement)

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

object (Person)

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

TextRun

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

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

string

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

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

string

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

string

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

object (TextStyle)

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

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

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

TextStyle

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

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

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

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

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

boolean

מציין אם הטקסט מודגש או לא.
italic

boolean

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

boolean

האם הטקסט מופיע עם קו תחתון או לא.
strikethrough

boolean

האם הטקסט מסומן בקו חוצה או לא.
smallCaps

boolean

האם הטקסט מופיע באותיות קטנות.
backgroundColor

object (OptionalColor)

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

object (OptionalColor)

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

object (Dimension)

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

object (WeightedFontFamily)

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

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

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

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

enum (BaselineOffset)

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

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

OptionalColor

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

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

object (Color)

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

צבע

צבע אחיד.

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

object (RgbColor)

ערך צבע ה-RGB.

RgbColor

צבע RGB.

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

number

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

number

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

number

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

מאפיין

עוצמת קול בכיוון אחד ביחידות שצוינו.

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

number

העוצמה.
unit

enum (Unit)

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

יחידה

יחידות מידה.

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

WeightedFontFamily

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

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

string

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

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

integer

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

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

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

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

BaselineOffset

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

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

SuggestedTextStyle

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

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

object (TextStyle)

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

object (TextStyleSuggestionState)

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

TextStyleSuggestionState

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

ייצוג JSON 
{
  "boldSuggested": boolean,
  "italicSuggested": boolean,
  "underlineSuggested": boolean,
  "strikethroughSuggested": boolean,
  "smallCapsSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "foregroundColorSuggested": boolean,
  "fontSizeSuggested": boolean,
  "weightedFontFamilySuggested": boolean,
  "baselineOffsetSuggested": boolean,
  "linkSuggested": boolean
}
שדות
boldSuggested

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

טקסט אוטומטי

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))

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

ColumnBreak

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

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

string

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

string

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

object (TextStyle)

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

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

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

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

FootnoteReference

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

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

string

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

string

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

string

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

string

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

object (TextStyle)

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

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

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

HorizontalRule

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

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

string

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

string

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

object (TextStyle)

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

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

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

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

משוואה

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

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

string

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

string

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

InlineObjectElement

ParagraphElement שמכיל InlineObject.

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

string

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

string

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

string

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

object (TextStyle)

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

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

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

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

אדם

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

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

string

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

string

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

string

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

object (TextStyle)

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

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

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

object (PersonProperties)

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

PersonProperties

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

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

string

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

string

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

RichLinkProperties

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

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

string

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

string

פלט בלבד. ה-URI ל-RichLink. השדה הזה תמיד קיים.
mimeType

string

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

ParagraphStyle

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

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

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

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

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

string

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

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

enum (NamedStyleType)

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

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

enum (Alignment)

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

number

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

enum (ContentDirection)

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

enum (SpacingMode)

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

object (Dimension)

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

object (Dimension)

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

object (ParagraphBorder)

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

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

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

object (ParagraphBorder)

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

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

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

object (ParagraphBorder)

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

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

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

object (ParagraphBorder)

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

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

object (ParagraphBorder)

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

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

object (Dimension)

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

object (Dimension)

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

object (Dimension)

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

object (TabStop)

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

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

boolean

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

boolean

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

boolean

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

object (Shading)

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

boolean

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

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

NamedStyleType

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

טיפוסים בני מנייה (enum)
NAMED_STYLE_TYPE_UNSPECIFIED הסוג של הסגנון המכונה לא צוין.
NORMAL_TEXT טקסט רגיל.
TITLE שם.
SUBTITLE כתובית.
HEADING_1 כותרת 1.
HEADING_2 כותרת 2.
HEADING_3 כותרת 3.
HEADING_4 כותרת 4.
HEADING_5 כותרת 5.
HEADING_6 כותרת 6.

יישור

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

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

ContentDirection

התוכן של המסלול יכול לזרום.

טיפוסים בני מנייה (enum)
CONTENT_DIRECTION_UNSPECIFIED לא צוינה כיוון התוכן.
LEFT_TO_RIGHT התוכן מופיע משמאל לימין.
RIGHT_TO_LEFT התוכן עובר מימין לשמאל.

SpacingMode

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

טיפוסים בני מנייה (enum)
SPACING_MODE_UNSPECIFIED מצב הריווח עובר בירושה מהתבנית הראשית.
NEVER_COLLAPSE הריווח של הפסקאות תמיד מוצג.
COLLAPSE_LISTS הריווח בין הפריטים ברשימה לא חל על הריווח בין הפסקים.

ParagraphBorder

שוליים סביב פסקה.

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

object (OptionalColor)

צבע הגבול.
width

object (Dimension)

רוחב הגבול.
padding

object (Dimension)

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

enum (DashStyle)

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

DashStyle

סוגי המקפים שאפשר להשתמש בהם כדי ליצור גיאומטריה לינארית. הערכים האלה מבוססים על הסוג הפשוט ST_PresetLineDashVal שמתואר בקטע 20.1.10.48 במאמר 'פורמטים של קובצי Office Open XML – עקרונות בסיסיים ומסמך עזר בנושא שפת ה-Markup', חלק 1 של ECMA-376 מהדורה 4.

טיפוסים בני מנייה (enum)
DASH_STYLE_UNSPECIFIED סגנון המקף לא צוין.
SOLID קו רצוף. תואם לערך 'solid' ב-ECMA-376 ST_PresetLineDashVal. זהו סגנון הקו המקווקו שמוגדר כברירת מחדל.
DOT קו מקווקו. תואם לערך 'dot' של ECMA-376 ST_PresetLineDashVal.
DASH קו מקווקו. תואם לערך 'dash' ב-ECMA-376 ST_PresetLineDashVal.

TabStop

ערך תצוגה של תצוגת טאב בתוך פסקה.

ייצוג JSON 
{
  "offset": {
    object (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}
שדות
offset

object (Dimension)

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

enum (TabStopAlignment)

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

TabStopAlignment

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

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

הצללה

את ההצללה של פסקה.

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

object (OptionalColor)

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

SuggestedParagraphStyle

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

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

object (ParagraphStyle)

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

object (ParagraphStyleSuggestionState)

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

ParagraphStyleSuggestionState

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

ייצוג JSON 
{
  "headingIdSuggested": boolean,
  "namedStyleTypeSuggested": boolean,
  "alignmentSuggested": boolean,
  "lineSpacingSuggested": boolean,
  "directionSuggested": boolean,
  "spacingModeSuggested": boolean,
  "spaceAboveSuggested": boolean,
  "spaceBelowSuggested": boolean,
  "borderBetweenSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "indentEndSuggested": boolean,
  "keepLinesTogetherSuggested": boolean,
  "keepWithNextSuggested": boolean,
  "avoidWidowAndOrphanSuggested": boolean,
  "shadingSuggestionState": {
    object (ShadingSuggestionState)
  },
  "pageBreakBeforeSuggested": boolean
}
שדות
headingIdSuggested

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

object (ShadingSuggestionState)

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

boolean

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

ShadingSuggestionState

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

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

boolean

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

תבליט

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

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

string

המזהה של הרשימה שאליה שייכת הפיסקה הזו.
nestingLevel

integer

רמת הסידור הפנימי של הפסקה הזו ברשימה.
textStyle

object (TextStyle)

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

SuggestedBullet

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

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

object (Bullet)

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

object (BulletSuggestionState)

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

BulletSuggestionState

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

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

boolean

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

boolean

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

object (TextStyleSuggestionState)

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

ObjectReferences

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

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

string

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

SectionBreak

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

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

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

string

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

string

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

object (SectionStyle)

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

SectionStyle

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

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

object (SectionColumnProperties)

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

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

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

enum (ColumnSeparatorStyle)

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

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

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

enum (ContentDirection)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

enum (SectionType)

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

string

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

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

string

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

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

string

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

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

string

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

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

string

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

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

boolean

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

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

integer

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

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

boolean

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

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

SectionColumnProperties

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

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

object (Dimension)

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

object (Dimension)

המרווח הפנימי בסוף העמודה.

ColumnSeparatorStyle

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

טיפוסים בני מנייה (enum)
COLUMN_SEPARATOR_STYLE_UNSPECIFIED סגנון מפריד עמודות לא צוין.
NONE אין קווים מפרידים בין העמודות.
BETWEEN_EACH_COLUMN הפונקציה יוצרת קו מפריד בין עמודות.

SectionType

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

טיפוסים בני מנייה (enum)
SECTION_TYPE_UNSPECIFIED סוג הקטע לא צוין.
CONTINUOUS הקטע מתחיל מיד אחרי הפסקה האחרונה בקטע הקודם.
NEXT_PAGE הקטע יתחיל בדף הבא.

טבלה

StructuralElement שמייצג טבלה.

ייצוג JSON 
{
  "rows": integer,
  "columns": integer,
  "tableRows": [
    {
      object (TableRow)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableStyle": {
    object (TableStyle)
  }
}
שדות
rows

integer

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

integer

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

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

object (TableRow)

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

string

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

string

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

object (TableStyle)

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

TableRow

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

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

integer

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

integer

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

object (TableCell)

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

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

string

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

string

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

object (TableRowStyle)

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

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

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

TableCell

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

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

integer

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

integer

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

object (StructuralElement)

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

object (TableCellStyle)

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

string

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

string

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

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

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

TableCellStyle

הסגנון של TableCell.

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

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

integer

טווח השורה של התא.

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

integer

היקף העמודות של התא.

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

object (OptionalColor)

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

object (TableCellBorder)

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

object (TableCellBorder)

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

object (TableCellBorder)

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

object (TableCellBorder)

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

object (Dimension)

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

object (Dimension)

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

object (Dimension)

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

object (Dimension)

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

enum (ContentAlignment)

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

TableCellBorder

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

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

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

object (OptionalColor)

צבע הגבול.

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

object (Dimension)

רוחב הגבול.
dashStyle

enum (DashStyle)

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

ContentAlignment

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

נגזר מקבוצת משנה של הערכים של הסוג הפשוט ST_TextAnchoringType בקטע 20.1.10.59 במאמר 'פורמטים של קובצי Office Open XML – עקרונות בסיסיים ומסמך עזר לשפת ה-Markup', חלק 1 של ECMA-376 מהדורה רביעית.

טיפוסים בני מנייה (enum)
CONTENT_ALIGNMENT_UNSPECIFIED התאמת תוכן שלא צוינה. התאמת התוכן עוברת בירושה מתבנית ההורה, אם יש כזו.
CONTENT_ALIGNMENT_UNSUPPORTED יישור תוכן שלא נתמך.
TOP התאמה שממקמת את התוכן בחלק העליון של מיקום התוכן. תואם ל-ECMA-376 ST_TextAnchoringType 't'.
MIDDLE יישור שמיישר את התוכן לאמצע התוכן. תואם ל-ECMA-376 ST_TextTextingType 'ctr'.
BOTTOM יישור שמיישר את התוכן לתחתית של בעלי התוכן. תואם ל-ECMA-376 ST_TextAnchoringType 'b'.

SuggestedTableCellStyle

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

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

object (TableCellStyle)

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

object (TableCellStyleSuggestionState)

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

TableCellStyleSuggestionState

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

ייצוג JSON 
{
  "rowSpanSuggested": boolean,
  "columnSpanSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "paddingLeftSuggested": boolean,
  "paddingRightSuggested": boolean,
  "paddingTopSuggested": boolean,
  "paddingBottomSuggested": boolean,
  "contentAlignmentSuggested": boolean
}
שדות
rowSpanSuggested

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

TableRowStyle

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

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

object (Dimension)

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

boolean

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

boolean

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

SuggestedTableRowStyle

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

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

object (TableRowStyle)

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

object (TableRowStyleSuggestionState)

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

TableRowStyleSuggestionState

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

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

boolean

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

TableStyle

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

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

object (TableColumnProperties)

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

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

TableColumnProperties

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

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

enum (WidthType)

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

object (Dimension)

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

WidthType

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

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

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

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

TableOfContents

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

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

object (StructuralElement)

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

string

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

string

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

הערת שוליים

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

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

string

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

object (StructuralElement)

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

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

DocumentStyle

סגנון המסמך.

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

object (Background)

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

string

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

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

string

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

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

string

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

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

string

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

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

string

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

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

boolean

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

boolean

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

integer

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Size)

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

object (Dimension)

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

boolean

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

רקע

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

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

object (OptionalColor)

צבע הרקע.

גודל

רוחב וגובה.

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

object (Dimension)

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

object (Dimension)

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

SuggestedDocumentStyle

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

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

object (DocumentStyle)

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

object (DocumentStyleSuggestionState)

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

DocumentStyleSuggestionState

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

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

object (BackgroundSuggestionState)

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

object (SizeSuggestionState)

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

boolean

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

boolean

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

BackgroundSuggestionState

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

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

boolean

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

SizeSuggestionState

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

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

boolean

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

boolean

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

NamedStyles

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

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

object (NamedStyle)

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

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

NamedStyle

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

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

enum (NamedStyleType)

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

object (TextStyle)

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

object (ParagraphStyle)

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

SuggestedNamedStyles

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

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

object (NamedStyles)

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

object (NamedStylesSuggestionState)

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

NamedStylesSuggestionState

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

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

object (NamedStyleSuggestionState)

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

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

NamedStyleSuggestionState

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

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

enum (NamedStyleType)

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

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

object (TextStyleSuggestionState)

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

object (ParagraphStyleSuggestionState)

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

רשימה

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

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

object (ListProperties)

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

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

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

string

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

string

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

ListProperties

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

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

object (NestingLevel)

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

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

NestingLevel

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

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

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

enum (BulletAlignment)

היישור של התג בתוך המרחב שהוקצה לצורך רינדור התג.
glyphFormat

string

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

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

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

A.

B.

C.

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

1.

2.

2.1.

2.2.

3.

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

object (Dimension)

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

object (Dimension)

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

object (TextStyle)

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

integer

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

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

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

enum (GlyphType)

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

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

string

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

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

BulletAlignment

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

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

GlyphType

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

טיפוסים בני מנייה (enum)
GLYPH_TYPE_UNSPECIFIED סוג הגליף לא צוין או שאין בו תמיכה.
NONE מחרוזת ריקה.
DECIMAL מספר, למשל 1, 2 או 3.
ZERO_DECIMAL מספר שבו ספרות בודדות מתחילות באפס, כמו 01,‏ 02 או 03. מספרים עם יותר מספרה אחת לא מתחילים בספרה אפס.
UPPER_ALPHA אות גדולה, כמו A, B או C.
ALPHA אות קטנה, כמו a, b או c.
UPPER_ROMAN ספרה רומית באותיות גדולות, כמו I,‏ II או III.
ROMAN ספרה רומית קטנה, כמו i,‏ ii או iii.

SuggestedListProperties

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

ייצוג JSON 
{
  "listProperties": {
    object (ListProperties)
  },
  "listPropertiesSuggestionState": {
    object (ListPropertiesSuggestionState)
  }
}
שדות
listProperties

object (ListProperties)

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

object (ListPropertiesSuggestionState)

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

ListPropertiesSuggestionState

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

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

object (NestingLevelSuggestionState)

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

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

NestingLevelSuggestionState

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

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

object (TextStyleSuggestionState)

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

boolean

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

NamedRanges

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

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

string

השם הזה משותף לכל named ranges.
namedRanges[]

object (NamedRange)

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

NamedRange

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

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

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

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

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

string

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

string

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

object (Range)

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

טווח

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

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

string

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

integer

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

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

integer

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

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

string

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

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

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

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

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

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

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

InlineObject

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

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

string

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

object (InlineObjectProperties)

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

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

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

string

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

string

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

InlineObjectProperties

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

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

object (EmbeddedObject)

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

EmbeddedObject

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

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

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

string

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

string

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

object (EmbeddedObjectBorder)

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

object (Size)

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

object (Dimension)

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

object (Dimension)

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

object (Dimension)

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

object (Dimension)

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

object (LinkedContentReference)

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

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

object (EmbeddedDrawingProperties)

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

object (ImageProperties)

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

EmbeddedDrawingProperties

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

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

ImageProperties

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

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

string

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

string

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

number

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

number

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

number

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

object (CropProperties)

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

number

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

CropProperties

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

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

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

number

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

number

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

number

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

number

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

number

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

EmbeddedObjectBorder

גבול סביב EmbeddedObject.

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

object (OptionalColor)

צבע הגבול.
width

object (Dimension)

רוחב הגבול.
dashStyle

enum (DashStyle)

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

enum (PropertyState)

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

PropertyState

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

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

LinkedContentReference

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

ייצוג ב-JSON 
{

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

object (SheetsChartReference)

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

SheetsChartReference

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

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

string

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

integer

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

SuggestedInlineObjectProperties

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

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

object (InlineObjectProperties)

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

object (InlineObjectPropertiesSuggestionState)

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

InlineObjectPropertiesSuggestionState

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

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

object (EmbeddedObjectSuggestionState)

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

EmbeddedObjectSuggestionState

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

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

object (EmbeddedDrawingPropertiesSuggestionState)

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

object (ImagePropertiesSuggestionState)

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

boolean

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

boolean

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

object (EmbeddedObjectBorderSuggestionState)

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

object (SizeSuggestionState)

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

boolean

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

boolean

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

boolean

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

boolean

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

object (LinkedContentReferenceSuggestionState)

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

EmbeddedDrawingPropertiesSuggestionState

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

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

ImagePropertiesSuggestionState

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

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

object (CropPropertiesSuggestionState)

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

boolean

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

CropPropertiesSuggestionState

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

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

EmbeddedObjectBorderSuggestionState

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

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

boolean

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

boolean

שדה זה מציין אם הוצע שינוי ב-[width] [google.apps.docs.v1.EmbeddedBorderObject.width].
dashStyleSuggested

boolean

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

boolean

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

LinkedContentReferenceSuggestionState

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

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

object (SheetsChartReferenceSuggestionState)

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

SheetsChartReferenceSuggestionState

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

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

boolean

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

boolean

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

PositionedObject

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

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

string

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

object (PositionedObjectProperties)

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

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

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

string

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

string

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

PositionedObjectProperties

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

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

object (PositionedObjectPositioning)

המיקום של האובייקט המוצב ביחס לשורה החדשה של Paragraph שמפנה לאובייקט המוצב.
embeddedObject

object (EmbeddedObject)

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

PositionedObjectPositioning

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

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

enum (PositionedObjectLayout)

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

object (Dimension)

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

object (Dimension)

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

PositionedObjectLayout

הפריסות האפשריות של [PositionedObject][google.aps.docs.v1.PositionedObject].

טיפוסים בני מנייה (enum)
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED הפריסה לא צוינה.
WRAP_TEXT הטקסט גולש מסביב לאובייקט שממוקם.
BREAK_LEFT שבירת הטקסט היא שהאובייקט שממוקם בצד שמאל והטקסט בצד ימין.
BREAK_RIGHT שבירת הטקסט היא שהאובייקט שממוקם בצד ימין והטקסט נמצא בצד שמאל.
BREAK_LEFT_RIGHT שבירה את הטקסט כך שאין טקסט בצד שמאל או מימין לאובייקט שממוקם.
IN_FRONT_OF_TEXT האובייקט הממוקם נמצא לפני הטקסט.
BEHIND_TEXT האובייקט המוצב נמצא מאחורי הטקסט.

SuggestedPositionedObjectProperties

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

ייצוג ב-JSON 
{
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "positionedObjectPropertiesSuggestionState": {
    object (PositionedObjectPropertiesSuggestionState)
  }
}
שדות
positionedObjectProperties

object (PositionedObjectProperties)

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

object (PositionedObjectPropertiesSuggestionState)

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

PositionedObjectPropertiesSuggestionState

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

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

object (PositionedObjectPositioningSuggestionState)

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

object (EmbeddedObjectSuggestionState)

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

PositionedObjectPositioningSuggestionState

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

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

boolean

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

boolean

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

boolean

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

SuggestionsViewMode

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

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

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

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

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

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

שיטות

batchUpdate

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

create

 יצירת מסמך ריק לפי הכותרת שמופיעה בבקשה.

get

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