- משאב: מסמך
- מקש Tab
- TabProperties
- DocumentTab
- גוף ההודעה
- StructuralElement
- פסקה
- ParagraphElement
- TextRun
- TextStyle
- OptionalColor
- צבע
- RgbColor
- מאפיין
- היחידה
- WeightedFontFamily
- BaselineOffset
- קישור
- BookmarkLink
- HeadingLink
- SuggestedTextStyle
- TextStyleSuggestionState
- AutoText
- סוג
- PageBreak
- ColumnBreak
- FootnoteReference
- HorizontalRule
- משוואה
- InlineObjectElement
- אדם
- PersonProperties
- RichLink
- RichLinkProperties
- ParagraphStyle
- NamedStyleType
- יישור
- ContentDirection
- SpacingMode
- ParagraphBorder
- DashStyle
- TabStop
- TabStopAlignment
- הצללה
- SuggestedParagraphStyle
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- תבליט
- SuggestedBullet
- BulletSuggestionState
- ObjectReferences
- SectionBreak
- SectionStyle
- SectionColumnProperties
- ColumnSeparatorStyle
- SectionType
- טבלה
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- ContentAlignment
- SuggestedTableCellStyle
- TableCellStyleSuggestionState
- TableRowStyle
- SuggestedTableRowStyle
- TableRowStyleSuggestionState
- TableStyle
- TableColumnProperties
- WidthType
- TableOfContents
- כותרת
- כותרת תחתונה
- הערת שוליים
- DocumentStyle
- רקע
- מידה
- SuggestedDocumentStyle
- DocumentStyleSuggestionState
- BackgroundSuggestionState
- SizeSuggestionState
- NamedStyles
- NamedStyle
- SuggestedNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- רשימה
- ListProperties
- NestingLevel
- BulletAlignment
- GlyphType
- SuggestedListProperties
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- NamedRanges
- NamedRange
- טווח
- InlineObject
- InlineObjectProperties
- EmbeddedObject
- EmbeddedDrawingProperties
- ImageProperties
- CropProperties
- EmbeddedObjectBorder
- PropertyState
- LinkedContentReference
- SheetsChartReference
- SuggestedInlineObjectProperties
- InlineObjectPropertiesSuggestionState
- EmbeddedObjectSuggestionState
- EmbeddedDrawingPropertiesSuggestionState
- ImagePropertiesSuggestionState
- CropPropertiesSuggestionState
- EmbeddedObjectBorderSuggestionState
- LinkedContentReferenceSuggestionState
- SheetsChartReferenceSuggestionState
- PositionedObject
- PositionedObjectProperties
- PositionedObjectPositioning
- PositionedObjectLayout
- SuggestedPositionedObjectProperties
- PositionedObjectPropertiesSuggestionState
- PositionedObjectPositioningSuggestionState
- SuggestionsViewMode
- שיטות
משאב: מסמך
מסמך ב-Google Docs.
ייצוג JSON |
---|
{ "documentId": string, "title": string, "tabs": [ { object ( |
שדות | |
---|---|
documentId |
פלט בלבד. המזהה של המסמך. |
title |
כותרת המסמך. |
tabs[] |
כרטיסיות שהן חלק ממסמך. כרטיסיות יכולות להכיל כרטיסיות צאצא, כרטיסייה שבתוך כרטיסייה אחרת. כרטיסיות צאצא מיוצגות על ידי השדה |
revisionId |
פלט בלבד. מזהה הגרסה הקודמת של המסמך. אפשר להשתמש בהן בבקשות עדכון כדי לציין על איזו גרסה של מסמך להחיל עדכונים, ואיך הבקשה צריכה להתנהג אם המסמך נערך מאז הגרסה הזו. השדה הזה מאוכלס רק אם למשתמש יש גישת עריכה למסמך. מזהה הגרסה הוא לא מספר סידורי אלא מחרוזת אטומה. הפורמט של מזהה הגרסה הקודמת עשוי להשתנות עם הזמן. מובטח שמזהה הגרסה שהוחזר יהיה תקף רק ל-24 שעות לאחר החזרתו, ולא ניתן לשתף אותו עם משתמשים. אם מזהה הגרסה לא השתנה בין הקריאות, המסמך לא השתנה. לעומת זאת, אם מדובר במזהה שהשתנה (לאותו מסמך ולאותו משתמש), בדרך כלל המסמך עודכן. עם זאת, שינוי המזהה יכול גם לנבוע מגורמים פנימיים, כמו שינויים בפורמט של המזהה. |
suggestionsViewMode |
פלט בלבד. מצב תצוגת ההצעות שהוחל על המסמך. הערה: כשעורכים מסמך, השינויים חייבים להתבסס על מסמך עם |
body |
פלט בלבד. הגוף הראשי של המסמך. השדה 'דור קודם': במקום זאת, צריך להשתמש ב- |
headers |
פלט בלבד. הכותרות במסמך, עם מפתח לפי מזהה הכותרת. השדה 'דור קודם': במקום זאת, צריך להשתמש ב- |
footers |
פלט בלבד. הכותרות התחתונות במסמך, מקודדות לפי מזהה הכותרת התחתונה. השדה 'דור קודם': במקום זאת, צריך להשתמש ב- |
footnotes |
פלט בלבד. הערות השוליים במסמך, כשהן מקובצות לפי מזהה של הערת שוליים. השדה 'דור קודם': במקום זאת, צריך להשתמש ב- |
documentStyle |
פלט בלבד. סגנון המסמך. השדה 'דור קודם': במקום זאת, צריך להשתמש ב- |
suggestedDocumentStyleChanges |
פלט בלבד. ההצעות לשינויים בסגנון של המסמך, עם מזהה ההצעה. השדה 'דור קודם': במקום זאת, צריך להשתמש ב- |
namedStyles |
פלט בלבד. סגנונות המסמך בעלי השם. השדה 'דור קודם': במקום זאת, צריך להשתמש ב- |
suggestedNamedStylesChanges |
פלט בלבד. ההצעות לשינויים לסגנונות של המסמך שקיבלו שם, עם מזהה ההצעה. השדה 'דור קודם': במקום זאת, צריך להשתמש ב- |
lists |
פלט בלבד. הרשימות במסמך, עם מפתח לפי מזהה הרשימה. השדה 'דור קודם': במקום זאת, צריך להשתמש ב- |
namedRanges |
פלט בלבד. טווחי התאים בעלי השם במסמך, מקובצים לפי שם. השדה 'דור קודם': במקום זאת, צריך להשתמש ב- |
inlineObjects |
פלט בלבד. האובייקטים המוטבעים במסמך, מקודדים לפי מזהה אובייקט. השדה 'דור קודם': במקום זאת, צריך להשתמש ב- |
positionedObjects |
פלט בלבד. האובייקטים הממוקמים במסמך, עם קידוד לפי מזהה אובייקט. השדה 'דור קודם': במקום זאת, צריך להשתמש ב- |
כרטיסייה
כרטיסייה במסמך.
ייצוג JSON |
---|
{ "tabProperties": { object ( |
שדות | |
---|---|
tabProperties |
המאפיינים של הכרטיסייה, כמו ID ו-title. |
childTabs[] |
כרטיסיות הצאצא בתוך הכרטיסייה הזו. |
שדה איחוד content . התוכן של הכרטיסייה. content יכול להיות רק אחת מהאפשרויות הבאות: |
|
documentTab |
כרטיסייה עם תוכן של מסמכים, כמו טקסט ותמונות. |
TabProperties
המאפיינים של כרטיסייה.
ייצוג JSON |
---|
{ "tabId": string, "title": string, "parentTabId": string, "index": integer, "nestingLevel": integer } |
שדות | |
---|---|
tabId |
פלט בלבד. המזהה של הכרטיסייה. אי אפשר לשנות את השדה הזה. |
title |
שם הכרטיסייה הגלוי למשתמש. |
parentTabId |
זה שינוי אופציונלי. המזהה של כרטיסיית ההורה. ריקה אם הכרטיסייה הנוכחית היא כרטיסייה ברמה הבסיסית (root), כלומר אין לה תבניות הורה. |
index |
האינדקס מבוסס על אפס של הכרטיסייה בתוך תבנית ההורה. |
nestingLevel |
פלט בלבד. עומק הכרטיסייה בתוך המסמך. כרטיסיות ברמה הבסיסית מתחילות ב-0. |
DocumentTab
כרטיסייה עם תוכן של מסמך.
ייצוג JSON |
---|
{ "body": { object ( |
שדות | |
---|---|
body |
התוכן הראשי של כרטיסיית המסמך. |
headers |
הכותרות בכרטיסיית המסמך, בקידוד לפי מזהה הכותרת. |
footers |
הכותרות התחתונות בכרטיסיית המסמך, מקובצות לפי מזהה הכותרת התחתונה. |
footnotes |
הערות השוליים בכרטיסיית המסמך, בקידוד לפי מזהה הערת שוליים. |
documentStyle |
הסגנון של כרטיסיית המסמך. |
suggestedDocumentStyleChanges |
ההצעות לשינויים בסגנון של כרטיסיית המסמך, בשיוך לפי מזהה ההצעה. |
namedStyles |
הסגנונות בעלי השם של כרטיסיית המסמך. |
suggestedNamedStylesChanges |
ההצעות לשינויים לסגנונות של כרטיסיית המסמך שקיבלו שם, עם כל מזהה ההצעה. |
lists |
הרשימות בכרטיסיית המסמך, עם המפתחות לפי מזהה הרשימה. |
namedRanges |
טווחי התאים בעלי השם בכרטיסיית המסמך, מקובצים לפי שם. |
inlineObjects |
האובייקטים המוטבעים בכרטיסיית המסמך, מקובצים לפי מזהה אובייקט. |
positionedObjects |
האובייקטים שממוקמים בכרטיסיית המסמך, מקובצים לפי מזהה אובייקט. |
גוף
גוף המסמך.
גוף המסמך בדרך כלל מכיל את כל התוכן של המסמך, מלבד headers
, footers
ו-footnotes
.
ייצוג JSON |
---|
{
"content": [
{
object ( |
שדות | |
---|---|
content[] |
התוכן של הגוף. האינדקסים של תוכן הגוף מתחילים באפס. |
StructuralElement
StructuredElement מתאר תוכן שמספק מבנה למסמך.
ייצוג JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
שדות | |
---|---|
startIndex |
אינדקס ההתחלה מבוסס אפס של הרכיב המבני הזה, ביחידות קוד UTF-16. |
endIndex |
אינדקס הקצה מבוסס אפס של הרכיב המבני הזה, בלעדי, ביחידות קוד UTF-16. |
שדה איחוד content . התוכן של הרכיב המבני. content יכול להיות רק אחת מהאפשרויות הבאות: |
|
paragraph |
סוג פסקה של רכיב מבני. |
sectionBreak |
סוג של מעבר קטע של רכיב מבני. |
table |
סוג טבלה של רכיב מבני. |
tableOfContents |
סוג תוכן עניינים של רכיב מבני. |
פסקה
StructuralElement
שמייצג פסקה. פסקה היא טווח של תוכן שמסתיים בתו של שורה חדשה.
ייצוג JSON |
---|
{ "elements": [ { object ( |
שדות | |
---|---|
elements[] |
תוכן הפסקה, בחלוקה לחלקים שמרכיבים אותה. |
paragraphStyle |
הסגנון של הפסקה הזו. |
suggestedParagraphStyleChanges |
סגנון הפסקה המוצע ישתנה לפסקה הזו, כשהוא מקודד לפי מזהה ההצעה. |
bullet |
התבליט של פסקה זו. אם הפסקה לא קיימת, היא לא שייכת לרשימה. |
suggestedBulletChanges |
ההצעות לשינויים בתבליט של פסקה זו. |
positionedObjectIds[] |
המזהים של האובייקטים הממוקמים, הקשורים לפיסקה זו. |
suggestedPositionedObjectIds |
המזהים של האובייקטים הממוקמים שהוצעו לצירוף לפסקה הזו, עם קידוד לפי מזהה הצעה. |
ParagraphElement
רכיב פסקה מתאר תוכן בתוך Paragraph
.
ייצוג JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
שדות | |
---|---|
startIndex |
אינדקס ההתחלה מבוסס אפס של רכיב פסקה זה, ביחידות קוד UTF-16. |
endIndex |
אינדקס הקצה אפס-בסיס של רכיב הפיסקה הזה, בלעדי, ביחידות קוד UTF-16. |
שדה איחוד content . התוכן של רכיב הפיסקה. content יכול להיות רק אחת מהאפשרויות הבאות: |
|
textRun |
רכיב פסקה להרצת טקסט. |
autoText |
רכיב אוטומטי של פסקה בטקסט. |
pageBreak |
רכיב פסקה של מעבר דף. |
columnBreak |
רכיב פסקה של מעבר עמודה. |
footnoteReference |
רכיב פסקה להפניה להערת שוליים. |
horizontalRule |
רכיב פסקה בכלל אופקי. |
equation |
רכיב של פסקה עם משוואה. |
inlineObjectElement |
רכיב פסקה של אובייקט בתוך שורה. |
person |
רכיב פסקה שמקושר לאדם או לכתובת אימייל. |
richLink |
רכיב פסקה שמקושר למשאב של Google (כמו קובץ ב-Google Drive, סרטון ב-YouTube או אירוע ביומן). |
TextRun
ParagraphElement
שמייצג רצף של טקסט שכולם מתאפיינים באותו סגנון.
ייצוג JSON |
---|
{ "content": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
שדות | |
---|---|
content |
הטקסט של הריצה הזאת. רכיבים שאינם טקסט בהרצה מוחלפים בתו Unicode U+E907. |
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
textStyle |
סגנון הטקסט בריצה הזו. |
suggestedTextStyleChanges |
סגנון הטקסט שהוצע משתנה בהרצה הזו, עם מפתח לפי מזהה ההצעה. |
סגנון טקסט
הסגנון שאפשר להחיל על טקסט.
סגנונות טקסט שעברו בירושה מיוצגים כשדות לא מוגדרים בהודעה הזו. ההורה של סגנון הטקסט תלוי במיקום שבו הוא מוגדר:
- סגנון 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 ( |
שדות | |
---|---|
bold |
האם הטקסט מוצג כמודגש. |
italic |
האם הטקסט נטוי או לא. |
underline |
האם הטקסט מופיע עם קו תחתון או לא. |
strikethrough |
האם יש קו חוצה בטקסט. |
smallCaps |
האם הטקסט מופיע באותיות קטנות. |
backgroundColor |
צבע הרקע של הטקסט. אם המדיניות מוגדרת, הצבע הוא צבע RGB או שקוף, בהתאם לשדה |
foregroundColor |
צבע החזית של הטקסט. אם המדיניות מוגדרת, הצבע הוא צבע RGB או שקוף, בהתאם לשדה |
fontSize |
גודל הגופן של הטקסט. |
weightedFontFamily |
משפחת הגופנים ומשקל הטקסט לאחר עיבוד. אם בבקשת עדכון מצוינים ערכים גם ל- אם לא מגדירים את אם מגדירים את |
baselineOffset |
ההיסט האנכי של הטקסט מהמיקום הרגיל שלו. טקסט עם ההיסט הבסיסי של |
link |
היעד של ההיפר-קישור בטקסט. אם המדיניות לא מוגדרת, אין קישור. הקישורים לא עוברים בירושה מטקסט ההורה. שינוי הקישור בבקשת עדכון יגרום לשינויים נוספים בסגנון הטקסט של הטווח:
|
OptionalColor
צבע שיכול להיות אטום לחלוטין או שקוף לחלוטין.
ייצוג JSON |
---|
{
"color": {
object ( |
שדות | |
---|---|
color |
אם האפשרות מוגדרת, הצבע הזה ישמש כצבע אטום. אם המדיניות לא מוגדרת, המשמעות היא צבע שקוף. |
צבע
צבע אחיד.
ייצוג JSON |
---|
{
"rgbColor": {
object ( |
שדות | |
---|---|
rgbColor |
ערך צבע ה-RGB. |
RgbColor
צבע RGB.
ייצוג JSON |
---|
{ "red": number, "green": number, "blue": number } |
שדות | |
---|---|
red |
הרכיב האדום של הצבע, מ-0.0 עד 1.0. |
green |
רכיב הצבע הירוק, מ-0.0 עד 1.0. |
blue |
הרכיב הכחול של הצבע, מ-0.0 עד 1.0. |
מאפיין
עוצמת קול בכיוון אחד ביחידות שצוינו.
ייצוג JSON |
---|
{
"magnitude": number,
"unit": enum ( |
שדות | |
---|---|
magnitude |
העוצמה. |
unit |
יחידות העוצמה. |
יחידה
יחידות מידה.
טיפוסים בני מנייה (enum) | |
---|---|
UNIT_UNSPECIFIED |
היחידות לא ידועות. |
PT |
נקודה, 1/72 אינץ'. |
WeightedFontFamily
מייצג את משפחת הגופנים והמשקל של הטקסט.
ייצוג JSON |
---|
{ "fontFamily": string, "weight": integer } |
שדות | |
---|---|
fontFamily |
משפחת הגופנים של הטקסט. משפחת הגופנים יכולה להיות כל גופן בתפריט 'גופן' ב-Docs או ב-Google Fonts. אם שם הגופן לא מזוהה, הטקסט מעובד ב- |
weight |
עובי הגופן. השדה הזה יכול להכיל כל ערך שהוא כפולה של ערך ברירת המחדל הוא עובי הגופן הוא רק רכיב אחד במשקל הגופן המעובד. שילוב של הערך
|
BaselineOffset
הדרכים שבהן ניתן להטות טקסט אנכית מהמיקום הרגיל שלו.
טיפוסים בני מנייה (enum) | |
---|---|
BASELINE_OFFSET_UNSPECIFIED |
ההיסט הבסיסי של הטקסט עובר בירושה מתבנית ההורה. |
NONE |
הטקסט לא קוזז אנכית. |
SUPERSCRIPT |
הטקסט מיסט אנכי למעלה (כתב עילי). |
SUBSCRIPT |
הטקסט מיסט אנכי למטה (כתב תחתי). |
קישור
הפניה לחלק אחר של מסמך או למשאב של כתובת URL חיצונית.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד destination . יעד הקישור. destination יכול להיות רק אחת מהאפשרויות הבאות: |
|
url |
כתובת URL חיצונית. |
tabId |
המזהה של כרטיסייה במסמך הזה. |
bookmark |
סימנייה במסמך הזה. במסמכים שמכילים כרטיסייה יחידה, קישורים לסימניות בכרטיסייה היחידה ממשיכים להחזיר |
heading |
כותרת במסמך הזה. במסמכים שמכילים כרטיסייה יחידה, קישורים לכותרות בכרטיסייה היחידה ממשיכים להחזיר |
bookmarkId |
המזהה של סימנייה במסמך הזה. השדה 'דור קודם': במקום זאת, צריך להגדיר את אם משתמשים בשדה הזה בבקשת כתיבה, הסימנייה נחשבת כאילו היא ממזהה הכרטיסייה שצוין בבקשה. אם לא צוין מזהה כרטיסייה בבקשה, היא נחשבת ככרטיסייה הראשונה במסמך. |
headingId |
המזהה של כותרת במסמך הזה. השדה 'דור קודם': במקום זאת, צריך להגדיר את אם משתמשים בשדה הזה בבקשת כתיבה, הכותרת נחשבת כמזהה הכרטיסייה שצוין בבקשה. אם לא צוין מזהה כרטיסייה בבקשה, היא נחשבת ככרטיסייה הראשונה במסמך. |
BookmarkLink
הפניה לסימנייה במסמך הזה.
ייצוג JSON |
---|
{ "id": string, "tabId": string } |
שדות | |
---|---|
id |
המזהה של סימנייה במסמך הזה. |
tabId |
מזהה הכרטיסייה שמכילה את הסימנייה הזו. |
HeadingLink
הפניה לכותרת במסמך הזה.
ייצוג JSON |
---|
{ "id": string, "tabId": string } |
שדות | |
---|---|
id |
המזהה של כותרת במסמך הזה. |
tabId |
מזהה הכרטיסייה שמכילה את הכותרת הזו. |
SuggestedTextStyle
הצעה לשינוי ל-TextStyle
.
ייצוג JSON |
---|
{ "textStyle": { object ( |
שדות | |
---|---|
textStyle |
|
textStyleSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
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 |
שדה זה מציין אם הוצע שינוי ל- |
italicSuggested |
שדה זה מציין אם הוצע שינוי ל- |
underlineSuggested |
שדה זה מציין אם הוצע שינוי ל- |
strikethroughSuggested |
שדה זה מציין אם הוצע שינוי ל- |
smallCapsSuggested |
שדה זה מציין אם הוצע שינוי ל- |
backgroundColorSuggested |
שדה זה מציין אם הוצע שינוי ל- |
foregroundColorSuggested |
שדה זה מציין אם הוצע שינוי ל- |
fontSizeSuggested |
שדה זה מציין אם הוצע שינוי ל- |
weightedFontFamilySuggested |
שדה זה מציין אם הוצע שינוי ל- |
baselineOffsetSuggested |
שדה זה מציין אם הוצע שינוי ל- |
linkSuggested |
שדה זה מציין אם הוצע שינוי ל- |
AutoText
ParagraphElement
שמייצג נקודה בטקסט שמוחלף באופן דינמי בתוכן שיכול להשתנות עם הזמן, כמו מספר דף.
ייצוג JSON |
---|
{ "type": enum ( |
שדות | |
---|---|
type |
הסוג של טקסט אוטומטי זה. |
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ב- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
textStyle |
סגנון הטקסט של ה-AutoText הזה. |
suggestedTextStyleChanges |
סגנון הטקסט המוצע ישתנה ל-AutoText הזה, עם מזהה הצעה. |
סוג
סוגי הטקסט האוטומטי.
טיפוסים בני מנייה (enum) | |
---|---|
TYPE_UNSPECIFIED |
סוג טקסט אוטומטי שלא צוין. |
PAGE_NUMBER |
הקלדה של טקסט אוטומטי שמייצג את מספר הדף הנוכחי. |
PAGE_COUNT |
טיפוס טקסט אוטומטי שמייצג את מספר הדפים הכולל במסמך. |
PageBreak
ParagraphElement
שמייצג מעבר דף. בעקבות מעבר דף, הטקסט הבא יתחיל בחלק העליון של הדף הבא.
ייצוג JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
שדות | |
---|---|
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
textStyle |
סגנון הטקסט של מעבר הדף הזה. בדומה לתוכן טקסט, כמו הרצת טקסט והפניות להערות שוליים, סגנון הטקסט של מעבר דף יכול להשפיע על פריסת התוכן ועל עיצוב הטקסט שמוסיפים לצידו. |
suggestedTextStyleChanges |
סגנון הטקסט המוצע ישתנה במעבר הדף הזה, בקידוד לפי מזהה ההצעה. |
ColumnBreak
ParagraphElement
שמייצג מעבר עמודה. מעבר עמודה גורם לטקסט הבא להתחיל בחלק העליון של העמודה הבאה.
ייצוג JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
שדות | |
---|---|
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
textStyle |
סגנון הטקסט של מעבר העמודות הזה. בדומה לתוכן טקסט, כמו הרצת טקסט והפניות להערות שוליים, סגנון הטקסט של מעבר עמודה יכול להשפיע על פריסת התוכן ועל עיצוב הטקסט שמוסיפים לצידה. |
suggestedTextStyleChanges |
סגנון הטקסט המוצע ישתנה למעבר העמודות הזה, עם מיקוד לפי מזהה ההצעה. |
FootnoteReference
ParagraphElement
שמייצג הפניה להערת שוליים. הפניה להערת שוליים היא התוכן המוטבע שעבר עיבוד באמצעות מספר ומשמש לזיהוי הערת השוליים.
ייצוג JSON |
---|
{ "footnoteId": string, "footnoteNumber": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
שדות | |
---|---|
footnoteId |
המזהה של |
footnoteNumber |
המספר של הערת השוליים הזו שעבר עיבוד. |
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
textStyle |
סגנון הטקסט של FootnoteReference הזה. |
suggestedTextStyleChanges |
סגנון הטקסט המוצע ישתנה ב-FootnoteReference, בקידוד לפי מזהה הצעה. |
HorizontalRule
ParagraphElement
שמייצג קו אופקי.
ייצוג JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
שדות | |
---|---|
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
textStyle |
סגנון הטקסט של הכלל האופקי הזה. בדומה לתוכן טקסט, כמו הרצת טקסט והפניות להערות שוליים, סגנון הטקסט של כלל אופקי יכול להשפיע על פריסת התוכן ועל עיצוב הטקסט שמוסיפים לצידו. |
suggestedTextStyleChanges |
סגנון הטקסט המוצע ישתנה לכלל האופקי הזה, בקידוד לפי מזהה ההצעה. |
משוואה
ParagraphElement
שמייצג משוואה.
ייצוג JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
שדות | |
---|---|
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ב- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
InlineObjectElement
ParagraphElement
שמכיל InlineObject
.
ייצוג JSON |
---|
{ "inlineObjectId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
שדות | |
---|---|
inlineObjectId |
המזהה של |
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ב- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
textStyle |
סגנון הטקסט של InlineObjectElement הזה. בדומה לתוכן טקסט, כמו הרצת טקסט והפניות להערות שוליים, סגנון הטקסט של רכיב אובייקט מוטבע יכול להשפיע על פריסת התוכן ועל עיצוב הטקסט שמוסיפים לצידו. |
suggestedTextStyleChanges |
סגנון הטקסט המוצע ישתנה ל-InlineObject הזה, עם מפתח לפי מזהה ההצעה. |
אדם
אדם או כתובת אימייל שהוזכרו במסמך. האזכורים האלה מתנהגים כרכיב יחיד שלא ניתן לשינוי, שמכיל את השם או את כתובת האימייל של אותו אדם.
ייצוג JSON |
---|
{ "personId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
שדות | |
---|---|
personId |
פלט בלבד. המזהה הייחודי של הקישור הזה. |
suggestedInsertionIds[] |
המזהים של הצעות שמוסיפות את הקישור לאדם הזה למסמך. ל- |
suggestedDeletionIds[] |
מזהים של הצעות להסרת הקישור לאדם הזה מהמסמך. ל- |
textStyle |
סגנון הטקסט של |
suggestedTextStyleChanges |
סגנון הטקסט המוצע ישתנה ל |
personProperties |
פלט בלבד. המאפיינים של |
PersonProperties
מאפיינים שספציפיים לחשבון Person
מקושר.
ייצוג JSON |
---|
{ "name": string, "email": string } |
שדות | |
---|---|
name |
פלט בלבד. שם האדם, אם הוא מוצג בטקסט הקישור, במקום כתובת האימייל שלו. |
email |
פלט בלבד. כתובת האימייל שמקושרת ל- |
RichLink
קישור למשאב של Google (כמו קובץ ב-Drive, סרטון ב-YouTube או אירוע ביומן).
ייצוג JSON |
---|
{ "richLinkId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
שדות | |
---|---|
richLinkId |
פלט בלבד. המזהה של הקישור הזה. |
suggestedInsertionIds[] |
מזהים של הצעות שמוסיפות את הקישור הזה למסמך. ל- |
suggestedDeletionIds[] |
מזהים של הצעות להסרת הקישור הזה מהמסמך. ל- |
textStyle |
סגנון הטקסט של |
suggestedTextStyleChanges |
סגנון הטקסט המוצע ישתנה ל |
richLinkProperties |
פלט בלבד. המאפיינים של |
RichLinkProperties
מאפיינים ספציפיים ל-RichLink
.
ייצוג JSON |
---|
{ "title": string, "uri": string, "mimeType": string } |
שדות | |
---|---|
title |
פלט בלבד. הכותרת של |
uri |
פלט בלבד. ה-URI ל- |
mimeType |
פלט בלבד. סוג MIME של |
סגנון פסקה
סגנונות שחלים על פסקה שלמה.
סגנונות פסקה שעברו בירושה מיוצגים כשדות לא מוגדרים בהודעה הזו. ההורה של סגנון הפסקה תלוי במיקום שבו מוגדר סגנון הפסקה:
- סגנון הפיסקה ב
Paragraph
יורש את ה-named style type
התואם בפסקה. - ה-PagraphStyle ב-
named style
יורש את הסגנון בעל השםnormal text
. - סגנון הפיסקה של הסגנון בעל השם
normal text
יורש את סגנון ברירת המחדל של הפסקה בעורך Docs. - סגנון הפסקה ברכיב
Paragraph
שנכלל בטבלה עשוי לרשת את סגנון הפסקה מסגנון הטבלה.
אם סגנון הפסקה לא יורש מהורה, ביטול ההגדרה של שדות יחזיר את הסגנון לערך שתואם לברירות המחדל בעורך Docs.
ייצוג JSON |
---|
{ "headingId": string, "namedStyleType": enum ( |
שדות | |
---|---|
headingId |
מזהה הכותרת של הפסקה. אם השדה ריק, הפסקה הזו אינה כותרת. הנכס הזה הוא לקריאה בלבד. |
namedStyleType |
סוג הסגנון של הפסקה, בעל השם. מכיוון שעדכון של סוג הסגנון בעל השם משפיע על מאפיינים אחרים ב-PagraphStyle, המערכת מחילה את סוג הסגנון בעל השם לפני ששאר המאפיינים מתעדכנים. |
alignment |
יישור הטקסט בפסקה הזו. |
lineSpacing |
כמות הרווח בין השורות, כאחוז מהנורמלי, כאשר הערך הרגיל מיוצג באמצעות 100.0. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. |
direction |
כיוון הטקסט של הפסקה הזו. אם המדיניות לא מוגדרת, ערך ברירת המחדל הוא |
spacingMode |
מצב הריווח בין הפסקה. |
spaceAbove |
גודל הרווח הנוסף מעל הפסקה. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. |
spaceBelow |
כמות השטח הנוסף מתחת לפסקה. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. |
borderBetween |
הגבול בין הפיסקה הזו לפיסקה הבאה והפיסקה הקודמת. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. הגבול שבין גבול מוצג כאשר לפסקה הסמוכה יש אותם מאפייני גבול וכניסת פסקה. לא ניתן לעדכן באופן חלקי את גבולות הפסקאות. כשמשנים גבול בפסקה, יש לציין את הגבול החדש בשלמותו. |
borderTop |
הגבול בחלק העליון של פסקה זו. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. הגבול העליון מוצג כאשר לפסקה שלמעלה יש מאפייני גבול וכניסת פסקה שונים. לא ניתן לעדכן באופן חלקי את גבולות הפסקאות. כשמשנים גבול בפסקה, יש לציין את הגבול החדש בשלמותו. |
borderBottom |
הגבול שבתחתית הפיסקה הזו. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. הגבול התחתון מוצג כאשר לפסקה שלמטה יש מאפייני גבול וכניסת פסקה שונים. לא ניתן לעדכן באופן חלקי את גבולות הפסקאות. כשמשנים גבול בפסקה, יש לציין את הגבול החדש בשלמותו. |
borderLeft |
הגבול שמשמאל לפסקה הזו. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. לא ניתן לעדכן באופן חלקי את גבולות הפסקאות. כשמשנים גבול בפסקה, יש לציין את הגבול החדש בשלמותו. |
borderRight |
הגבול מימין לפיסקה זו. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. לא ניתן לעדכן באופן חלקי את גבולות הפסקאות. כשמשנים גבול בפסקה, יש לציין את הגבול החדש בשלמותו. |
indentFirstLine |
מידת כניסת הפיסקה בשורה הראשונה בפסקה. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. |
indentStart |
מידת כניסת הפיסקה בצד ימין שמתאימה לתחילת הטקסט, על סמך כיוון הפסקה הנוכחי. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. |
indentEnd |
מידת כניסת הפיסקה בצד ימין שמתאימה לסוף הטקסט, על סמך כיוון הפסקה הנוכחי. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. |
tabStops[] |
רשימת הטאבים נעצרת בפסקה הזו. הרשימה של עצירות הטאב לא עוברת בירושה. הנכס הזה הוא לקריאה בלבד. |
keepLinesTogether |
האם כל השורות בפסקה צריכות להיות פרוסות באותו דף או באותו עמודה, אם אפשר. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. |
keepWithNext |
אם אפשר, אם אפשר, לפרוס לפחות חלק מפסקה זו באותו דף או עמודה כמו בפסקה העוקבת לה. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. |
avoidWidowAndOrphan |
האם להימנע מאלמנים ויתומים בפסקה. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. |
shading |
ההצללה של הפסקה. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. |
pageBreakBefore |
אם הפסקה הנוכחית צריכה להתחיל תמיד בתחילת דף. אם המדיניות לא מוגדרת, הערך עובר בירושה מתבניות ההורה. ניסיון לעדכן את |
NamedStyleType
סוגי הסגנונות של הסגנונות.
טיפוסים בני מנייה (enum) | |
---|---|
NAMED_STYLE_TYPE_UNSPECIFIED |
לא צוין סוג הסגנון בעל השם. |
NORMAL_TEXT |
טקסט רגיל. |
TITLE |
כותרת. |
SUBTITLE |
כתובית. |
HEADING_1 |
כותרת 1. |
HEADING_2 |
כותרת 2. |
HEADING_3 |
כותרת 3. |
HEADING_4 |
כותרת 4. |
HEADING_5 |
כותרת 5. |
HEADING_6 |
כותרת 6. |
יישור
סוגי היישור של טקסט בפסקה.
טיפוסים בני מנייה (enum) | |
---|---|
ALIGNMENT_UNSPECIFIED |
היישור בין הפסקאות עובר בירושה מתבנית ההורה. |
START |
הפסקה מיושרת לתחילת השורה. יישור לשמאל לטקסט LTR, אחרת מיושר לימין. |
CENTER |
הפסקה במרכז. |
END |
הפסקה מיושרת לסוף השורה. יישור לימין לטקסט LTR, אחרת מיושר לשמאל. |
JUSTIFIED |
הפסקה ישרה. |
ContentDirection
התוכן של המסלול יכול לזרום.
טיפוסים בני מנייה (enum) | |
---|---|
CONTENT_DIRECTION_UNSPECIFIED |
כיוון התוכן לא צוין. |
LEFT_TO_RIGHT |
התוכן מופיע משמאל לימין. |
RIGHT_TO_LEFT |
התוכן מופיע מימין לשמאל. |
SpacingMode
המצבים השונים של ריווח פסקאות.
טיפוסים בני מנייה (enum) | |
---|---|
SPACING_MODE_UNSPECIFIED |
מצב הריווח עובר בירושה מתבנית ההורה. |
NEVER_COLLAPSE |
הריווח של הפסקאות תמיד מוצג. |
COLLAPSE_LISTS |
המערכת מדלגת על רווחים בין פסקאות. |
ParagraphBorder
גבול מסביב לפיסקה.
ייצוג JSON |
---|
{ "color": { object ( |
שדות | |
---|---|
color |
צבע הגבול. |
width |
רוחב הגבול. |
padding |
המרווח הפנימי של הגבול. |
dashStyle |
סגנון המקף של הגבול. |
DashStyle
סוגי המקפים שבהם אפשר לעבד גיאומטריה לינארית. הערכים האלה מבוססים על העמודה 'ST_PresetLineDashVal' סוג פשוט המתואר בסעיף 20.1.10.48 של "פורמטים של קובצי XML פתוחים ל-Office - יסודות ושפת הסימון", חלק 1 של ECMA-376 מהדורה רביעית.
טיפוסים בני מנייה (enum) | |
---|---|
DASH_STYLE_UNSPECIFIED |
סגנון המקף לא צוין. |
SOLID |
קו רציף. תואם לערך 'solid' של ECMA-376 ST_PresetLineDashVal. זהו סגנון ברירת המחדל של הקו. |
DOT |
קו מקווקו. תואם לערך 'dot' של ECMA-376 ST_PresetLineDashVal. |
DASH |
קו מקווקו. תואם לערך 'dash' של ECMA-376 ST_PresetLineDashVal. |
TabStop
עצירת טאב בתוך פסקה.
ייצוג JSON |
---|
{ "offset": { object ( |
שדות | |
---|---|
offset |
ההיסט בין עצירת הטאב הזו לבין שולי ההתחלה. |
alignment |
היישור של עצירת הטאב הזו. אם המדיניות לא מוגדרת, ערך ברירת המחדל הוא |
TabStopAlignment
היישור של עצירת הטאב.
טיפוסים בני מנייה (enum) | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED |
לא צוין יישור לעצירת הטאב. |
START |
עצירת הטאב מיושרת לתחילת הקו. (זוהי ברירת המחדל) |
CENTER |
עצירת הטאב מיושרת למרכז הקו. |
END |
עצירת הטאב מיושרת לסוף הקו. |
הצללה
את ההצללה של פסקה.
ייצוג JSON |
---|
{
"backgroundColor": {
object ( |
שדות | |
---|---|
backgroundColor |
צבע הרקע של ההצללה של פסקה זו. |
SuggestedParagraphStyle
הצעה לשינוי ל-ParagraphStyle
.
ייצוג JSON |
---|
{ "paragraphStyle": { object ( |
שדות | |
---|---|
paragraphStyle |
|
paragraphStyleSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
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 ( |
שדות | |
---|---|
headingIdSuggested |
שדה זה מציין אם הוצע שינוי ל- |
namedStyleTypeSuggested |
שדה זה מציין אם הוצע שינוי ל- |
alignmentSuggested |
שדה זה מציין אם הוצע שינוי ל- |
lineSpacingSuggested |
שדה זה מציין אם הוצע שינוי ל- |
directionSuggested |
שדה זה מציין אם הוצע שינוי ל- |
spacingModeSuggested |
שדה זה מציין אם הוצע שינוי ל- |
spaceAboveSuggested |
שדה זה מציין אם הוצע שינוי ל- |
spaceBelowSuggested |
שדה זה מציין אם הוצע שינוי ל- |
borderBetweenSuggested |
שדה זה מציין אם הוצע שינוי ל- |
borderTopSuggested |
שדה זה מציין אם הוצע שינוי ל- |
borderBottomSuggested |
שדה זה מציין אם הוצע שינוי ל- |
borderLeftSuggested |
שדה זה מציין אם הוצע שינוי ל- |
borderRightSuggested |
שדה זה מציין אם הוצע שינוי ל- |
indentFirstLineSuggested |
שדה זה מציין אם הוצע שינוי ל- |
indentStartSuggested |
שדה זה מציין אם הוצע שינוי ל- |
indentEndSuggested |
שדה זה מציין אם הוצע שינוי ל- |
keepLinesTogetherSuggested |
שדה זה מציין אם הוצע שינוי ל- |
keepWithNextSuggested |
שדה זה מציין אם הוצע שינוי ל- |
avoidWidowAndOrphanSuggested |
שדה זה מציין אם הוצע שינוי ל- |
shadingSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
pageBreakBeforeSuggested |
שדה זה מציין אם הוצע שינוי ל- |
ShadingSuggestionState
מסכה שמציינת אילו מהשדות בבסיס Shading
השתנו בשינוי המוצע הזה. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "backgroundColorSuggested": boolean } |
שדות | |
---|---|
backgroundColorSuggested |
שדה זה מציין אם הוצע שינוי ב- |
תבליט
מתאר את התבליט של פסקה.
ייצוג JSON |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
שדות | |
---|---|
listId |
המזהה של הרשימה שאליה שייכת הפיסקה הזו. |
nestingLevel |
רמת הסידור הפנימי של הפסקה הזו ברשימה. |
textStyle |
סגנון הטקסט הספציפי לפסקה שהוחל על התבליט הזה. |
SuggestedBullet
הצעה לשינוי ל-Bullet
.
ייצוג JSON |
---|
{ "bullet": { object ( |
שדות | |
---|---|
bullet |
|
bulletSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
BulletSuggestionState
מסכה שמציינת אילו מהשדות בבסיס Bullet
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{
"listIdSuggested": boolean,
"nestingLevelSuggested": boolean,
"textStyleSuggestionState": {
object ( |
שדות | |
---|---|
listIdSuggested |
שדה זה מציין אם הוצע שינוי ב- |
nestingLevelSuggested |
שדה זה מציין אם הוצע שינוי ב- |
textStyleSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
ObjectReferences
אוסף של מזהי אובייקטים.
ייצוג JSON |
---|
{ "objectIds": [ string ] } |
שדות | |
---|---|
objectIds[] |
מזהי האובייקטים |
SectionBreak
StructuralElement
שמייצג מעבר קטע. קטע הוא טווח של תוכן עם אותו SectionStyle
. מעבר קטע מייצג את ההתחלה של קטע חדש, וסגנון הקטע חל על הקטע אחרי מעבר הקטע.
גוף המסמך תמיד מתחיל במעבר קטע.
ייצוג JSON |
---|
{
"suggestedInsertionIds": [
string
],
"suggestedDeletionIds": [
string
],
"sectionStyle": {
object ( |
שדות | |
---|---|
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
sectionStyle |
הסגנון של הקטע אחרי מעבר הקטע הזה. |
SectionStyle
הסגנון שרלוונטי לקטע מסוים.
ייצוג JSON |
---|
{ "columnProperties": [ { object ( |
שדות | |
---|---|
columnProperties[] |
מאפייני העמודות של הקטע. אם השדה ריק, הקטע מכיל עמודה אחת עם מאפייני ברירת המחדל בעורך Docs. אפשר לעדכן קטע כך שלא יכלול יותר מ-3 עמודות. כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
columnSeparatorStyle |
הסגנון של תווי הפרדה בין עמודות. אפשר להגדיר את הסגנון הזה גם כשיש עמודה אחת בקטע. כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
contentDirection |
כיוון התוכן של הקטע הזה. אם המדיניות לא מוגדרת, ערך ברירת המחדל הוא כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
marginTop |
השוליים העליונים של הקטע. אם לא מוגדר, ערך ברירת המחדל הוא כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
marginBottom |
השוליים התחתוניים של הקטע. אם לא מוגדר, ערך ברירת המחדל הוא כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
marginRight |
השוליים השמאליים של הקטע. אם לא מוגדר, ערך ברירת המחדל הוא כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
marginLeft |
השוליים השמאליים של הקטע. אם לא מוגדר, ערך ברירת המחדל הוא כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
marginHeader |
השוליים של הכותרת העליונה של הקטע. אם לא מוגדר, ערך ברירת המחדל הוא כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
marginFooter |
השוליים של הכותרת התחתונה בקטע. אם לא מוגדר, ערך ברירת המחדל הוא כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
sectionType |
פלט בלבד. סוג הקטע. |
defaultHeaderId |
המזהה של כותרת ברירת המחדל. אם המדיניות לא מוגדרת, הערך עובר בירושה מסגנון המדור הקודם של הנכס הזה הוא לקריאה בלבד. |
defaultFooterId |
המזהה של הכותרת התחתונה המוגדרת כברירת המחדל. אם המדיניות לא מוגדרת, הערך עובר בירושה מסגנון המדור הקודם של הנכס הזה הוא לקריאה בלבד. |
firstPageHeaderId |
מזהה הכותרת שמשמשת רק את הדף הראשון של הקטע. אם הערך של הנכס הזה הוא לקריאה בלבד. |
firstPageFooterId |
מזהה הכותרת התחתונה המשמש רק לדף הראשון של הקטע. אם הערך של הנכס הזה הוא לקריאה בלבד. |
evenPageHeaderId |
מזהה הכותרת שמשמשת רק לדפים זוגיים. אם הערך של הנכס הזה הוא לקריאה בלבד. |
evenPageFooterId |
המזהה של הכותרת התחתונה משמש רק לדפים זוגיים. אם הערך של הנכס הזה הוא לקריאה בלבד. |
useFirstPageHeaderFooter |
מציין אם להשתמש במזהים של הכותרת העליונה / הכותרת התחתונה בדף הראשון של הקטע. אם היא לא מוגדרת, היא עוברת בירושה מה כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
pageNumberStart |
מספר הדף שממנו יש להתחיל בספירת הדפים עבור הקטע הזה. אם המדיניות לא מוגדרת, מספור הדפים ממשיך מהקטע הקודם. אם הערך לא מוגדר ב- כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
flipPageOrientation |
זה שינוי אופציונלי. מציינת אם להפוך את המידות של כשמעדכנים את הנכס הזה, חובה להגדיר ערך קונקרטי. ביטול ההגדרה של המאפיין הזה יגרום לשגיאה 400 של בקשה שגויה. |
SectionColumnProperties
מאפיינים שחלים על עמודה של מקטע.
ייצוג JSON |
---|
{ "width": { object ( |
שדות | |
---|---|
width |
פלט בלבד. רוחב העמודה. |
paddingEnd |
המרווח הפנימי בסוף העמודה. |
ColumnSeparatorStyle
הסגנון של תווי ההפרדה בין עמודות.
טיפוסים בני מנייה (enum) | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED |
סגנון מפריד עמודות שלא צוין. |
NONE |
אין קווים מפרידים בין עמודות. |
BETWEEN_EACH_COLUMN |
הפונקציה יוצרת קו מפריד בין עמודות. |
SectionType
מייצג את המיקום של תחילת הקטע הנוכחי ביחס לקטע הקודם.
טיפוסים בני מנייה (enum) | |
---|---|
SECTION_TYPE_UNSPECIFIED |
סוג הקטע לא צוין. |
CONTINUOUS |
הקטע מתחיל מיד אחרי הפסקה האחרונה של הקטע הקודם. |
NEXT_PAGE |
הקטע יתחיל בדף הבא. |
טבלה
StructuralElement
שמייצג טבלה.
ייצוג JSON |
---|
{ "rows": integer, "columns": integer, "tableRows": [ { object ( |
שדות | |
---|---|
rows |
מספר השורות בטבלה. |
columns |
מספר העמודות בטבלה. טבלה יכולה להיות לא מלבנית, ולכן בחלק מהשורות מספר התאים שונה. |
tableRows[] |
התוכן והסגנון של כל שורה. |
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
tableStyle |
סגנון הטבלה. |
TableRow
התוכן והסגנון של שורה ב-Table
.
ייצוג JSON |
---|
{ "startIndex": integer, "endIndex": integer, "tableCells": [ { object ( |
שדות | |
---|---|
startIndex |
אינדקס ההתחלה מבוסס אפס של שורה זו, ביחידות קוד UTF-16. |
endIndex |
אינדקס הקצה מבוסס אפס של שורה זו, בלעדי, ביחידות קוד UTF-16. |
tableCells[] |
התוכן והסגנון של כל תא בשורה הזו. טבלה יכולה להיות לא מלבנית, לכן בחלק מהשורות עשוי להיות מספר תאים שונה מזה של שורות אחרות באותה טבלה. |
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
tableRowStyle |
הסגנון של השורה בטבלה. |
suggestedTableRowStyleChanges |
ההצעות לשינויי סגנון בשורה הזו, עם קידוד לפי מזהה ההצעה. |
TableCell
התוכן והסגנון של תא ב-Table
.
ייצוג JSON |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
שדות | |
---|---|
startIndex |
אינדקס ההתחלה אפס של התא הזה, ביחידות קוד מסוג UTF-16. |
endIndex |
אינדקס הקצה מבוסס אפס של התא הזה, בלעדי, ביחידות קוד UTF-16. |
content[] |
תוכן התא. |
tableCellStyle |
הסגנון של התא. |
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
suggestedTableCellStyleChanges |
ההצעות לשינויים בסגנון התא בטבלה, עם מיקוד לפי מזהה ההצעה. |
TableCellStyle
הסגנון של TableCell
.
סגנונות של תאים בטבלה שעברו בירושה מיוצגים כשדות לא מוגדרים בהודעה הזו. סגנון של תא בטבלה יכול לקבל בירושה מהסגנון של הטבלה.
ייצוג JSON |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
שדות | |
---|---|
rowSpan |
טווח השורה של התא. הנכס הזה הוא לקריאה בלבד. |
columnSpan |
טווח העמודה של התא. הנכס הזה הוא לקריאה בלבד. |
backgroundColor |
צבע הרקע של התא. |
borderLeft |
הגבול השמאלי של התא. |
borderRight |
הגבול הימני של התא. |
borderTop |
הגבול העליון של התא. |
borderBottom |
הגבול התחתון של התא. |
paddingLeft |
המרווח הפנימי השמאלי של התא. |
paddingRight |
המרווח הפנימי הימני של התא. |
paddingTop |
המרווח הפנימי העליון של התא. |
paddingBottom |
המרווח הפנימי התחתון של התא. |
contentAlignment |
היישור של התוכן בתא בטבלה. יישור ברירת המחדל תואם ליישור של תאים חדשים בטבלה שנוצרו בעורך Docs. |
TableCellBorder
גבול מסביב לתא בטבלה.
גבולות התאים בטבלה לא יכולים להיות שקופים. כדי להסתיר גבול של תא בטבלה, צריך לשנות את הרוחב של 0.
ייצוג JSON |
---|
{ "color": { object ( |
שדות | |
---|---|
color |
צבע הגבול. הצבע הזה לא יכול להיות שקוף. |
width |
רוחב הגבול. |
dashStyle |
סגנון המקף של הגבול. |
ContentAlignment
סוגי ההתאמה של התוכן.
נגזר מתת-קבוצה של הערכים של "ST_TextDescriptioningType" הקלדה פשוטה בסעיף 20.1.10.59 של "Office Open XML File Formats - Fundamentals and Markup Language Reference", חלק 1 של ECMA-376 מהדורת 4th.
טיפוסים בני מנייה (enum) | |
---|---|
CONTENT_ALIGNMENT_UNSPECIFIED |
התאמת תוכן שלא צוינה. התאמת התוכן עוברת בירושה מתבנית ההורה, אם יש כזו. |
CONTENT_ALIGNMENT_UNSUPPORTED |
יישור תוכן שלא נתמך. |
TOP |
יישור שמיישר את התוכן לחלק העליון של בעלי התוכן. תואם ל-ECMA-376 ST_TextTextingType 't'. |
MIDDLE |
יישור שמיישר את התוכן לאמצע התוכן. תואם ל-ECMA-376 ST_TextTextingType 'ctr'. |
BOTTOM |
יישור שמיישר את התוכן לתחתית של בעלי התוכן. תואם ל-ECMA-376 ST_TextTextingType 'b' . |
SuggestedTableCellStyle
הצעה לשינוי ל-TableCellStyle
.
ייצוג JSON |
---|
{ "tableCellStyle": { object ( |
שדות | |
---|---|
tableCellStyle |
|
tableCellStyleSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
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 |
שדה זה מציין אם הוצע שינוי ל- |
columnSpanSuggested |
שדה זה מציין אם הוצע שינוי ל- |
backgroundColorSuggested |
שדה זה מציין אם הוצע שינוי ל- |
borderLeftSuggested |
שדה זה מציין אם הוצע שינוי ל- |
borderRightSuggested |
שדה זה מציין אם הוצע שינוי ל- |
borderTopSuggested |
שדה זה מציין אם הוצע שינוי ל- |
borderBottomSuggested |
שדה זה מציין אם הוצע שינוי ל- |
paddingLeftSuggested |
שדה זה מציין אם הוצע שינוי ל- |
paddingRightSuggested |
שדה זה מציין אם הוצע שינוי ל- |
paddingTopSuggested |
שדה זה מציין אם הוצע שינוי ל- |
paddingBottomSuggested |
שדה זה מציין אם הוצע שינוי ל- |
contentAlignmentSuggested |
שדה זה מציין אם הוצע שינוי ל- |
TableRowStyle
סגנונות שחלים על שורה בטבלה.
ייצוג JSON |
---|
{
"minRowHeight": {
object ( |
שדות | |
---|---|
minRowHeight |
הגובה המינימלי של השורה. השורה תעובד בעורך Docs בגובה ששווה לערך הזה או גדול ממנו, כדי להציג את כל התוכן בתאים של השורה. |
tableHeader |
האם השורה היא כותרת של טבלה. |
preventOverflow |
האם השורה לא יכולה לגלוש מעבר לגבולות הדפים או העמודות. |
SuggestedTableRowStyle
הצעה לשינוי ל-TableRowStyle
.
ייצוג JSON |
---|
{ "tableRowStyle": { object ( |
שדות | |
---|---|
tableRowStyle |
|
tableRowStyleSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
TableRowStyleSuggestionState
מסכה שמציינת אילו מהשדות בבסיס TableRowStyle
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "minRowHeightSuggested": boolean } |
שדות | |
---|---|
minRowHeightSuggested |
שדה זה מציין אם הוצע שינוי ל- |
TableStyle
סגנונות שחלים על טבלה.
ייצוג JSON |
---|
{
"tableColumnProperties": [
{
object ( |
שדות | |
---|---|
tableColumnProperties[] |
המאפיינים של כל עמודה. שימו לב שב-Docs, טבלאות מכילות שורות ושורות מכילות תאים, בדומה ל-HTML. לכן, המאפיינים של שורה נמצאים ב- |
TableColumnProperties
המאפיינים של עמודה בטבלה.
ייצוג JSON |
---|
{ "widthType": enum ( |
שדות | |
---|---|
widthType |
סוג הרוחב של העמודה. |
width |
רוחב העמודה. מגדירים מתי הערך של |
WidthType
סוג הרוחב של העמודה.
טיפוסים בני מנייה (enum) | |
---|---|
WIDTH_TYPE_UNSPECIFIED |
סוג הרוחב של העמודה לא צוין. |
EVENLY_DISTRIBUTED |
רוחב העמודה מחולק באופן שווה בין העמודות האחרות המפוזרות באופן שווה. רוחב העמודה נקבע באופן אוטומטי, וחלק מהרוחב שנותר לטבלה יהיה שווה, אחרי התייחסות לכל העמודות במידות הרוחב שצוינו. |
FIXED_WIDTH |
רוחב עמודה קבוע. המאפיין [width][google.apps.docs.v1.TableColumnProperties.width ] מכיל את רוחב העמודה. |
TableOfContents
StructuralElement
שמייצג תוכן עניינים.
ייצוג JSON |
---|
{
"content": [
{
object ( |
שדות | |
---|---|
content[] |
התוכן של תוכן העניינים. |
suggestedInsertionIds[] |
מזהי ההוספה המוצעים. ל- |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
שם
כותרת של מסמך.
ייצוג JSON |
---|
{
"headerId": string,
"content": [
{
object ( |
שדות | |
---|---|
headerId |
המזהה של הכותרת. |
content[] |
תוכן הכותרת. האינדקסים של תוכן כותרת מתחילים באפס. |
הערת שוליים
הערת שוליים של מסמך.
ייצוג JSON |
---|
{
"footnoteId": string,
"content": [
{
object ( |
שדות | |
---|---|
footnoteId |
המזהה של הערת השוליים. |
content[] |
התוכן של הערת השוליים. האינדקסים של תוכן של הערת שוליים מתחילים באפס. |
DocumentStyle
סגנון המסמך.
ייצוג JSON |
---|
{ "background": { object ( |
שדות | |
---|---|
background |
הרקע של המסמך. צבע הרקע של המסמכים לא יכול להיות שקוף. |
defaultHeaderId |
המזהה של כותרת ברירת המחדל. אם המדיניות לא מוגדרת, אין כותרת ברירת מחדל. הנכס הזה הוא לקריאה בלבד. |
defaultFooterId |
המזהה של הכותרת התחתונה המוגדרת כברירת המחדל. אם המדיניות לא מוגדרת, אין כותרת תחתונה שתשמש כברירת מחדל. הנכס הזה הוא לקריאה בלבד. |
evenPageHeaderId |
מזהה הכותרת שמשמשת רק לדפים זוגיים. הערך של הנכס הזה הוא לקריאה בלבד. |
evenPageFooterId |
המזהה של הכותרת התחתונה משמש רק לדפים זוגיים. הערך של הנכס הזה הוא לקריאה בלבד. |
firstPageHeaderId |
מזהה הכותרת שמשמשת רק לדף הראשון. אם המדיניות לא מוגדרת, לא קיימת כותרת ייחודית לדף הראשון. הערך של הנכס הזה הוא לקריאה בלבד. |
firstPageFooterId |
המזהה של הכותרת התחתונה המשמש רק לדף הראשון. אם המדיניות לא מוגדרת, לא קיימת כותרת תחתונה ייחודית לדף הראשון. הערך של הנכס הזה הוא לקריאה בלבד. |
useFirstPageHeaderFooter |
מציין אם להשתמש במזהים של הכותרת העליונה / הכותרת התחתונה בדף הראשון. |
useEvenPageHeaderFooter |
מציין אם להשתמש במזהים של כותרות / תחתונות בדפים זוגיים. |
pageNumberStart |
מספר הדף שממנו יש להתחיל בספירת הדפים. |
marginTop |
השוליים העליונים של הדף. עדכון השוליים העליונים של סגנון המסמך מנקה את השוליים העליונים בכל סגנונות הקטעים. |
marginBottom |
השוליים התחתוניים של הדף. עדכון השוליים התחתוניים של סגנון המסמך מנקה את השוליים התחתונים של הדף בכל סגנונות הקטעים. |
marginRight |
השוליים השמאליים של הדף. עדכון השוליים השמאליים בסגנון המסמך מנקה את השוליים הימניים בכל סגנונות הקטעים. היא עלולה גם לגרום לשינוי גודל של עמודות בכל הקטעים. |
marginLeft |
השוליים השמאליים של הדף. עדכון השוליים השמאליים בסגנון המסמך מנקה את השוליים השמאליים של כל סגנונות הקטעים. היא עלולה גם לגרום לשינוי גודל של עמודות בכל הקטעים. |
pageSize |
גודל הדף במסמך. |
marginHeader |
הרווח בין החלק העליון של הדף לתוכן של הכותרת. |
marginFooter |
הרווח בין החלק התחתון של הדף לתוכן של הכותרת התחתונה. |
useCustomHeaderFooterMargins |
מציין אם נעשה שימוש ב-DocumentStyle הנכס הזה הוא לקריאה בלבד. |
flipPageOrientation |
זה שינוי אופציונלי. מאפיין זה מציין אם להפוך את המידות של |
רקע
מייצג את הרקע של מסמך.
ייצוג JSON |
---|
{
"color": {
object ( |
שדות | |
---|---|
color |
צבע הרקע |
גודל
רוחב וגובה.
ייצוג JSON |
---|
{ "height": { object ( |
שדות | |
---|---|
height |
גובה האובייקט. |
width |
רוחב האובייקט. |
SuggestedDocumentStyle
הצעה לשינוי ב-DocumentStyle
.
ייצוג JSON |
---|
{ "documentStyle": { object ( |
שדות | |
---|---|
documentStyle |
|
documentStyleSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
DocumentStyleSuggestionState
מסכה שמציינת אילו מהשדות בבסיס DocumentStyle
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "backgroundSuggestionState": { object ( |
שדות | |
---|---|
backgroundSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
defaultHeaderIdSuggested |
שדה זה מציין אם הוצע שינוי ל- |
defaultFooterIdSuggested |
שדה זה מציין אם הוצע שינוי ל- |
evenPageHeaderIdSuggested |
שדה זה מציין אם הוצע שינוי ל- |
evenPageFooterIdSuggested |
שדה זה מציין אם הוצע שינוי ל- |
firstPageHeaderIdSuggested |
שדה זה מציין אם הוצע שינוי ל- |
firstPageFooterIdSuggested |
שדה זה מציין אם הוצע שינוי ל- |
useFirstPageHeaderFooterSuggested |
שדה זה מציין אם הוצע שינוי ל- |
useEvenPageHeaderFooterSuggested |
שדה זה מציין אם הוצע שינוי ל- |
pageNumberStartSuggested |
שדה זה מציין אם הוצע שינוי ל- |
marginTopSuggested |
שדה זה מציין אם הוצע שינוי ל- |
marginBottomSuggested |
שדה זה מציין אם הוצע שינוי ל- |
marginRightSuggested |
שדה זה מציין אם הוצע שינוי ל- |
marginLeftSuggested |
שדה זה מציין אם הוצע שינוי ל- |
pageSizeSuggestionState |
מסכה שמציינת אילו מהשדות ב-[size] [google.apps.docs.v1.DocumentStyle.size] השתנו בהצעה הזו. |
marginHeaderSuggested |
שדה זה מציין אם הוצע שינוי ל- |
marginFooterSuggested |
שדה זה מציין אם הוצע שינוי ל- |
useCustomHeaderFooterMarginsSuggested |
שדה זה מציין אם הוצע שינוי ל- |
flipPageOrientationSuggested |
זה שינוי אופציונלי. שדה זה מציין אם הוצע שינוי ל- |
BackgroundSuggestionState
מסכה שמציינת אילו מהשדות בבסיס Background
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True, יש ל-Backgound
ערך מוצע חדש.
ייצוג JSON |
---|
{ "backgroundColorSuggested": boolean } |
שדות | |
---|---|
backgroundColorSuggested |
השדה הזה מציין אם צבע הרקע הנוכחי השתנה בהצעה הזו. |
SizeSuggestionState
מסכה שמציינת אילו מהשדות בבסיס Size
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True, יש ל-Size
ערך מוצע חדש.
ייצוג JSON |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
שדות | |
---|---|
heightSuggested |
שדה זה מציין אם הוצע שינוי ל- |
widthSuggested |
שדה זה מציין אם הוצע שינוי ל- |
NamedStyles
הסגנונות עם השמות. פסקאות במסמך יכולות לרשת את הTextStyle
והParagraphStyle
שלהן מהסגנונות האלה עם השמות.
ייצוג JSON |
---|
{
"styles": [
{
object ( |
שדות | |
---|---|
styles[] |
הסגנונות עם השמות. יש ערך עבור כל אחד מה- |
NamedStyle
סגנון בעל שם. פסקאות במסמך יכולות לרשת את ה-TextStyle
וה-ParagraphStyle
שלהן מהסגנון בעל השם הזה כשיש להן סוג סגנון בעל שם.
ייצוג JSON |
---|
{ "namedStyleType": enum ( |
שדות | |
---|---|
namedStyleType |
הסוג של הסגנון בעל השם. |
textStyle |
סגנון הטקסט של הסגנון הזה בעל השם. |
paragraphStyle |
סגנון הפסקה של הסגנון הזה. |
SuggestedNamedStyles
הצעה לשינוי ב-NamedStyles
.
ייצוג JSON |
---|
{ "namedStyles": { object ( |
שדות | |
---|---|
namedStyles |
|
namedStylesSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
NamedStylesSuggestionState
מצב ההצעה של הודעת NamedStyles
.
ייצוג JSON |
---|
{
"stylesSuggestionStates": [
{
object ( |
שדות | |
---|---|
stylesSuggestionStates[] |
מסכה שמציינת אילו מהשדות ב- הסדר של המצבים של הצעות הסגנון בעלות השם תואם לסדר של הסגנון התואם בעל השם בהצעה של |
NamedStyleSuggestionState
מצב הצעה של הודעת NamedStyle
.
ייצוג JSON |
---|
{ "namedStyleType": enum ( |
שדות | |
---|---|
namedStyleType |
סוג הסגנון בעל השם שמצב ההצעה הזה תואם לו. השדה הזה זמין לנוחותך כדי להתאים בין NamedStyleSuggestionState לבין |
textStyleSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
paragraphStyleSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
רשימה
רשימה מייצגת את מאפייני הרשימה של קבוצה של פסקאות שכולן משתייכות לאותה רשימה. בפסקה שמופיעה ברשימה יש הפניה למזהה הרשימה ב-bullet
.
ייצוג JSON |
---|
{ "listProperties": { object ( |
שדות | |
---|---|
listProperties |
המאפיינים של הרשימה. |
suggestedListPropertiesChanges |
ההצעות לשינויים במאפייני הרשימה, עם המפתחות לפי מזהה ההצעה. |
suggestedInsertionId |
מזהה ההוספה המוצע. אם השדה ריק, לא ניתן להשתמש בהצעה להזנה. |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם הרשימה ריקה, אין הצעות למחיקת הרשימה. |
ListProperties
המאפיינים של list
שמתארים את המראה והתחושה של תבליטים ששייכים לפסקאות שמשויכות לרשימה.
ייצוג JSON |
---|
{
"nestingLevels": [
{
object ( |
שדות | |
---|---|
nestingLevels[] |
תיאור המאפיינים של התבליטים ברמה המשויכת. רשימה כוללת 9 רמות של קינון לכל היותר. רמת הסידור הפנימי 0 שתואמת לרמה העליונה ביותר ורמת הסידור הפנימי 8 המתאימה ביותר לרמה המקוננת ביותר. רמות הסידור הפנימי מוחזרות בסדר עולה, והרמה הנמוכה ביותר מוחזרת קודם. |
NestingLevel
כולל מאפיינים שמתארים את המראה והתחושה של תבליט רשימה ברמה נתונה של סידור פנימי.
ייצוג JSON |
---|
{ "bulletAlignment": enum ( |
שדות | |
---|---|
bulletAlignment |
יישור התבליט בתוך השטח שהוקצה לעיבוד התבליט. |
glyphFormat |
מחרוזת הפורמט שמשמשת את התבליטים ברמת קינון זו. פורמט הגליף מכיל placeholder אחד או יותר, וה-placeholders האלה מוחלפים בערכים המתאימים בהתאם ל- לדוגמה, פורמט הגליף
פורמט הגליף יכול להכיל placeholders לרמת הסידור הנוכחי וגם placeholders לרמות הקינון ברמת ההורה. לדוגמה, רשימה יכולה לכלול פורמט גליף ברמת
ברמות סידור פנימי, המחרוזת שמחליפה placeholder בפורמט גליף בפסקה מסוימת תלויה בסדר הפסקה ברשימה. |
indentFirstLine |
כמות כניסת הפיסקה בשורה הראשונה של פסקאות ברמת הקינון הזו. |
indentStart |
כמות כניסת הפיסקה בפסקאות ברמת הקינון הזו. מוחל בצד שמתאים לתחילת הטקסט, על סמך כיוון התוכן של הפסקה. |
textStyle |
סגנון הטקסט של תבליטים ברמת קינון זו. |
startNumber |
מספר הפריט הראשון ברשימה ברמת הסידור הפנימי הזו. המערכת מתייחסת לערך 0 כערך של 1 לרשימות עם אותיות ולרשימות של ספרות רומיות. לערכים של 0 וגם 1, רשימות ספרות עם אותיות וספרות רומיות יתחילו ב- רמות בתוך ערכים עם גליפים לא מסודרים לא נלקחות בחשבון בערך הזה. |
שדה איחוד glyph_kind . סוג הגליף שבו משתמשים בתבליטים. ההגדרה הזו מגדירה את הגליף של התבליט שמחליף את מצייני ה-placeholder ב-glyph_format . glyph_kind יכול להיות רק אחת מהאפשרויות הבאות: |
|
glyphType |
סוג הגליף המשמש בתבליטים כאשר פסקאות ברמת קינון זו מסודרות לפי סדר. סוג הגליף קובע את סוג הגליף שמשמש להחלפת placeholders בתוך |
glyphSymbol |
גליף מותאם אישית המשמש בתבליטים כאשר פסקאות ברמת קינון זו אינן מסודרות. סמל הגליף מחליף את ה-placeholders בתוך |
BulletAlignment
סוגי היישור של תבליט.
טיפוסים בני מנייה (enum) | |
---|---|
BULLET_ALIGNMENT_UNSPECIFIED |
יישור התבליטים לא צוין. |
START |
התבליט מיושר לתחילת השטח שהוקצה לעיבוד התבליט. יישור לשמאל לטקסט LTR, אחרת מיושר לימין. |
CENTER |
התבליט מיושר למרכז השטח שהוקצה לעיבוד התבליט. |
END |
התבליט מיושר לסוף השטח שהוקצה לעיבוד התבליט. יישור לימין לטקסט LTR, אחרת מיושר לשמאל. |
GlyphType
סוגי הגליפים שבהם משתמשים תבליטים כאשר פסקאות ברמת קינון זו מסודרות בצורה כזו.
טיפוסים בני מנייה (enum) | |
---|---|
GLYPH_TYPE_UNSPECIFIED |
סוג הגליף לא צוין או שאין תמיכה בו. |
NONE |
מחרוזת ריקה. |
DECIMAL |
מספר, למשל 1 , 2 או 3 . |
ZERO_DECIMAL |
מספר שבו התחילית של מספרים בני ספרה אחת היא אפס, למשל 01 , 02 או 03 . מספרים שיש להם יותר מספרה אחת לא מתחילים באפס. |
UPPER_ALPHA |
אות גדולה, כמו A , B או C . |
ALPHA |
אות קטנה, כמו a , b או c . |
UPPER_ROMAN |
ספרה רומית באותיות רישיות, כמו I , II או III . |
ROMAN |
ספרה רומית קטנה, כמו i , ii או iii . |
SuggestedListProperties
הצעה לשינוי ב-ListProperties
.
ייצוג JSON |
---|
{ "listProperties": { object ( |
שדות | |
---|---|
listProperties |
|
listPropertiesSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
ListPropertiesSuggestionState
מסכה שמציינת אילו מהשדות בבסיס ListProperties
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{
"nestingLevelsSuggestionStates": [
{
object ( |
שדות | |
---|---|
nestingLevelsSuggestionStates[] |
מסכה שמציינת אילו מהשדות ב- מצבי ההצעה של רמת הסידור הפנימי מוחזרים בסדר עולה של רמת הסידור הפנימי, והרמה הנמוכה ביותר מוחזרת קודם. |
NestingLevelSuggestionState
מסכה שמציינת אילו מהשדות בבסיס NestingLevel
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{
"bulletAlignmentSuggested": boolean,
"glyphTypeSuggested": boolean,
"glyphFormatSuggested": boolean,
"glyphSymbolSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"textStyleSuggestionState": {
object ( |
שדות | |
---|---|
bulletAlignmentSuggested |
שדה זה מציין אם הוצע שינוי ל- |
glyphTypeSuggested |
שדה זה מציין אם הוצע שינוי ל- |
glyphFormatSuggested |
שדה זה מציין אם הוצע שינוי ל- |
glyphSymbolSuggested |
שדה זה מציין אם הוצע שינוי ל- |
indentFirstLineSuggested |
שדה זה מציין אם הוצע שינוי ל- |
indentStartSuggested |
שדה זה מציין אם הוצע שינוי ל- |
textStyleSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
startNumberSuggested |
שדה זה מציין אם הוצע שינוי ל- |
NamedRanges
אוסף של כל הפריטים מסוג 'NamedRange
' במסמך שיש להם שם מסוים.
ייצוג JSON |
---|
{
"name": string,
"namedRanges": [
{
object ( |
שדות | |
---|---|
name |
השם הזה משותף לכל |
namedRanges[] |
פריטי |
NamedRange
אוסף של Range
עם אותו מזהה של טווח תאים בעל שם.
טווחי תאים בעלי שם מאפשרים למפתחים לשייך חלקים ממסמך לתווית שרירותית שהוגדרה על ידי המשתמש, כדי שניתן יהיה לקרוא או לערוך את התוכן שלהם באופן פרוגרמטי מאוחר יותר. מסמך יכול להכיל כמה טווחי תאים בעלי שם זהה, אבל לכל טווח בעל שם יש מזהה ייחודי.
המערכת יוצרת טווח תאים בעל שם עם Range
יחיד, ותוכן שמוסיפים לטווח תאים בעל שם מרחיב בדרך כלל את הטווח הזה. עם זאת, שינויים מסוימים במסמך עלולים לגרום לפיצול הטווח למספר טווחים.
טווחי תאים בעלי שם לא פרטיים. כל האפליקציות ושותפי העריכה שיש להם גישה למסמך יכולים לראות את טווחי השמות שלו.
ייצוג JSON |
---|
{
"namedRangeId": string,
"name": string,
"ranges": [
{
object ( |
שדות | |
---|---|
namedRangeId |
המזהה של טווח התאים בעל השם. |
name |
השם של טווח התאים בעל השם. |
ranges[] |
הטווחים ששייכים לטווח בעל השם הזה. |
טווח
מציינת טווח מתמשך של טקסט.
ייצוג JSON |
---|
{ "segmentId": string, "startIndex": integer, "endIndex": integer, "tabId": string } |
שדות | |
---|---|
segmentId |
המזהה של הכותרת העליונה, הכותרת התחתונה או הערת השוליים שבהן הטווח הזה נכלל. מזהה מקטע ריק מציין את גוף המסמך. |
startIndex |
אינדקס ההתחלה מבוסס אפס של הטווח הזה, ביחידות קוד מסוג UTF-16. עבור כל השימושים הנוכחיים, יש לספק אינדקס התחלה. השדה הזה הוא Int32Value כדי להתאים לתרחישים לדוגמה עתידיים עם טווחים פתוחים. |
endIndex |
אינדקס הקצה מבוסס אפס של הטווח הזה, בלעדי, ביחידות קוד UTF-16. בכל השימושים הנוכחיים, צריך לספק אינדקס סיום. השדה הזה הוא Int32Value כדי להתאים לתרחישים לדוגמה עתידיים עם טווחים פתוחים. |
tabId |
הכרטיסייה שמכילה את הטווח הזה. אם לא כוללים את הפרמטר הזה, הבקשה חלה על הכרטיסייה הראשונה. במסמך שמכיל כרטיסייה אחת:
במסמך שמכיל כמה כרטיסיות:
|
InlineObject
אובייקט שמופיע בתוך השורה עם טקסט. InlineObject מכיל EmbeddedObject
כמו תמונה.
ייצוג JSON |
---|
{ "objectId": string, "inlineObjectProperties": { object ( |
שדות | |
---|---|
objectId |
המזהה של האובייקט המוטבע הזה. אפשר להשתמש בה כדי לעדכן מאפיינים של אובייקט. |
inlineObjectProperties |
המאפיינים של האובייקט המוטבע הזה. |
suggestedInlineObjectPropertiesChanges |
ההצעות לשינויים במאפייני האובייקטים המוטבעים, עם המפתחות לפי מזהה ההצעה. |
suggestedInsertionId |
מזהה ההוספה המוצע. אם השדה ריק, לא ניתן להשתמש בהצעה להזנה. |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
InlineObjectProperties
המאפיינים של InlineObject
.
ייצוג JSON |
---|
{
"embeddedObject": {
object ( |
שדות | |
---|---|
embeddedObject |
האובייקט המוטמע של האובייקט המוטבע הזה. |
EmbeddedObject
אובייקט מוטמע במסמך.
ייצוג JSON |
---|
{ "title": string, "description": string, "embeddedObjectBorder": { object ( |
שדות | |
---|---|
title |
כותרת האובייקט המוטמע. גם |
description |
תיאור האובייקט המוטמע. גם |
embeddedObjectBorder |
הגבול של האובייקט המוטמע. |
size |
הגודל הגלוי של התמונה לאחר החיתוך. |
marginTop |
השוליים העליונים של האובייקט המוטמע. |
marginBottom |
השוליים התחתוניים של האובייקט המוטמע. |
marginRight |
השוליים הימניים של האובייקט המוטמע. |
marginLeft |
השוליים השמאליים של האובייקט המוטמע. |
linkedContentReference |
הפניה לתוכן המקור המקושר החיצוני. לדוגמה, היא מכילה הפניה לתרשים המקור ב-Google Sheets כשהאובייקט המוטמע הוא תרשים מקושר. אם המדיניות לא מוגדרת, האובייקט המוטמע לא מקושר. |
שדה איחוד properties . המאפיינים שספציפיים לכל סוג של אובייקט מוטמע. properties יכול להיות רק אחת מהאפשרויות הבאות: |
|
embeddedDrawingProperties |
המאפיינים של שרטוט מוטמע. |
imageProperties |
המאפיינים של תמונה. |
EmbeddedDrawingProperties
אין שדות בסוג הזה.
המאפיינים של שרטוט מוטמע ומשמשים להבחנה בין סוג האובייקט. שרטוט מוטמע הוא שרטוט שנוצר וערוך בתוך מסמך. לתשומת ליבכם: אין תמיכה בפרטים מקיפים.
ImageProperties
המאפיינים של תמונה.
ייצוג JSON |
---|
{
"contentUri": string,
"sourceUri": string,
"brightness": number,
"contrast": number,
"transparency": number,
"cropProperties": {
object ( |
שדות | |
---|---|
contentUri |
URI לתמונה עם משך חיים של 30 דקות כברירת מחדל. ה-URI הזה מתויג עם החשבון של מגיש הבקשה. כל מי שיש לו את ה-URI ניגש בפועל לתמונה בתור המבקש המקורי. אם הגדרות השיתוף של המסמך ישתנו, יכול להיות שלא תהיה לך יותר גישה לתמונה. |
sourceUri |
ה-URI של המקור הוא ה-URI המשמש להוספת התמונה. ה-URI של המקור יכול להיות ריק. |
brightness |
אפקט הבהירות של התמונה. הערך צריך להיות במרווח הזמן [-1.0, 1.0], כאשר 0 פירושו שאין השפעה. |
contrast |
אפקט הניגודיות של התמונה. הערך צריך להיות במרווח הזמן [-1.0, 1.0], כאשר 0 פירושו שאין השפעה. |
transparency |
אפקט השקיפות של התמונה. הערך צריך להיות במרווח זמן [0.0, 1.0], שבו 0 פירושו שאין השפעה ו-1 פירושו שקיפות. |
cropProperties |
מאפייני החיתוך של התמונה. |
angle |
זווית הסיבוב של התמונה בכיוון השעון, ברדיאנים. |
CropProperties
מאפייני החיתוך של תמונה.
מלבן החיתוך מיוצג באמצעות קיזוזים שברים מ-4 הקצוות של התוכן המקורי.
- אם ההיסט הוא במרווחים (0, 1), הקצה המתאים של מלבן החיתוך ימוקם בתוך המלבן התוחם המקורי של התמונה.
- אם ההיסט הוא שלילי או גדול מ-1, הקצה המתאים של מלבן החיתוך ימוקם מחוץ למלבן הגבולות המקורי של התמונה.
- אם כל ההיסטים וזווית הסיבוב הם 0, התמונה לא תיחתך.
ייצוג JSON |
---|
{ "offsetLeft": number, "offsetRight": number, "offsetTop": number, "offsetBottom": number, "angle": number } |
שדות | |
---|---|
offsetLeft |
ההיסט מציין את המרחק פנימה מהקצה השמאלי של מלבן החיתוך מהקצה השמאלי של התוכן המקורי, כחלק מרוחב התוכן המקורי. |
offsetRight |
ההיסט מציין את המרחק פנימה מהקצה הימני של מלבן החיתוך מהקצה הימני של התוכן המקורי, כחלק מרוחב התוכן המקורי. |
offsetTop |
ההיסט מציין את המרחק מהקצה העליון של מלבן החיתוך מהקצה העליון של התוכן המקורי, כחלק מגובה התוכן המקורי. |
offsetBottom |
ההיסט מציין את המרחק מהקצה התחתון של מלבן החיתוך מהקצה התחתון של התוכן המקורי, כחלק מגובה התוכן המקורי. |
angle |
הזווית של הסיבוב בכיוון השעון של מלבן החיתוך סביב המרכז, ברדיאנים. הסיבוב מוחל אחרי ההיסט. |
EmbeddedObjectBorder
גבול סביב EmbeddedObject
.
ייצוג JSON |
---|
{ "color": { object ( |
שדות | |
---|---|
color |
צבע הגבול. |
width |
רוחב הגבול. |
dashStyle |
סגנון המקף של הגבול. |
propertyState |
מצב הנכס של נכס הגבול. |
PropertyState
המצבים האפשריים של נכס.
טיפוסים בני מנייה (enum) | |
---|---|
RENDERED |
אם מצב הנכס הוא RENDERED, אז לרכיב יש את המאפיין התואם בזמן העיבוד במסמך. זהו ערך ברירת המחדל. |
NOT_RENDERED |
אם מצב הנכס הוא NOT_RENDERED, אז לרכיב אין מאפיין מתאים בזמן העיבוד שלו במסמך. |
LinkedContentReference
הפניה לתוכן המקור המקושר החיצוני.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד reference . ההפניה הספציפית לסוג התוכן המקושר. reference יכול להיות רק אחת מהאפשרויות הבאות: |
|
sheetsChartReference |
הפניה לתרשים המקושר. |
SheetsChartReference
הפניה לתרשים מקושר שמוטמע מ-Google Sheets.
ייצוג JSON |
---|
{ "spreadsheetId": string, "chartId": integer } |
שדות | |
---|---|
spreadsheetId |
המזהה של הגיליון האלקטרוני ב-Google Sheets שמכיל את תרשים המקור. |
chartId |
המזהה של התרשים הספציפי בגיליון האלקטרוני של Google Sheets שמוטמע. |
SuggestedInlineObjectProperties
הצעה לשינוי ב-InlineObjectProperties
.
ייצוג JSON |
---|
{ "inlineObjectProperties": { object ( |
שדות | |
---|---|
inlineObjectProperties |
|
inlineObjectPropertiesSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
InlineObjectPropertiesSuggestionState
מסכה שמציינת אילו מהשדות בבסיס InlineObjectProperties
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{
"embeddedObjectSuggestionState": {
object ( |
שדות | |
---|---|
embeddedObjectSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
EmbeddedObjectSuggestionState
מסכה שמציינת אילו מהשדות בבסיס EmbeddedObject
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "embeddedDrawingPropertiesSuggestionState": { object ( |
שדות | |
---|---|
embeddedDrawingPropertiesSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
imagePropertiesSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
titleSuggested |
שדה זה מציין אם הוצע שינוי ל- |
descriptionSuggested |
שדה זה מציין אם הוצע שינוי ל- |
embeddedObjectBorderSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
sizeSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
marginLeftSuggested |
שדה זה מציין אם הוצע שינוי ל- |
marginRightSuggested |
שדה זה מציין אם הוצע שינוי ל- |
marginTopSuggested |
שדה זה מציין אם הוצע שינוי ל- |
marginBottomSuggested |
שדה זה מציין אם הוצע שינוי ל- |
linkedContentReferenceSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
EmbeddedDrawingPropertiesSuggestionState
אין שדות בסוג הזה.
מסכה שמציינת אילו מהשדות בבסיס EmbeddedDrawingProperties
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ImagePropertiesSuggestionState
מסכה שמציינת אילו מהשדות בבסיס ImageProperties
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{
"contentUriSuggested": boolean,
"sourceUriSuggested": boolean,
"brightnessSuggested": boolean,
"contrastSuggested": boolean,
"transparencySuggested": boolean,
"cropPropertiesSuggestionState": {
object ( |
שדות | |
---|---|
contentUriSuggested |
שדה זה מציין אם הוצע שינוי ל- |
sourceUriSuggested |
שדה זה מציין אם הייתה הצעה לשינוי ל-[sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri]. |
brightnessSuggested |
שדה זה מציין אם הוצע שינוי ב[בהירות] [google.apps.docs.v1.EmbeddedObject.brightness]. |
contrastSuggested |
שדה זה מציין אם היה הצעה לשינוי של [ניגודיות] [google.apps.docs.v1.EmbeddedObject.contrast]. |
transparencySuggested |
שדה זה מציין אם היה הצעה לשינוי ב-[transparency] [google.apps.docs.v1.EmbeddedObject.transparency]. |
cropPropertiesSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
angleSuggested |
שדה זה מציין אם היה שינוי מוצע ל-[angle] [google.apps.docs.v1.EmbeddedObject.angle]. |
CropPropertiesSuggestionState
מסכה שמציינת אילו מהשדות בבסיס CropProperties
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "offsetLeftSuggested": boolean, "offsetRightSuggested": boolean, "offsetTopSuggested": boolean, "offsetBottomSuggested": boolean, "angleSuggested": boolean } |
שדות | |
---|---|
offsetLeftSuggested |
שדה זה מציין אם הוצע שינוי ל- |
offsetRightSuggested |
שדה זה מציין אם הוצע שינוי ל- |
offsetTopSuggested |
שדה זה מציין אם הוצע שינוי ל- |
offsetBottomSuggested |
שדה זה מציין אם הוצע שינוי ל- |
angleSuggested |
שדה זה מציין אם הוצע שינוי ל- |
EmbeddedObjectBorderSuggestionState
מסכה שמציינת אילו מהשדות בבסיס EmbeddedObjectBorder
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "colorSuggested": boolean, "widthSuggested": boolean, "dashStyleSuggested": boolean, "propertyStateSuggested": boolean } |
שדות | |
---|---|
colorSuggested |
שדה זה מציין אם הייתה הצעה לשינוי ב-[color] [google.apps.docs.v1.EmbeddedBorderObject.color]. |
widthSuggested |
שדה זה מציין אם הוצע שינוי ב-[width] [google.apps.docs.v1.EmbeddedBorderObject.width]. |
dashStyleSuggested |
שדה זה מציין אם הוצע שינוי ל-[dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style]. |
propertyStateSuggested |
שדה זה מציין אם היה הצעה לשינוי ב-[propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state]. |
LinkedContentReferenceSuggestionState
מסכה שמציינת אילו מהשדות בבסיס LinkedContentReference
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
שדות | |
---|---|
sheetsChartReferenceSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
SheetsChartReferenceSuggestionState
מסכה שמציינת אילו מהשדות בבסיס SheetsChartReference
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "spreadsheetIdSuggested": boolean, "chartIdSuggested": boolean } |
שדות | |
---|---|
spreadsheetIdSuggested |
שדה זה מציין אם הוצע שינוי ל- |
chartIdSuggested |
שדה זה מציין אם הוצע שינוי ל- |
PositionedObject
אובייקט שמקושר ל-Paragraph
וממוקם ביחס לתחילת הפסקה. PositionedObject מכיל EmbeddedObject
כמו תמונה.
ייצוג JSON |
---|
{ "objectId": string, "positionedObjectProperties": { object ( |
שדות | |
---|---|
objectId |
המזהה של האובייקט המוצב הזה. |
positionedObjectProperties |
המאפיינים של האובייקט המוצב הזה. |
suggestedPositionedObjectPropertiesChanges |
ההצעות לשינויים במאפייני האובייקטים המוצבים, עם קידוד לפי מזהה ההצעה. |
suggestedInsertionId |
מזהה ההוספה המוצע. אם השדה ריק, לא ניתן להשתמש בהצעה להזנה. |
suggestedDeletionIds[] |
מזהי המחיקה המוצעים. אם השדה ריק, אין הצעות למחיקת התוכן. |
PositionedObjectProperties
המאפיינים של PositionedObject
.
ייצוג JSON |
---|
{ "positioning": { object ( |
שדות | |
---|---|
positioning |
המיקום של האובייקט הממוקם ביחס לשורה החדשה של |
embeddedObject |
האובייקט המוטמע של האובייקט המוצב הזה. |
PositionedObjectPositioning
המיקום של PositionedObject
. האובייקט הממוקם ממוקם ביחס להתחלה של ה-Paragraph
שאליו הוא מקושר.
ייצוג JSON |
---|
{ "layout": enum ( |
שדות | |
---|---|
layout |
הפריסה של האובייקט המוצב הזה. |
leftOffset |
ההיסט של הקצה השמאלי של האובייקט הממוקם ביחס לתחילת ה- |
topOffset |
ההיסט של הקצה העליון של האובייקט המוצב ביחס לתחילת ה- |
PositionedObjectLayout
הפריסות האפשריות של [PositionedObject][google.aps.docs.v1.PositionedObject].
טיפוסים בני מנייה (enum) | |
---|---|
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED |
הפריסה לא צוינה. |
WRAP_TEXT |
הטקסט גולש מסביב לאובייקט שממוקם. |
BREAK_LEFT |
שבירת הטקסט היא שהאובייקט שממוקם בצד שמאל והטקסט בצד ימין. |
BREAK_RIGHT |
שבירת הטקסט היא שהאובייקט שממוקם בצד ימין והטקסט נמצא בצד שמאל. |
BREAK_LEFT_RIGHT |
שבירה את הטקסט כך שאין טקסט בצד שמאל או מימין לאובייקט שממוקם. |
IN_FRONT_OF_TEXT |
האובייקט המוצב נמצא לפני הטקסט. |
BEHIND_TEXT |
האובייקט המוצב נמצא מאחורי הטקסט. |
SuggestedPositionedObjectProperties
הצעה לשינוי ב-PositionedObjectProperties
.
ייצוג JSON |
---|
{ "positionedObjectProperties": { object ( |
שדות | |
---|---|
positionedObjectProperties |
|
positionedObjectPropertiesSuggestionState |
מסכה שמציינת אילו מהשדות בבסיס |
PositionedObjectPropertiesSuggestionState
מסכה שמציינת אילו מהשדות בבסיס PositionedObjectProperties
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "positioningSuggestionState": { object ( |
שדות | |
---|---|
positioningSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
embeddedObjectSuggestionState |
מסכה שמציינת אילו מהשדות ב- |
PositionedObjectPositioningSuggestionState
מסכה שמציינת אילו מהשדות בבסיס PositionedObjectPositioning
השתנו בהצעה הזו. לכל שדה שמוגדר כ-True יש הצעה חדשה לערך.
ייצוג JSON |
---|
{ "layoutSuggested": boolean, "leftOffsetSuggested": boolean, "topOffsetSuggested": boolean } |
שדות | |
---|---|
layoutSuggested |
שדה זה מציין אם הוצע שינוי ל- |
leftOffsetSuggested |
שדה זה מציין אם הוצע שינוי ל- |
topOffsetSuggested |
שדה זה מציין אם הוצע שינוי ל- |
SuggestionsViewMode
מצב תצוגת ההצעות שהוחל על המסמך מציין את האופן שבו מיוצגים שינויים מוצעים. הוא מספק אפשרויות לקריאת המסמך כאשר כל ההצעות מופיעות בתוך השורה, מתקבלות או נדחות.
טיפוסים בני מנייה (enum) | |
---|---|
DEFAULT_FOR_CURRENT_ACCESS |
הערך SuggestedViewMode שהוחל על המסמך שמוחזר תלוי ברמת הגישה הנוכחית של המשתמש. אם למשתמש יש רק גישת צפייה, יוחל PREVIEW_WITHOUT_SUGGESTIONS . אחרת, מוחלת הערך SUGGESTIONS_INLINE . זהו מצב ברירת המחדל של תצוגת הצעות. |
SUGGESTIONS_INLINE |
המסמך שמוחזר כולל הצעות בתוך השורה. הצעות לשינויים יהיו שונות מתוכן הבסיס במסמך. בקשות לאחזור מסמך באמצעות מצב זה יחזירו שגיאת 403 אם למשתמש אין הרשאה להציג את השינויים המוצעים. |
PREVIEW_SUGGESTIONS_ACCEPTED |
המסמך שמוחזר הוא תצוגה מקדימה עם כל ההצעות לשינויים שאושרו. בקשות לאחזור מסמך באמצעות מצב זה יחזירו שגיאת 403 אם למשתמש אין הרשאה להציג את השינויים המוצעים. |
PREVIEW_WITHOUT_SUGGESTIONS |
המסמך שמוחזר הוא תצוגה מקדימה שבה כל השינויים המוצעים נדחו, אם יש הצעות כלשהן במסמך. |
שיטות |
|
---|---|
|
החלת עדכון אחד או יותר במסמך. |
|
יצירת מסמך ריק לפי הכותרת שמופיעה בבקשה. |
|
קבלת הגרסה האחרונה של המסמך שצוין. |