REST Resource: documents

{
  "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)
    },
    ...
  }
}

string

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

string

כותרת המסמך.

object (Tab)

כרטיסיות שנכללות במסמך.

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

string

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

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

enum (SuggestionsViewMode)

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

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

object (Body)

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

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

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

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

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

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

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

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

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

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

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

object (DocumentStyle)

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

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

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

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

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

object (NamedStyles)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{
  "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.
}

object (TabProperties)

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

object (Tab)

הכרטיסיות המשניות שמוטמעות בכרטיסייה הזו.

object (DocumentTab)

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

{
  "tabId": string,
  "title": string,
  "parentTabId": string,
  "index": integer,
  "nestingLevel": integer
}

string

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

string

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

string

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

integer

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

integer

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

{
  "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)
    },
    ...
  }
}

object (Body)

הגוף הראשי של הכרטיסייה של המסמך.

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

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

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

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

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

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

object (DocumentStyle)

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

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

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

object (NamedStyles)

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

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

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

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

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

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

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

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

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

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

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

{
  "content": [
    {
      object (StructuralElement)
    }
  ]
}

object (StructuralElement)

תוכן הגוף.

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

{
  "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.
}

integer

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

integer

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

object (Paragraph)

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

object (SectionBreak)

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

object (Table)

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

object (TableOfContents)

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

{
  "elements": [
    {
      object (ParagraphElement)
    }
  ],
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "suggestedParagraphStyleChanges": {
    string: {
      object (SuggestedParagraphStyle)
    },
    ...
  },
  "bullet": {
    object (Bullet)
  },
  "suggestedBulletChanges": {
    string: {
      object (SuggestedBullet)
    },
    ...
  },
  "positionedObjectIds": [
    string
  ],
  "suggestedPositionedObjectIds": {
    string: {
      object (ObjectReferences)
    },
    ...
  }
}

object (ParagraphElement)

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

object (ParagraphStyle)

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

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

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

object (Bullet)

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

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

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

string

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

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

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

{
  "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.
}

integer

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

integer

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

object (TextRun)

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

object (AutoText)

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

object (PageBreak)

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

object (ColumnBreak)

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

object (FootnoteReference)

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

object (HorizontalRule)

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

object (Equation)

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

object (InlineObjectElement)

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

object (Person)

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

object (RichLink)

רכיב של פסקה שמקשר למשאב של Google (למשל קובץ ב-Google Drive, סרטון ב-YouTube או אירוע ביומן Google).

{
  "content": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}

string

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

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

string

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

string

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

object (TextStyle)

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

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

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

{
  "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)
  }
}

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

object (OptionalColor)

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

object (OptionalColor)

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

object (Dimension)

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

object (WeightedFontFamily)

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

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

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

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

enum (BaselineOffset)

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

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

object (Link)

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

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

• כשמגדירים קישור, צבע החזית של הטקסט מתעדכן בצבע ברירת המחדל של הקישור והטקסט מודגש. אם השדות האלה ישתנו באותה בקשה, המערכת תשתמש בערכים האלה במקום בברירת המחדל של הקישור.
• הגדרת קישור בטווח טקסט שחופף לקישור קיים תעדכן גם את הקישור הקיים כך שיצביע לכתובת ה-URL החדשה.
• לא ניתן להגדיר קישורים בתווי מעבר לשורה חדשה. כתוצאה מכך, הגדרת קישור בטווח טקסט שחוצה את גבול הפסקה, כמו "ABC\n123", תפריד את תווים של שורת חדשה למקטעי טקסט משלהם. הקישור יוחל בנפרד על ההרצות לפני ואחרי שורת ההתחלה.
• הסרת קישור תעדכן את סגנון הטקסט של הטווח כך שיתאים לסגנון של הטקסט הקודם (או לסגנונות ברירת המחדל של הטקסט אם הטקסט הקודם הוא קישור אחר), אלא אם מגדירים סגנונות שונים באותה בקשה.

{
  "color": {
    object (Color)
  }
}

object (Color)

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

{
  "rgbColor": {
    object (RgbColor)
  }
}

object (RgbColor)

ערך הצבע ב-RGB.

{
  "red": number,
  "green": number,
  "blue": number
}

number

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

number

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

number

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

{
  "magnitude": number,
  "unit": enum (Unit)
}

number

העוצמה.

enum (Unit)

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

{
  "fontFamily": string,
  "weight": integer
}

string

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

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

integer

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

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

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

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

{

  // Union field destination can be only one of the following:
  "url": string,
  "tabId": string,
  "bookmark": {
    object (BookmarkLink)
  },
  "heading": {
    object (HeadingLink)
  },
  "bookmarkId": string,
  "headingId": string
  // End of list of possible types for union field destination.
}

string

כתובת URL חיצונית.

string

המזהה של כרטיסייה במסמך הזה.

object (BookmarkLink)

סימנייה במסמך הזה.

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

object (HeadingLink)

כותרת במסמך הזה.

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

string

המזהה של סימנייה במסמך הזה.

שדה מדור קודם: במקום זאת, מגדירים את includeTabsContent כ-true ומשתמשים ב-Link.bookmark לפעולות קריאה וכתיבה. השדה הזה מוחזר רק כאשר השדה includeTabsContent מוגדר כ-false במסמכים שמכילים כרטיסייה אחת וקישורים לסימניות בכרטיסייה היחידה. אחרת, יוחזר הערך Link.bookmark.

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

string

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

שדה מדור קודם: במקום זאת, מגדירים את includeTabsContent כ-true ומשתמשים ב-Link.heading לפעולות קריאה וכתיבה. השדה הזה מוחזר רק כאשר השדה includeTabsContent מוגדר כ-false במסמכים שמכילים כרטיסייה אחת ומקשרים לכותרת בכרטיסייה היחידה. אחרת, יוחזר הערך Link.heading.

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

{
  "id": string,
  "tabId": string
}

string

המזהה של סימנייה במסמך הזה.

string

המזהה של הכרטיסייה שמכילה את הסימנייה הזו.

{
  "id": string,
  "tabId": string
}

string

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

string

המזהה של הכרטיסייה שמכילה את הכותרת הזו.

{
  "textStyle": {
    object (TextStyle)
  },
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}

object (TextStyle)

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

object (TextStyleSuggestionState)

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

{
  "boldSuggested": boolean,
  "italicSuggested": boolean,
  "underlineSuggested": boolean,
  "strikethroughSuggested": boolean,
  "smallCapsSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "foregroundColorSuggested": boolean,
  "fontSizeSuggested": boolean,
  "weightedFontFamilySuggested": boolean,
  "baselineOffsetSuggested": boolean,
  "linkSuggested": boolean
}

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

{
  "type": enum (Type),
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}

enum (Type)

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

string

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

string

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

object (TextStyle)

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

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

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

{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}

string

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

string

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

object (TextStyle)

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

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

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

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

{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}

string

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

string

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

object (TextStyle)

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

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

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

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

{
  "footnoteId": string,
  "footnoteNumber": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}

string

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

string

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

string

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

string

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

object (TextStyle)

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

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

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

{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}

string

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

string

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

object (TextStyle)

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

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

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

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

{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}

string

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

string

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

{
  "inlineObjectId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}

string

המזהה של ה-InlineObject שהרכיב הזה מכיל.

string

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

string

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

object (TextStyle)

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

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

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

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

{
  "personId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "personProperties": {
    object (PersonProperties)
  }
}

string

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

string

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

string

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

object (TextStyle)

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

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

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

object (PersonProperties)

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

{
  "name": string,
  "email": string
}

string

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

string

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

{
  "richLinkId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "richLinkProperties": {
    object (RichLinkProperties)
  }
}

string

פלט בלבד. המזהה של הקישור הזה.

string

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

string

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

object (TextStyle)

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

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

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

object (RichLinkProperties)

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

{
  "title": string,
  "uri": string,
  "mimeType": string
}

string

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

string

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

string

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

{
  "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
}

string

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

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

enum (NamedStyleType)

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

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

enum (Alignment)

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

number

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

enum (ContentDirection)

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

enum (SpacingMode)

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

object (Dimension)

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

object (Dimension)

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

object (ParagraphBorder)

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

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

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

object (ParagraphBorder)

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

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

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

object (ParagraphBorder)

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

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

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

object (ParagraphBorder)

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

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

object (ParagraphBorder)

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

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

object (Dimension)

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

object (Dimension)

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

object (Dimension)

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

object (TabStop)

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

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

boolean

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

boolean

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

boolean

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

object (Shading)

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

boolean

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

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

{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "padding": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}

object (OptionalColor)

צבע הגבול.

object (Dimension)

רוחב הגבול.

object (Dimension)

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

enum (DashStyle)

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

{
  "offset": {
    object (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}

object (Dimension)

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

enum (TabStopAlignment)

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

{
  "backgroundColor": {
    object (OptionalColor)
  }
}

object (OptionalColor)

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

{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}

object (ParagraphStyle)

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

object (ParagraphStyleSuggestionState)

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

{
  "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
}

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

object (ShadingSuggestionState)

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

boolean

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

{
  "backgroundColorSuggested": boolean
}

boolean

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

{
  "listId": string,
  "nestingLevel": integer,
  "textStyle": {
    object (TextStyle)
  }
}

string

המזהה של הרשימה שאליה שייך הפסקה.

integer

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

object (TextStyle)

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

{
  "bullet": {
    object (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}

object (Bullet)

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

object (BulletSuggestionState)

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

{
  "listIdSuggested": boolean,
  "nestingLevelSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}

boolean

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

boolean

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

object (TextStyleSuggestionState)

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

{
  "objectIds": [
    string
  ]
}

string

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

{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "sectionStyle": {
    object (SectionStyle)
  }
}

string

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

string

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

object (SectionStyle)

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

{
  "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
}

object (SectionColumnProperties)

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

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

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

enum (ColumnSeparatorStyle)

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

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

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

enum (ContentDirection)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

enum (SectionType)

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

string

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

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

string

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

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

string

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

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

string

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

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

string

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

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

string

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

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

boolean

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

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

integer

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

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

boolean

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

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

{
  "width": {
    object (Dimension)
  },
  "paddingEnd": {
    object (Dimension)
  }
}

object (Dimension)

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

object (Dimension)

הארגזים בסוף העמודה.

{
  "rows": integer,
  "columns": integer,
  "tableRows": [
    {
      object (TableRow)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableStyle": {
    object (TableStyle)
  }
}

integer

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

integer

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

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

object (TableRow)

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

string

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

string

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

object (TableStyle)

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

{
  "startIndex": integer,
  "endIndex": integer,
  "tableCells": [
    {
      object (TableCell)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "suggestedTableRowStyleChanges": {
    string: {
      object (SuggestedTableRowStyle)
    },
    ...
  }
}

integer

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

integer

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

object (TableCell)

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

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

string

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

string

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

object (TableRowStyle)

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

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

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

{
  "startIndex": integer,
  "endIndex": integer,
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "suggestedTableCellStyleChanges": {
    string: {
      object (SuggestedTableCellStyle)
    },
    ...
  }
}

integer

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

integer

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

object (StructuralElement)

התוכן של התא.

object (TableCellStyle)

הסגנון של התא.

string

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

string

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

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

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

{
  "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)
}

integer

היקף השורות של התא.

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

integer

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

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

object (OptionalColor)

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

object (TableCellBorder)

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

object (TableCellBorder)

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

object (TableCellBorder)

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

object (TableCellBorder)

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

object (Dimension)

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

object (Dimension)

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

object (Dimension)

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

object (Dimension)

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

enum (ContentAlignment)

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

{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}

object (OptionalColor)

צבע הגבול.

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

object (Dimension)

רוחב הגבול.

enum (DashStyle)

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

{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "tableCellStyleSuggestionState": {
    object (TableCellStyleSuggestionState)
  }
}

object (TableCellStyle)

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

object (TableCellStyleSuggestionState)

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

{
  "rowSpanSuggested": boolean,
  "columnSpanSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "paddingLeftSuggested": boolean,
  "paddingRightSuggested": boolean,
  "paddingTopSuggested": boolean,
  "paddingBottomSuggested": boolean,
  "contentAlignmentSuggested": boolean
}

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

{
  "minRowHeight": {
    object (Dimension)
  },
  "tableHeader": boolean,
  "preventOverflow": boolean
}

object (Dimension)

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

boolean

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

boolean

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

{
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}

object (TableRowStyle)

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

object (TableRowStyleSuggestionState)

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

{
  "minRowHeightSuggested": boolean
}

boolean

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

{
  "tableColumnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}

object (TableColumnProperties)

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

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

{
  "widthType": enum (WidthType),
  "width": {
    object (Dimension)
  }
}

enum (WidthType)

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

object (Dimension)

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

{
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}

object (StructuralElement)

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

string

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

string

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

{
  "headerId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}

string

המזהה של הכותרת.

object (StructuralElement)

תוכן הכותרת.

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

{
  "footerId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}

string

המזהה של הכותרת התחתונה.

object (StructuralElement)