REST Resource: documents

منبع: سند

یک سند گوگل داکز.

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

string

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

title

string

عنوان سند.

tabs[]

object ( Tab )

تب‌هایی که بخشی از یک سند هستند.

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

revisionId

string

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

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

suggestionsViewMode

enum ( SuggestionsViewMode )

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

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

body

object ( Body )

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

فیلد قدیمی: در عوض، از Document.tabs.documentTab.body استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی درباره اولین تب در سند است.

headers

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

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

فیلد قدیمی: در عوض، از Document.tabs.documentTab.headers استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی درباره اولین تب در سند است.

footers

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

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

فیلد قدیمی: در عوض، از Document.tabs.documentTab.footers استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی درباره اولین تب در سند است.

footnotes

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

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

فیلد قدیمی: در عوض، از Document.tabs.documentTab.footnotes استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی در مورد اولین تب در سند است.

documentStyle

object ( DocumentStyle )

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

فیلد قدیمی: در عوض، از Document.tabs.documentTab.documentStyle استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی در مورد اولین تب در سند است.

suggestedDocumentStyleChanges

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

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

فیلد قدیمی: در عوض، از Document.tabs.documentTab.suggestedDocumentStyleChanges استفاده کنید، که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی در مورد اولین تب در سند است.

namedStyles

object ( NamedStyles )

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

فیلد قدیمی: در عوض، از Document.tabs.documentTab.namedStyles استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی درباره اولین تب در سند است.

suggestedNamedStylesChanges

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

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

فیلد قدیمی: در عوض، از Document.tabs.documentTab.suggestedNamedStylesChanges استفاده کنید، که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی در مورد اولین تب در سند است.

lists

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

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

فیلد قدیمی: در عوض، از Document.tabs.documentTab.lists استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی درباره اولین تب در سند است.

namedRanges

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

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

فیلد قدیمی: در عوض، از Document.tabs.documentTab.namedRanges استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی درباره اولین تب در سند است.

inlineObjects

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

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

فیلد قدیمی: در عوض، از Document.tabs.documentTab.inlineObjects استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی در مورد اولین تب در سند است.

positionedObjects

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

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

فیلد قدیمی: در عوض، از Document.tabs.documentTab.positionedObjects استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی در مورد اولین تب در سند است.

تب

یک برگه در یک سند.

نمایش JSON 
{
  "tabProperties": {
    object (TabProperties)
  },
  "childTabs": [
    {
      object (Tab)
    }
  ],

  // Union field content can be only one of the following:
  "documentTab": {
    object (DocumentTab)
  }
  // End of list of possible types for union field content.
}
فیلدها
tabProperties

object ( TabProperties )

ویژگی‌های برگه، مانند شناسه و عنوان.

childTabs[]

object ( Tab )

تب‌های فرزند درون این تب قرار گرفته‌اند.

content فیلد Union. محتوای تب. content می‌تواند فقط یکی از موارد زیر باشد:
documentTab

object ( DocumentTab )

یک برگه با محتوای سند، مانند متن و تصاویر.

ویژگی‌های برگه

ویژگی‌های یک برگه.

نمایش JSON 
{
  "tabId": string,
  "title": string,
  "parentTabId": string,
  "index": integer,
  "nestingLevel": integer
}
فیلدها
tabId

string

فقط خروجی. شناسه برگه. این فیلد قابل تغییر نیست.

title

string

نام تب که توسط کاربر قابل مشاهده است.

parentTabId

string

اختیاری. شناسه‌ی برگه‌ی والد. وقتی برگه‌ی فعلی یک برگه‌ی سطح ریشه است، یعنی هیچ والد ندارد، خالی است.

index

integer

اندیس مبتنی بر صفرِ تبِ درون والد.

nestingLevel

integer

فقط خروجی. عمق تب درون سند. تب‌های سطح ریشه از ۰ شروع می‌شوند.

برگه سند

یک برگه با محتوای سند.

نمایش JSON 
{
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
فیلدها
body

object ( Body )

بدنه اصلی تب سند.

headers

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

سربرگ‌های موجود در برگه سند، که با شناسه سربرگ تنظیم شده‌اند.

footers

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

پاورقی‌های موجود در برگه سند، که با شناسه پاورقی مشخص شده‌اند.

footnotes

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

پاورقی‌ها در برگه سند، که با شناسه پاورقی مشخص شده‌اند.

documentStyle

object ( DocumentStyle )

سبک تب سند.

suggestedDocumentStyleChanges

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

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

namedStyles

object ( NamedStyles )

سبک‌های نامگذاری‌شده‌ی تب سند.

suggestedNamedStylesChanges

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

تغییرات پیشنهادی برای سبک‌های نامگذاری‌شده‌ی برگه‌ی سند، که با شناسه‌ی پیشنهاد مشخص شده‌اند.

lists

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

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

namedRanges

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

محدوده‌های نامگذاری شده در برگه سند، که بر اساس نام تنظیم شده‌اند.

inlineObjects

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

اشیاء درون‌خطی در برگه سند، که با شناسه شیء مشخص شده‌اند.

positionedObjects

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

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

بدن

بدنه سند.

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

نمایش JSON 
{
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
فیلدها
content[]

object ( StructuralElement )

محتویات بدن.

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

عنصر ساختاری

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

نمایش 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 فیلد Union. محتوای عنصر ساختاری. content می‌تواند فقط یکی از موارد زیر باشد:
paragraph

object ( Paragraph )

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

sectionBreak

object ( SectionBreak )

نوعی المان سازه‌ای از نوع شکست مقطعی.

table

object ( Table )

نوعی عنصر سازه‌ای از نوع میز.

tableOfContents

object ( TableOfContents )

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

پاراگراف

یک StructuralElement که نمایانگر یک پاراگراف است. یک پاراگراف، محدوده‌ای از محتوا است که با یک کاراکتر خط جدید (newline) خاتمه می‌یابد.

نمایش 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 فیلد Union. محتوای عنصر پاراگراف. 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 )

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

متن‌ران

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

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

string

متن این اجرا.

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

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

textStyle

object ( TextStyle )

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

suggestedTextStyleChanges

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

سبک متن پیشنهادی با استفاده از شناسه پیشنهاد، در این اجرا تغییر می‌کند.

سبک متن

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

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

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

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

نمایش 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 نیز باید با مقداری غیر تهی تنظیم شود. در غیر این صورت، خطای درخواست نامناسب ۴۰۰ بازگردانده می‌شود.

baselineOffset

enum ( BaselineOffset )

انحراف عمودی متن از موقعیت عادی آن.

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

رنگ اختیاری

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

نمایش JSON 
{
  "color": {
    object (Color)
  }
}
فیلدها
color

object ( Color )

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

رنگ

یک رنگ ثابت.

نمایش JSON 
{
  "rgbColor": {
    object (RgbColor)
  }
}
فیلدها
rgbColor

object ( RgbColor )

مقدار رنگ RGB.

رنگ RGB

یک رنگ RGB.

نمایش JSON 
{
  "red": number,
  "green": number,
  "blue": number
}
فیلدها
red

number

جزء قرمز رنگ، از ۰.۰ تا ۱.۰.

green

number

جزء سبز رنگ، از ۰.۰ تا ۱.۰.

blue

number

جزء آبی رنگ، از ۰.۰ تا ۱.۰.

ابعاد

بزرگی در یک جهت واحد در واحدهای مشخص شده.

نمایش JSON 
{
  "magnitude": number,
  "unit": enum (Unit)
}
فیلدها
magnitude

number

بزرگی.

unit

enum ( Unit )

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

واحد

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

انوم‌ها
UNIT_UNSPECIFIED واحدها مشخص نیستند.
PT یک نقطه، ۱/۷۲ اینچ.

خانواده فونت وزن‌دار

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

نمایش JSON 
{
  "fontFamily": string,
  "weight": integer
}
فیلدها
fontFamily

string

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

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

weight

integer

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

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

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

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

افست پایه

روش‌هایی که متن می‌تواند به صورت عمودی از موقعیت عادی خود فاصله بگیرد.

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

سبک متن پیشنهادی

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

نمایش JSON 
{
  "textStyle": {
    object (TextStyle)
  },
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
فیلدها
textStyle

object ( TextStyle )

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

textStyleSuggestionState

object ( TextStyleSuggestionState )

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

پیشنهاد سبک متن

یک ماسک که نشان می‌دهد کدام یک از فیلدهای 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 ))

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

نوع

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

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

صفحه‌شکن

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

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

string

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

suggestedDeletionIds[]

string

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

textStyle

object ( TextStyle )

سبک متن این PageBreak.

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

suggestedTextStyleChanges

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

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

ستون‌شکن

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

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

string

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

suggestedDeletionIds[]

string

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

textStyle

object ( TextStyle )

سبک متن این ColumnBreak.

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

suggestedTextStyleChanges

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

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

پاورقی

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

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

string

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

footnoteNumber

string

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

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

textStyle

object ( TextStyle )

سبک متن این مرجع پاورقی.

suggestedTextStyleChanges

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

سبک متن پیشنهادی به این 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

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

عنصر شیء درون‌خطی

یک 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 با نام style از سبک پاراگراف پیش‌فرض در ویرایشگر Docs ارث‌بری می‌کند.
  • ParagraphStyle روی یک عنصر Paragraph که در یک جدول قرار دارد، ممکن است سبک پاراگراف خود را از سبک جدول به ارث ببرد.

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

نمایش 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

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

direction

enum ( ContentDirection )

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

spacingMode

enum ( SpacingMode )

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

spaceAbove

object ( Dimension )

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

spaceBelow

object ( Dimension )

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

borderBetween

object ( ParagraphBorder )

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

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

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

borderTop

object ( ParagraphBorder )

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

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

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

borderBottom

object ( ParagraphBorder )

The border at the bottom of this paragraph. If unset, the value is inherited from the parent.

The bottom border is rendered when the paragraph below has different border and indent properties.

Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.

borderLeft

object ( ParagraphBorder )

The border to the left of this paragraph. If unset, the value is inherited from the parent.

Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.

borderRight

object ( ParagraphBorder )

The border to the right of this paragraph. If unset, the value is inherited from the parent.

Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.

indentFirstLine

object ( Dimension )

The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.

indentStart

object ( Dimension )

The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.

indentEnd

object ( Dimension )

The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.

tabStops[]

object ( TabStop )

A list of the tab stops for this paragraph. The list of tab stops is not inherited.

This property is read-only.

keepLinesTogether

boolean

Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.

keepWithNext

boolean

Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.

avoidWidowAndOrphan

boolean

Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.

shading

object ( Shading )

The shading of the paragraph. If unset, the value is inherited from the parent.

pageBreakBefore

boolean

Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent.

Attempting to update pageBreakBefore for paragraphs in unsupported regions, including Table , Header , Footer and Footnote , can result in an invalid document state that returns a 400 bad request error.

NamedStyleType

The types of named styles.

Enums
NAMED_STYLE_TYPE_UNSPECIFIED The type of named style is unspecified.
NORMAL_TEXT Normal text.
TITLE Title.
SUBTITLE Subtitle.
HEADING_1 Heading 1.
HEADING_2 Heading 2.
HEADING_3 Heading 3.
HEADING_4 Heading 4.
HEADING_5 Heading 5.
HEADING_6 Heading 6.

Alignment

The types of text alignment for a paragraph.

Enums
ALIGNMENT_UNSPECIFIED The paragraph alignment is inherited from the parent.
START The paragraph is aligned to the start of the line. Left-aligned for LTR text, right-aligned otherwise.
CENTER The paragraph is centered.
END The paragraph is aligned to the end of the line. Right-aligned for LTR text, left-aligned otherwise.
JUSTIFIED The paragraph is justified.

ContentDirection

The directions content can flow in.

Enums
CONTENT_DIRECTION_UNSPECIFIED The content direction is unspecified.
LEFT_TO_RIGHT The content goes from left to right.
RIGHT_TO_LEFT The content goes from right to left.

SpacingMode

The different modes for paragraph spacing.

Enums
SPACING_MODE_UNSPECIFIED The spacing mode is inherited from the parent.
NEVER_COLLAPSE Paragraph spacing is always rendered.
COLLAPSE_LISTS Paragraph spacing is skipped between list elements.

ParagraphBorder

A border around a paragraph.

JSON representation 
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "padding": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
فیلدها
color

object ( OptionalColor )

The color of the border.

width

object ( Dimension )

The width of the border.

padding

object ( Dimension )

The padding of the border.

dashStyle

enum ( DashStyle )

The dash style of the border.

DashStyle

The kinds of dashes with which linear geometry can be rendered. These values are based on the "ST_PresetLineDashVal" simple type described in section 20.1.10.49 of "Office Open XML File Formats - Fundamentals and Markup Language Reference", part 1 of ECMA-376 5th edition .

Enums
DASH_STYLE_UNSPECIFIED Unspecified dash style.
SOLID Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'. This is the default dash style.
DOT Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.
DASH Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.

TabStop

A tab stop within a paragraph.

JSON representation 
{
  "offset": {
    object (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}
فیلدها
offset

object ( Dimension )

The offset between this tab stop and the start margin.

alignment

enum ( TabStopAlignment )

The alignment of this tab stop. If unset, the value defaults to START .

TabStopAlignment

The alignment of the tab stop.

Enums
TAB_STOP_ALIGNMENT_UNSPECIFIED The tab stop alignment is unspecified.
START The tab stop is aligned to the start of the line. This is the default.
CENTER The tab stop is aligned to the center of the line.
END The tab stop is aligned to the end of the line.

Shading

The shading of a paragraph.

JSON representation 
{
  "backgroundColor": {
    object (OptionalColor)
  }
}
فیلدها
backgroundColor

object ( OptionalColor )

The background color of this paragraph shading.

SuggestedParagraphStyle

A suggested change to a ParagraphStyle .

JSON representation 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
فیلدها
paragraphStyle

object ( ParagraphStyle )

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

paragraphStyleSuggestionState

object ( ParagraphStyleSuggestionState )

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

ParagraphStyleSuggestionState

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

JSON representation 
{
  "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

Indicates if there was a suggested change to headingId .

namedStyleTypeSuggested

boolean

Indicates if there was a suggested change to namedStyleType .

alignmentSuggested

boolean

Indicates if there was a suggested change to alignment .

lineSpacingSuggested

boolean

Indicates if there was a suggested change to lineSpacing .

directionSuggested

boolean

Indicates if there was a suggested change to direction .

spacingModeSuggested

boolean

Indicates if there was a suggested change to spacingMode .

spaceAboveSuggested

boolean

Indicates if there was a suggested change to spaceAbove .

spaceBelowSuggested

boolean

Indicates if there was a suggested change to spaceBelow .

borderBetweenSuggested

boolean

Indicates if there was a suggested change to borderBetween .

borderTopSuggested

boolean

Indicates if there was a suggested change to borderTop .

borderBottomSuggested

boolean

Indicates if there was a suggested change to borderBottom .

borderLeftSuggested

boolean

Indicates if there was a suggested change to borderLeft .

borderRightSuggested

boolean

Indicates if there was a suggested change to borderRight .

indentFirstLineSuggested

boolean

Indicates if there was a suggested change to indentFirstLine .

indentStartSuggested

boolean

Indicates if there was a suggested change to indentStart .

indentEndSuggested

boolean

Indicates if there was a suggested change to indentEnd .

keepLinesTogetherSuggested

boolean

Indicates if there was a suggested change to keepLinesTogether .

keepWithNextSuggested

boolean

Indicates if there was a suggested change to keepWithNext .

avoidWidowAndOrphanSuggested

boolean

Indicates if there was a suggested change to avoidWidowAndOrphan .

shadingSuggestionState

object ( ShadingSuggestionState )

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

pageBreakBeforeSuggested

boolean

Indicates if there was a suggested change to pageBreakBefore .

ShadingSuggestionState

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

JSON representation 
{
  "backgroundColorSuggested": boolean
}
فیلدها
backgroundColorSuggested

boolean

Indicates if there was a suggested change to the Shading .

Bullet

Describes the bullet of a paragraph.

JSON representation 
{
  "listId": string,
  "nestingLevel": integer,
  "textStyle": {
    object (TextStyle)
  }
}
فیلدها
listId

string

The ID of the list this paragraph belongs to.

nestingLevel

integer

The nesting level of this paragraph in the list.

textStyle

object ( TextStyle )

The paragraph-specific text style applied to this bullet.

SuggestedBullet

A suggested change to a Bullet .

JSON representation 
{
  "bullet": {
    object (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}
فیلدها
bullet

object ( Bullet )

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

bulletSuggestionState

object ( BulletSuggestionState )

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

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 )

Output only. 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

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

Output only. 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.60 of "Office Open XML File Formats - Fundamentals and Markup Language Reference", part 1 of ECMA-376 5th 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

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

اندازه

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

Optional. 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 is 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 the list item's order within the list.

glyphSymbol

string

A custom glyph symbol used by bullets when paragraphs at this level of nesting is 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 is 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,
  "tabId": string
}
فیلدها
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.

tabId

string

The tab that contains this range. When omitted, the request applies to the first tab.

In a document containing a single tab:

  • If provided, must match the singular tab's ID.

  • If omitted, the request applies to the singular tab.

In a document containing multiple tabs:

  • If provided, the request applies to the specified tab.

  • If omitted, the request applies to the first tab 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

This type has no fields.

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 angles 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

This type has no fields.

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 .

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.

Methods

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.