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.child_tabs.

revisionId

string

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

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

suggestionsViewMode

enum (SuggestionsViewMode)

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

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

body

object (Body)

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

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

headers

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

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

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

footers

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

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

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

footnotes

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

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

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

documentStyle

object (DocumentStyle)

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

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

suggestedDocumentStyleChanges

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

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

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

namedStyles

object (NamedStyles)

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

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

suggestedNamedStylesChanges

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

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

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

lists

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

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

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

namedRanges

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

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

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

inlineObjects

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

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

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

positionedObjects

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

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

השדה 'מדור קודם': במקום זאת, צריך להשתמש ב-Document.tabs.document_tab.positioned_objects, שחושף את תוכן המסמך עצמו מכל הכרטיסיות כשהפרמטר 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

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

ייצוג 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 של הטקסט ב-Paragraph יורש מה-named style type התואם בפסקה.
  • TextStyle ב-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.

AutoText

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

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

enum (Type)

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

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

textStyle

object (TextStyle)

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

suggestedTextStyleChanges

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

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

סוג

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

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

PageBreak

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

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

string

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

suggestedDeletionIds[]

string

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

textStyle

object (TextStyle)

סגנון הטקסט של מעבר הדף הזה.

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

suggestedTextStyleChanges

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

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

ColumnBreak

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

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

string

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

suggestedDeletionIds[]

string

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

textStyle

object (TextStyle)

סגנון הטקסט של מעבר העמודות הזה.

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

suggestedTextStyleChanges

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

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

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

סגנון פסקה

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

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

  • סגנון הפיסקה ב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)

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

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

alignment

enum (Alignment)

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

lineSpacing

number

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

direction

enum (ContentDirection)

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

spacingMode

enum (SpacingMode)

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

spaceAbove

object (Dimension)

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

spaceBelow

object (Dimension)

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

borderBetween

object (ParagraphBorder)

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

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

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

borderTop

object (ParagraphBorder)

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

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

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

borderBottom

object (ParagraphBorder)

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

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

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

borderLeft

object (ParagraphBorder)

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

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

borderRight

object (ParagraphBorder)

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

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

indentFirstLine

object (Dimension)

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

indentStart

object (Dimension)

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

indentEnd

object (Dimension)

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

tabStops[]

object (TabStop)

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

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

keepLinesTogether

boolean

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

keepWithNext

boolean

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

avoidWidowAndOrphan

boolean

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

shading

object (Shading)

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

pageBreakBefore

boolean

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

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

NamedStyleType

סוגי הסגנונות של הסגנונות.

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

יישור

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

טיפוסים בני מנייה (enum)
ALIGNMENT_UNSPECIFIED היישור בין הפסקאות עובר בירושה מתבנית ההורה.
START הפסקה מיושרת לתחילת השורה. יישור לשמאל לטקסט 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 של "פורמטים של קובצי XML פתוחים ל-Office - יסודות ושפת הסימון", חלק 1 של ECMA-376 מהדורה רביעית.

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

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

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

firstPageHeaderId

string

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

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

evenPageHeaderId

string

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

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

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_TextDescriptioningType" הקלדה פשוטה בסעיף 20.1.10.59 של "Office Open XML File Formats - Fundamentals and Markup Language Reference", חלק 1 של ECMA-376 מהדורת 4th.

טיפוסים בני מנייה (enum)
CONTENT_ALIGNMENT_UNSPECIFIED התאמת תוכן שלא צוינה. התאמת התוכן עוברת בירושה מתבנית ההורה, אם יש כזו.
CONTENT_ALIGNMENT_UNSUPPORTED יישור תוכן שלא נתמך.
TOP יישור שמיישר את התוכן לחלק העליון של בעלי התוכן. תואם ל-ECMA-376 ST_TextTextingType 't'.
MIDDLE יישור שמיישר את התוכן לאמצע התוכן. תואם ל-ECMA-376 ST_TextTextingType 'ctr'.
BOTTOM יישור שמיישר את התוכן לתחתית של בעלי התוכן. תואם ל-ECMA-376 ST_TextTextingType '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 או בערך הזה לגבי הכותרת בדפים זוגיים. אם המדיניות לא מוגדרת, אין כותרת עליונה בדף זוגי.

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

firstPageHeaderId

string

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

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

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.

firstPageHeaderIdSuggested

boolean

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

pageNumberStartSuggested

boolean

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

marginTopSuggested

boolean

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

marginBottomSuggested

boolean

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

marginRightSuggested

boolean

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

marginLeftSuggested

boolean

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

pageSizeSuggestionState

object (SizeSuggestionState)

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

marginHeaderSuggested

boolean

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

flipPageOrientationSuggested

boolean

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

BackgroundSuggestionState

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

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

boolean

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

SizeSuggestionState

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

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

boolean

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

widthSuggested

boolean

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

NamedStyles

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

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

object (NamedStyle)

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

יש ערך עבור כל אחד מה-named style types האפשריים.

NamedStyle

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

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

enum (NamedStyleType)

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

textStyle

object (TextStyle)

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

paragraphStyle

object (ParagraphStyle)

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

SuggestedNamedStyles

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

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

object (NamedStyles)

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

namedStylesSuggestionState

object (NamedStylesSuggestionState)

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

NamedStylesSuggestionState

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

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

object (NamedStyleSuggestionState)

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

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

NamedStyleSuggestionState

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

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

enum (NamedStyleType)

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

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

textStyleSuggestionState

object (TextStyleSuggestionState)

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

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

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

רשימה

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

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

object (ListProperties)

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

suggestedListPropertiesChanges

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

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

suggestedInsertionId

string

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

suggestedDeletionIds[]

string

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

ListProperties

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

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

object (NestingLevel)

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

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

NestingLevel

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

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

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

enum (BulletAlignment)

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

glyphFormat

string

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

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

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

A.

B.

C.

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

1.

2.

2.1.

2.2.

3.

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

indentFirstLine

object (Dimension)

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

indentStart

object (Dimension)

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

textStyle

object (TextStyle)

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

startNumber

integer

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

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

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

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

enum (GlyphType)

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

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

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

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

string

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

positionedObjectProperties

object (PositionedObjectProperties)

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

suggestedPositionedObjectPropertiesChanges

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

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

suggestedInsertionId

string

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

suggestedDeletionIds[]

string

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

PositionedObjectProperties

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

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

object (PositionedObjectPositioning)

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

embeddedObject

object (EmbeddedObject)

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

PositionedObjectPositioning

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

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

enum (PositionedObjectLayout)

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

leftOffset

object (Dimension)

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

topOffset

object (Dimension)

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

PositionedObjectLayout

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

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

SuggestedPositionedObjectProperties

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

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

object (PositionedObjectProperties)

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

positionedObjectPropertiesSuggestionState

object (PositionedObjectPropertiesSuggestionState)

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

PositionedObjectPropertiesSuggestionState

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

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

object (PositionedObjectPositioningSuggestionState)

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

embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

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

PositionedObjectPositioningSuggestionState

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

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

boolean

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

leftOffsetSuggested

boolean

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

topOffsetSuggested

boolean

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

SuggestionsViewMode

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

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

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

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

PREVIEW_SUGGESTIONS_ACCEPTED

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

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

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

שיטות

batchUpdate

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

create

יצירת מסמך ריק לפי הכותרת שמופיעה בבקשה.

get

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