REST Resource: documents

منبع: سند

یک سند Google Docs.

نمایندگی JSON
{
  "documentId": string,
  "title": string,
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
زمینه های
documentId

string

فقط خروجی شناسه سند.

title

string

عنوان سند.

body

object ( Body )

فقط خروجی بدنه اصلی سند.

headers

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

فقط خروجی سرصفحه های موجود در سند، با شناسه سرصفحه کلید شده اند.

footers

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

فقط خروجی پاورقی های موجود در سند، با شناسه پاورقی کلید زده می شوند.

footnotes

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

فقط خروجی پاورقی های موجود در سند، با شناسه پاورقی کلید زده شده اند.

documentStyle

object ( DocumentStyle )

فقط خروجی سبک سند.

suggestedDocumentStyleChanges

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

فقط خروجی تغییرات پیشنهادی در سبک سند، با شناسه پیشنهاد کلید زده شده است.

namedStyles

object ( NamedStyles )

فقط خروجی سبک های نامگذاری شده سند.

suggestedNamedStylesChanges

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

فقط خروجی تغییرات پیشنهادی در سبک های نامگذاری شده سند، با شناسه پیشنهاد کلید زده شده است.

lists

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

فقط خروجی فهرست‌های موجود در سند، با شناسه فهرست کلید زده می‌شوند.

namedRanges

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

فقط خروجی محدوده های نامگذاری شده در سند، با نام کلید شده است.

revisionId

string

فقط خروجی شناسه ویرایش سند. می‌تواند در درخواست‌های به‌روزرسانی استفاده شود تا مشخص شود که در کدام یک از ویرایش‌های یک سند، به‌روزرسانی‌ها اعمال شود و اگر سند از آن تجدیدنظر ویرایش شده است، چگونه باید رفتار کند. فقط در صورتی پر می شود که کاربر دسترسی ویرایش به سند داشته باشد.

شناسه تجدیدنظر یک عدد متوالی نیست بلکه یک رشته مات است. قالب شناسه بازبینی ممکن است در طول زمان تغییر کند. شناسه بازگردانی شده فقط تا 24 ساعت پس از بازگرداندن آن تضمین شده است که اعتبار دارد و نمی‌توان آن را بین کاربران به اشتراک گذاشت. اگر شناسه بازبینی بین تماس ها تغییر نکرده باشد، سند تغییر نکرده است. برعکس، شناسه تغییر یافته (برای همان سند و کاربر) معمولاً به این معنی است که سند به روز شده است. با این حال، تغییر شناسه می تواند به دلیل عوامل داخلی مانند تغییر فرمت شناسه نیز باشد.

suggestionsViewMode

enum ( SuggestionsViewMode )

فقط خروجی حالت نمایش پیشنهادات روی سند اعمال شد.

توجه: هنگام ویرایش یک سند، تغییرات باید بر اساس سندی با SUGGESTIONS_INLINE باشد.

inlineObjects

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

فقط خروجی اشیاء درون خطی در سند، با شناسه شی کلید زده می شوند.

positionedObjects

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

فقط خروجی اشیاء قرار داده شده در سند، با شناسه شی کلید زده می شوند.

بدن

بدنه سند

بدنه معمولاً حاوی محتوای کامل سند به جز headers ، footers و footnotes است.

نمایندگی JSON
{
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
زمینه های
content[]

object ( StructuralElement )

محتویات بدن.

شاخص های محتوای بدن از صفر شروع می شود.

عنصر ساختاری

یک StructuralElement محتوایی را توصیف می کند که ساختاری را برای سند فراهم می کند.

نمایندگی JSON
{
  "startIndex": integer,
  "endIndex": integer,

  // Union field content can be only one of the following:
  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
  // End of list of possible types for union field content.
}
زمینه های
startIndex

integer

شاخص شروع مبتنی بر صفر این عنصر ساختاری، در واحدهای کد UTF-16.

endIndex

integer

شاخص پایانی مبتنی بر صفر این عنصر ساختاری، منحصر به فرد، در واحدهای کد UTF-16.

content زمینه اتحادیه محتوای عنصر ساختاری. content فقط می تواند یکی از موارد زیر باشد:
paragraph

object ( Paragraph )

نوع پاراگراف عنصر ساختاری.

sectionBreak

object ( SectionBreak )

یک نوع شکست بخش از عنصر ساختاری.

table

object ( Table )

یک نوع جدول از عنصر ساختاری.

tableOfContents

object ( TableOfContents )

فهرست مطالب نوع عنصر ساختاری.

پاراگراف

یک StructuralElement که یک پاراگراف را نشان می دهد. پاراگراف طیفی از محتوا است که با یک کاراکتر خط جدید خاتمه می یابد.

نمایندگی JSON
{
  "elements": [
    {
      object (ParagraphElement)
    }
  ],
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "suggestedParagraphStyleChanges": {
    string: {
      object (SuggestedParagraphStyle)
    },
    ...
  },
  "bullet": {
    object (Bullet)
  },
  "suggestedBulletChanges": {
    string: {
      object (SuggestedBullet)
    },
    ...
  },
  "positionedObjectIds": [
    string
  ],
  "suggestedPositionedObjectIds": {
    string: {
      object (ObjectReferences)
    },
    ...
  }
}
زمینه های
elements[]

object ( ParagraphElement )

محتوای پاراگراف، به اجزای سازنده آن تقسیم شده است.

paragraphStyle

object ( ParagraphStyle )

سبک این پاراگراف

suggestedParagraphStyleChanges

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

سبک پاراگراف پیشنهادی به این پاراگراف تغییر می‌کند که با شناسه پیشنهاد کلید می‌خورد.

bullet

object ( Bullet )

گلوله این پاراگراف. اگر پاراگراف موجود نباشد، به فهرستی تعلق ندارد.

suggestedBulletChanges

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

تغییرات پیشنهادی برای گلوله این پاراگراف.

positionedObjectIds[]

string

شناسه‌های اشیاء موقعیت‌یافته متصل به این پاراگراف.

suggestedPositionedObjectIds

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

شناسه‌های اشیاء موقعیت‌یافته پیشنهاد شده به این پاراگراف پیوست شوند، با شناسه پیشنهاد کلید می‌زنند.

عنصر پاراگراف

یک ParagraphElement محتوای یک Paragraph را توصیف می کند.

نمایندگی JSON
{
  "startIndex": integer,
  "endIndex": integer,

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

integer

شاخص شروع مبتنی بر صفر این عنصر پاراگراف، در واحدهای کد UTF-16.

endIndex

integer

شاخص پایانی پایه صفر این عنصر پاراگراف، انحصاری، در واحدهای کد UTF-16.

content زمینه اتحادیه محتوای عنصر پاراگراف. content فقط می تواند یکی از موارد زیر باشد:
textRun

object ( TextRun )

یک عنصر پاراگراف اجرای متن.

autoText

object ( AutoText )

یک عنصر پاراگراف متن خودکار.

pageBreak

object ( PageBreak )

یک عنصر پاراگراف شکستن صفحه.

columnBreak

object ( ColumnBreak )

عنصر پاراگراف شکست ستون.

footnoteReference

object ( FootnoteReference )

عنصر پاراگراف مرجع پاورقی.

horizontalRule

object ( HorizontalRule )

عنصر پاراگراف قانون افقی.

equation

object ( Equation )

عنصر پاراگراف معادله

inlineObjectElement

object ( InlineObjectElement )

عنصر پاراگراف شی درون خطی.

person

object ( Person )

یک عنصر پاراگراف که به یک شخص یا آدرس ایمیل پیوند دارد.

TextRun

یک ParagraphElement که نشان‌دهنده مجموعه‌ای از متن است که همگی یک استایل دارند.

نمایندگی JSON
{
  "content": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
زمینه های
content

string

متن این اجرا.

هر عنصر غیر متنی در اجرا با کاراکتر Unicode U+E907 جایگزین می‌شود.

suggestedInsertionIds[]

string

شناسه‌های درج پیشنهادی اگر یک TextRun یک تغییر پیشنهادی تودرتو باشد، ممکن است چندین شناسه درج داشته باشد. اگر خالی باشد، این یک درج پیشنهادی نیست.

suggestedDeletionIds[]

string

شناسه های حذف پیشنهادی اگر خالی باشد، هیچ پیشنهادی برای حذف این محتوا وجود ندارد.

textStyle

object ( TextStyle )

سبک متن این اجرا.

suggestedTextStyleChanges

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

سبک متن پیشنهادی به این اجرا تغییر می‌کند که با شناسه پیشنهاد کلید می‌خورد.

TextStyle

نمایانگر استایلی است که می توان روی متن اعمال کرد.

سبک های متن ارثی به صورت فیلدهای تنظیم نشده در این پیام نمایش داده می شوند. والد یک سبک متن به محل تعریف سبک متن بستگی دارد:

  • TextStyle متن در یک Paragraph از named style type مربوط به پاراگراف به ارث می‌رسد.
  • TextStyle در یک named style از normal text به نام style به ارث می رسد.
  • TextStyle normal text به نام سبک از سبک متن پیش‌فرض در ویرایشگر Docs به ارث می‌رسد.
  • TextStyle در یک عنصر Paragraph که در جدول موجود است ممکن است سبک متن خود را از سبک جدول به ارث ببرد.

اگر سبک متن از والدین به ارث نمی‌رسد، با لغو تنظیمات، سبک به مقداری مطابق با پیش‌فرض‌های ویرایشگر Docs برمی‌گردد.

نمایندگی JSON
{
  "bold": boolean,
  "italic": boolean,
  "underline": boolean,
  "strikethrough": boolean,
  "smallCaps": boolean,
  "backgroundColor": {
    object (OptionalColor)
  },
  "foregroundColor": {
    object (OptionalColor)
  },
  "fontSize": {
    object (Dimension)
  },
  "weightedFontFamily": {
    object (WeightedFontFamily)
  },
  "baselineOffset": enum (BaselineOffset),
  "link": {
    object (Link)
  }
}
زمینه های
bold

boolean

این که آیا متن به صورت پررنگ ارائه می شود یا نه.

italic

boolean

خواه متن مورب باشد یا نه.

underline

boolean

خط دار بودن یا نبودن متن.

strikethrough

boolean

این که آیا متن از طریق ضربه زده می شود یا نه.

smallCaps

boolean

خواه متن با حروف کوچک باشد یا نه.

backgroundColor

object ( OptionalColor )

رنگ پس زمینه متن. اگر تنظیم شود، بسته به قسمت color ، رنگ یا رنگ RGB یا شفاف است.

foregroundColor

object ( OptionalColor )

رنگ پیش زمینه متن. اگر تنظیم شود، بسته به قسمت color ، رنگ یا رنگ RGB یا شفاف است.

fontSize

object ( Dimension )

اندازه فونت متن

weightedFontFamily

object ( WeightedFontFamily )

خانواده فونت و وزن رندر شده متن.

اگر یک درخواست به‌روزرسانی مقادیری را هم برای weightedFontFamily و هم bold مشخص کند، ابتدا weightedFontFamily اعمال می‌شود، سپس bold .

اگر weightedFontFamily#weight تنظیم نشده باشد، به طور پیش فرض روی 400 تنظیم می شود.

اگر weightedFontFamily تنظیم شده باشد، پس weightedFontFamily#fontFamily نیز باید با مقدار غیر خالی تنظیم شود. در غیر این صورت یک خطای درخواست بد 400 برگردانده می شود.

baselineOffset

enum ( BaselineOffset )

افست عمودی متن از موقعیت عادی خود.

متن با SUPERSCRIPT یا SUBSCRIPT آفست خط پایه به طور خودکار در اندازه قلم کوچکتر ارائه می شود که بر اساس فیلد fontSize محاسبه می شود. تغییرات در این قسمت fontSize تأثیر نمی گذارد.

رنگ اختیاری

رنگی که می تواند کاملاً مات یا کاملاً شفاف باشد.

نمایندگی JSON
{
  "color": {
    object (Color)
  }
}
زمینه های
color

object ( Color )

اگر تنظیم شود، از این رنگ به عنوان یک رنگ مات استفاده می شود. اگر تنظیم نشده باشد، این یک رنگ شفاف است.

رنگ

یک رنگ ثابت

نمایندگی JSON
{
  "rgbColor": {
    object (RgbColor)
  }
}
زمینه های
rgbColor

object ( RgbColor )

مقدار رنگ RGB

RgbColor

یک رنگ RGB

نمایندگی JSON
{
  "red": number,
  "green": number,
  "blue": number
}
زمینه های
red

number

جزء قرمز رنگ، از 0.0 تا 1.0.

green

number

جزء سبز رنگ، از 0.0 تا 1.0.

blue

number

جزء آبی رنگ، از 0.0 تا 1.0.

بعد، ابعاد، اندازه

قدر در یک جهت در واحدهای مشخص شده.

نمایندگی JSON
{
  "magnitude": number,
  "unit": enum (Unit)
}
زمینه های
magnitude

number

بزرگی.

unit

enum ( Unit )

واحدهای قدر

واحد

واحد های اندازه گیری.

Enums
UNIT_UNSPECIFIED واحدها ناشناخته هستند
PT یک نقطه، 1/72 اینچ.

WeightedFontFamily

خانواده فونت و وزن متن را نشان می دهد.

نمایندگی JSON
{
  "fontFamily": string,
  "weight": integer
}
زمینه های
fontFamily

string

خانواده فونت متن

خانواده فونت می تواند هر قلمی از منوی فونت در Docs یا از فونت های Google باشد. اگر نام فونت شناسایی نشود، متن در Arial ارائه می شود.

weight

integer

وزن فونت این فیلد می‌تواند هر مقداری داشته باشد که مضرب 100 بین 100 و 900 باشد. این محدوده با مقادیر عددی شرح داده شده در مشخصات CSS 2.1، بخش 15.6 مطابقت دارد و مقادیر غیر عددی مجاز نیستند.

مقدار پیش فرض 400 ("عادی") است.

وزن فونت فقط یک جزء از وزن فونت رندر شده را تشکیل می دهد. ترکیبی از weight و مقدار bold حل‌شده سبک متن، وزن ارائه‌شده را پس از محاسبه وراثت تعیین می‌کند:

  • اگر متن پررنگ باشد و وزن آن کمتر از 400 باشد، وزن رندر شده 400 است.
  • اگر متن پررنگ باشد و وزن آن بزرگتر یا مساوی 400 باشد اما کمتر از 700 باشد، وزن رندر شده 700 است.
  • اگر وزن بزرگتر یا مساوی 700 باشد، وزن رندر شده برابر با وزن است.
  • اگر متن پررنگ نباشد، وزن رندر شده با وزن برابر است.

آفست پایه

روش هایی که در آنها می توان متن را به صورت عمودی از موقعیت عادی خود منحرف کرد.

Enums
BASELINE_OFFSET_UNSPECIFIED افست خط پایه متن از والد به ارث می رسد.
NONE متن به صورت عمودی افست نیست.
SUPERSCRIPT متن به صورت عمودی به سمت بالا جابجا شده است (بالا خط).
SUBSCRIPT متن به صورت عمودی به سمت پایین افست شده است (زیرنویس).

SuggestedTextStyle

یک تغییر پیشنهادی به یک TextStyle .

نمایندگی JSON
{
  "textStyle": {
    object (TextStyle)
  },
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
زمینه های
textStyle

object ( TextStyle )

یک TextStyle که فقط شامل تغییرات ایجاد شده در این پیشنهاد می شود. این را می توان همراه با textStyleSuggestionState استفاده کرد تا ببینید کدام فیلدها و مقادیر جدید آنها تغییر کرده اند.

textStyleSuggestionState

object ( TextStyleSuggestionState )

ماسکی که نشان می دهد کدام یک از فیلدهای TextStyle پایه در این پیشنهاد تغییر کرده است.

TextStyleSuggestionState

ماسکی که نشان می دهد کدام یک از فیلدهای TextStyle پایه در این پیشنهاد تغییر کرده است. برای هر فیلدی که روی true تنظیم شده است، یک مقدار پیشنهادی جدید وجود دارد.

نمایندگی JSON
{
  "boldSuggested": boolean,
  "italicSuggested": boolean,
  "underlineSuggested": boolean,
  "strikethroughSuggested": boolean,
  "smallCapsSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "foregroundColorSuggested": boolean,
  "fontSizeSuggested": boolean,
  "weightedFontFamilySuggested": boolean,
  "baselineOffsetSuggested": boolean,
  "linkSuggested": boolean
}
زمینه های
boldSuggested

boolean

نشان می دهد که آیا تغییری به bold پیشنهاد شده است یا خیر.

italicSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی به italic وجود داشته است یا خیر.

underlineSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی برای underline وجود دارد یا خیر.

strikethroughSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی برای strikethrough وجود داشته است یا خیر.

smallCapsSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی به smallCaps وجود داشته است یا خیر.

backgroundColorSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی به backgroundColor وجود داشته است.

foregroundColorSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی به foregroundColor وجود داشته است یا خیر.

fontSizeSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی در fontSize وجود داشته است.

weightedFontFamilySuggested

boolean

نشان می‌دهد که آیا تغییر پیشنهادی در weightedFontFamily وجود داشته است.

baselineOffsetSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی به baselineOffset وجود داشته است یا خیر.

متن خودکار

یک ParagraphElement نشان دهنده نقطه ای در متن است که به صورت پویا با محتوایی جایگزین می شود که می تواند در طول زمان تغییر کند، مانند شماره صفحه.

نمایندگی JSON
{
  "type": enum (Type),
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
زمینه های
type

enum ( Type )

نوع این متن خودکار.

suggestedInsertionIds[]

string

شناسه‌های درج پیشنهادی اگر یک AutoText یک تغییر پیشنهادی تودرتو باشد، ممکن است چندین شناسه درج داشته باشد. اگر خالی باشد، این یک درج پیشنهادی نیست.

suggestedDeletionIds[]

string

شناسه های حذف پیشنهادی اگر خالی باشد، هیچ پیشنهادی برای حذف این محتوا وجود ندارد.

textStyle

object ( TextStyle )

سبک متن این AutoText.

suggestedTextStyleChanges

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

سبک متن پیشنهادی به این متن خودکار تغییر می‌کند که با شناسه پیشنهاد کلید می‌خورد.

تایپ کنید

انواع متن خودکار

Enums
TYPE_UNSPECIFIED نوع متن خودکار نامشخص.
PAGE_NUMBER برای متن خودکار که نشان دهنده شماره صفحه فعلی است تایپ کنید.
PAGE_COUNT متن خودکار را تایپ کنید که تعداد کل صفحات سند را نشان می دهد.

Page Break

یک ParagraphElement که نمایانگر یک شکست صفحه است. شکست صفحه باعث می شود متن بعدی از بالای صفحه بعد شروع شود.

نمایندگی JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
زمینه های
suggestedInsertionIds[]

string

شناسه‌های درج پیشنهادی یک PageBreak ممکن است چندین شناسه درج داشته باشد اگر یک تغییر پیشنهادی تودرتو باشد. اگر خالی باشد، این یک درج پیشنهادی نیست.

suggestedDeletionIds[]

string

شناسه های حذف پیشنهادی اگر خالی باشد، هیچ پیشنهادی برای حذف این محتوا وجود ندارد.

textStyle

object ( TextStyle )

سبک متن این PageBreak.

شبیه به محتوای متنی، مانند اجراهای متن و مراجع پاورقی، سبک متن شکستگی صفحه می تواند بر طرح بندی محتوا و همچنین استایل متن درج شده در کنار آن تأثیر بگذارد.

suggestedTextStyleChanges

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

سبک متن پیشنهادی به این PageBreak تغییر می‌کند که با شناسه پیشنهاد کلید می‌خورد.

ColumnBreak

یک ParagraphElement که نمایانگر یک شکست ستون است. شکست ستون باعث می شود متن بعدی از بالای ستون بعدی شروع شود.

نمایندگی JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
زمینه های
suggestedInsertionIds[]

string

شناسه‌های درج پیشنهادی اگر یک تغییر پیشنهادی تودرتو باشد، ممکن است یک ColumnBreak چندین شناسه درج داشته باشد. اگر خالی باشد، این یک درج پیشنهادی نیست.

suggestedDeletionIds[]

string

شناسه های حذف پیشنهادی اگر خالی باشد، هیچ پیشنهادی برای حذف این محتوا وجود ندارد.

textStyle

object ( TextStyle )

سبک متن این ColumnBreak.

شبیه به محتوای متن، مانند اجراهای متن و مراجع پاورقی، سبک متن شکستن ستون می‌تواند بر طرح‌بندی محتوا و همچنین استایل متن درج شده در کنار آن تأثیر بگذارد.

suggestedTextStyleChanges

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

سبک متن پیشنهادی به این ColumnBreak تغییر می‌کند که با شناسه پیشنهاد کلید می‌خورد.

پانوشت مرجع

یک ParagraphElement که نشان دهنده یک مرجع پاورقی است. مرجع پاورقی محتوای درون خطی است که با یک عدد ارائه می شود و برای شناسایی پاورقی استفاده می شود.

نمایندگی JSON
{
  "footnoteId": string,
  "footnoteNumber": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
زمینه های
footnoteId

string

شناسه footnote که حاوی محتوای این مرجع پاورقی است.

footnoteNumber

string

شماره ارائه شده این پاورقی.

suggestedInsertionIds[]

string

شناسه‌های درج پیشنهادی یک FootnoteReference ممکن است چندین شناسه درج داشته باشد اگر یک تغییر پیشنهادی تودرتو باشد. اگر خالی باشد، این یک درج پیشنهادی نیست.

suggestedDeletionIds[]

string

شناسه های حذف پیشنهادی اگر خالی باشد، هیچ پیشنهادی برای حذف این محتوا وجود ندارد.

textStyle

object ( TextStyle )

سبک متن این FootnoteReference.

suggestedTextStyleChanges

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

سبک متن پیشنهادی به این FootnoteReference تغییر می‌کند که با شناسه پیشنهاد کلید می‌خورد.

قانون افقی

یک ParagraphElement که یک خط افقی را نشان می دهد.

نمایندگی JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
زمینه های
suggestedInsertionIds[]

string

شناسه‌های درج پیشنهادی اگر HorizontalRule یک تغییر پیشنهادی تودرتو باشد، ممکن است چندین شناسه درج داشته باشد. اگر خالی باشد، این یک درج پیشنهادی نیست.

suggestedDeletionIds[]

string

شناسه های حذف پیشنهادی اگر خالی باشد، هیچ پیشنهادی برای حذف این محتوا وجود ندارد.

textStyle

object ( TextStyle )

سبک متن این HorizontalRule.

شبیه به محتوای متن، مانند اجراهای متن و مراجع پاورقی، سبک متن یک قانون افقی می‌تواند بر طرح‌بندی محتوا و همچنین استایل متن درج شده در کنار آن تأثیر بگذارد.

suggestedTextStyleChanges

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

سبک متن پیشنهادی به این HorizontalRule تغییر می‌کند که با شناسه پیشنهاد کلید می‌خورد.

معادله

یک ParagraphElement که یک معادله را نشان می دهد.

نمایندگی JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
زمینه های
suggestedInsertionIds[]

string

شناسه‌های درج پیشنهادی اگر یک Equation یک تغییر پیشنهادی تودرتو باشد، ممکن است چندین شناسه درج داشته باشد. اگر خالی باشد، این یک درج پیشنهادی نیست.

suggestedDeletionIds[]

string

شناسه های حذف پیشنهادی اگر خالی باشد، هیچ پیشنهادی برای حذف این محتوا وجود ندارد.

InlineObjectElement

یک ParagraphElement که حاوی یک InlineObject است.

نمایندگی JSON
{
  "inlineObjectId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
زمینه های
inlineObjectId

string

شناسه InlineObject این عنصر حاوی است.

suggestedInsertionIds[]

string

شناسه‌های درج پیشنهادی اگر یک تغییر پیشنهادی تودرتو باشد، ممکن است یک InlineObjectElement چندین شناسه درج داشته باشد. اگر خالی باشد، این یک درج پیشنهادی نیست.

suggestedDeletionIds[]

string

شناسه های حذف پیشنهادی اگر خالی باشد، هیچ پیشنهادی برای حذف این محتوا وجود ندارد.

textStyle

object ( TextStyle )

سبک متن این InlineObjectElement.

مانند محتوای متن، مانند اجراهای متن و مراجع پانوشت، سبک متن یک عنصر شی درون خطی می تواند بر طرح بندی محتوا و همچنین استایل متن درج شده در کنار آن تأثیر بگذارد.

suggestedTextStyleChanges

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

سبک متن پیشنهادی به این InlineObject تغییر می‌کند که با شناسه پیشنهاد کلید می‌خورد.

شخص

یک شخص یا آدرس ایمیل ذکر شده در یک سند. این نام‌ها به‌عنوان یک عنصر منفرد و غیرقابل تغییر رفتار می‌کنند که حاوی نام یا آدرس ایمیل شخص است.

نمایندگی JSON
{
  "personId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "personProperties": {
    object (PersonProperties)
  }
}
زمینه های
personId

string

فقط خروجی شناسه منحصر به فرد این لینک.

suggestedInsertionIds[]

string

شناسه‌های پیشنهادهایی که پیوند این شخص را در سند درج می‌کنند. اگر یک Person یک تغییر پیشنهادی تودرتو باشد (برای مثال، یک پیشنهاد در یک پیشنهاد ارائه شده توسط کاربر دیگری) ممکن است چندین شناسه درج داشته باشد. اگر خالی باشد، پیوند این شخص درج پیشنهادی نیست.

suggestedDeletionIds[]

string

شناسه‌های پیشنهادهایی که پیوند این شخص را از سند حذف می‌کنند. برای مثال اگر چند کاربر پیشنهاد حذف آن را داشته باشند، ممکن است یک Person چندین شناسه حذف داشته باشد. اگر خالی باشد، پیوند این شخص برای حذف پیشنهاد نمی شود.

textStyle

object ( TextStyle )

سبک متن این Person .

suggestedTextStyleChanges

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

سبک متن پیشنهادی به این Person تغییر می کند که با شناسه پیشنهاد کلید می خورد.

personProperties

object ( PersonProperties )

فقط خروجی خواص این Person . این میدان همیشه وجود دارد.

ویژگی های شخص

ویژگی های خاص یک Person مرتبط.

نمایندگی JSON
{
  "name": string,
  "email": string
}
زمینه های
name

string

فقط خروجی نام شخص در صورتی که به جای آدرس ایمیل شخص در متن پیوند نمایش داده شود.

email

string

فقط خروجی آدرس ایمیل مرتبط با این Person . این میدان همیشه وجود دارد.

RichLinkProperties

ویژگی های خاص یک RichLink .

نمایندگی JSON
{
  "title": string,
  "uri": string,
  "mimeType": string
}
زمینه های
title

string

فقط خروجی عنوان RichLink همانطور که در پیوند نشان داده شده است. این عنوان با عنوان منبع پیوندی در زمان درج یا آخرین به روز رسانی پیوند مطابقت دارد. این میدان همیشه حضور دارد.

uri

string

فقط خروجی URI به RichLink . این همیشه وجود دارد.

mimeType

string

فقط خروجی نوع MIME RichLink ، اگر وجود داشته باشد (مثلاً وقتی فایلی در Drive است).

سبک پاراگراف

سبک هایی که برای کل یک پاراگراف کاربرد دارند.

سبک‌های پاراگراف ارثی به صورت فیلدهای تنظیم نشده در این پیام نمایش داده می‌شوند. والد سبک پاراگراف به محل تعریف سبک پاراگراف بستگی دارد:

  • ParagraphStyle در یک Paragraph از named style type مربوط به پاراگراف به ارث می‌رسد.
  • ParagraphStyle در یک named style از normal text به نام style به ارث می رسد.
  • ParagraphStyle normal text به نام سبک از سبک پاراگراف پیش‌فرض در ویرایشگر Docs به ارث می‌رسد.
  • ParagraphStyle در یک عنصر Paragraph که در جدول موجود است ممکن است سبک پاراگراف خود را از سبک جدول به ارث ببرد.

اگر سبک پاراگراف از والدین به ارث نمی‌رسد، با لغو تنظیمات، سبک به مقداری مطابق با پیش‌فرض‌های ویرایشگر Docs برمی‌گردد.

نمایندگی JSON
{
  "headingId": string,
  "namedStyleType": enum (NamedStyleType),
  "alignment": enum (Alignment),
  "lineSpacing": number,
  "direction": enum (ContentDirection),
  "spacingMode": enum (SpacingMode),
  "spaceAbove": {
    object (Dimension)
  },
  "spaceBelow": {
    object (Dimension)
  },
  "borderBetween": {
    object (ParagraphBorder)
  },
  "borderTop": {
    object (ParagraphBorder)
  },
  "borderBottom": {
    object (ParagraphBorder)
  },
  "borderLeft": {
    object (ParagraphBorder)
  },
  "borderRight": {
    object (ParagraphBorder)
  },
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "indentEnd": {
    object (Dimension)
  },
  "tabStops": [
    {
      object (TabStop)
    }
  ],
  "keepLinesTogether": boolean,
  "keepWithNext": boolean,
  "avoidWidowAndOrphan": boolean,
  "shading": {
    object (Shading)
  },
  "pageBreakBefore": boolean
}
زمینه های
headingId

string

شناسه عنوان پاراگراف. اگر خالی باشد، این پاراگراف یک عنوان نیست.

این ویژگی فقط خواندنی است.

namedStyleType

enum ( NamedStyleType )

نوع سبک نامگذاری شده پاراگراف.

از آنجایی که به‌روزرسانی نوع سبک نام‌گذاری‌شده بر سایر ویژگی‌های داخل ParagraphStyle تأثیر می‌گذارد، نوع سبک نام‌گذاری‌شده قبل از به‌روزرسانی ویژگی‌های دیگر اعمال می‌شود.

alignment

enum ( Alignment )

تراز متن برای این پاراگراف.

lineSpacing

number

مقدار فاصله بین خطوط، به عنوان درصد نرمال، که در آن نرمال به صورت 100.0 نمایش داده می شود. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد.

direction

enum ( ContentDirection )

جهت متن این پاراگراف. اگر تنظیم نشود، مقدار پیش‌فرض روی LEFT_TO_RIGHT می‌شود، زیرا جهت پاراگراف به ارث نمی‌رسد.

spacingMode

enum ( SpacingMode )

حالت فاصله برای پاراگراف.

spaceAbove

object ( Dimension )

مقدار فضای اضافی بالای پاراگراف. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد.

spaceBelow

object ( Dimension )

مقدار فضای اضافی زیر پاراگراف. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد.

borderBetween

object ( ParagraphBorder )

مرز بین این بند و پاراگراف های بعدی و قبلی. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد.

مرز بین زمانی نمایش داده می شود که پاراگراف مجاور دارای ویژگی های حاشیه و تورفتگی یکسان باشد.

مرزهای پاراگراف را نمی توان تا حدی به روز کرد. هنگام تغییر مرز پاراگراف، حاشیه جدید باید به طور کامل مشخص شود.

borderTop

object ( ParagraphBorder )

حاشیه بالای این پاراگراف. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد.

حاشیه بالایی زمانی نمایش داده می شود که پاراگراف بالا دارای ویژگی های حاشیه و تورفتگی متفاوت باشد.

مرزهای پاراگراف را نمی توان تا حدی به روز کرد. هنگام تغییر مرز پاراگراف، حاشیه جدید باید به طور کامل مشخص شود.

borderBottom

object ( ParagraphBorder )

حاشیه در پایین این پاراگراف. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد.

حاشیه پایین زمانی نمایش داده می شود که پاراگراف زیر دارای ویژگی های حاشیه و تورفتگی متفاوت باشد.

مرزهای پاراگراف را نمی توان تا حدی به روز کرد. هنگام تغییر مرز پاراگراف، حاشیه جدید باید به طور کامل مشخص شود.

borderLeft

object ( ParagraphBorder )

حاشیه سمت چپ این پاراگراف. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد.

مرزهای پاراگراف را نمی توان تا حدی به روز کرد. هنگام تغییر مرز پاراگراف، حاشیه جدید باید به طور کامل مشخص شود.

borderRight

object ( ParagraphBorder )

حاشیه سمت راست این بند. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد.

مرزهای پاراگراف را نمی توان تا حدی به روز کرد. هنگام تغییر مرز پاراگراف، حاشیه جدید باید به طور کامل مشخص شود.

indentFirstLine

object ( Dimension )

مقدار تورفتگی برای خط اول پاراگراف. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد.

indentStart

object ( Dimension )

مقدار تورفتگی برای پاراگراف در سمتی که با شروع متن مطابقت دارد، بر اساس جهت پاراگراف فعلی. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد.

indentEnd

object ( Dimension )

مقدار تورفتگی برای پاراگراف در سمتی که با انتهای متن مطابقت دارد، بر اساس جهت پاراگراف فعلی. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد.

tabStops[]

object ( TabStop )

فهرستی از برگه ها برای این پاراگراف متوقف می شود. لیستی از tab stop ها به ارث نمی رسد.

این ویژگی فقط خواندنی است.

keepLinesTogether

boolean

در صورت امکان، تمام خطوط پاراگراف باید در یک صفحه یا ستون قرار داده شوند یا خیر. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد.

keepWithNext

boolean

در صورت امکان حداقل بخشی از این پاراگراف باید در همان صفحه یا ستون پاراگراف بعدی قرار گیرد یا خیر. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد.

avoidWidowAndOrphan

boolean

آیا برای پاراگراف از زنان بیوه و یتیم اجتناب شود. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد.

shading

object ( Shading )

سایه زنی پاراگراف. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد.

pageBreakBefore

boolean

آیا پاراگراف فعلی باید همیشه از ابتدای یک صفحه شروع شود یا خیر. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد.

تلاش برای به‌روزرسانی pageBreakBefore برای پاراگراف‌ها در مناطق پشتیبانی‌نشده، از جمله Table ، Header ، Footer و Footnote ، می‌تواند منجر به وضعیت سند نامعتبر شود که یک خطای درخواست 400 بد را برمی‌گرداند.

NamedStyleType

انواع سبک های نامگذاری شده

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

هم ترازی

انواع تراز متن برای یک پاراگراف

Enums
ALIGNMENT_UNSPECIFIED تراز پاراگراف از والد به ارث می رسد.
START پاراگراف با شروع خط تراز شده است. تراز چپ برای متن LTR، در غیر این صورت تراز راست.
CENTER پاراگراف در مرکز قرار دارد.
END پاراگراف تا آخر خط تراز شده است. تراز راست برای متن LTR، در غیر این صورت تراز چپ.
JUSTIFIED پاراگراف توجیه شده است.

جهت محتوا

جهت‌هایی که محتوا می‌تواند در آن جریان یابد.

Enums
CONTENT_DIRECTION_UNSPECIFIED جهت محتوا مشخص نشده است.
LEFT_TO_RIGHT محتوا از چپ به راست می رود.
RIGHT_TO_LEFT محتوا از راست به چپ می رود.

فاصله فاصله

حالت های مختلف برای فاصله پاراگراف.

Enums
SPACING_MODE_UNSPECIFIED حالت فاصله از والد به ارث رسیده است.
NEVER_COLLAPSE فاصله پاراگراف ها همیشه ارائه می شود.
COLLAPSE_LISTS فاصله پاراگراف بین عناصر لیست حذف می شود.

ParagraphBorder

یک حاشیه در اطراف یک پاراگراف.

نمایندگی JSON
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "padding": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
زمینه های
color

object ( OptionalColor )

رنگ حاشیه.

width

object ( Dimension )

عرض حاشیه.

padding

object ( Dimension )

لایه بندی حاشیه.

dashStyle

enum ( DashStyle )

سبک خط تیره حاشیه.

DashStyle

انواع خط تیره هایی که هندسه خطی را می توان با آنها ارائه کرد. این مقادیر بر اساس نوع ساده "ST_PresetLineDashVal" شرح داده شده در بخش 20.1.10.48 "فرمت‌های فایل XML باز آفیس - مبانی و مرجع زبان نشانه‌گذاری"، بخش 1 از ویرایش چهارم ECMA-376 هستند.

Enums
DASH_STYLE_UNSPECIFIED سبک خط تیره نامشخص.
SOLID خط توپر. مربوط به ECMA-376 ST_PresetLineDashVal مقدار 'solid' است. این سبک خط تیره پیش فرض است.
DOT خط نقطه چین. مربوط به ECMA-376 ST_PresetLineDashVal مقدار 'dot' است.
DASH خط بریده بریده. با مقدار ECMA-376 ST_PresetLineDashVal 'dash' مطابقت دارد.

TabStop

توقف برگه در یک پاراگراف.

نمایندگی JSON
{
  "offset": {
    object (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}
زمینه های
offset

object ( Dimension )

فاصله بین این tab stop و حاشیه شروع.

alignment

enum ( TabStopAlignment )

تراز این برگه متوقف می شود. اگر تنظیم نشود، مقدار پیش‌فرض روی START می‌شود.

TabStopAlignment

ترازبندی نقطه زبانه.

Enums
TAB_STOP_ALIGNMENT_UNSPECIFIED ترازبندی tab stop نامشخص است.
START tab stop با شروع خط تراز شده است. این پیش فرض است.
CENTER نقطه برگه در مرکز خط تراز شده است.
END tab stop تا انتهای خط تراز شده است.

سایه زدن

سایه زدن یک پاراگراف

نمایندگی JSON
{
  "backgroundColor": {
    object (OptionalColor)
  }
}
زمینه های
backgroundColor

object ( OptionalColor )

رنگ پس زمینه این پاراگراف سایه می زند.

سبک پاراگراف پیشنهادی

یک تغییر پیشنهادی به یک ParagraphStyle .

نمایندگی JSON
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
زمینه های
paragraphStyle

object ( ParagraphStyle )

یک ParagraphStyle که فقط شامل تغییرات ایجاد شده در این پیشنهاد می شود. این را می توان همراه با paragraphStyleSuggestionState استفاده کرد تا ببینید کدام فیلدها و مقادیر جدید آنها تغییر کرده اند.

paragraphStyleSuggestionState

object ( ParagraphStyleSuggestionState )

ماسکی که نشان می‌دهد کدام یک از فیلدهای ParagraphStyle در این پیشنهاد تغییر کرده است.

ParagraphStyleSuggestionState

ماسکی که نشان می‌دهد کدام یک از فیلدهای ParagraphStyle در این پیشنهاد تغییر کرده است. برای هر فیلدی که روی true تنظیم شده است، یک مقدار پیشنهادی جدید وجود دارد.

نمایندگی JSON
{
  "headingIdSuggested": boolean,
  "namedStyleTypeSuggested": boolean,
  "alignmentSuggested": boolean,
  "lineSpacingSuggested": boolean,
  "directionSuggested": boolean,
  "spacingModeSuggested": boolean,
  "spaceAboveSuggested": boolean,
  "spaceBelowSuggested": boolean,
  "borderBetweenSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "indentEndSuggested": boolean,
  "keepLinesTogetherSuggested": boolean,
  "keepWithNextSuggested": boolean,
  "avoidWidowAndOrphanSuggested": boolean,
  "shadingSuggestionState": {
    object (ShadingSuggestionState)
  },
  "pageBreakBeforeSuggested": boolean
}
زمینه های
headingIdSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی برای headingId وجود داشته است یا خیر.

namedStyleTypeSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی برای namedStyleType وجود داشته است یا خیر.

alignmentSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی برای alignment وجود دارد یا خیر.

lineSpacingSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی برای lineSpacing وجود داشته است.

directionSuggested

boolean

نشان می دهد که آیا تغییر direction پیشنهاد شده است یا خیر.

spacingModeSuggested

boolean

نشان می‌دهد که آیا تغییر پیشنهادی در spacingMode وجود داشته است.

spaceAboveSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی به spaceAbove وجود داشته است یا خیر.

spaceBelowSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی در spaceBelow وجود داشته است.

borderBetweenSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی به borderBetween وجود داشته است.

borderTopSuggested

boolean

نشان می دهد که آیا تغییری در borderTop پیشنهاد شده است یا خیر.

borderBottomSuggested

boolean

نشان می دهد که آیا تغییری به borderBottom پیشنهاد شده است یا خیر.

borderLeftSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی به borderLeft وجود داشته است.

borderRightSuggested

boolean

نشان می دهد که آیا تغییری به borderRight پیشنهاد شده است یا خیر.

indentFirstLineSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی برای indentFirstLine وجود داشته است.

indentStartSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی برای indentStart وجود داشته است.

indentEndSuggested

boolean

نشان می دهد که آیا تغییری برای indentEnd پیشنهاد شده است یا خیر.

keepLinesTogetherSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی برای keepLinesTogether وجود داشته است.

keepWithNextSuggested

boolean

نشان می دهد که آیا تغییری برای keepWithNext پیشنهاد شده است یا خیر.

avoidWidowAndOrphanSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی برای avoidWidowAndOrphan وجود داشته است یا خیر.

shadingSuggestionState

object ( ShadingSuggestionState )

ماسکی که نشان می دهد کدام یک از فیلدهای shading در این پیشنهاد تغییر کرده است.

pageBreakBeforeSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی به pageBreakBefore وجود داشته است یا خیر.

ShadingSuggestionState

ماسکی که نشان می‌دهد در این تغییر پیشنهادی کدام یک از فیلدهای روی پایه Shading تغییر کرده است. برای هر فیلدی که روی true تنظیم شده است، یک مقدار پیشنهادی جدید وجود دارد.

نمایندگی JSON
{
  "backgroundColorSuggested": boolean
}
زمینه های
backgroundColorSuggested

boolean

نشان می دهد که آیا تغییر پیشنهادی در Shading وجود دارد یا خیر.

گلوله

گلوله یک پاراگراف را توصیف می کند.

نمایندگی JSON
{
  "listId": string,
  "nestingLevel": integer,
  "textStyle": {
    object (TextStyle)
  }
}
زمینه های
listId

string

شناسه فهرستی که این پاراگراف به آن تعلق دارد.

nestingLevel

integer

سطح تودرتو این پاراگراف در لیست.

textStyle

object ( TextStyle )

سبک متن خاص پاراگراف برای این گلوله اعمال می شود.

گلوله پیشنهادی

یک تغییر پیشنهادی به یک Bullet .

نمایندگی JSON
{
  "bullet": {
    object (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}
زمینه های
bullet

object ( Bullet )

Bullet ای که فقط شامل تغییرات ایجاد شده در این پیشنهاد می شود. این می تواند همراه با bulletSuggestionState استفاده شود تا ببینید کدام فیلدها و مقادیر جدید آنها تغییر کرده اند.

bulletSuggestionState

object ( BulletSuggestionState )

ماسکی که نشان می دهد کدام یک از فیلدهای Bullet پایه در این پیشنهاد تغییر کرده است.

BulletSuggestionState

A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation
{
  "listIdSuggested": boolean,
  "nestingLevelSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
زمینه های
listIdSuggested

boolean

Indicates if there was a suggested change to the listId .

nestingLevelSuggested

boolean

Indicates if there was a suggested change to the nestingLevel .

textStyleSuggestionState

object ( TextStyleSuggestionState )

A mask that indicates which of the fields in text style have been changed in this suggestion.

ObjectReferences

A collection of object IDs.

JSON representation
{
  "objectIds": [
    string
  ]
}
زمینه های
objectIds[]

string

The object IDs.

SectionBreak

A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle . A section break represents the start of a new section, and the section style applies to the section after the section break.

The document body always begins with a section break.

JSON representation
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "sectionStyle": {
    object (SectionStyle)
  }
}
زمینه های
suggestedInsertionIds[]

string

The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

suggestedDeletionIds[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

sectionStyle

object ( SectionStyle )

The style of the section after this section break.

SectionStyle

The styling that applies to a section.

JSON representation
{
  "columnProperties": [
    {
      object (SectionColumnProperties)
    }
  ],
  "columnSeparatorStyle": enum (ColumnSeparatorStyle),
  "contentDirection": enum (ContentDirection),
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "sectionType": enum (SectionType),
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "flipPageOrientation": boolean
}
زمینه های
columnProperties[]

object ( SectionColumnProperties )

The section's columns properties.

If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns.

When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.

columnSeparatorStyle

enum ( ColumnSeparatorStyle )

The style of column separators.

This style can be set even when there's one column in the section.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

contentDirection

enum ( ContentDirection )

The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT .

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

marginTop

object ( Dimension )

The top page margin of the section. If unset, the value defaults to marginTop from DocumentStyle.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

marginBottom

object ( Dimension )

The bottom page margin of the section. If unset, the value defaults to marginBottom from DocumentStyle.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

marginRight

object ( Dimension )

The right page margin of the section. If unset, the value defaults to marginRight from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

marginLeft

object ( Dimension )

The left page margin of the section. If unset, the value defaults to marginLeft from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

marginHeader

object ( Dimension )

The header margin of the section. If unset, the value defaults to marginHeader from DocumentStyle. If updated, useCustomHeaderFooterMargins is set to true on DocumentStyle. The value of useCustomHeaderFooterMargins on DocumentStyle indicates if a header margin is being respected for this section.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

sectionType

enum ( SectionType )

فقط خروجی The type of section.

defaultHeaderId

string

The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's defaultHeaderId .

This property is read-only.

firstPageHeaderId

string

The ID of the header used only for the first page of the section. If useFirstPageHeaderFooter is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the defaultHeaderId . If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's firstPageHeaderId .

This property is read-only.

firstPageFooterId

string

The ID of the footer used only for the first page of the section. If useFirstPageHeaderFooter is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the defaultFooterId . If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's firstPageFooterId .

This property is read-only.

evenPageHeaderId

string

The ID of the header used only for even pages. If the value of DocumentStyle's useEvenPageHeaderFooter is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the defaultHeaderId . If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's evenPageHeaderId .

This property is read-only.

evenPageFooterId

string

The ID of the footer used only for even pages. If the value of DocumentStyle's useEvenPageHeaderFooter is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the defaultFooterId . If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's evenPageFooterId .

This property is read-only.

useFirstPageHeaderFooter

boolean

Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's useFirstPageHeaderFooter for the first section. If the value is unset for subsequent sectors, it should be interpreted as false.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

pageNumberStart

integer

The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak , refer to DocumentStyle's pageNumberStart .

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

flipPageOrientation

boolean

اختیاری. Indicates whether to flip the dimensions of DocumentStyle's pageSize for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flipPageOrientation .

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

SectionColumnProperties

Properties that apply to a section's column.

JSON representation
{
  "width": {
    object (Dimension)
  },
  "paddingEnd": {
    object (Dimension)
  }
}
زمینه های
width

object ( Dimension )

فقط خروجی The width of the column.

paddingEnd

object ( Dimension )

The padding at the end of the column.

ColumnSeparatorStyle

The style of column separators between columns.

Enums
COLUMN_SEPARATOR_STYLE_UNSPECIFIED An unspecified column separator style.
NONE No column separator lines between columns.
BETWEEN_EACH_COLUMN Renders a column separator line between each column.

SectionType

Represents how the start of the current section is positioned relative to the previous section.

Enums
SECTION_TYPE_UNSPECIFIED The section type is unspecified.
CONTINUOUS The section starts immediately after the last paragraph of the previous section.
NEXT_PAGE The section starts on the next page.

Table

A StructuralElement representing a table.

JSON representation
{
  "rows": integer,
  "columns": integer,
  "tableRows": [
    {
      object (TableRow)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableStyle": {
    object (TableStyle)
  }
}
زمینه های
rows

integer

Number of rows in the table.

columns

integer

Number of columns in the table.

It's possible for a table to be non-rectangular, so some rows may have a different number of cells.

tableRows[]

object ( TableRow )

The contents and style of each row.

suggestedInsertionIds[]

string

The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

suggestedDeletionIds[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

tableStyle

object ( TableStyle )

The style of the table.

TableRow

The contents and style of a row in a Table .

JSON representation
{
  "startIndex": integer,
  "endIndex": integer,
  "tableCells": [
    {
      object (TableCell)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "suggestedTableRowStyleChanges": {
    string: {
      object (SuggestedTableRowStyle)
    },
    ...
  }
}
زمینه های
startIndex

integer

The zero-based start index of this row, in UTF-16 code units.

endIndex

integer

The zero-based end index of this row, exclusive, in UTF-16 code units.

tableCells[]

object ( TableCell )

The contents and style of each cell in this row.

It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.

suggestedInsertionIds[]

string

The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

suggestedDeletionIds[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

tableRowStyle

object ( TableRowStyle )

The style of the table row.

suggestedTableRowStyleChanges

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

The suggested style changes to this row, keyed by suggestion ID.

TableCell

The contents and style of a cell in a Table .

JSON representation
{
  "startIndex": integer,
  "endIndex": integer,
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "suggestedTableCellStyleChanges": {
    string: {
      object (SuggestedTableCellStyle)
    },
    ...
  }
}
زمینه های
startIndex

integer

The zero-based start index of this cell, in UTF-16 code units.

endIndex

integer

The zero-based end index of this cell, exclusive, in UTF-16 code units.

content[]

object ( StructuralElement )

The content of the cell.

tableCellStyle

object ( TableCellStyle )

The style of the cell.

suggestedInsertionIds[]

string

The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

suggestedDeletionIds[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

suggestedTableCellStyleChanges

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

The suggested changes to the table cell style, keyed by suggestion ID.

TableCellStyle

The style of a TableCell .

Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style.

JSON representation
{
  "rowSpan": integer,
  "columnSpan": integer,
  "backgroundColor": {
    object (OptionalColor)
  },
  "borderLeft": {
    object (TableCellBorder)
  },
  "borderRight": {
    object (TableCellBorder)
  },
  "borderTop": {
    object (TableCellBorder)
  },
  "borderBottom": {
    object (TableCellBorder)
  },
  "paddingLeft": {
    object (Dimension)
  },
  "paddingRight": {
    object (Dimension)
  },
  "paddingTop": {
    object (Dimension)
  },
  "paddingBottom": {
    object (Dimension)
  },
  "contentAlignment": enum (ContentAlignment)
}
زمینه های
rowSpan

integer

The row span of the cell.

This property is read-only.

columnSpan

integer

The column span of the cell.

This property is read-only.

backgroundColor

object ( OptionalColor )

The background color of the cell.

borderLeft

object ( TableCellBorder )

The left border of the cell.

borderRight

object ( TableCellBorder )

The right border of the cell.

borderTop

object ( TableCellBorder )

The top border of the cell.

borderBottom

object ( TableCellBorder )

The bottom border of the cell.

paddingLeft

object ( Dimension )

The left padding of the cell.

paddingRight

object ( Dimension )

The right padding of the cell.

paddingTop

object ( Dimension )

The top padding of the cell.

paddingBottom

object ( Dimension )

The bottom padding of the cell.

contentAlignment

enum ( ContentAlignment )

The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.

TableCellBorder

A border around a table cell.

Table cell borders cannot be transparent. To hide a table cell border, make its width 0.

JSON representation
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
زمینه های
color

object ( OptionalColor )

The color of the border.

This color cannot be transparent.

width

object ( Dimension )

The width of the border.

dashStyle

enum ( DashStyle )

The dash style of the border.

ContentAlignment

The types of content alignment.

Derived from a subset of the values of the "ST_TextAnchoringType" simple type in section 20.1.10.59 of "Office Open XML File Formats - Fundamentals and Markup Language Reference", part 1 of ECMA-376 4th edition .

Enums
CONTENT_ALIGNMENT_UNSPECIFIED An unspecified content alignment. The content alignment is inherited from the parent if one exists.
CONTENT_ALIGNMENT_UNSUPPORTED An unsupported content alignment.
TOP An alignment that aligns the content to the top of the content holder. Corresponds to ECMA-376 ST_TextAnchoringType 't'.
MIDDLE An alignment that aligns the content to the middle of the content holder. Corresponds to ECMA-376 ST_TextAnchoringType 'ctr'.
BOTTOM An alignment that aligns the content to the bottom of the content holder. Corresponds to ECMA-376 ST_TextAnchoringType 'b'.

SuggestedTableCellStyle

A suggested change to a TableCellStyle .

JSON representation
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "tableCellStyleSuggestionState": {
    object (TableCellStyleSuggestionState)
  }
}
زمینه های
tableCellStyle

object ( TableCellStyle )

A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the tableCellStyleSuggestionState to see which fields have changed and their new values.

tableCellStyleSuggestionState

object ( TableCellStyleSuggestionState )

A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.

TableCellStyleSuggestionState

A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation
{
  "rowSpanSuggested": boolean,
  "columnSpanSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "paddingLeftSuggested": boolean,
  "paddingRightSuggested": boolean,
  "paddingTopSuggested": boolean,
  "paddingBottomSuggested": boolean,
  "contentAlignmentSuggested": boolean
}
زمینه های
rowSpanSuggested

boolean

Indicates if there was a suggested change to rowSpan .

columnSpanSuggested

boolean

Indicates if there was a suggested change to columnSpan .

backgroundColorSuggested

boolean

Indicates if there was a suggested change to backgroundColor .

borderLeftSuggested

boolean

Indicates if there was a suggested change to borderLeft .

borderRightSuggested

boolean

Indicates if there was a suggested change to borderRight .

borderTopSuggested

boolean

Indicates if there was a suggested change to borderTop .

borderBottomSuggested

boolean

Indicates if there was a suggested change to borderBottom .

paddingLeftSuggested

boolean

Indicates if there was a suggested change to paddingLeft .

paddingRightSuggested

boolean

Indicates if there was a suggested change to paddingRight .

paddingTopSuggested

boolean

Indicates if there was a suggested change to paddingTop .

paddingBottomSuggested

boolean

Indicates if there was a suggested change to paddingBottom .

contentAlignmentSuggested

boolean

Indicates if there was a suggested change to contentAlignment .

TableRowStyle

Styles that apply to a table row.

JSON representation
{
  "minRowHeight": {
    object (Dimension)
  },
  "tableHeader": boolean,
  "preventOverflow": boolean
}
زمینه های
minRowHeight

object ( Dimension )

The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.

tableHeader

boolean

Whether the row is a table header.

preventOverflow

boolean

Whether the row cannot overflow across page or column boundaries.

SuggestedTableRowStyle

A suggested change to a TableRowStyle .

JSON representation
{
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}
زمینه های
tableRowStyle

object ( TableRowStyle )

A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the tableRowStyleSuggestionState to see which fields have changed and their new values.

tableRowStyleSuggestionState

object ( TableRowStyleSuggestionState )

A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.

TableRowStyleSuggestionState

A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation
{
  "minRowHeightSuggested": boolean
}
زمینه های
minRowHeightSuggested

boolean

Indicates if there was a suggested change to minRowHeight .

TableStyle

Styles that apply to a table.

JSON representation
{
  "tableColumnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
زمینه های
tableColumnProperties[]

object ( TableColumnProperties )

The properties of each column.

Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's tableRowStyle .

TableColumnProperties

The properties of a column in a table.

JSON representation
{
  "widthType": enum (WidthType),
  "width": {
    object (Dimension)
  }
}
زمینه های
widthType

enum ( WidthType )

The width type of the column.

width

object ( Dimension )

The width of the column. Set when the column's widthType is FIXED_WIDTH .

WidthType

The type of width of the column.

Enums
WIDTH_TYPE_UNSPECIFIED The column width type is unspecified.
EVENLY_DISTRIBUTED

The column width is evenly distributed among the other evenly distributed columns.

The width of the column is automatically determined and will have an equal portion of the width remaining for the table after accounting for all columns with specified widths.

FIXED_WIDTH A fixed column width. The [width][ google.apps.docs.v1.TableColumnProperties.width property contains the column's width.

TableOfContents

A StructuralElement representing a table of contents.

JSON representation
{
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
زمینه های
content[]

object ( StructuralElement )

The content of the table of contents.

suggestedInsertionIds[]

string

The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.

suggestedDeletionIds[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

Footnote

A document footnote.

JSON representation
{
  "footnoteId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
زمینه های
footnoteId

string

The ID of the footnote.

content[]

object ( StructuralElement )

The contents of the footnote.

The indexes for a footnote's content begin at zero.

DocumentStyle

The style of the document.

JSON representation
{
  "background": {
    object (Background)
  },
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "useEvenPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "pageSize": {
    object (Size)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "useCustomHeaderFooterMargins": boolean,
  "flipPageOrientation": boolean
}
زمینه های
background

object ( Background )

The background of the document. Documents cannot have a transparent background color.

defaultHeaderId

string

The ID of the default header. If not set, there's no default header.

This property is read-only.

evenPageHeaderId

string

The ID of the header used only for even pages. The value of useEvenPageHeaderFooter determines whether to use the defaultHeaderId or this value for the header on even pages. If not set, there's no even page header.

This property is read-only.

evenPageFooterId

string

The ID of the footer used only for even pages. The value of useEvenPageHeaderFooter determines whether to use the defaultFooterId or this value for the footer on even pages. If not set, there's no even page footer.

This property is read-only.

firstPageHeaderId

string

The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of useFirstPageHeaderFooter determines whether to use the defaultHeaderId or this value for the header on the first page. If not set, there's no first page header.

This property is read-only.

firstPageFooterId

string

The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of useFirstPageHeaderFooter determines whether to use the defaultFooterId or this value for the footer on the first page. If not set, there's no first page footer.

This property is read-only.

useFirstPageHeaderFooter

boolean

Indicates whether to use the first page header / footer IDs for the first page.

useEvenPageHeaderFooter

boolean

Indicates whether to use the even page header / footer IDs for the even pages.

pageNumberStart

integer

The page number from which to start counting the number of pages.

marginTop

object ( Dimension )

The top page margin.

Updating the top page margin on the document style clears the top page margin on all section styles.

marginBottom

object ( Dimension )

The bottom page margin.

Updating the bottom page margin on the document style clears the bottom page margin on all section styles.

marginRight

object ( Dimension )

The right page margin.

Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections.

marginLeft

object ( Dimension )

The left page margin.

Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections.

pageSize

object ( Size )

The size of a page in the document.

marginHeader

object ( Dimension )

The amount of space between the top of the page and the contents of the header.

flipPageOrientation

boolean

اختیاری. Indicates whether to flip the dimensions of the pageSize , which allows changing the page orientation between portrait and landscape.

Background

Represents the background of a document.

JSON representation
{
  "color": {
    object (OptionalColor)
  }
}
زمینه های
color

object ( OptionalColor )

The background color.

Size

A width and height.

JSON representation
{
  "height": {
    object (Dimension)
  },
  "width": {
    object (Dimension)
  }
}
زمینه های
height

object ( Dimension )

The height of the object.

width

object ( Dimension )

The width of the object.

SuggestedDocumentStyle

A suggested change to the DocumentStyle .

JSON representation
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "documentStyleSuggestionState": {
    object (DocumentStyleSuggestionState)
  }
}
زمینه های
documentStyle

object ( DocumentStyle )

A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the documentStyleSuggestionState to see which fields have changed and their new values.

documentStyleSuggestionState

object ( DocumentStyleSuggestionState )

A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion.

DocumentStyleSuggestionState

A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation
{
  "backgroundSuggestionState": {
    object (BackgroundSuggestionState)
  },
  "defaultHeaderIdSuggested": boolean,
  "defaultFooterIdSuggested": boolean,
  "evenPageHeaderIdSuggested": boolean,
  "evenPageFooterIdSuggested": boolean,
  "firstPageHeaderIdSuggested": boolean,
  "firstPageFooterIdSuggested": boolean,
  "useFirstPageHeaderFooterSuggested": boolean,
  "useEvenPageHeaderFooterSuggested": boolean,
  "pageNumberStartSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginLeftSuggested": boolean,
  "pageSizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginHeaderSuggested": boolean,
  "marginFooterSuggested": boolean,
  "useCustomHeaderFooterMarginsSuggested": boolean,
  "flipPageOrientationSuggested": boolean
}
زمینه های
backgroundSuggestionState

object ( BackgroundSuggestionState )

A mask that indicates which of the fields in background have been changed in this suggestion.

defaultHeaderIdSuggested

boolean

Indicates if there was a suggested change to defaultHeaderId .

evenPageHeaderIdSuggested

boolean

Indicates if there was a suggested change to evenPageHeaderId .

evenPageFooterIdSuggested

boolean

Indicates if there was a suggested change to evenPageFooterId .

firstPageHeaderIdSuggested

boolean

Indicates if there was a suggested change to firstPageHeaderId .

firstPageFooterIdSuggested

boolean

Indicates if there was a suggested change to firstPageFooterId .

useFirstPageHeaderFooterSuggested

boolean

Indicates if there was a suggested change to useFirstPageHeaderFooter .

useEvenPageHeaderFooterSuggested

boolean

Indicates if there was a suggested change to useEvenPageHeaderFooter .

pageNumberStartSuggested

boolean

Indicates if there was a suggested change to pageNumberStart .

marginTopSuggested

boolean

Indicates if there was a suggested change to marginTop .

marginBottomSuggested

boolean

Indicates if there was a suggested change to marginBottom .

marginRightSuggested

boolean

Indicates if there was a suggested change to marginRight .

marginLeftSuggested

boolean

Indicates if there was a suggested change to marginLeft .

pageSizeSuggestionState

object ( SizeSuggestionState )

A mask that indicates which of the fields in [size] [google.apps.docs.v1.DocumentStyle.size] have been changed in this suggestion.

marginHeaderSuggested

boolean

Indicates if there was a suggested change to marginHeader .

flipPageOrientationSuggested

boolean

اختیاری. Indicates if there was a suggested change to flipPageOrientation .

BackgroundSuggestionState

A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value.

JSON representation
{
  "backgroundColorSuggested": boolean
}
زمینه های
backgroundColorSuggested

boolean

Indicates whether the current background color has been modified in this suggestion.

SizeSuggestionState

A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value.

JSON representation
{
  "heightSuggested": boolean,
  "widthSuggested": boolean
}
زمینه های
heightSuggested

boolean

Indicates if there was a suggested change to height .

widthSuggested

boolean

Indicates if there was a suggested change to width .

NamedStyles

The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles.

JSON representation
{
  "styles": [
    {
      object (NamedStyle)
    }
  ]
}
زمینه های
styles[]

object ( NamedStyle )

The named styles.

There's an entry for each of the possible named style types .

NamedStyle

A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type.

JSON representation
{
  "namedStyleType": enum (NamedStyleType),
  "textStyle": {
    object (TextStyle)
  },
  "paragraphStyle": {
    object (ParagraphStyle)
  }
}
زمینه های
namedStyleType

enum ( NamedStyleType )

The type of this named style.

textStyle

object ( TextStyle )

The text style of this named style.

paragraphStyle

object ( ParagraphStyle )

The paragraph style of this named style.

SuggestedNamedStyles

A suggested change to the NamedStyles .

JSON representation
{
  "namedStyles": {
    object (NamedStyles)
  },
  "namedStylesSuggestionState": {
    object (NamedStylesSuggestionState)
  }
}
زمینه های
namedStyles

object ( NamedStyles )

A NamedStyles that only includes the changes made in this suggestion. This can be used along with the namedStylesSuggestionState to see which fields have changed and their new values.

namedStylesSuggestionState

object ( NamedStylesSuggestionState )

A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion.

NamedStylesSuggestionState

The suggestion state of a NamedStyles message.

JSON representation
{
  "stylesSuggestionStates": [
    {
      object (NamedStyleSuggestionState)
    }
  ]
}
زمینه های
stylesSuggestionStates[]

object ( NamedStyleSuggestionState )

A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion.

The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion.

NamedStyleSuggestionState

A suggestion state of a NamedStyle message.

JSON representation
{
  "namedStyleType": enum (NamedStyleType),
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
زمینه های
namedStyleType

enum ( NamedStyleType )

The named style type that this suggestion state corresponds to.

This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle .

textStyleSuggestionState

object ( TextStyleSuggestionState )

A mask that indicates which of the fields in text style have been changed in this suggestion.

paragraphStyleSuggestionState

object ( ParagraphStyleSuggestionState )

A mask that indicates which of the fields in paragraph style have been changed in this suggestion.

List

A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet .

JSON representation
{
  "listProperties": {
    object (ListProperties)
  },
  "suggestedListPropertiesChanges": {
    string: {
      object (SuggestedListProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
زمینه های
listProperties

object ( ListProperties )

The properties of the list.

suggestedListPropertiesChanges

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

The suggested changes to the list properties, keyed by suggestion ID.

suggestedInsertionId

string

The suggested insertion ID. If empty, then this is not a suggested insertion.

suggestedDeletionIds[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this list.

ListProperties

The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list.

JSON representation
{
  "nestingLevels": [
    {
      object (NestingLevel)
    }
  ]
}
زمینه های
nestingLevels[]

object ( NestingLevel )

Describes the properties of the bullets at the associated level.

A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.

NestingLevel

Contains properties describing the look and feel of a list bullet at a given level of nesting.

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

  // Union field glyph_kind can be only one of the following:
  "glyphType": enum (GlyphType),
  "glyphSymbol": string
  // End of list of possible types for union field glyph_kind.
}
زمینه های
bulletAlignment

enum ( BulletAlignment )

The alignment of the bullet within the space allotted for rendering the bullet.

glyphFormat

string

The format string used by bullets at this level of nesting.

The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyphType or glyphSymbol . The placeholders follow the pattern %[nestingLevel] . Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern <prefix>%[nestingLevel]<suffix> . Note that the prefix and suffix are optional and can be arbitrary strings.

For example, the glyph format %0. indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format %0. at nesting level 0 will result in a list with rendered glyphs

A.

B.

C.

The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of %0. at nesting level 0 and a glyph format of %0.%1. at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs

1.

2.

2.1.

2.2.

3.

For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.

indentFirstLine

object ( Dimension )

The amount of indentation for the first line of paragraphs at this level of nesting.

indentStart

object ( Dimension )

The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction.

textStyle

object ( TextStyle )

The text style of bullets at this level of nesting.

startNumber

integer

The number of the first list item at this nesting level.

A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at a and i respectively.

This value is ignored for nesting levels with unordered glyphs.

Union field glyph_kind . The kind of glyph used by bullets. This defines the bullet glyph that replaces the placeholders in the glyph_format . glyph_kind can be only one of the following:
glyphType

enum ( GlyphType )

The type of glyph used by bullets when paragraphs at this level of nesting are ordered.

The glyph type determines the type of glyph used to replace placeholders within the glyphFormat when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyphFormat is %0. and the glyph type is DECIMAL , then the rendered glyph would replace the placeholder %0 in the glyph format with a number corresponding to list item's order within the list.

glyphSymbol

string

A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered.

The glyph symbol replaces placeholders within the glyphFormat . For example, if the glyphSymbol is the solid circle corresponding to Unicode U+25cf code point and the glyphFormat is %0 , the rendered glyph would be the solid circle.

BulletAlignment

The types of alignment for a bullet.

Enums
BULLET_ALIGNMENT_UNSPECIFIED The bullet alignment is unspecified.
START The bullet is aligned to the start of the space allotted for rendering the bullet. Left-aligned for LTR text, right-aligned otherwise.
CENTER The bullet is aligned to the center of the space allotted for rendering the bullet.
END The bullet is aligned to the end of the space allotted for rendering the bullet. Right-aligned for LTR text, left-aligned otherwise.

GlyphType

The types of glyphs used by bullets when paragraphs at this level of nesting are ordered.

Enums
GLYPH_TYPE_UNSPECIFIED The glyph type is unspecified or unsupported.
NONE An empty string.
DECIMAL A number, like 1 , 2 , or 3 .
ZERO_DECIMAL A number where single digit numbers are prefixed with a zero, like 01 , 02 , or 03 . Numbers with more than one digit are not prefixed with a zero.
UPPER_ALPHA An uppercase letter, like A , B , or C .
ALPHA A lowercase letter, like a , b , or c .
UPPER_ROMAN An uppercase Roman numeral, like I , II , or III .
ROMAN A lowercase Roman numeral, like i , ii , or iii .

SuggestedListProperties

A suggested change to ListProperties .

JSON representation
{
  "listProperties": {
    object (ListProperties)
  },
  "listPropertiesSuggestionState": {
    object (ListPropertiesSuggestionState)
  }
}
زمینه های
listProperties

object ( ListProperties )

A ListProperties that only includes the changes made in this suggestion. This can be used along with the listPropertiesSuggestionState to see which fields have changed and their new values.

listPropertiesSuggestionState

object ( ListPropertiesSuggestionState )

A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion.

ListPropertiesSuggestionState

A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation
{
  "nestingLevelsSuggestionStates": [
    {
      object (NestingLevelSuggestionState)
    }
  ]
}
زمینه های
nestingLevelsSuggestionStates[]

object ( NestingLevelSuggestionState )

A mask that indicates which of the fields on the corresponding NestingLevel in nestingLevels have been changed in this suggestion.

The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first.

NestingLevelSuggestionState

A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation
{
  "bulletAlignmentSuggested": boolean,
  "glyphTypeSuggested": boolean,
  "glyphFormatSuggested": boolean,
  "glyphSymbolSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "startNumberSuggested": boolean
}
زمینه های
bulletAlignmentSuggested

boolean

Indicates if there was a suggested change to bulletAlignment .

glyphTypeSuggested

boolean

Indicates if there was a suggested change to glyphType .

glyphFormatSuggested

boolean

Indicates if there was a suggested change to glyphFormat .

glyphSymbolSuggested

boolean

Indicates if there was a suggested change to glyphSymbol .

indentFirstLineSuggested

boolean

Indicates if there was a suggested change to indentFirstLine .

indentStartSuggested

boolean

Indicates if there was a suggested change to indentStart .

textStyleSuggestionState

object ( TextStyleSuggestionState )

A mask that indicates which of the fields in text style have been changed in this suggestion.

startNumberSuggested

boolean

Indicates if there was a suggested change to startNumber .

NamedRanges

A collection of all the NamedRange s in the document that share a given name.

JSON representation
{
  "name": string,
  "namedRanges": [
    {
      object (NamedRange)
    }
  ]
}
زمینه های
name

string

The name that all the named ranges share.

namedRanges[]

object ( NamedRange )

The NamedRange s that share the same name.

NamedRange

A collection of Range s with the same named range ID.

Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID.

A named range is created with a single Range , and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges.

Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges.

JSON representation
{
  "namedRangeId": string,
  "name": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
زمینه های
namedRangeId

string

The ID of the named range.

name

string

The name of the named range.

ranges[]

object ( Range )

The ranges that belong to this named range.

Range

Specifies a contiguous range of text.

JSON representation
{
  "segmentId": string,
  "startIndex": integer,
  "endIndex": integer
}
زمینه های
segmentId

string

The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body.

startIndex

integer

The zero-based start index of this range, in UTF-16 code units.

In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.

endIndex

integer

The zero-based end index of this range, exclusive, in UTF-16 code units.

In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.

SuggestionsViewMode

The suggestions view mode applied to the document that indicates how suggested changes are represented. It provides options for reading the document with all suggestions inline, accepted, or rejected.

Enums
DEFAULT_FOR_CURRENT_ACCESS The SuggestionsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, PREVIEW_WITHOUT_SUGGESTIONS is applied. Otherwise, SUGGESTIONS_INLINE is applied. This is the default suggestions view mode.
SUGGESTIONS_INLINE

The returned document has suggestions inline. Suggested changes will be differentiated from base content within the document.

Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.

PREVIEW_SUGGESTIONS_ACCEPTED

The returned document is a preview with all suggested changes accepted.

Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.

PREVIEW_WITHOUT_SUGGESTIONS The returned document is a preview with all suggested changes rejected if there are any suggestions in the document.

InlineObject

An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image.

JSON representation
{
  "objectId": string,
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "suggestedInlineObjectPropertiesChanges": {
    string: {
      object (SuggestedInlineObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
زمینه های
objectId

string

The ID of this inline object. Can be used to update an object's properties.

inlineObjectProperties

object ( InlineObjectProperties )

The properties of this inline object.

suggestedInlineObjectPropertiesChanges

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

The suggested changes to the inline object properties, keyed by suggestion ID.

suggestedInsertionId

string

The suggested insertion ID. If empty, then this is not a suggested insertion.

suggestedDeletionIds[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

InlineObjectProperties

Properties of an InlineObject .

JSON representation
{
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
زمینه های
embeddedObject

object ( EmbeddedObject )

The embedded object of this inline object.

EmbeddedObject

An embedded object in the document.

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

  // Union field properties can be only one of the following:
  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
  // End of list of possible types for union field properties.
}
زمینه های
title

string

The title of the embedded object. The title and description are both combined to display alt text.

description

string

The description of the embedded object. The title and description are both combined to display alt text.

embeddedObjectBorder

object ( EmbeddedObjectBorder )

The border of the embedded object.

size

object ( Size )

The visible size of the image after cropping.

marginTop

object ( Dimension )

The top margin of the embedded object.

marginBottom

object ( Dimension )

The bottom margin of the embedded object.

marginRight

object ( Dimension )

The right margin of the embedded object.

marginLeft

object ( Dimension )

The left margin of the embedded object.

linkedContentReference

object ( LinkedContentReference )

A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart.

If unset, then the embedded object is not linked.

Union field properties . The properties that are specific to each embedded object type. properties can be only one of the following:
embeddedDrawingProperties

object ( EmbeddedDrawingProperties )

The properties of an embedded drawing.

imageProperties

object ( ImageProperties )

The properties of an image.

EmbeddedDrawingProperties

این نوع هیچ فیلدی ندارد.

The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported.

ImageProperties

The properties of an image.

JSON representation
{
  "contentUri": string,
  "sourceUri": string,
  "brightness": number,
  "contrast": number,
  "transparency": number,
  "cropProperties": {
    object (CropProperties)
  },
  "angle": number
}
زمینه های
contentUri

string

A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.

sourceUri

string

The source URI is the URI used to insert the image. The source URI can be empty.

brightness

number

The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.

contrast

number

The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.

transparency

number

The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.

cropProperties

object ( CropProperties )

The crop properties of the image.

angle

number

The clockwise rotation angle of the image, in radians.

CropProperties

The crop properties of an image.

The crop rectangle is represented using fractional offsets from the original content's 4 edges.

  • If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle.
  • If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle.
  • If all offsets and rotation angle are 0, the image is not cropped.
JSON representation
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
زمینه های
offsetLeft

number

The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.

offsetRight

number

The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.

offsetTop

number

The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.

offsetBottom

number

The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.

angle

number

The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.

EmbeddedObjectBorder

A border around an EmbeddedObject .

JSON representation
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle),
  "propertyState": enum (PropertyState)
}
زمینه های
color

object ( OptionalColor )

The color of the border.

width

object ( Dimension )

The width of the border.

dashStyle

enum ( DashStyle )

The dash style of the border.

propertyState

enum ( PropertyState )

The property state of the border property.

PropertyState

The possible states of a property.

Enums
RENDERED If a property's state is RENDERED, then the element has the corresponding property when rendered in the document. This is the default value.
NOT_RENDERED If a property's state is NOT_RENDERED, then the element does not have the corresponding property when rendered in the document.

LinkedContentReference

A reference to the external linked source content.

JSON representation
{

  // Union field reference can be only one of the following:
  "sheetsChartReference": {
    object (SheetsChartReference)
  }
  // End of list of possible types for union field reference.
}
زمینه های
Union field reference . The reference specific to the type of linked content. reference can be only one of the following:
sheetsChartReference

object ( SheetsChartReference )

A reference to the linked chart.

SheetsChartReference

A reference to a linked chart embedded from Google Sheets.

JSON representation
{
  "spreadsheetId": string,
  "chartId": integer
}
زمینه های
spreadsheetId

string

The ID of the Google Sheets spreadsheet that contains the source chart.

chartId

integer

The ID of the specific chart in the Google Sheets spreadsheet that's embedded.

SuggestedInlineObjectProperties

A suggested change to InlineObjectProperties .

JSON representation
{
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "inlineObjectPropertiesSuggestionState": {
    object (InlineObjectPropertiesSuggestionState)
  }
}
زمینه های
inlineObjectProperties

object ( InlineObjectProperties )

An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inlineObjectPropertiesSuggestionState to see which fields have changed and their new values.

inlineObjectPropertiesSuggestionState

object ( InlineObjectPropertiesSuggestionState )

A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion.

InlineObjectPropertiesSuggestionState

A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation
{
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
زمینه های
embeddedObjectSuggestionState

object ( EmbeddedObjectSuggestionState )

A mask that indicates which of the fields in embeddedObject have been changed in this suggestion.

EmbeddedObjectSuggestionState

A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation
{
  "embeddedDrawingPropertiesSuggestionState": {
    object (EmbeddedDrawingPropertiesSuggestionState)
  },
  "imagePropertiesSuggestionState": {
    object (ImagePropertiesSuggestionState)
  },
  "titleSuggested": boolean,
  "descriptionSuggested": boolean,
  "embeddedObjectBorderSuggestionState": {
    object (EmbeddedObjectBorderSuggestionState)
  },
  "sizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginLeftSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "linkedContentReferenceSuggestionState": {
    object (LinkedContentReferenceSuggestionState)
  }
}
زمینه های
embeddedDrawingPropertiesSuggestionState

object ( EmbeddedDrawingPropertiesSuggestionState )

A mask that indicates which of the fields in embeddedDrawingProperties have been changed in this suggestion.

imagePropertiesSuggestionState

object ( ImagePropertiesSuggestionState )

A mask that indicates which of the fields in imageProperties have been changed in this suggestion.

titleSuggested

boolean

Indicates if there was a suggested change to title .

descriptionSuggested

boolean

Indicates if there was a suggested change to description .

embeddedObjectBorderSuggestionState

object ( EmbeddedObjectBorderSuggestionState )

A mask that indicates which of the fields in embeddedObjectBorder have been changed in this suggestion.

sizeSuggestionState

object ( SizeSuggestionState )

A mask that indicates which of the fields in size have been changed in this suggestion.

marginLeftSuggested

boolean

Indicates if there was a suggested change to marginLeft .

marginRightSuggested

boolean

Indicates if there was a suggested change to marginRight .

marginTopSuggested

boolean

Indicates if there was a suggested change to marginTop .

marginBottomSuggested

boolean

Indicates if there was a suggested change to marginBottom .

linkedContentReferenceSuggestionState

object ( LinkedContentReferenceSuggestionState )

A mask that indicates which of the fields in linkedContentReference have been changed in this suggestion.

EmbeddedDrawingPropertiesSuggestionState

این نوع هیچ فیلدی ندارد.

A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.

ImagePropertiesSuggestionState

A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation
{
  "contentUriSuggested": boolean,
  "sourceUriSuggested": boolean,
  "brightnessSuggested": boolean,
  "contrastSuggested": boolean,
  "transparencySuggested": boolean,
  "cropPropertiesSuggestionState": {
    object (CropPropertiesSuggestionState)
  },
  "angleSuggested": boolean
}
زمینه های
contentUriSuggested

boolean

Indicates if there was a suggested change to contentUri .

sourceUriSuggested

boolean

Indicates if there was a suggested change to [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri].

brightnessSuggested

boolean

Indicates if there was a suggested change to [brightness] [google.apps.docs.v1.EmbeddedObject.brightness].

contrastSuggested

boolean

Indicates if there was a suggested change to [contrast] [google.apps.docs.v1.EmbeddedObject.contrast].

transparencySuggested

boolean

Indicates if there was a suggested change to [transparency] [google.apps.docs.v1.EmbeddedObject.transparency].

cropPropertiesSuggestionState

object ( CropPropertiesSuggestionState )

A mask that indicates which of the fields in cropProperties have been changed in this suggestion.

angleSuggested

boolean

Indicates if there was a suggested change to [angle] [google.apps.docs.v1.EmbeddedObject.angle].

CropPropertiesSuggestionState

A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation
{
  "offsetLeftSuggested": boolean,
  "offsetRightSuggested": boolean,
  "offsetTopSuggested": boolean,
  "offsetBottomSuggested": boolean,
  "angleSuggested": boolean
}
زمینه های
offsetLeftSuggested

boolean

Indicates if there was a suggested change to offsetLeft .

offsetRightSuggested

boolean

Indicates if there was a suggested change to offsetRight .

offsetTopSuggested

boolean

Indicates if there was a suggested change to offsetTop .

offsetBottomSuggested

boolean

Indicates if there was a suggested change to offsetBottom .

angleSuggested

boolean

Indicates if there was a suggested change to angle .

EmbeddedObjectBorderSuggestionState

A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation
{
  "colorSuggested": boolean,
  "widthSuggested": boolean,
  "dashStyleSuggested": boolean,
  "propertyStateSuggested": boolean
}
زمینه های
colorSuggested

boolean

Indicates if there was a suggested change to [color] [google.apps.docs.v1.EmbeddedBorderObject.color].

widthSuggested

boolean

Indicates if there was a suggested change to [width] [google.apps.docs.v1.EmbeddedBorderObject.width].

dashStyleSuggested

boolean

Indicates if there was a suggested change to [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style].

propertyStateSuggested

boolean

Indicates if there was a suggested change to [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state].

LinkedContentReferenceSuggestionState

A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation
{
  "sheetsChartReferenceSuggestionState": {
    object (SheetsChartReferenceSuggestionState)
  }
}
زمینه های
sheetsChartReferenceSuggestionState

object ( SheetsChartReferenceSuggestionState )

A mask that indicates which of the fields in sheetsChartReference have been changed in this suggestion.

SheetsChartReferenceSuggestionState

A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation
{
  "spreadsheetIdSuggested": boolean,
  "chartIdSuggested": boolean
}
زمینه های
spreadsheetIdSuggested

boolean

Indicates if there was a suggested change to spreadsheetId .

chartIdSuggested

boolean

Indicates if there was a suggested change to chartId .

PositionedObject

An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image.

JSON representation
{
  "objectId": string,
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "suggestedPositionedObjectPropertiesChanges": {
    string: {
      object (SuggestedPositionedObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
زمینه های
objectId

string

The ID of this positioned object.

positionedObjectProperties

object ( PositionedObjectProperties )

The properties of this positioned object.

suggestedPositionedObjectPropertiesChanges

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

The suggested changes to the positioned object properties, keyed by suggestion ID.

suggestedInsertionId

string

The suggested insertion ID. If empty, then this is not a suggested insertion.

suggestedDeletionIds[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

PositionedObjectProperties

Properties of a PositionedObject .

JSON representation
{
  "positioning": {
    object (PositionedObjectPositioning)
  },
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
زمینه های
positioning

object ( PositionedObjectPositioning )

The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object.

embeddedObject

object ( EmbeddedObject )

The embedded object of this positioned object.

PositionedObjectPositioning

The positioning of a PositionedObject . The positioned object is positioned relative to the beginning of the Paragraph it's tethered to.

JSON representation
{
  "layout": enum (PositionedObjectLayout),
  "leftOffset": {
    object (Dimension)
  },
  "topOffset": {
    object (Dimension)
  }
}
زمینه های
layout

enum ( PositionedObjectLayout )

The layout of this positioned object.

leftOffset

object ( Dimension )

The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.

topOffset

object ( Dimension )

The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.

PositionedObjectLayout

The possible layouts of a [PositionedObject][google.aps.docs.v1.PositionedObject].

Enums
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED The layout is unspecified.
WRAP_TEXT The text wraps around the positioned object.
BREAK_LEFT Breaks text such that the positioned object is on the left and text is on the right.
BREAK_RIGHT Breaks text such that the positioned object is on the right and text is on the left.
BREAK_LEFT_RIGHT Breaks text such that there's no text on the left or right of the positioned object.
IN_FRONT_OF_TEXT The positioned object is in front of the text.
BEHIND_TEXT The positioned object is behind the text.

SuggestedPositionedObjectProperties

A suggested change to PositionedObjectProperties .

JSON representation
{
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "positionedObjectPropertiesSuggestionState": {
    object (PositionedObjectPropertiesSuggestionState)
  }
}
زمینه های
positionedObjectProperties

object ( PositionedObjectProperties )

A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positionedObjectPropertiesSuggestionState to see which fields have changed and their new values.

positionedObjectPropertiesSuggestionState

object ( PositionedObjectPropertiesSuggestionState )

A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion.

PositionedObjectPropertiesSuggestionState

A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation
{
  "positioningSuggestionState": {
    object (PositionedObjectPositioningSuggestionState)
  },
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
زمینه های
positioningSuggestionState

object ( PositionedObjectPositioningSuggestionState )

A mask that indicates which of the fields in positioning have been changed in this suggestion.

embeddedObjectSuggestionState

object ( EmbeddedObjectSuggestionState )

A mask that indicates which of the fields in embeddedObject have been changed in this suggestion.

PositionedObjectPositioningSuggestionState

A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation
{
  "layoutSuggested": boolean,
  "leftOffsetSuggested": boolean,
  "topOffsetSuggested": boolean
}
زمینه های
layoutSuggested

boolean

Indicates if there was a suggested change to layout .

leftOffsetSuggested

boolean

Indicates if there was a suggested change to leftOffset .

topOffsetSuggested

boolean

Indicates if there was a suggested change to topOffset .

مواد و روش ها

batchUpdate

 Applies one or more updates to the document.

create

 Creates a blank document using the title given in the request.

get

 Gets the latest version of the specified document.