REST Resource: documents

منبع: سند

یک سند Google Docs.

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

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

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

suggestionsViewMode

enum ( SuggestionsViewMode )

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

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

body

object ( Body )

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

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

headers

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

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

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

footers

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

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

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

footnotes

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

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

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

documentStyle

object ( DocumentStyle )

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

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

suggestedDocumentStyleChanges

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

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

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

namedStyles

object ( NamedStyles )

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

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

suggestedNamedStylesChanges

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

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

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

lists

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

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

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

namedRanges

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

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

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

inlineObjects

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

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

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

positionedObjects

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

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

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

Tab

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

نمایندگی 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 زمینه اتحادیه محتوای برگه. content فقط می تواند یکی از موارد زیر باشد:
documentTab

object ( DocumentTab )

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

TabProperties

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

نمایندگی JSON
{
  "tabId": string,
  "title": string,
  "parentTabId": string,
  "index": integer,
  "nestingLevel": integer
}
زمینه های
tabId

string

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

title

string

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

parentTabId

string

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

index

integer

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

nestingLevel

integer

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

DocumentTab

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

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

object ( Paragraph )

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

sectionBreak

object ( SectionBreak )

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

table

object ( Table )

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

tableOfContents

object ( TableOfContents )

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

پاراگراف

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

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

object ( ParagraphElement )

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

paragraphStyle

object ( ParagraphStyle )

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

suggestedParagraphStyleChanges

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

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

bullet

object ( Bullet )

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

suggestedBulletChanges

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

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

positionedObjectIds[]

string

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

suggestedPositionedObjectIds

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

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

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

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

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

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

integer

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

endIndex

integer

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

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

object ( TextRun )

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

autoText

object ( AutoText )

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

pageBreak

object ( PageBreak )

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

columnBreak

object ( ColumnBreak )

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

footnoteReference

object ( FootnoteReference )

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

horizontalRule

object ( HorizontalRule )

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

equation

object ( Equation )

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

inlineObjectElement

object ( InlineObjectElement )

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

person

object ( Person )

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

TextRun

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

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

string

متن این اجرا.

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

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

textStyle

object ( TextStyle )

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

suggestedTextStyleChanges

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

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

TextStyle

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

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

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

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

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

boolean

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

italic

boolean

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

underline

boolean

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

strikethrough

boolean

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

smallCaps

boolean

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

backgroundColor

object ( OptionalColor )

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

foregroundColor

object ( OptionalColor )

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

fontSize

object ( Dimension )

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

weightedFontFamily

object ( WeightedFontFamily )

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

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

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

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

baselineOffset

enum ( BaselineOffset )

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

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

رنگ اختیاری

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

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

object ( Color )

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

رنگ

یک رنگ ثابت

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

object ( RgbColor )

مقدار رنگ RGB

RgbColor

یک رنگ RGB

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

number

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

green

number

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

blue

number

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

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

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

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

number

بزرگی.

unit

enum ( Unit )

واحدهای قدر

واحد

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

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

WeightedFontFamily

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

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

string

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

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

weight

integer

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

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

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

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

آفست پایه

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

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

SuggestedTextStyle

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

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

object ( TextStyle )

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

textStyleSuggestionState

object ( TextStyleSuggestionState )

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

TextStyleSuggestionState

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

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

boolean

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

italicSuggested

boolean

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

underlineSuggested

boolean

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

strikethroughSuggested

boolean

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

smallCapsSuggested

boolean

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

backgroundColorSuggested

boolean

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

foregroundColorSuggested

boolean

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

fontSizeSuggested

boolean

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

weightedFontFamilySuggested

boolean

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

baselineOffsetSuggested

boolean

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

متن خودکار

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

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

enum ( Type )

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

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

textStyle

object ( TextStyle )

سبک متن این AutoText.

suggestedTextStyleChanges

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

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

تایپ کنید

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

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

Page Break

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

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

string

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

suggestedDeletionIds[]

string

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

textStyle

object ( TextStyle )

سبک متن این PageBreak.

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

suggestedTextStyleChanges

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

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

ColumnBreak

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

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

string

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

suggestedDeletionIds[]

string

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

textStyle

object ( TextStyle )

سبک متن این ColumnBreak.

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

suggestedTextStyleChanges

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

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

پانوشت مرجع

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

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

string

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

footnoteNumber

string

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

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

textStyle

object ( TextStyle )

سبک متن این FootnoteReference.

suggestedTextStyleChanges

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

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

قانون افقی

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

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

string

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

suggestedDeletionIds[]

string

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

textStyle

object ( TextStyle )

سبک متن این HorizontalRule.

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

suggestedTextStyleChanges

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

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

معادله

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

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

string

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

suggestedDeletionIds[]

string

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

InlineObjectElement

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

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

string

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

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

textStyle

object ( TextStyle )

سبک متن این InlineObjectElement.

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

suggestedTextStyleChanges

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

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

شخص

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

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

string

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

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

textStyle

object ( TextStyle )

سبک متن این Person .

suggestedTextStyleChanges

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

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

personProperties

object ( PersonProperties )

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

ویژگی های شخص

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

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

string

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

email

string

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

RichLinkProperties

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

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

string

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

uri

string

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

mimeType

string

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

سبک پاراگراف

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

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

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

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

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

string

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

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

namedStyleType

enum ( NamedStyleType )

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

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

alignment

enum ( Alignment )

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

lineSpacing

number

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

direction

enum ( ContentDirection )

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

spacingMode

enum ( SpacingMode )

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

spaceAbove

object ( Dimension )

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

spaceBelow

object ( Dimension )

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

borderBetween

object ( ParagraphBorder )

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

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

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

borderTop

object ( ParagraphBorder )

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

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

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

borderBottom

object ( ParagraphBorder )

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

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

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

borderLeft

object ( ParagraphBorder )

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

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

borderRight

object ( ParagraphBorder )

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

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

indentFirstLine

object ( Dimension )

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

indentStart

object ( Dimension )

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

indentEnd

object ( Dimension )

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

tabStops[]

object ( TabStop )

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

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

keepLinesTogether

boolean

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

keepWithNext

boolean

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

avoidWidowAndOrphan

boolean

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

shading

object ( Shading )

سایه بند. در صورت عدم استفاده ، مقدار از والدین به ارث می رسد.

pageBreakBefore

boolean

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

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

نامگذاری شده

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

نماد
NAMED_STYLE_TYPE_UNSPECIFIED نوع سبک نامگذاری شده نامشخص است.
NORMAL_TEXT متن عادی
TITLE عنوان.
SUBTITLE عنوان فرعی.
HEADING_1 سرفصل 1.
HEADING_2 عنوان 2.
HEADING_3 عنوان 3.
HEADING_4 عنوان 4.
HEADING_5 عنوان 5.
HEADING_6 عنوان 6.

هم ترازی

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

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

جهت گیری محتوا

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

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

حالت فضا

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

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

بند پاراگراف

یک مرز در اطراف یک پاراگراف.

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

object ( OptionalColor )

رنگ مرز.

width

object ( Dimension )

عرض مرز.

padding

object ( Dimension )

بالشتک مرز.

dashStyle

enum ( DashStyle )

سبک خط مرز.

سبک کوچک

انواع خطوطی که هندسه خطی با آنها قابل ارائه است. این مقادیر مبتنی بر نوع ساده "ST_PRESETLINEDASHVAL" است که در بخش 20.1.10.48 "فرمت های پرونده XML Office Open - اصول و مرجع زبان نشانه گذاری" ، قسمت 1 ECMA -376 چاپ 4 .

نماد
DASH_STYLE_UNSPECIFIED سبک داش نامشخص.
SOLID خط توپر. مطابق با ECMA-376 ST_PRESETLINEDASHVAL "جامد" است. این سبک پیش فرض داش است.
DOT خط نقطه چین. مطابق با ECMA-376 ST_PRESETLINEDASHVAL "نقطه" است.
DASH خط بریده بریده. مطابق با ECMA-376 ST_PRESETLINEDASHVAL "DASH" است.

TabStop

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

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

object ( Dimension )

جبران بین این برگه و حاشیه شروع.

alignment

enum ( TabStopAlignment )

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

تبادل نظر

تراز کردن برگه.

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

سایه زدن

سایه یک پاراگراف.

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

object ( OptionalColor )

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

پیشنهادی پاراگراف استایل

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

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

object ( ParagraphStyle )

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

paragraphStyleSuggestionState

object ( ParagraphStyleSuggestionState )

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

پاراگراف

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

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

boolean

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

namedStyleTypeSuggested

boolean

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

alignmentSuggested

boolean

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

lineSpacingSuggested

boolean

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

directionSuggested

boolean

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

spacingModeSuggested

boolean

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

spaceAboveSuggested

boolean

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

spaceBelowSuggested

boolean

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

borderBetweenSuggested

boolean

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

borderTopSuggested

boolean

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

borderBottomSuggested

boolean

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

borderLeftSuggested

boolean

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

borderRightSuggested

boolean

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

indentFirstLineSuggested

boolean

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

indentStartSuggested

boolean

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

indentEndSuggested

boolean

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

keepLinesTogetherSuggested

boolean

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

keepWithNextSuggested

boolean

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

avoidWidowAndOrphanSuggested

boolean

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

shadingSuggestionState

object ( ShadingSuggestionState )

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

pageBreakBeforeSuggested

boolean

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

ShadingsuggestionState

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

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

boolean

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

گلوله

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

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

string

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

nestingLevel

integer

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

textStyle

object ( TextStyle )

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

پیشنهاد شده

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

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

object ( Bullet )

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

bulletSuggestionState

object ( BulletSuggestionState )

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

BulletSuggestionState

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

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

boolean

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

nestingLevelSuggested

boolean

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

textStyleSuggestionState

object ( TextStyleSuggestionState )

ماسک ای که نشان می دهد کدام یک از زمینه های text style در این پیشنهاد تغییر کرده است.

عذاب

مجموعه ای از شناسه های شی.

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

string

IDS Object.

بخشیدن

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

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

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

string

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

suggestedDeletionIds[]

string

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

sectionStyle

object ( SectionStyle )

سبک بخش پس از شکستن این بخش.

بخش

یک ظاهر طراحی شده برای یک بخش اعمال می شود.

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

object ( SectionColumnProperties )

خصوصیات ستون بخش.

در صورت خالی بودن ، این بخش شامل یک ستون با خصوصیات پیش فرض در ویرایشگر Docs است. یک بخش را می توان به روز کرد تا بیش از 3 ستون نداشته باشد.

هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 خواهد شد.

columnSeparatorStyle

enum ( ColumnSeparatorStyle )

سبک جداکننده های ستون.

این سبک حتی در صورت وجود یک ستون در بخش قابل تنظیم است.

هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود.

contentDirection

enum ( ContentDirection )

جهت محتوای این بخش. در صورت عدم استفاده ، مقدار پیش فرض به LEFT_TO_RIGHT است.

هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود.

marginTop

object ( Dimension )

حاشیه صفحه بالای بخش. در صورت عدم استفاده ، مقدار پیش فرض از marginTop از DocumentStyle است.

هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود.

marginBottom

object ( Dimension )

حاشیه صفحه پایین بخش. در صورت عدم استفاده ، مقدار پیش فرض به marginBottom از DocumentStyle است.

هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود.

marginRight

object ( Dimension )

حاشیه صفحه سمت راست بخش. در صورت عدم استفاده ، مقدار پیش فرض از marginRight از DocumentStyle است. به روزرسانی حاشیه سمت راست باعث تغییر اندازه ستون ها در این بخش می شود. از آنجا که حاشیه بر عرض ستون تأثیر می گذارد ، قبل از خصوصیات ستون اعمال می شود.

هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود.

marginLeft

object ( Dimension )

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

هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود.

marginHeader

object ( Dimension )

حاشیه هدر بخش. در صورت عدم استفاده ، مقدار پیش فرض به marginHeader از DocumentStyle است. در صورت بروزرسانی ، useCustomHeaderFooterMargins در DocumentStyle True تنظیم شده است. ارزش UsecustomheaderfooterMargins در DocumentStyle نشان می دهد که آیا حاشیه هدر برای این بخش رعایت شده است یا خیر.

هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود.

sectionType

enum ( SectionType )

فقط خروجی نوع بخش

defaultHeaderId

string

شناسه هدر پیش فرض. در صورت عدم استفاده ، مقدار از بخش SectionBreak's Style به ارث می رسد. اگر مقدار در اولین بخش از بین برود ، از defaultHeaderId DocumentStyle به ارث می برد.

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

firstPageHeaderId

string

شناسه هدر فقط برای صفحه اول بخش استفاده می شود. اگر useFirstPageHeaderFooter صحیح باشد ، این مقدار برای هدر در صفحه اول بخش استفاده می شود. اگر نادرست باشد ، هدر در صفحه اول بخش از defaultHeaderId استفاده می کند. در صورت عدم استفاده ، مقدار از بخش SectionBreak's Style به ارث می رسد. اگر مقدار در اولین بخش از بین برود ، از firstPageHeaderId DocumentStyle به ارث می برد.

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

evenPageHeaderId

string

شناسه هدر فقط برای صفحات حتی استفاده می شد. اگر مقدار DocumentStyle's useEvenPageHeaderFooter صحیح باشد ، این مقدار برای هدر در صفحات حتی در بخش استفاده می شود. اگر نادرست باشد ، هدرها در صفحات حتی از defaultHeaderId استفاده می کنند. در صورت عدم استفاده ، مقدار از بخش SectionBreak's Style به ارث می رسد. اگر مقدار در اولین بخش از بین برود ، از evenPageHeaderId DocumentStyle به ارث می رسد.

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

pageNumberStart

integer

شماره صفحه ای که از آن می توانید تعداد صفحات این بخش را شروع کنید. در صورت عدم استفاده ، شماره گذاری صفحه از بخش قبلی ادامه می یابد. اگر مقدار در اولین SectionBreak از بین رفته است ، به pageNumberStart DocumentStyle مراجعه کنید.

هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود.

flipPageOrientation

boolean

اختیاری. نشان می دهد که آیا می توانید ابعاد pageSize DocumentStyle را برای این بخش تلنگر بزنید ، که امکان تغییر جهت گیری صفحه بین پرتره و چشم انداز را فراهم می کند. در صورت عدم استفاده ، این مقدار از flipPageOrientation DocumentStyle به ارث می برد.

هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود.

بخش columnproperties

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

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

object ( Dimension )

فقط خروجی عرض ستون.

paddingEnd

object ( Dimension )

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

ستونهای ستونی

سبک جداکننده های ستون بین ستون ها.

نماد
COLUMN_SEPARATOR_STYLE_UNSPECIFIED یک سبک جداکننده ستون نامشخص.
NONE بدون خط جداکننده ستون بین ستون ها.
BETWEEN_EACH_COLUMN یک خط جداکننده ستون بین هر ستون را ارائه می دهد.

نوع

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

نماد
SECTION_TYPE_UNSPECIFIED نوع بخش نا مشخص است.
CONTINUOUS این بخش بلافاصله پس از آخرین بند بخش قبلی شروع می شود.
NEXT_PAGE بخش از صفحه بعد شروع می شود.

جدول

یک StructuralElement که یک جدول را نشان می دهد.

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

integer

تعداد ردیف های جدول.

columns

integer

تعداد ستون های جدول.

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

tableRows[]

object ( TableRow )

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

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

tableStyle

object ( TableStyle )

سبک جدول.

تابه

محتویات و سبک یک ردیف در یک Table .

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

integer

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

endIndex

integer

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

tableCells[]

object ( TableCell )

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

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

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

tableRowStyle

object ( TableRowStyle )

سبک ردیف جدول.

suggestedTableRowStyleChanges

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

سبک پیشنهادی در این ردیف تغییر می کند ، که توسط شناسه پیشنهاد شده است.

سفره سفالی

محتویات و سبک یک سلول در یک Table .

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

integer

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

endIndex

integer

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

content[]

object ( StructuralElement )

محتوای سلول

tableCellStyle

object ( TableCellStyle )

سبک سلول

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

suggestedTableCellStyleChanges

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

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

سفره سفالی

سبک یک TableCell .

سبک های سلول جدول ارثی در این پیام به عنوان زمینه های UNSET نشان داده شده است. یک سبک سلول جدول می تواند از سبک جدول به ارث ببرد.

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

integer

دهانه ردیف سلول.

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

columnSpan

integer

دهانه ستون سلول.

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

backgroundColor

object ( OptionalColor )

رنگ پس زمینه سلول.

borderLeft

object ( TableCellBorder )

مرز چپ سلول.

borderRight

object ( TableCellBorder )

مرز مناسب سلول.

borderTop

object ( TableCellBorder )

مرز بالای سلول.

borderBottom

object ( TableCellBorder )

مرز پایین سلول.

paddingLeft

object ( Dimension )

بالشتک سمت چپ سلول.

paddingRight

object ( Dimension )

بالشتک مناسب سلول.

paddingTop

object ( Dimension )

بالشتک بالای سلول.

paddingBottom

object ( Dimension )

بالشتک پایین سلول.

contentAlignment

enum ( ContentAlignment )

تراز محتوای موجود در سلول جدول. تراز پیش فرض با تراز سلولهای جدول تازه ایجاد شده در ویرایشگر DOCS مطابقت دارد.

سفره سفالی

حاشیه ای در اطراف یک سلول میز.

مرزهای سلول جدول نمی توانند شفاف باشند. برای مخفی کردن یک مرز سلول میز ، عرض آن 0 را درست کنید.

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

object ( OptionalColor )

رنگ مرز.

این رنگ نمی تواند شفاف باشد.

width

object ( Dimension )

عرض مرز.

dashStyle

enum ( DashStyle )

سبک خط مرز.

محتوای محتوا

انواع تراز محتوا.

مشتق شده از زیر مجموعه ای از مقادیر "ST_TEXTANCHORGINGTYPE" نوع ساده در بخش 20.1.10.59 "فرمت های پرونده XML Office Open - اصول و مرجع زبان نشانه گذاری" ، قسمت 1 ECMA -376 چاپ 4 .

نماد
CONTENT_ALIGNMENT_UNSPECIFIED تراز محتوای نامشخص. در صورت وجود تراز محتوا از والدین به ارث می رسد.
CONTENT_ALIGNMENT_UNSUPPORTED تراز محتوای پشتیبانی نشده.
TOP تراز که محتوا را با بالای دارنده محتوا تراز می کند. مطابق با ECMA-376 ST_TEXTANCHORGINGTYPE 'T'.
MIDDLE تراز که محتوا را با وسط دارنده محتوا تراز می کند. مطابق با ECMA-376 ST_TEXTANCHORGINGTYPE "CTR" است.
BOTTOM تراز که محتوا را به پایین نگهدارنده محتوا تراز می کند. مطابق با ECMA-376 ST_TEXTANCHORGINGTYPE 'B' است.

پیشنهاد شده

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

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

object ( TableCellStyle )

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

tableCellStyleSuggestionState

object ( TableCellStyleSuggestionState )

ماسک ای که نشان می دهد کدام یک از زمینه های موجود در TableCellStyle اصلی در این پیشنهاد تغییر یافته است.

سفره های سفالی

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

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

boolean

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

columnSpanSuggested

boolean

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

backgroundColorSuggested

boolean

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

borderLeftSuggested

boolean

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

borderRightSuggested

boolean

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

borderTopSuggested

boolean

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

borderBottomSuggested

boolean

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

paddingLeftSuggested

boolean

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

paddingRightSuggested

boolean

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

paddingTopSuggested

boolean

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

paddingBottomSuggested

boolean

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

contentAlignmentSuggested

boolean

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

سبک سفره

سبک هایی که برای یک ردیف جدول اعمال می شود.

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

object ( Dimension )

حداقل ارتفاع ردیف. این ردیف در ویرایشگر Docs در ارتفاع برابر یا بیشتر از این مقدار ارائه می شود تا تمام محتوای موجود در سلولهای ردیف را نشان دهد.

tableHeader

boolean

آیا ردیف یک هدر جدول است.

preventOverflow

boolean

این که آیا ردیف نمی تواند در مرزهای صفحه یا ستون سرریز شود.

پیشنهاد شده

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

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

object ( TableRowStyle )

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

tableRowStyleSuggestionState

object ( TableRowStyleSuggestionState )

ماسک ای که نشان می دهد کدام یک از زمینه های موجود در TableRowStyle پایه در این پیشنهاد تغییر یافته است.

TableRowstylesuggestState

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

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

boolean

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

سبک سفره

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

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

object ( TableColumnProperties )

خواص هر ستون.

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

سفره

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

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

enum ( WidthType )

نوع عرض ستون.

width

object ( Dimension )

عرض ستون. تنظیم کنید که widthType ستون FIXED_WIDTH باشد.

نوع عرض

نوع عرض ستون.

نماد
WIDTH_TYPE_UNSPECIFIED نوع عرض ستون نامشخص است.
EVENLY_DISTRIBUTED

عرض ستون به طور مساوی در بین ستون های دیگر به طور مساوی توزیع می شود.

عرض ستون به طور خودکار تعیین می شود و پس از حسابداری برای کلیه ستون ها با عرض مشخص ، قسمت مساوی از عرض باقی مانده برای جدول را خواهد داشت.

FIXED_WIDTH عرض ستون ثابت. [Width] [ google.apps.docs.v1.TableColumnProperties.width Wwidth شامل عرض ستون است.

فهرست مطالب

StructuralElement نمایانگر یک فهرست از مطالب است.

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

object ( StructuralElement )

محتوای فهرست مطالب.

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

پاورقی

پاورقی سند.

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

string

شناسه پاورقی.

content[]

object ( StructuralElement )

محتویات پاورقی.

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

سبک نامه

سبک سند.

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

object ( Background )

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

defaultHeaderId

string

شناسه هدر پیش فرض. اگر تنظیم نشده باشد ، هیچ هدر پیش فرض وجود ندارد.

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

evenPageHeaderId

string

شناسه هدر فقط برای صفحات حتی استفاده می شد. مقدار useEvenPageHeaderFooter تعیین می کند که آیا از defaultHeaderId یا این مقدار برای هدر در صفحات استفاده می کند. اگر تنظیم نشده باشد ، هیچ عنوان یک صفحه ای وجود ندارد.

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

firstPageHeaderId

string

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

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

pageNumberStart

integer

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

marginTop

object ( Dimension )

حاشیه صفحه بالا.

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

marginBottom

object ( Dimension )

حاشیه صفحه پایین.

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

marginRight

object ( Dimension )

حاشیه صفحه مناسب.

به روزرسانی حاشیه صفحه مناسب در سبک سند ، حاشیه صفحه مناسب را در تمام سبک های بخش پاک می کند. همچنین ممکن است باعث تغییر اندازه ستون ها در همه بخش ها شود.

marginLeft

object ( Dimension )

حاشیه صفحه سمت چپ.

به روزرسانی حاشیه صفحه سمت چپ در سبک سند حاشیه صفحه سمت چپ را در تمام سبک های بخش پاک می کند. همچنین ممکن است باعث تغییر اندازه ستون ها در همه بخش ها شود.

pageSize

object ( Size )

اندازه یک صفحه در سند.

marginHeader

object ( Dimension )

میزان فضای بین بالای صفحه و محتوای هدر.

flipPageOrientation

boolean

اختیاری. نشان می دهد که آیا باید ابعاد pageSize را بپیچید ، که امکان تغییر جهت گیری صفحه بین پرتره و چشم انداز را فراهم می کند.

زمینه

پیشینه یک سند را نشان می دهد.

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

object ( OptionalColor )

رنگ پس زمینه

اندازه

عرض و ارتفاع.

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

object ( Dimension )

ارتفاع شی.

width

object ( Dimension )

عرض شی.

پیشنهادی documentStyle

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

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

object ( DocumentStyle )

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

documentStyleSuggestionState

object ( DocumentStyleSuggestionState )

ماسک که نشان می دهد کدام یک از قسمت های موجود در DocumentStyle پایه در این پیشنهاد تغییر یافته است.

DocumentStylesuggestionState

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

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

object ( BackgroundSuggestionState )

ماسک ای که نشان می دهد کدام یک از زمینه های موجود در background در این پیشنهاد تغییر یافته است.

defaultHeaderIdSuggested

boolean

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

evenPageHeaderIdSuggested

boolean

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

firstPageHeaderIdSuggested

boolean

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

pageNumberStartSuggested

boolean

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

marginTopSuggested

boolean

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

marginBottomSuggested

boolean

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

marginRightSuggested

boolean

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

marginLeftSuggested

boolean

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

pageSizeSuggestionState

object ( SizeSuggestionState )

ماسک ای که نشان می دهد کدام یک از زمینه ها در [اندازه] [google.apps.docs.v1.documentStyle.Size] در این پیشنهاد تغییر یافته است.

marginHeaderSuggested

boolean

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

flipPageOrientationSuggested

boolean

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

پیش زمینه

ماسک که نشان می دهد کدام یک از زمینه های موجود در Background پایه در این پیشنهاد تغییر یافته است. برای هر زمینه ای که در True تنظیم شده است ، Backgound یک مقدار پیشنهادی جدید دارد.

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

boolean

نشان می دهد که آیا رنگ پس زمینه فعلی در این پیشنهاد اصلاح شده است یا خیر.

اندازه های UgegestionState

ماسک ای که نشان می دهد کدام یک از زمینه های Size پایه در این پیشنهاد تغییر یافته است. برای هر زمینه تنظیم شده در True ، Size یک مقدار پیشنهادی جدید دارد.

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

boolean

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

widthSuggested

boolean

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

نامگذاری شده

سبک های نامگذاری شده پاراگراف های موجود در این سند می توانند TextStyle و ParagraphStyle خود را از این سبک های نامگذاری شده به ارث ببرند.

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

object ( NamedStyle )

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

یک ورودی برای هر یک از named style types ممکن است وجود دارد.

نامگذاری شده

یک سبک نامگذاری شده پاراگراف های موجود در این سند می توانند در صورت داشتن همان نوع سبک نامگذاری شده TextStyle و ParagraphStyle خود را از این سبک نامگذاری شده به ارث ببرند.

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

enum ( NamedStyleType )

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

textStyle

object ( TextStyle )

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

paragraphStyle

object ( ParagraphStyle )

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

نامگذاری شده

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

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

object ( NamedStyles )

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

namedStylesSuggestionState

object ( NamedStylesSuggestionState )

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

نامگذاری شده

وضعیت پیشنهاد یک پیام NamedStyles .

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

object ( NamedStyleSuggestionState )

ماسک ای که نشان می دهد کدام یک از زمینه های موجود در NamedStyle در styles در این پیشنهاد تغییر یافته است.

ترتیب این پیشنهادات به سبک نامگذاری شده با ترتیب سبک نامگذاری شده مربوطه در پیشنهاد named styles مطابقت دارد.

نامگذاری شده است

وضعیت پیشنهادی از یک پیام NamedStyle .

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

enum ( NamedStyleType )

نوع سبک نامگذاری شده که این وضعیت پیشنهاد با آن مطابقت دارد.

این زمینه به عنوان راحتی برای تطبیق نامگذاری شده با نام StyleSuggestionState با NamedStyle مربوطه ارائه شده است.

textStyleSuggestionState

object ( TextStyleSuggestionState )

ماسک ای که نشان می دهد کدام یک از زمینه های text style در این پیشنهاد تغییر کرده است.

paragraphStyleSuggestionState

object ( ParagraphStyleSuggestionState )

ماسک ای که نشان می دهد کدام یک از زمینه های paragraph style در این پیشنهاد تغییر کرده است.

فهرست کنید

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

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

object ( ListProperties )

خصوصیات لیست.

suggestedListPropertiesChanges

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

تغییرات پیشنهادی در خصوصیات لیست ، که توسط شناسه پیشنهاد شده است.

suggestedInsertionId

string

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

suggestedDeletionIds[]

string

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

ListProperties

خواص list که ظاهر و احساس گلوله های متعلق به پاراگراف های مرتبط با یک لیست را توصیف می کند.

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

object ( NestingLevel )

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

یک لیست حداکثر 9 سطح لانه سازی با سطح لانه سازی 0 متناسب با سطح بالاترین سطح و سطح لانه سازی 8 مربوط به سطح تو در تو است. سطح لانه سازی به ترتیب صعودی با کمترین برگشتی که در ابتدا برگشت داده می شود ، بازگردانده می شوند.

با روکش سطحی

شامل خواصی است که ظاهر و احساس یک گلوله لیست را در سطح معینی از لانه سازی توصیف می کند.

نمایندگی JSON
{
  "bulletAlignment": enum (BulletAlignment),
  "glyphFormat": string,
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "textStyle": {
    object (TextStyle)
  },
  "startNumber": integer,

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

enum ( BulletAlignment )

تراز گلوله در فضا که برای ارائه گلوله اختصاص یافته است.

glyphFormat

string

رشته فرمت استفاده شده توسط گلوله ها در این سطح از لانه سازی.

فرمت Glyph شامل یک یا چند صاحب مکان است و این مکان ها بسته به glyphType یا glyphSymbol با مقادیر مناسب جایگزین می شوند. متقاضیان از الگوی %[nestingLevel] پیروی می کنند. علاوه بر این ، متغیرها می توانند پیشوندها و پسوندها داشته باشند. بنابراین ، فرمت Glyph از الگوی <prefix>%[nestingLevel]<suffix> پیروی می کند. توجه داشته باشید که پیشوند و پسوند اختیاری هستند و می توانند رشته های دلخواه باشند.

به عنوان مثال ، قالب Glyph %0. indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format %0. at nesting level 0 will result in a list with rendered glyphs

A.

B.

C.

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

1.

2.

2.1.

2.2.

3.

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

indentFirstLine

object ( Dimension )

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

indentStart

object ( Dimension )

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

textStyle

object ( TextStyle )

The text style of bullets at this level of nesting.

startNumber

integer

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

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

This value is ignored for nesting levels with unordered glyphs.

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

enum ( GlyphType )

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

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

glyphSymbol

string

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

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

BulletAlignment

The types of alignment for a bullet.

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

GlyphType

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

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

SuggestedListProperties

A suggested change to ListProperties .

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

object ( ListProperties )

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

listPropertiesSuggestionState

object ( ListPropertiesSuggestionState )

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

ListPropertiesSuggestionState

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

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

object ( NestingLevelSuggestionState )

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

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

NestingLevelSuggestionState

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

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

boolean

Indicates if there was a suggested change to bulletAlignment .

glyphTypeSuggested

boolean

Indicates if there was a suggested change to glyphType .

glyphFormatSuggested

boolean

Indicates if there was a suggested change to glyphFormat .

glyphSymbolSuggested

boolean

Indicates if there was a suggested change to glyphSymbol .

indentFirstLineSuggested

boolean

Indicates if there was a suggested change to indentFirstLine .

indentStartSuggested

boolean

Indicates if there was a suggested change to indentStart .

textStyleSuggestionState

object ( TextStyleSuggestionState )

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

startNumberSuggested

boolean

Indicates if there was a suggested change to startNumber .

NamedRanges

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

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

string

The name that all the named ranges share.

namedRanges[]

object ( NamedRange )

The NamedRange s that share the same name.

NamedRange

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

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

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

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

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

string

The ID of the named range.

name

string

The name of the named range.

ranges[]

object ( Range )

The ranges that belong to this named range.

دامنه

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 angle are 0, the image is not cropped.
JSON representation
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
زمینه های
offsetLeft

number

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

offsetRight

number

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

offsetTop

number

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

offsetBottom

number

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

angle

number

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

EmbeddedObjectBorder

A border around an EmbeddedObject .

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

object ( OptionalColor )

The color of the border.

width

object ( Dimension )

The width of the border.

dashStyle

enum ( DashStyle )

The dash style of the border.

propertyState

enum ( PropertyState )

The property state of the border property.

PropertyState

The possible states of a property.

Enums
RENDERED If a property's state is RENDERED, then the element has the corresponding property when rendered in the document. این مقدار پیش فرض است.
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.

مواد و روش ها

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.