REST Resource: documents

משאב: מסמך

מסמך ב-Google Docs

ייצוג JSON 
{
  "documentId": string,
  "title": string,
  "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)
    },
    ...
  },
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
שדות
documentId

string

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

string

כותרת המסמך.
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))

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

string

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

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

enum (SuggestionsViewMode)

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

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

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

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

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

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

גוף

גוף המסמך.

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

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

object (StructuralElement)

תוכן הגוף.

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

רכיב מבני

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

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

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

integer

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

integer

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

object (Paragraph)

סוג פסקה של רכיב מבני.
sectionBreak

object (SectionBreak)

סוג של מעבר קטע של רכיב מבני.
table

object (Table)

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

object (TableOfContents)

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

פיסקה

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

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

object (ParagraphElement)

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

object (ParagraphStyle)

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

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

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

object (Bullet)

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

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

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

string

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

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

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

רכיב פסקה

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

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

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

integer

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

integer

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

object (TextRun)

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

object (AutoText)

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

object (PageBreak)

רכיב של מעבר דף.
columnBreak

object (ColumnBreak)

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

object (FootnoteReference)

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

object (HorizontalRule)

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

object (Equation)

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

object (InlineObjectElement)

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

object (Person)

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

TextRun

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

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

string

הטקסט של ההפעלה הזו.

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

string

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

string

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

object (TextStyle)

סגנון הטקסט בהפעלה הזו.
suggestedTextStyleChanges

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

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

סגנון טקסט

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

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

  • TextStyle של טקסט 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.

צבע אופציונלי

צבע שיכול להיות אטום לחלוטין או שקוף לחלוטין.

ייצוג 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 או שווה לו, המשקל לאחר עיבוד שווה למשקל.
  • אם הטקסט לא מודגש, המשקל לאחר עיבוד יהיה שווה למשקל.

הסטה בסיסית

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

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

הצעה לסגנון טקסט

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

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

object (TextStyle)

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

object (TextStyleSuggestionState)

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

TextStyleSuggestionState

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

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

boolean

הערך הזה מציין אם הוצע שינוי ל-bold.
italicSuggested

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

הערך הזה מציין אם הוצע שינוי ל-foregroundColor.
fontSizeSuggested

boolean

הערך הזה מציין אם הוצע שינוי ל-fontSize.
weightedFontFamilySuggested

boolean

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

boolean

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

טקסט אוטומטי

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

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

enum (Type)

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

string

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

string

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

object (TextStyle)

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

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

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

סוג

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

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

מעבר דף

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

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

string

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

string

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

object (TextStyle)

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

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

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

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

מעבר עמודה

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

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

string

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

string

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

object (TextStyle)

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

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

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

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

הפנייה להערת שוליים

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

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

string

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

string

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

string

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

string

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

object (TextStyle)

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

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

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

כלל אופקי

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

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

string

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

string

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

object (TextStyle)

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

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

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

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

משוואה

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

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

string

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

string

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

InlineObjectElement

ParagraphElement שמכיל InlineObject.

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

string

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

string

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

string

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

object (TextStyle)

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

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

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

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

אדם

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

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

string

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

string

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

string

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

object (TextStyle)

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

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

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

object (PersonProperties)

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

מאפייני אנשים

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

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

string

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

string

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

נכסי RichLink

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

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

string

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

string

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

string

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

סגנון פסקה

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

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

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

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

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

string

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

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

enum (NamedStyleType)

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

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

enum (Alignment)

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

number

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

enum (ContentDirection)

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

enum (SpacingMode)

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

object (Dimension)

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

object (Dimension)

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

object (ParagraphBorder)

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

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

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

object (ParagraphBorder)

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

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

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

object (ParagraphBorder)

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

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

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

object (ParagraphBorder)

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

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

object (ParagraphBorder)

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

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

object (Dimension)

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

object (Dimension)

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

object (Dimension)

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

object (TabStop)

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

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

boolean

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

boolean

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

boolean

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

object (Shading)

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

boolean

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

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

NamedStyleType

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

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

יישור

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

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

כיוון תוכן

תוכן ההנחיות יכול לזרום פנימה.

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

ריווח

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

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

גבול פיסקה

גבול מסביב לפיסקה.

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

object (OptionalColor)

צבע הגבול.
width

object (Dimension)

רוחב הגבול.
padding

object (Dimension)

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

enum (DashStyle)

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

סגנון DashStyle

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

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

עצירת Tab

עצירת טאב בתוך פסקה.

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

object (Dimension)

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

enum (TabStopAlignment)

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

יישור Tab

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

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

הצללה

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

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

object (OptionalColor)

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

הצעה לסגנון פיסקה

הצעה לשינוי ל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.

מצב הצללה

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

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

boolean

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

תבליט

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

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

string

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

integer

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

object (TextStyle)

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

תבליט הצעה

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

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

object (Bullet)

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

object (BulletSuggestionState)

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

מצב הצעת התבליט

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

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

boolean

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

boolean

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

object (TextStyleSuggestionState)

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

הפניות לאובייקטים

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

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

string

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

מעבר קטע

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

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

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

string

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

string

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

object (SectionStyle)

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

סגנון קטע

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

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

object (SectionColumnProperties)

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

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

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

enum (ColumnSeparatorStyle)

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

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

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

enum (ContentDirection)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

enum (SectionType)

פלט בלבד. סוג המדור.
defaultHeaderId

string

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

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

string

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

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

string

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

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

string

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

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

string

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

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

boolean

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

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

integer

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

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

boolean

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

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

מאפייני מדור עמודה

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

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

object (Dimension)

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

object (Dimension)

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

ColumnSeparatorStyle

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

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

סוג הענף

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

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

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

תא טבלה

התוכן והסגנון של תא ברכיב 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)

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

התאמת תוכן

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

נגזר מקבוצת משנה של הערכים של הסוג הפשוט ST_TextanchoringType בסעיף 20.1.10.59 של "Office Open XML File Formats - Fundamentals and Markup Language Reference", חלק 1 של ECMA-376 4th Edition.

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

SuggestTableCellStyle

הצעה לשינוי ל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.

סגנון טבלה

עיצובים שחלים על טבלה.

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

סוג רוחב

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

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

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

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

תוכן העניינים

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)

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

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

סגנון מסמך

הסגנון של המסמך.

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

object (Background)

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

string

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

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

string

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

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

string

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

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

string

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

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

string

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

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

boolean

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

boolean

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

integer

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Size)

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

object (Dimension)

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

boolean

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

רקע

הרקע של המסמך.

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

object (OptionalColor)

צבע הרקע.

גודל

נתוני רוחב וגובה.

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

object (Dimension)

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

object (Dimension)

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

SuggestDocumentStyle

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

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

object (DocumentStyle)

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

object (DocumentStyleSuggestionState)

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

מצב DocsStyleSuggestion

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

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

object (BackgroundSuggestionState)

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

boolean

הערך הזה מציין אם הוצע שינוי ל-defaultHeaderId.
evenPageHeaderIdSuggested

boolean

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

boolean

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

boolean

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

boolean

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

boolean

הערך הזה מציין אם הוצע שינוי ל-useFirstPageHeaderFooter.
useEvenPageHeaderFooterSuggested

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

object (SizeSuggestionState)

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

boolean

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

boolean

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

מצב הצעת רקע

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

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

boolean

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

sizeSuggestionState

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

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

boolean

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

boolean

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

סגנונות בשם

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

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

object (NamedStyle)

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

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

סגנון שם

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

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

enum (NamedStyleType)

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

object (TextStyle)

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

object (ParagraphStyle)

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

סגנונות של הצעות לשמות

הצעה לשינוי לגבי 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

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

מאפייני רשימה

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

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

object (NestingLevel)

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

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

רמת מקונן

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

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

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

יישור תבליטים

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

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

סוג גליף

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

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

SuggestionsListProperties

הצעה לשינוי אל ListProperties.

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

object (ListProperties)

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

object (ListPropertiesSuggestionState)

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

מצב ListPropertiesSuggestion

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

טווחים בעלי שם

אוסף של כל NamedRange במסמך שיש להם שם נתון.

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

string

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

object (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
}
שדות
segmentId

string

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

integer

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

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

integer

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

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

הצעותViewMode

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

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

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

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

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

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

אובייקט בתוך שורה

אובייקט שמופיע בתוך הטקסט. 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

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

מאפייני InlineObject

תכונות של InlineObject.

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

object (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

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

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

מאפייני תמונה

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

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

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

נכסי תבואה

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

מלבן החיתוך מיוצג באמצעות קיזוזים חלקיים מ-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

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

מוטמעObjectBorder

גבול מסביב ל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)

מצב הנכס של נכס הגבול.

מצב הנכס

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

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

OfferInlineObjectProperties

הצעה לשינוי אל 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 השתנו בהצעה הזו.

מצב EmbedSuggestionState

מסכה שמציינת אילו מהשדות בבסיס 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 יש ערך מוצע חדש.

מצב הצעת מאפייני התמונה

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

מציין אם היה שינוי מוצע ב-[contrast] [google.apps.docs.v1.embeddedObject.contrast].
transparencySuggested

boolean

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

object (CropPropertiesSuggestionState)

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

boolean

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

מצב CropPropertiesSuggestionState

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

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

boolean

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

boolean

הערך הזה מציין אם הוצע שינוי ל-offsetRight.
offsetTopSuggested

boolean

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

boolean

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

boolean

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

מוטמעObjectBorderSuggestionState

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

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

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

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

מיקום_אובייקטים

תכונות של PositionedObject.

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

object (PositionedObjectPositioning)

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

object (EmbeddedObject)

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

LocationedObjectPositioning

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

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

enum (PositionedObjectLayout)

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

object (Dimension)

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

object (Dimension)

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

LocationedObjectLayouts

הפריסות האפשריות של [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 השתנו בהצעה הזו.

LocationedObjectPropertiesSuggestionState

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

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

object (PositionedObjectPositioningSuggestionState)

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

object (EmbeddedObjectSuggestionState)

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

LocationedObjectPositioningSuggestionState

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

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

boolean

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

boolean

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

boolean

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

שיטות

batchUpdate

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

create

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

get

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