- منبع: سند
- Tab
- TabProperties
- DocumentTab
- بدن
- عنصر ساختاری
- پاراگراف
- عنصر پاراگراف
- TextRun
- TextStyle
- رنگ اختیاری
- رنگ
- RgbColor
- بعد
- واحد
- WeightedFontFamily
- آفست پایه
- پیوند
- پیوند نشانک
- Heading Link
- SuggestedTextStyle
- TextStyleSuggestionState
- متن خودکار
- تایپ کنید
- Page Break
- Column Break
- پانوشت مرجع
- قانون افقی
- معادله
- InlineObjectElement
- شخص
- ویژگی های شخص
- RichLink
- RichLinkProperties
- سبک پاراگراف
- NamedStyleType
- تراز
- جهت محتوا
- فاصله فاصله
- ParagraphBorder
- DashStyle
- TabStop
- TabStopAlignment
- سایه زدن
- سبک پاراگراف پیشنهادی
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- گلوله
- گلوله پیشنهادی
- BulletSuggestionState
- ObjectReferences
- بخش شکست
- بخش سبک
- SectionColumnProperties
- ColumnSeparatorStyle
- نوع بخش
- جدول
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- هم ترازی محتوا
- SuggestedTableCellStyle
- TableCellStyleSuggestionState
- TableRowStyle
- پیشنهاد TableRowStyle
- TableRowStyleSuggestionState
- TableStyle
- TableColumnProperties
- WidthType
- TableOfContents
- سربرگ
- پاورقی
- پاورقی
- DocumentStyle
- پس زمینه
- اندازه
- SuggestedDocumentStyle
- DocumentStyleSuggestionState
- پس زمینه پیشنهاد دولت
- SizeSuggestionState
- NamedStyles
- NamedStyle
- SuggestedNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- فهرست کنید
- ListProperties
- NestingLevel
- گلوله تراز
- GlyphType
- Properties SuggestedList
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- Named Ranges
- Named Range
- محدوده
- InlineObject
- InlineObjectProperties
- EmbeddedObject
- EmbeddedDrawingProperties
- ImageProperties
- CropProperties
- EmbeddedObjectBorder
- PropertyState
- LinkedContentReference
- SheetsChartReference
- SuggestedInline Object Properties
- InlineObjectPropertiesSuggestionState
- EmbeddedObjectSuggestionState
- EmbeddedDrawingPropertiesSuggestionState
- ImagePropertiesSuggestionState
- CropPropertiesSuggestionState
- EmbeddedObjectBorderSuggestionState
- LinkedContentReferenceSuggestionState
- SheetsChartReferenceSuggestionState
- Positioned Object
- PositionedObjectProperties
- PositionedObject Positioning
- PositionedObjectLayout
- Properties SuggestedPositioned Object
- PositionedObjectPropertiesSuggestionState
- PositionedObjectPositioningSuggestionState
- SuggestionsViewMode
- روش ها
منبع: سند
یک سند Google Docs.
نمایندگی JSON |
---|
{ "documentId": string, "title": string, "tabs": [ { object ( |
فیلدها | |
---|---|
documentId | فقط خروجی شناسه سند. |
title | عنوان سند. |
tabs[] | برگه هایی که بخشی از یک سند هستند. برگهها میتوانند حاوی برگههای فرزند باشند، یک برگه تودرتو در یک برگه دیگر. برگه های فرزند با فیلد |
revisionId | فقط خروجی شناسه ویرایش سند. میتواند در درخواستهای بهروزرسانی استفاده شود تا مشخص شود که در کدام یک از ویرایشهای یک سند، بهروزرسانیها اعمال شود و اگر سند از آن تجدیدنظر ویرایش شده است، چگونه باید رفتار کند. فقط در صورتی پر می شود که کاربر دسترسی ویرایش به سند داشته باشد. شناسه تجدیدنظر یک عدد متوالی نیست بلکه یک رشته مات است. قالب شناسه بازبینی ممکن است در طول زمان تغییر کند. شناسه بازگردانی شده فقط تا 24 ساعت پس از بازگرداندن آن تضمین شده است که اعتبار دارد و نمیتوان آن را بین کاربران به اشتراک گذاشت. اگر شناسه بازبینی بین تماس ها تغییر نکرده باشد، سند تغییر نکرده است. برعکس، شناسه تغییر یافته (برای همان سند و کاربر) معمولاً به این معنی است که سند به روز شده است. با این حال، تغییر شناسه می تواند به دلیل عوامل داخلی مانند تغییر فرمت شناسه نیز باشد. |
suggestionsViewMode | فقط خروجی حالت نمایش پیشنهادات روی سند اعمال شد. توجه: هنگام ویرایش یک سند، تغییرات باید بر اساس سندی با |
body | فقط خروجی بدنه اصلی سند. فیلد قدیمی: به جای آن، از |
headers | فقط خروجی سرصفحه های موجود در سند، با شناسه سرصفحه کلید شده اند. فیلد قدیمی: به جای آن، از |
footers | فقط خروجی پاورقی های موجود در سند، با شناسه پاورقی کلید زده می شوند. فیلد قدیمی: به جای آن، از |
footnotes | فقط خروجی پاورقی های موجود در سند، با شناسه پاورقی کلید زده شده اند. فیلد قدیمی: به جای آن، از |
documentStyle | فقط خروجی سبک سند. فیلد قدیمی: به جای آن، از |
suggestedDocumentStyleChanges | فقط خروجی تغییرات پیشنهادی در سبک سند، با شناسه پیشنهاد کلید زده شده است. فیلد قدیمی: به جای آن، از |
namedStyles | فقط خروجی سبک های نامگذاری شده سند. فیلد قدیمی: به جای آن، از |
suggestedNamedStylesChanges | فقط خروجی تغییرات پیشنهادی در سبک های نامگذاری شده سند، با شناسه پیشنهاد کلید زده شده است. فیلد قدیمی: به جای آن، از |
lists | فقط خروجی فهرستهای موجود در سند، با شناسه فهرست کلید زده میشوند. فیلد قدیمی: به جای آن، از |
namedRanges | فقط خروجی محدوده های نامگذاری شده در سند، با نام کلید شده است. فیلد قدیمی: به جای آن، از |
inlineObjects | فقط خروجی اشیاء درون خطی در سند، با شناسه شی کلید زده می شوند. فیلد قدیمی: به جای آن، از |
positionedObjects | فقط خروجی اشیاء قرار داده شده در سند، با شناسه شی کلید زده می شوند. فیلد قدیمی: به جای آن، از |
Tab
یک برگه در یک سند
نمایندگی JSON |
---|
{ "tabProperties": { object ( |
فیلدها | |
---|---|
tabProperties | ویژگی های برگه، مانند شناسه و عنوان. |
childTabs[] | زبانه های فرزند در این برگه تودرتو هستند. |
content زمینه اتحادیه محتوای برگه. content فقط می تواند یکی از موارد زیر باشد: | |
documentTab | یک برگه با محتوای سند، مانند متن و تصاویر. |
TabProperties
ویژگی های یک برگه
نمایندگی JSON |
---|
{ "tabId": string, "title": string, "parentTabId": string, "index": integer, "nestingLevel": integer } |
فیلدها | |
---|---|
tabId | فقط خروجی شناسه برگه این فیلد قابل تغییر نیست. |
title | نام برگه قابل مشاهده توسط کاربر. |
parentTabId | اختیاری. شناسه برگه والد. هنگامی که برگه فعلی یک برگه در سطح ریشه باشد خالی است، به این معنی که هیچ والدینی ندارد. |
index | شاخص مبتنی بر صفر برگه در والد. |
nestingLevel | فقط خروجی عمق برگه در سند. تب های سطح ریشه از 0 شروع می شوند. |
DocumentTab
یک برگه با محتوای سند.
نمایندگی JSON |
---|
{ "body": { object ( |
فیلدها | |
---|---|
body | بدنه اصلی برگه سند. |
headers | سرصفحه ها در برگه سند، با شناسه سرصفحه کلید شده اند. |
footers | پاورقی ها در برگه سند، با شناسه پاورقی کلید می زنند. |
footnotes | پاورقی ها در برگه سند، با شناسه پاورقی کلید می زنند. |
documentStyle | سبک برگه سند. |
suggestedDocumentStyleChanges | تغییرات پیشنهادی در سبک برگه سند که با شناسه پیشنهاد کلید میخورد. |
namedStyles | سبک های نامگذاری شده برگه سند. |
suggestedNamedStylesChanges | تغییرات پیشنهادی در سبکهای نامگذاریشده برگه سند، با شناسه پیشنهاد کلید میخورد. |
lists | فهرستهای موجود در برگه سند، با شناسه فهرست کلید میزنند. |
namedRanges | محدوده های نامگذاری شده در برگه سند، با نام کلید شده است. |
inlineObjects | اشیاء درون خطی در برگه سند، با شناسه شی کلید زده می شوند. |
positionedObjects | اشیاء قرار داده شده در برگه سند، با شناسه شی کلید زده می شوند. |
بدن
بدنه سند
بدنه معمولاً حاوی محتوای کامل سند به جز headers
، footers
و footnotes
است.
نمایندگی JSON |
---|
{
"content": [
{
object ( |
فیلدها | |
---|---|
content[] | محتویات بدن. شاخص های محتوای بدن از صفر شروع می شود. |
عنصر ساختاری
یک StructuralElement محتوایی را توصیف می کند که ساختاری را برای سند فراهم می کند.
نمایندگی JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
فیلدها | |
---|---|
startIndex | شاخص شروع مبتنی بر صفر این عنصر ساختاری، در واحدهای کد UTF-16. |
endIndex | شاخص پایانی مبتنی بر صفر این عنصر ساختاری، منحصر به فرد، در واحدهای کد UTF-16. |
content زمینه اتحادیه محتوای عنصر ساختاری. content فقط می تواند یکی از موارد زیر باشد: | |
paragraph | یک نوع پاراگراف از عنصر ساختاری. |
sectionBreak | یک نوع شکست بخش از عنصر ساختاری. |
table | یک نوع جدول از عنصر ساختاری. |
tableOfContents | فهرست مطالب نوع عنصر ساختاری. |
پاراگراف
یک StructuralElement
که یک پاراگراف را نشان می دهد. پاراگراف طیفی از محتوا است که با یک کاراکتر خط جدید خاتمه می یابد.
نمایندگی JSON |
---|
{ "elements": [ { object ( |
فیلدها | |
---|---|
elements[] | محتوای پاراگراف، به اجزای سازنده آن تقسیم شده است. |
paragraphStyle | سبک این پاراگراف. |
suggestedParagraphStyleChanges | سبک پاراگراف پیشنهادی به این پاراگراف تغییر میکند که با شناسه پیشنهاد کلید میخورد. |
bullet | گلوله این پاراگراف. اگر پاراگراف موجود نباشد، به فهرستی تعلق ندارد. |
suggestedBulletChanges | تغییرات پیشنهادی برای گلوله این پاراگراف. |
positionedObjectIds[] | شناسههای اشیاء موقعیتیافته متصل به این پاراگراف. |
suggestedPositionedObjectIds | شناسههای اشیاء موقعیتیافته پیشنهاد شده به این پاراگراف پیوست شوند، با شناسه پیشنهاد کلید میزنند. |
عنصر پاراگراف
یک ParagraphElement محتوای یک Paragraph
را توصیف می کند.
نمایندگی JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
فیلدها | |
---|---|
startIndex | شاخص شروع مبتنی بر صفر این عنصر پاراگراف، در واحدهای کد UTF-16. |
endIndex | شاخص پایانی پایه صفر این عنصر پاراگراف، انحصاری، در واحدهای کد UTF-16. |
content زمینه اتحادیه محتوای عنصر پاراگراف. content فقط می تواند یکی از موارد زیر باشد: | |
textRun | یک عنصر پاراگراف اجرای متن. |
autoText | یک عنصر پاراگراف متن خودکار. |
pageBreak | یک عنصر پاراگراف شکستن صفحه. |
columnBreak | عنصر پاراگراف شکست ستون. |
footnoteReference | عنصر پاراگراف مرجع پاورقی. |
horizontalRule | عنصر پاراگراف قانون افقی. |
equation | عنصر پاراگراف معادله |
inlineObjectElement | عنصر پاراگراف شی درون خطی. |
person | یک عنصر پاراگراف که به یک شخص یا آدرس ایمیل پیوند دارد. |
richLink | یک عنصر پاراگراف که به یک منبع Google (مانند یک فایل در Google Drive، یک ویدیوی YouTube یا یک رویداد تقویم) پیوند میدهد. |
TextRun
یک ParagraphElement
که نشاندهنده مجموعهای از متن است که همگی یک استایل دارند.
نمایندگی JSON |
---|
{ "content": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
فیلدها | |
---|---|
content | متن این اجرا. هر عنصر غیر متنی در اجرا با کاراکتر Unicode U+E907 جایگزین میشود. |
suggestedInsertionIds[] | شناسههای درج پیشنهادی اگر یک |
suggestedDeletionIds[] | شناسه های حذف پیشنهادی اگر خالی باشد، هیچ پیشنهادی برای حذف این محتوا وجود ندارد. |
textStyle | سبک متن این اجرا. |
suggestedTextStyleChanges | سبک متن پیشنهادی به این اجرا تغییر میکند که با شناسه پیشنهاد کلید میخورد. |
TextStyle
نمایانگر استایلی است که می توان روی متن اعمال کرد.
سبک های متن ارثی به صورت فیلدهای تنظیم نشده در این پیام نمایش داده می شوند. والد یک سبک متن به محل تعریف سبک متن بستگی دارد:
- 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 ( |
فیلدها | |
---|---|
bold | این که آیا متن به صورت پررنگ ارائه می شود یا نه. |
italic | خواه متن مورب باشد یا نه. |
underline | خط دار بودن یا نبودن متن. |
strikethrough | این که آیا متن از طریق ضربه زده می شود یا نه. |
smallCaps | خواه متن با حروف کوچک باشد یا نه. |
backgroundColor | رنگ پس زمینه متن. اگر تنظیم شود، بسته به قسمت |
foregroundColor | رنگ پیش زمینه متن. اگر تنظیم شود، بسته به قسمت |
fontSize | اندازه فونت متن |
weightedFontFamily | خانواده فونت و وزن رندر شده متن. اگر یک درخواست بهروزرسانی مقادیری را هم برای اگر اگر |
baselineOffset | افست عمودی متن از موقعیت عادی خود. متن با |
link | مقصد هایپرلینک متن. اگر تنظیم نشده باشد، پیوندی وجود ندارد. پیوندها از متن والد به ارث برده نمی شوند. تغییر پیوند در یک درخواست به روز رسانی باعث ایجاد برخی تغییرات دیگر در سبک متن محدوده می شود:
|
رنگ اختیاری
رنگی که می تواند کاملاً مات یا کاملاً شفاف باشد.
نمایندگی JSON |
---|
{
"color": {
object ( |
فیلدها | |
---|---|
color | اگر تنظیم شود، از این رنگ به عنوان یک رنگ مات استفاده می شود. اگر تنظیم نشده باشد، این یک رنگ شفاف است. |
رنگ
یک رنگ ثابت
نمایندگی JSON |
---|
{
"rgbColor": {
object ( |
فیلدها | |
---|---|
rgbColor | مقدار رنگ RGB |
RgbColor
یک رنگ RGB
نمایندگی JSON |
---|
{ "red": number, "green": number, "blue": number } |
فیلدها | |
---|---|
red | جزء قرمز رنگ، از 0.0 تا 1.0. |
green | جزء سبز رنگ، از 0.0 تا 1.0. |
blue | جزء آبی رنگ، از 0.0 تا 1.0. |
بعد
قدر در یک جهت در واحدهای مشخص شده.
نمایندگی JSON |
---|
{
"magnitude": number,
"unit": enum ( |
فیلدها | |
---|---|
magnitude | بزرگی. |
unit | واحدهای قدر |
واحد
واحدهای اندازه گیری
Enums | |
---|---|
UNIT_UNSPECIFIED | واحدها ناشناخته هستند |
PT | یک نقطه، 1/72 اینچ. |
WeightedFontFamily
خانواده فونت و وزن متن را نشان می دهد.
نمایندگی JSON |
---|
{ "fontFamily": string, "weight": integer } |
فیلدها | |
---|---|
fontFamily | خانواده فونت متن خانواده فونت می تواند هر قلمی از منوی فونت در Docs یا از فونت های Google باشد. اگر نام فونت شناسایی نشود، متن در |
weight | وزن فونت این فیلد میتواند هر مقداری داشته باشد که مضرب مقدار پیش فرض وزن فونت فقط یک جزء از وزن فونت رندر شده را تشکیل می دهد. ترکیبی از
|
آفست پایه
روش هایی که در آنها می توان متن را به صورت عمودی از موقعیت عادی خود منحرف کرد.
Enums | |
---|---|
BASELINE_OFFSET_UNSPECIFIED | افست خط پایه متن از والد به ارث می رسد. |
NONE | متن به صورت عمودی افست نیست. |
SUPERSCRIPT | متن به صورت عمودی به سمت بالا جابجا شده است (بالا خط). |
SUBSCRIPT | متن به صورت عمودی به سمت پایین افست شده است (زیرنویس). |
پیوند
ارجاع به بخش دیگری از یک سند یا یک منبع URL خارجی.
نمایندگی JSON |
---|
{ // Union field |
فیلدها | |
---|---|
destination میدان اتحادیه مقصد پیوند. destination فقط می تواند یکی از موارد زیر باشد: | |
url | یک URL خارجی |
tabId | شناسه یک برگه در این سند. |
bookmark | یک نشانک در این سند. در اسنادی که حاوی یک برگه هستند، پیوندها به نشانکهای موجود در برگه منحصر به فرد، زمانی که پارامتر |
heading | عنوانی در این سند در اسنادی که حاوی یک برگه واحد هستند، پیوندها به عناوین درون برگه منحصر به فرد، زمانی که پارامتر |
bookmarkId | شناسه یک نشانک در این سند. فیلد قدیمی: در عوض، اگر این فیلد در درخواست نوشتن استفاده شود، نشانک از شناسه برگه مشخص شده در درخواست در نظر گرفته می شود. اگر شناسه برگه در درخواست مشخص نشده باشد، در نظر گرفته می شود که از اولین برگه سند است. |
headingId | شناسه یک عنوان در این سند. فیلد قدیمی: در عوض، اگر این فیلد در درخواست نوشتن استفاده شود، عنوان از شناسه تب مشخص شده در درخواست در نظر گرفته می شود. اگر شناسه برگه در درخواست مشخص نشده باشد، در نظر گرفته می شود که از اولین برگه سند است. |
پیوند نشانک
اشاره به یک نشانک در این سند.
نمایندگی JSON |
---|
{ "id": string, "tabId": string } |
فیلدها | |
---|---|
id | شناسه یک نشانک در این سند. |
tabId | شناسه برگه حاوی این نشانک. |
Heading Link
اشاره به عنوانی در این سند.
نمایندگی JSON |
---|
{ "id": string, "tabId": string } |
فیلدها | |
---|---|
id | شناسه یک عنوان در این سند. |
tabId | شناسه برگه حاوی این عنوان. |
SuggestedTextStyle
یک تغییر پیشنهادی به یک TextStyle
.
نمایندگی JSON |
---|
{ "textStyle": { object ( |
فیلدها | |
---|---|
textStyle | یک |
textStyleSuggestionState | ماسکی که نشان می دهد کدام یک از فیلدهای |
TextStyleSuggestionState
ماسکی که نشان می دهد کدام یک از فیلدهای TextStyle
پایه در این پیشنهاد تغییر کرده است. برای هر فیلدی که روی true تنظیم شده است، یک مقدار پیشنهادی جدید وجود دارد.
نمایندگی JSON |
---|
{ "boldSuggested": boolean, "italicSuggested": boolean, "underlineSuggested": boolean, "strikethroughSuggested": boolean, "smallCapsSuggested": boolean, "backgroundColorSuggested": boolean, "foregroundColorSuggested": boolean, "fontSizeSuggested": boolean, "weightedFontFamilySuggested": boolean, "baselineOffsetSuggested": boolean, "linkSuggested": boolean } |
فیلدها | |
---|---|
boldSuggested | نشان می دهد که آیا تغییری به |
italicSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
underlineSuggested | نشان می دهد که آیا تغییر پیشنهادی برای |
strikethroughSuggested | نشان می دهد که آیا تغییر پیشنهادی برای |
smallCapsSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
backgroundColorSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
foregroundColorSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
fontSizeSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
weightedFontFamilySuggested | نشان میدهد که آیا تغییر پیشنهادی در |
baselineOffsetSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
linkSuggested | نشان می دهد که آیا تغییر پیشنهادی برای |
متن خودکار
یک ParagraphElement
نشان دهنده نقطه ای در متن است که به صورت پویا با محتوایی جایگزین می شود که می تواند در طول زمان تغییر کند، مانند شماره صفحه.
نمایندگی JSON |
---|
{ "type": enum ( |
فیلدها | |
---|---|
type | نوع این متن خودکار. |
suggestedInsertionIds[] | شناسههای درج پیشنهادی اگر یک |
suggestedDeletionIds[] | شناسه های حذف پیشنهادی اگر خالی باشد، هیچ پیشنهادی برای حذف این محتوا وجود ندارد. |
textStyle | سبک متن این AutoText. |
suggestedTextStyleChanges | سبک متن پیشنهادی به این متن خودکار تغییر میکند که با شناسه پیشنهاد کلید میخورد. |
تایپ کنید
انواع متن خودکار
Enums | |
---|---|
TYPE_UNSPECIFIED | نوع متن خودکار نامشخص. |
PAGE_NUMBER | برای متن خودکار که نشان دهنده شماره صفحه فعلی است تایپ کنید. |
PAGE_COUNT | متن خودکار را تایپ کنید که تعداد کل صفحات سند را نشان می دهد. |
Page Break
یک ParagraphElement
که نمایانگر یک شکست صفحه است. شکست صفحه باعث می شود متن بعدی از بالای صفحه بعد شروع شود.
نمایندگی JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
فیلدها | |
---|---|
suggestedInsertionIds[] | شناسههای درج پیشنهادی یک |
suggestedDeletionIds[] | شناسه های حذف پیشنهادی اگر خالی باشد، حذف پیشنهادی از این محتوا وجود ندارد. |
textStyle | سبک متن این PageBreak. شبیه به محتوای متنی، مانند اجراهای متن و مراجع پاورقی، سبک متن شکستگی صفحه می تواند بر طرح بندی محتوا و همچنین استایل متن درج شده در کنار آن تأثیر بگذارد. |
suggestedTextStyleChanges | سبک متن پیشنهادی به این PageBreak تغییر میکند که با شناسه پیشنهاد کلید میخورد. |
ColumnBreak
یک ParagraphElement
که نمایانگر شکست ستون است. شکست ستون باعث می شود متن بعدی از بالای ستون بعدی شروع شود.
نمایندگی JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
فیلدها | |
---|---|
suggestedInsertionIds[] | شناسههای درج پیشنهادی اگر یک تغییر پیشنهادی تودرتو باشد، ممکن است یک |
suggestedDeletionIds[] | شناسه های حذف پیشنهادی اگر خالی باشد، حذف پیشنهادی از این محتوا وجود ندارد. |
textStyle | سبک متن این ColumnBreak. شبیه به محتوای متن، مانند اجراهای متن و مراجع پاورقی، سبک متن شکستن ستون میتواند بر طرحبندی محتوا و همچنین استایل متن درج شده در کنار آن تأثیر بگذارد. |
suggestedTextStyleChanges | سبک متن پیشنهادی به این ColumnBreak تغییر میکند که با شناسه پیشنهاد کلید میخورد. |
پانوشت مرجع
یک ParagraphElement
که نشان دهنده یک مرجع پاورقی است. مرجع پاورقی محتوای درون خطی است که با یک عدد ارائه می شود و برای شناسایی پاورقی استفاده می شود.
نمایندگی JSON |
---|
{ "footnoteId": string, "footnoteNumber": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
فیلدها | |
---|---|
footnoteId | شناسه |
footnoteNumber | شماره ارائه شده این پاورقی. |
suggestedInsertionIds[] | شناسههای درج پیشنهادی یک |
suggestedDeletionIds[] | شناسه های حذف پیشنهادی اگر خالی باشد، حذف پیشنهادی از این محتوا وجود ندارد. |
textStyle | سبک متن این FootnoteReference. |
suggestedTextStyleChanges | سبک متن پیشنهادی به این FootnoteReference تغییر میکند که با شناسه پیشنهاد کلید میخورد. |
قانون افقی
یک ParagraphElement
که یک خط افقی را نشان می دهد.
نمایندگی JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
فیلدها | |
---|---|
suggestedInsertionIds[] | شناسههای درج پیشنهادی اگر |
suggestedDeletionIds[] | شناسه های حذف پیشنهادی اگر خالی باشد، هیچ پیشنهادی برای حذف این محتوا وجود ندارد. |
textStyle | سبک متن این HorizontalRule. شبیه به محتوای متن، مانند اجراهای متن و مراجع پاورقی، سبک متن یک قانون افقی میتواند بر طرحبندی محتوا و همچنین استایل متن درج شده در کنار آن تأثیر بگذارد. |
suggestedTextStyleChanges | سبک متن پیشنهادی به این HorizontalRule تغییر میکند که با شناسه پیشنهاد کلید میخورد. |
معادله
یک ParagraphElement
که یک معادله را نشان می دهد.
نمایندگی JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
فیلدها | |
---|---|
suggestedInsertionIds[] | شناسههای درج پیشنهادی اگر یک |
suggestedDeletionIds[] | شناسه های حذف پیشنهادی اگر خالی باشد، هیچ پیشنهادی برای حذف این محتوا وجود ندارد. |
InlineObjectElement
یک ParagraphElement
که حاوی یک InlineObject
است.
نمایندگی JSON |
---|
{ "inlineObjectId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
فیلدها | |
---|---|
inlineObjectId | شناسه |
suggestedInsertionIds[] | شناسههای درج پیشنهادی اگر یک تغییر پیشنهادی تودرتو باشد، ممکن است یک |
suggestedDeletionIds[] | شناسه های حذف پیشنهادی اگر خالی باشد، هیچ پیشنهادی برای حذف این محتوا وجود ندارد. |
textStyle | سبک متن این InlineObjectElement. مانند محتوای متن، مانند اجراهای متن و مراجع پانوشت، سبک متن یک عنصر شی درون خطی می تواند بر طرح بندی محتوا و همچنین استایل متن درج شده در کنار آن تأثیر بگذارد. |
suggestedTextStyleChanges | سبک متن پیشنهادی به این InlineObject تغییر میکند که با شناسه پیشنهاد کلید میخورد. |
شخص
یک شخص یا آدرس ایمیل ذکر شده در یک سند. این نامها بهعنوان یک عنصر منفرد و غیرقابل تغییر رفتار میکنند که حاوی نام یا آدرس ایمیل شخص است.
نمایندگی JSON |
---|
{ "personId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
فیلدها | |
---|---|
personId | فقط خروجی شناسه منحصر به فرد این لینک. |
suggestedInsertionIds[] | شناسههای پیشنهادهایی که پیوند این شخص را در سند درج میکنند. اگر یک |
suggestedDeletionIds[] | شناسههای پیشنهادهایی که پیوند این شخص را از سند حذف میکنند. برای مثال اگر چند کاربر پیشنهاد حذف آن را داشته باشند، ممکن است یک |
textStyle | سبک متن این |
suggestedTextStyleChanges | سبک متن پیشنهادی به این |
personProperties | فقط خروجی خواص این |
ویژگی های شخص
ویژگی های خاص یک Person
مرتبط.
نمایندگی JSON |
---|
{ "name": string, "email": string } |
فیلدها | |
---|---|
name | فقط خروجی نام شخص در صورتی که به جای آدرس ایمیل شخص در متن پیوند نمایش داده شود. |
email | فقط خروجی آدرس ایمیل مرتبط با این |
RichLink
پیوندی به یک منبع Google (مانند یک فایل در Drive، یک ویدیوی YouTube یا یک رویداد تقویم).
نمایندگی JSON |
---|
{ "richLinkId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
فیلدها | |
---|---|
richLinkId | فقط خروجی شناسه این لینک |
suggestedInsertionIds[] | شناسههای پیشنهادهایی که این پیوند را در سند وارد میکنند. اگر یک |
suggestedDeletionIds[] | شناسههای پیشنهادهایی که این پیوند را از سند حذف میکنند. یک |
textStyle | سبک متن این |
suggestedTextStyleChanges | سبک متن پیشنهادی به این |
richLinkProperties | فقط خروجی ویژگی های این |
RichLinkProperties
ویژگی های خاص یک RichLink
.
نمایندگی JSON |
---|
{ "title": string, "uri": string, "mimeType": string } |
فیلدها | |
---|---|
title | فقط خروجی عنوان |
uri | فقط خروجی URI به |
mimeType | فقط خروجی نوع MIME |
سبک پاراگراف
سبک هایی که برای کل یک پاراگراف کاربرد دارند.
سبکهای پاراگراف ارثی به صورت فیلدهای تنظیم نشده در این پیام نمایش داده میشوند. والد سبک پاراگراف به محل تعریف سبک پاراگراف بستگی دارد:
- ParagraphStyle در یک
Paragraph
ازnamed style type
مربوط به پاراگراف به ارث میرسد. - ParagraphStyle در یک
named style
ازnormal text
به نام style به ارث می رسد. - ParagraphStyle
normal text
به نام سبک از سبک پاراگراف پیشفرض در ویرایشگر Docs به ارث میرسد. - ParagraphStyle در یک عنصر
Paragraph
که در جدول موجود است ممکن است سبک پاراگراف خود را از سبک جدول به ارث ببرد.
اگر سبک پاراگراف از والدین به ارث نمیرسد، با لغو تنظیمات، سبک به مقداری مطابق با پیشفرضهای ویرایشگر Docs برمیگردد.
نمایندگی JSON |
---|
{ "headingId": string, "namedStyleType": enum ( |
فیلدها | |
---|---|
headingId | شناسه عنوان پاراگراف. اگر خالی باشد، این پاراگراف یک عنوان نیست. این ویژگی فقط خواندنی است. |
namedStyleType | نوع سبک نامگذاری شده پاراگراف. از آنجایی که بهروزرسانی نوع سبک نامگذاریشده بر سایر ویژگیهای داخل ParagraphStyle تأثیر میگذارد، نوع سبک نامگذاریشده قبل از بهروزرسانی ویژگیهای دیگر اعمال میشود. |
alignment | تراز متن برای این پاراگراف. |
lineSpacing | مقدار فاصله بین خطوط، به عنوان درصد نرمال، که در آن نرمال به صورت 100.0 نمایش داده می شود. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد. |
direction | جهت متن این پاراگراف. اگر تنظیم نشود، مقدار پیشفرض روی |
spacingMode | حالت فاصله برای پاراگراف. |
spaceAbove | مقدار فضای اضافی بالای پاراگراف. اگر تنظیم نشود، مقدار از والد به ارث می رسد. |
spaceBelow | مقدار فضای اضافی زیر پاراگراف. اگر تنظیم نشود، مقدار از والد به ارث می رسد. |
borderBetween | مرز بین این بند و پاراگراف های بعدی و قبلی. اگر تنظیم نشود، مقدار از والد به ارث می رسد. مرز بین زمانی نمایش داده می شود که پاراگراف مجاور دارای ویژگی های حاشیه و تورفتگی یکسان باشد. مرزهای پاراگراف را نمی توان تا حدی به روز کرد. هنگام تغییر مرز پاراگراف، حاشیه جدید باید به طور کامل مشخص شود. |
borderTop | حاشیه بالای این پاراگراف. اگر تنظیم نشود، مقدار از والد به ارث می رسد. حاشیه بالایی زمانی ارائه می شود که پاراگراف بالا دارای ویژگی های حاشیه و تورفتگی متفاوت باشد. مرزهای پاراگراف را نمی توان تا حدی به روز کرد. هنگام تغییر مرز پاراگراف، حاشیه جدید باید به طور کامل مشخص شود. |
borderBottom | حاشیه در پایین این پاراگراف. اگر تنظیم نشود، مقدار از والد به ارث می رسد. حاشیه پایین زمانی نمایش داده می شود که پاراگراف زیر دارای ویژگی های حاشیه و تورفتگی متفاوت باشد. مرزهای پاراگراف را نمی توان تا حدی به روز کرد. هنگام تغییر مرز پاراگراف، حاشیه جدید باید به طور کامل مشخص شود. |
borderLeft | حاشیه سمت چپ این پاراگراف. اگر تنظیم نشود، مقدار از والد به ارث می رسد. مرزهای پاراگراف را نمی توان تا حدی به روز کرد. هنگام تغییر مرز پاراگراف، حاشیه جدید باید به طور کامل مشخص شود. |
borderRight | حاشیه سمت راست این بند. اگر تنظیم نشود، مقدار از والد به ارث می رسد. مرزهای پاراگراف را نمی توان تا حدی به روز کرد. هنگام تغییر مرز پاراگراف ، مرز جدید باید به طور کامل مشخص شود. |
indentFirstLine | مقدار تورفتگی برای خط اول بند. در صورت عدم استفاده ، مقدار از والدین به ارث می رسد. |
indentStart | میزان تورفتگی برای پاراگراف در طرف که مطابق با شروع متن است ، بر اساس جهت پاراگراف فعلی. در صورت عدم استفاده ، مقدار از والدین به ارث می رسد. |
indentEnd | مقدار تورفتگی برای پاراگراف در طرف که مطابق با جهت پاراگراف فعلی است ، مربوط به انتهای متن است. در صورت عدم استفاده ، مقدار از والدین به ارث می رسد. |
tabStops[] | لیستی از برگه برای این بند متوقف می شود. لیست توقف برگه به ارث رسیده است. این خاصیت فقط خواندنی است. |
keepLinesTogether | این که آیا همه خطوط پاراگراف باید در صورت امکان در همان صفحه یا ستون گذاشته شود. در صورت عدم استفاده ، مقدار از والدین به ارث می رسد. |
keepWithNext | این که آیا حداقل بخشی از این پاراگراف باید در همان صفحه یا ستون به عنوان پاراگراف بعدی در صورت امکان قرار داده شود. در صورت عدم استفاده ، مقدار از والدین به ارث می رسد. |
avoidWidowAndOrphan | برای جلوگیری از بیوه ها و یتیمان برای پاراگراف. در صورت عدم استفاده ، مقدار از والدین به ارث می رسد. |
shading | سایه بند. در صورت عدم استفاده ، مقدار از والدین به ارث می رسد. |
pageBreakBefore | اینکه پاراگراف فعلی همیشه باید در ابتدای یک صفحه شروع شود. در صورت عدم استفاده ، مقدار از والدین به ارث می رسد. تلاش برای به روزرسانی |
نامگذاری شده
انواع سبک های نامگذاری شده.
Enums | |
---|---|
NAMED_STYLE_TYPE_UNSPECIFIED | نوع سبک نامگذاری شده نامشخص است. |
NORMAL_TEXT | متن معمولی |
TITLE | عنوان |
SUBTITLE | زیرنویس. |
HEADING_1 | سرفصل 1. |
HEADING_2 | سرفصل 2. |
HEADING_3 | عنوان 3. |
HEADING_4 | سرفصل 4. |
HEADING_5 | عنوان 5. |
HEADING_6 | عنوان 6. |
تراز
انواع تراز متن برای یک پاراگراف.
Enums | |
---|---|
ALIGNMENT_UNSPECIFIED | تراز پاراگراف از والدین به ارث رسیده است. |
START | پاراگراف با شروع خط تراز شده است. سمت چپ برای متن LTR ، در غیر این صورت با هم تراز شده است. |
CENTER | پاراگراف محور است. |
END | پاراگراف تا انتهای خط تراز شده است. راست برای متن LTR ، در غیر این صورت با هم تراز شده است. |
JUSTIFIED | پاراگراف توجیه شده است. |
جهت گیری محتوا
محتوای دستورالعمل ها می توانند وارد شوند.
Enums | |
---|---|
CONTENT_DIRECTION_UNSPECIFIED | جهت محتوا نا مشخص است. |
LEFT_TO_RIGHT | محتوا از چپ به راست می رود. |
RIGHT_TO_LEFT | محتوا از راست به چپ می رود. |
حالت فضا
حالت های مختلف برای فاصله پاراگراف.
Enums | |
---|---|
SPACING_MODE_UNSPECIFIED | حالت فاصله از والدین به ارث می رسد. |
NEVER_COLLAPSE | فاصله پاراگراف همیشه ارائه می شود. |
COLLAPSE_LISTS | فاصله پاراگراف بین عناصر لیست رد می شود. |
بند پاراگراف
یک مرز در اطراف یک پاراگراف.
نمایندگی JSON |
---|
{ "color": { object ( |
فیلدها | |
---|---|
color | رنگ مرز. |
width | عرض مرز. |
padding | بالشتک مرز. |
dashStyle | سبک خط مرز. |
DashStyle
انواع خطوطی که هندسه خطی با آنها قابل ارائه است. این مقادیر مبتنی بر نوع ساده "ST_PRESETLINEDASHVAL" است که در بخش 20.1.10.48 "فرمت های پرونده XML Office Open - اصول و مرجع زبان نشانه گذاری" ، قسمت 1 ECMA -376 چاپ 4 .
Enums | |
---|---|
DASH_STYLE_UNSPECIFIED | سبک داش نامشخص. |
SOLID | خط جامد مطابق با ECMA-376 ST_PRESETLINEDASHVAL "جامد" است. این سبک پیش فرض داش است. |
DOT | خط نقطه مطابق با ECMA-376 ST_PRESETLINEDASHVAL "نقطه" است. |
DASH | خط شکسته مطابق با ECMA-376 ST_PRESETLINEDASHVAL "DASH" است. |
TabStop
یک برگه در یک پاراگراف متوقف می شود.
نمایندگی JSON |
---|
{ "offset": { object ( |
فیلدها | |
---|---|
offset | جبران بین این برگه و حاشیه شروع. |
alignment | تراز این برگه متوقف می شود. در صورت عدم استفاده ، مقدار پیش فرض برای |
تبادل نظر
تراز کردن برگه.
Enums | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED | تراز توقف برگه نامشخص است. |
START | توقف برگه با شروع خط تراز شده است. این پیش فرض است. |
CENTER | توقف برگه به مرکز خط تراز شده است. |
END | توقف برگه تا انتهای خط تراز شده است. |
سایه زدن
سایه یک پاراگراف.
نمایندگی JSON |
---|
{
"backgroundColor": {
object ( |
فیلدها | |
---|---|
backgroundColor | رنگ پس زمینه این سایه پاراگراف. |
پیشنهادی پاراگراف استایل
تغییر پیشنهادی به یک ParagraphStyle
.
نمایندگی JSON |
---|
{ "paragraphStyle": { object ( |
فیلدها | |
---|---|
paragraphStyle | |
paragraphStyleSuggestionState | ماسک ای که نشان می دهد کدام یک از زمینه های موجود در |
پاراگراف
ماسک ای که نشان می دهد کدام یک از زمینه های موجود در 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 ( |
فیلدها | |
---|---|
headingIdSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
namedStyleTypeSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
alignmentSuggested | نشان می دهد که آیا تغییر پیشنهادی برای |
lineSpacingSuggested | نشان می دهد که آیا یک تغییر پیشنهادی در |
directionSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
spacingModeSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
spaceAboveSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
spaceBelowSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
borderBetweenSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
borderTopSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
borderBottomSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
borderLeftSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
borderRightSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
indentFirstLineSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
indentStartSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
indentEndSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
keepLinesTogetherSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
keepWithNextSuggested | نشان می دهد که آیا تغییر پیشنهادی برای |
avoidWidowAndOrphanSuggested | نشان می دهد که آیا یک تغییر پیشنهادی برای |
shadingSuggestionState | ماسک ای که نشان می دهد کدام یک از زمینه های |
pageBreakBeforeSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
ShadingsuggestionState
ماسک ای که نشان می دهد کدام یک از زمینه های Shading
پایه در این تغییر پیشنهادی تغییر یافته است. برای هر زمینه تنظیم شده ، یک مقدار پیشنهادی جدید وجود دارد.
نمایندگی JSON |
---|
{ "backgroundColorSuggested": boolean } |
فیلدها | |
---|---|
backgroundColorSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
گلوله
گلوله یک پاراگراف را توصیف می کند.
نمایندگی JSON |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
فیلدها | |
---|---|
listId | شناسه لیست این پاراگراف متعلق به آن است. |
nestingLevel | سطح لانه سازی این پاراگراف در لیست. |
textStyle | سبک متن خاص پاراگراف برای این گلوله اعمال می شود. |
پیشنهاد شده
تغییر پیشنهادی به یک Bullet
.
نمایندگی JSON |
---|
{ "bullet": { object ( |
فیلدها | |
---|---|
bullet | |
bulletSuggestionState | ماسک که نشان می دهد کدام یک از زمینه های موجود در |
BulletSuggestionState
ماسک که نشان می دهد کدام یک از زمینه های موجود در Bullet
پایه در این پیشنهاد تغییر یافته است. برای هر زمینه تنظیم شده ، یک مقدار پیشنهادی جدید وجود دارد.
نمایندگی JSON |
---|
{
"listIdSuggested": boolean,
"nestingLevelSuggested": boolean,
"textStyleSuggestionState": {
object ( |
فیلدها | |
---|---|
listIdSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
nestingLevelSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
textStyleSuggestionState | ماسک ای که نشان می دهد کدام یک از زمینه های |
عذاب
مجموعه ای از شناسه های شی.
نمایندگی JSON |
---|
{ "objectIds": [ string ] } |
فیلدها | |
---|---|
objectIds[] | IDS Object. |
بخشیدن
یک StructuralElement
که نمایانگر یک بخش است. یک بخش طیف وسیعی از مطالب است که دارای همان SectionStyle
است. یک بخش استراحت نشان دهنده شروع یک بخش جدید است و سبک بخش پس از استراحت بخش مربوط به بخش است.
بدنه سند همیشه با یک بخش استراحت شروع می شود.
نمایندگی JSON |
---|
{
"suggestedInsertionIds": [
string
],
"suggestedDeletionIds": [
string
],
"sectionStyle": {
object ( |
فیلدها | |
---|---|
suggestedInsertionIds[] | شناسه های درج پیشنهادی. اگر یک تغییر پیشنهادی تو در تو باشد ، ممکن است یک |
suggestedDeletionIds[] | شناسه های حذف پیشنهادی. اگر خالی باشد ، هیچ حذف پیشنهادی از این محتوا وجود ندارد. |
sectionStyle | سبک بخش پس از شکستن این بخش. |
بخش
یک ظاهر طراحی شده برای یک بخش اعمال می شود.
نمایندگی JSON |
---|
{ "columnProperties": [ { object ( |
فیلدها | |
---|---|
columnProperties[] | خصوصیات ستون بخش. در صورت خالی بودن ، این بخش شامل یک ستون با خصوصیات پیش فرض در ویرایشگر Docs است. یک بخش را می توان به روز کرد تا بیش از 3 ستون نداشته باشد. هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 خواهد شد. |
columnSeparatorStyle | سبک جداکننده های ستون. این سبک حتی در صورت وجود یک ستون در بخش قابل تنظیم است. هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود. |
contentDirection | جهت محتوای این بخش. در صورت عدم استفاده ، مقدار پیش فرض به هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود. |
marginTop | حاشیه صفحه بالای بخش. در صورت عدم استفاده ، مقدار پیش فرض از هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود. |
marginBottom | حاشیه صفحه پایین بخش. در صورت عدم استفاده ، مقدار پیش فرض به هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود. |
marginRight | حاشیه صفحه سمت راست بخش. در صورت عدم استفاده ، مقدار پیش فرض از هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود. |
marginLeft | حاشیه صفحه سمت چپ بخش. در صورت عدم استفاده ، مقدار پیش فرض از هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود. |
marginHeader | حاشیه هدر بخش. در صورت عدم استفاده ، مقدار پیش فرض به هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود. |
marginFooter | حاشیه پاورقی بخش. در صورت عدم استفاده ، مقدار پیش فرض به هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود. |
sectionType | فقط خروجی نوع بخش |
defaultHeaderId | شناسه هدر پیش فرض. در صورت عدم استفاده ، مقدار از بخش این خاصیت فقط خواندنی است. |
defaultFooterId | شناسه پاورقی پیش فرض. در صورت عدم استفاده ، مقدار از بخش این خاصیت فقط خواندنی است. |
firstPageHeaderId | شناسه هدر فقط برای صفحه اول بخش استفاده می شود. اگر این خاصیت فقط خواندنی است. |
firstPageFooterId | شناسه پاورقی فقط برای صفحه اول بخش استفاده می شود. اگر این خاصیت فقط خواندنی است. |
evenPageHeaderId | شناسه هدر فقط برای صفحات حتی استفاده می شد. اگر مقدار DocumentStyle's این خاصیت فقط خواندنی است. |
evenPageFooterId | شناسه پاورقی فقط برای صفحات حتی استفاده می شد. اگر مقدار DocumentStyle's این خاصیت فقط خواندنی است. |
useFirstPageHeaderFooter | نشان می دهد که آیا می توانید از صفحه اول / شناسه صفحه / صفحه برای صفحه اول بخش استفاده کنید. در صورت عدم استفاده ، آن را برای بخش اول از DocumentStyle's هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود. |
pageNumberStart | شماره صفحه ای که از آن می توانید تعداد صفحات این بخش را شروع کنید. در صورت عدم استفاده ، شماره گذاری صفحه از بخش قبلی ادامه می یابد. اگر مقدار در اولین هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود. |
flipPageOrientation | اختیاری. نشان می دهد که آیا می توانید ابعاد هنگام به روزرسانی این ویژگی ، تعیین مقدار مشخصی لازم است. عدم استفاده از این ویژگی منجر به خطای درخواست بد 400 می شود. |
بخش columnproperties
خواصی که در ستون یک بخش اعمال می شود.
نمایندگی JSON |
---|
{ "width": { object ( |
فیلدها | |
---|---|
width | فقط خروجی عرض ستون. |
paddingEnd | بالشتک در انتهای ستون. |
ستونهای ستونی
سبک جداکننده های ستون بین ستون ها.
Enums | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED | یک سبک جداکننده ستون نامشخص. |
NONE | بدون خط جداکننده ستون بین ستون ها. |
BETWEEN_EACH_COLUMN | یک خط جداکننده ستون بین هر ستون را ارائه می دهد. |
نوع
نشان می دهد که چگونه شروع بخش فعلی نسبت به بخش قبلی قرار گرفته است.
Enums | |
---|---|
SECTION_TYPE_UNSPECIFIED | نوع بخش نا مشخص است. |
CONTINUOUS | این بخش بلافاصله پس از آخرین بند بخش قبلی شروع می شود. |
NEXT_PAGE | بخش از صفحه بعد شروع می شود. |
جدول
یک StructuralElement
یک جدول را نشان می دهد.
نمایندگی JSON |
---|
{ "rows": integer, "columns": integer, "tableRows": [ { object ( |
فیلدها | |
---|---|
rows | تعداد ردیف های جدول. |
columns | تعداد ستون های جدول. این امکان وجود دارد که یک جدول غیر مستطیل باشد ، بنابراین برخی از ردیف ها ممکن است تعداد متفاوتی از سلول داشته باشند. |
tableRows[] | محتویات و سبک هر ردیف. |
suggestedInsertionIds[] | شناسه های درج پیشنهادی. اگر یک تغییر پیشنهادی تو در تو باشد ، یک |
suggestedDeletionIds[] | شناسه های حذف پیشنهادی. اگر خالی باشد ، هیچ حذف پیشنهادی از این محتوا وجود ندارد. |
tableStyle | سبک جدول. |
TableRow
محتویات و سبک یک ردیف در یک Table
.
نمایندگی JSON |
---|
{ "startIndex": integer, "endIndex": integer, "tableCells": [ { object ( |
فیلدها | |
---|---|
startIndex | شاخص شروع مبتنی بر صفر این ردیف ، در واحدهای کد UTF-16. |
endIndex | شاخص پایان صفر مبتنی بر این ردیف ، اختصاصی ، در واحدهای کد UTF-16. |
tableCells[] | محتویات و سبک هر سلول در این ردیف. این امکان وجود دارد که یک جدول غیر متمایز باشد ، بنابراین برخی از ردیف ها ممکن است تعداد متفاوتی از سلول ها نسبت به سایر ردیف ها در همان جدول داشته باشند. |
suggestedInsertionIds[] | شناسه های درج پیشنهادی. اگر یک تغییر پیشنهادی تو در تو باشد ، یک |
suggestedDeletionIds[] | شناسه های حذف پیشنهادی. اگر خالی باشد ، هیچ حذف پیشنهادی از این محتوا وجود ندارد. |
tableRowStyle | سبک ردیف جدول. |
suggestedTableRowStyleChanges | سبک پیشنهادی در این ردیف تغییر می کند ، که توسط شناسه پیشنهاد شده است. |
TableCell
محتویات و سبک یک سلول در یک Table
.
نمایندگی JSON |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
فیلدها | |
---|---|
startIndex | شاخص شروع مبتنی بر صفر این سلول ، در واحدهای کد UTF-16. |
endIndex | شاخص انتهایی مبتنی بر صفر این سلول ، اختصاصی ، در واحدهای کد UTF-16. |
content[] | محتوای سلول |
tableCellStyle | سبک سلول |
suggestedInsertionIds[] | شناسه های درج پیشنهادی. در صورت تغییر پیشنهادی تو در تو ، یک |
suggestedDeletionIds[] | شناسه های حذف پیشنهادی. اگر خالی باشد ، هیچ حذف پیشنهادی از این محتوا وجود ندارد. |
suggestedTableCellStyleChanges | تغییرات پیشنهادی در سبک سلول جدول ، که توسط شناسه پیشنهاد شده است. |
سفره سفالی
سبک یک TableCell
.
سبک های سلول جدول ارثی در این پیام به عنوان زمینه های UNSET نشان داده شده است. یک سبک سلول جدول می تواند از سبک جدول به ارث ببرد.
نمایندگی JSON |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
فیلدها | |
---|---|
rowSpan | دهانه ردیف سلول. این خاصیت فقط خواندنی است. |
columnSpan | دهانه ستون سلول. این خاصیت فقط خواندنی است. |
backgroundColor | رنگ پس زمینه سلول. |
borderLeft | مرز چپ سلول. |
borderRight | مرز مناسب سلول. |
borderTop | مرز بالای سلول. |
borderBottom | مرز پایین سلول. |
paddingLeft | بالشتک سمت چپ سلول. |
paddingRight | بالشتک مناسب سلول. |
paddingTop | بالشتک بالای سلول. |
paddingBottom | بالشتک پایین سلول. |
contentAlignment | تراز محتوای موجود در سلول جدول. تراز پیش فرض با تراز سلولهای جدول تازه ایجاد شده در ویرایشگر DOCS مطابقت دارد. |
سفره سفالی
حاشیه ای در اطراف یک سلول میز.
مرزهای سلول جدول نمی توانند شفاف باشند. برای مخفی کردن یک مرز سلول میز ، عرض آن 0 را درست کنید.
نمایندگی JSON |
---|
{ "color": { object ( |
فیلدها | |
---|---|
color | رنگ مرز. این رنگ نمی تواند شفاف باشد. |
width | عرض مرز. |
dashStyle | سبک خط مرز. |
محتوای محتوا
انواع تراز محتوا.
مشتق شده از زیر مجموعه ای از مقادیر "ST_TEXTANCHORGINGTYPE" نوع ساده در بخش 20.1.10.59 "فرمت های پرونده XML Office Open - اصول و مرجع زبان نشانه گذاری" ، قسمت 1 ECMA -376 چاپ 4 .
Enums | |
---|---|
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 | ماسک ای که نشان می دهد کدام یک از زمینه های موجود در |
سفره های سفالی
ماسک ای که نشان می دهد کدام یک از زمینه های موجود در 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 | نشان می دهد که آیا تغییر پیشنهادی در |
columnSpanSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
backgroundColorSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
borderLeftSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
borderRightSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
borderTopSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
borderBottomSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
paddingLeftSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
paddingRightSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
paddingTopSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
paddingBottomSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
contentAlignmentSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
سبک سفره
سبک هایی که برای یک ردیف جدول اعمال می شود.
نمایندگی JSON |
---|
{
"minRowHeight": {
object ( |
فیلدها | |
---|---|
minRowHeight | حداقل ارتفاع ردیف. این ردیف در ویرایشگر Docs در ارتفاع برابر یا بیشتر از این مقدار ارائه می شود تا تمام محتوای موجود در سلولهای ردیف را نشان دهد. |
tableHeader | آیا ردیف یک هدر جدول است. |
preventOverflow | این که آیا ردیف نمی تواند در مرزهای صفحه یا ستون سرریز شود. |
پیشنهاد شده
تغییر پیشنهادی در یک TableRowStyle
.
نمایندگی JSON |
---|
{ "tableRowStyle": { object ( |
فیلدها | |
---|---|
tableRowStyle | یک |
tableRowStyleSuggestionState | ماسک ای که نشان می دهد کدام یک از زمینه های موجود در |
TableRowstylesuggestState
ماسک ای که نشان می دهد کدام یک از زمینه های موجود در TableRowStyle
پایه در این پیشنهاد تغییر یافته است. برای هر زمینه تنظیم شده ، یک مقدار پیشنهادی جدید وجود دارد.
نمایندگی JSON |
---|
{ "minRowHeightSuggested": boolean } |
فیلدها | |
---|---|
minRowHeightSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
سبک سفره
سبک هایی که روی یک جدول اعمال می شود.
نمایندگی JSON |
---|
{
"tableColumnProperties": [
{
object ( |
فیلدها | |
---|---|
tableColumnProperties[] | خواص هر ستون. توجه داشته باشید که در اسناد ، جداول حاوی ردیف و ردیف ها حاوی سلول هایی هستند ، مشابه HTML. بنابراین خواص یک ردیف را می توان در |
سفره
خواص یک ستون در یک جدول.
نمایندگی JSON |
---|
{ "widthType": enum ( |
فیلدها | |
---|---|
widthType | نوع عرض ستون. |
width | عرض ستون. تنظیم کنید که |
نوع عرض
نوع عرض ستون.
Enums | |
---|---|
WIDTH_TYPE_UNSPECIFIED | نوع عرض ستون نامشخص است. |
EVENLY_DISTRIBUTED | عرض ستون به طور مساوی در بین ستون های دیگر به طور مساوی توزیع می شود. عرض ستون به طور خودکار تعیین می شود و پس از حسابداری برای کلیه ستون ها با عرض مشخص ، قسمت مساوی از عرض باقی مانده برای جدول را خواهد داشت. |
FIXED_WIDTH | عرض ستون ثابت. [Width] [ google.apps.docs.v1.TableColumnProperties.width Wwidth شامل عرض ستون است. |
میزهای جدول
StructuralElement
نمایانگر یک فهرست از مطالب است.
نمایندگی JSON |
---|
{
"content": [
{
object ( |
فیلدها | |
---|---|
content[] | محتوای فهرست مطالب. |
suggestedInsertionIds[] | شناسه های درج پیشنهادی. اگر یک تغییر پیشنهادی تو در تو باشد ، ممکن است یک میزهای مختلف |
suggestedDeletionIds[] | شناسه های حذف پیشنهادی. اگر خالی باشد ، هیچ حذف پیشنهادی از این محتوا وجود ندارد. |
سربرگ
یک هدر سند.
نمایندگی JSON |
---|
{
"headerId": string,
"content": [
{
object ( |
فیلدها | |
---|---|
headerId | شناسه هدر. |
content[] | محتوای هدر. شاخص های محتوای هدر از صفر شروع می شود. |
پاورقی
پاورقی سند.
نمایندگی JSON |
---|
{
"footnoteId": string,
"content": [
{
object ( |
فیلدها | |
---|---|
footnoteId | شناسه پاورقی. |
content[] | محتویات پاورقی. شاخص های محتوای پاورقی از صفر شروع می شود. |
سبک نامه
سبک سند.
نمایندگی JSON |
---|
{ "background": { object ( |
فیلدها | |
---|---|
background | پیشینه سند. اسناد نمی توانند رنگ پس زمینه شفاف داشته باشند. |
defaultHeaderId | شناسه هدر پیش فرض. اگر تنظیم نشده باشد ، هیچ هدر پیش فرض وجود ندارد. این خاصیت فقط خواندنی است. |
defaultFooterId | شناسه پاورقی پیش فرض. اگر تنظیم نشده باشد ، هیچ پاورقی پیش فرض وجود ندارد. این خاصیت فقط خواندنی است. |
evenPageHeaderId | شناسه هدر فقط برای صفحات حتی استفاده می شد. مقدار این خاصیت فقط خواندنی است. |
evenPageFooterId | شناسه پاورقی فقط برای صفحات حتی استفاده می شد. مقدار این خاصیت فقط خواندنی است. |
firstPageHeaderId | شناسه هدر فقط برای صفحه اول استفاده می شود. اگر تنظیم نشده باشد ، یک عنوان منحصر به فرد برای صفحه اول وجود ندارد. مقدار این خاصیت فقط خواندنی است. |
firstPageFooterId | شناسه پاورقی فقط برای صفحه اول استفاده می شود. اگر تنظیم نشده باشد ، یک پاورقی منحصر به فرد برای صفحه اول وجود ندارد. مقدار این خاصیت فقط خواندنی است. |
useFirstPageHeaderFooter | نشان می دهد که آیا می توان از صفحه اول / شناسه صفحه / صفحه برای صفحه اول استفاده کرد. |
useEvenPageHeaderFooter | نشان می دهد که آیا می توانید از شناسه های هدر / صفحه یکنواخت برای صفحات استفاده کنید. |
pageNumberStart | شماره صفحه ای که از آن می توانید تعداد صفحات را شروع کنید. |
marginTop | حاشیه صفحه بالا. به روزرسانی حاشیه صفحه برتر در سبک سند ، حاشیه صفحه بالای همه سبک های بخش را پاک می کند. |
marginBottom | حاشیه صفحه پایین. به روزرسانی حاشیه صفحه پایین در سبک سند حاشیه صفحه پایین را در تمام سبک های بخش پاک می کند. |
marginRight | حاشیه صفحه مناسب. به روزرسانی حاشیه صفحه مناسب در سبک سند ، حاشیه صفحه مناسب را در تمام سبک های بخش پاک می کند. همچنین ممکن است باعث تغییر اندازه ستون ها در همه بخش ها شود. |
marginLeft | حاشیه صفحه سمت چپ. به روزرسانی حاشیه صفحه سمت چپ در سبک سند حاشیه صفحه سمت چپ را در تمام سبک های بخش پاک می کند. همچنین ممکن است باعث تغییر اندازه ستون ها در همه بخش ها شود. |
pageSize | اندازه یک صفحه در سند. |
marginHeader | میزان فضای بین بالای صفحه و محتوای هدر. |
marginFooter | میزان فضای بین پایین صفحه و محتویات پاورقی. |
useCustomHeaderFooterMargins | نشان می دهد که آیا DocumentStyle این خاصیت فقط خواندنی است. |
flipPageOrientation | اختیاری. نشان می دهد که آیا باید ابعاد |
پس زمینه
پیشینه یک سند را نشان می دهد.
نمایندگی JSON |
---|
{
"color": {
object ( |
فیلدها | |
---|---|
color | رنگ پس زمینه |
اندازه
عرض و ارتفاع.
نمایندگی JSON |
---|
{ "height": { object ( |
فیلدها | |
---|---|
height | ارتفاع شی. |
width | عرض شی. |
پیشنهادی documentStyle
یک تغییر پیشنهادی در DocumentStyle
.
نمایندگی JSON |
---|
{ "documentStyle": { object ( |
فیلدها | |
---|---|
documentStyle | |
documentStyleSuggestionState | ماسک که نشان می دهد کدام یک از قسمت های موجود در |
DocumentStylesuggestionState
ماسک که نشان می دهد کدام یک از قسمت های موجود در DocumentStyle
پایه در این پیشنهاد تغییر یافته است. برای هر زمینه تنظیم شده ، یک مقدار پیشنهادی جدید وجود دارد.
نمایندگی JSON |
---|
{ "backgroundSuggestionState": { object ( |
فیلدها | |
---|---|
backgroundSuggestionState | ماسک ای که نشان می دهد کدام یک از زمینه های موجود در |
defaultHeaderIdSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
defaultFooterIdSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
evenPageHeaderIdSuggested | نشان می دهد که آیا یک تغییر پیشنهادی به |
evenPageFooterIdSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
firstPageHeaderIdSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
firstPageFooterIdSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
useFirstPageHeaderFooterSuggested | نشان می دهد که آیا یک تغییر پیشنهادی در |
useEvenPageHeaderFooterSuggested | نشان می دهد که آیا یک تغییر پیشنهادی برای |
pageNumberStartSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
marginTopSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
marginBottomSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
marginRightSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
marginLeftSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
pageSizeSuggestionState | ماسک ای که نشان می دهد کدام یک از زمینه ها در [اندازه] [google.apps.docs.v1.documentStyle.Size] در این پیشنهاد تغییر یافته است. |
marginHeaderSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
marginFooterSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
useCustomHeaderFooterMarginsSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
flipPageOrientationSuggested | اختیاری. نشان می دهد که آیا تغییر پیشنهادی به |
پیش زمینه
ماسک که نشان می دهد کدام یک از زمینه های موجود در Background
پایه در این پیشنهاد تغییر یافته است. برای هر زمینه ای که در True تنظیم شده است ، Backgound
یک مقدار پیشنهادی جدید دارد.
نمایندگی JSON |
---|
{ "backgroundColorSuggested": boolean } |
فیلدها | |
---|---|
backgroundColorSuggested | نشان می دهد که آیا رنگ پس زمینه فعلی در این پیشنهاد اصلاح شده است یا خیر. |
اندازه های UgegestionState
ماسک ای که نشان می دهد کدام یک از زمینه های Size
پایه در این پیشنهاد تغییر یافته است. برای هر زمینه تنظیم شده در True ، Size
یک مقدار پیشنهادی جدید دارد.
نمایندگی JSON |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
فیلدها | |
---|---|
heightSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
widthSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
نامگذاری شده
سبک های نامگذاری شده پاراگراف های موجود در این سند می توانند TextStyle
و ParagraphStyle
خود را از این سبک های نامگذاری شده به ارث ببرند.
نمایندگی JSON |
---|
{
"styles": [
{
object ( |
فیلدها | |
---|---|
styles[] | سبک های نامگذاری شده یک ورودی برای هر یک از |
نامگذاری شده
یک سبک نامگذاری شده پاراگراف های موجود در این سند می توانند در صورت داشتن همان نوع سبک نامگذاری شده TextStyle
و ParagraphStyle
خود را از این سبک نامگذاری شده به ارث ببرند.
نمایندگی JSON |
---|
{ "namedStyleType": enum ( |
فیلدها | |
---|---|
namedStyleType | نوع این سبک نامگذاری شده. |
textStyle | سبک متن این سبک نامگذاری شده. |
paragraphStyle | سبک پاراگراف این سبک نامگذاری شده. |
نامگذاری شده
یک تغییر پیشنهادی به NamedStyles
.
نمایندگی JSON |
---|
{ "namedStyles": { object ( |
فیلدها | |
---|---|
namedStyles | |
namedStylesSuggestionState | ماسک ای که نشان می دهد کدام یک از زمینه های |
نامگذاری شده
وضعیت پیشنهاد یک پیام NamedStyles
.
نمایندگی JSON |
---|
{
"stylesSuggestionStates": [
{
object ( |
فیلدها | |
---|---|
stylesSuggestionStates[] | ماسک ای که نشان می دهد کدام یک از زمینه های موجود در استایل ترتیب این پیشنهادات به سبک نامگذاری شده با ترتیب سبک نامگذاری شده مربوطه در پیشنهاد |
نامگذاری شده است
وضعیت پیشنهادی از یک پیام NamedStyle
.
نمایندگی JSON |
---|
{ "namedStyleType": enum ( |
فیلدها | |
---|---|
namedStyleType | نوع سبک نامگذاری شده که این وضعیت پیشنهاد با آن مطابقت دارد. این زمینه به عنوان راحتی برای تطبیق نامگذاری شده با نام StyleSuggestionState با |
textStyleSuggestionState | ماسک ای که نشان می دهد کدام یک از زمینه های |
paragraphStyleSuggestionState | ماسک ای که نشان می دهد کدام یک از زمینه های |
فهرست کنید
یک لیست ویژگی های لیست را برای گروهی از پاراگراف ها نشان می دهد که همه متعلق به یک لیست هستند. پاراگراف که بخشی از یک لیست است ، اشاره ای به شناسه لیست در bullet
آن دارد.
نمایندگی JSON |
---|
{ "listProperties": { object ( |
فیلدها | |
---|---|
listProperties | خصوصیات لیست. |
suggestedListPropertiesChanges | تغییرات پیشنهادی در خصوصیات لیست ، که توسط شناسه پیشنهاد شده است. |
suggestedInsertionId | شناسه درج پیشنهادی. اگر خالی باشد ، این یک درج پیشنهادی نیست. |
suggestedDeletionIds[] | شناسه های حذف پیشنهادی. اگر خالی باشد ، هیچ حذف پیشنهادی از این لیست وجود ندارد. |
ListProperties
خواص list
که ظاهر و احساس گلوله های متعلق به پاراگراف های مرتبط با یک لیست را توصیف می کند.
نمایندگی JSON |
---|
{
"nestingLevels": [
{
object ( |
فیلدها | |
---|---|
nestingLevels[] | خصوصیات گلوله ها را در سطح مرتبط توصیف می کند. یک لیست حداکثر 9 سطح لانه سازی با سطح لانه سازی 0 متناسب با سطح بالاترین سطح و سطح لانه سازی 8 مربوط به سطح تو در تو است. سطح لانه سازی به ترتیب صعودی با کمترین برگشتی که در ابتدا برگشت داده می شود ، بازگردانده می شوند. |
با روکش سطحی
شامل خواصی است که ظاهر و احساس یک گلوله لیست را در سطح معینی از لانه سازی توصیف می کند.
نمایندگی JSON |
---|
{ "bulletAlignment": enum ( |
فیلدها | |
---|---|
bulletAlignment | تراز گلوله در فضا که برای ارائه گلوله اختصاص یافته است. |
glyphFormat | رشته فرمت استفاده شده توسط گلوله ها در این سطح از لانه سازی. فرمت Glyph شامل یک یا چند صاحب مکان است و این مکان ها بسته به به عنوان مثال ، قالب Glyph فرمت گلیف می تواند دارای متغیرها برای سطح لانه سازی فعلی و همچنین متغیرها برای سطح لانه سازی والدین باشد. For example, a list can have a glyph format of 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 | The amount of indentation for the first line of paragraphs at this level of nesting. |
indentStart | 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 | The text style of bullets at this level of nesting. |
startNumber | 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 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 | 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 |
glyphSymbol | A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the |
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 | یک رشته خالی |
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 | A |
listPropertiesSuggestionState | A mask that indicates which of the fields on the base |
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 ( |
فیلدها | |
---|---|
nestingLevelsSuggestionStates[] | A mask that indicates which of the fields on the corresponding 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 ( |
فیلدها | |
---|---|
bulletAlignmentSuggested | Indicates if there was a suggested change to |
glyphTypeSuggested | Indicates if there was a suggested change to |
glyphFormatSuggested | Indicates if there was a suggested change to |
glyphSymbolSuggested | Indicates if there was a suggested change to |
indentFirstLineSuggested | Indicates if there was a suggested change to |
indentStartSuggested | Indicates if there was a suggested change to |
textStyleSuggestionState | A mask that indicates which of the fields in |
startNumberSuggested | Indicates if there was a suggested change to |
NamedRanges
A collection of all the NamedRange
s in the document that share a given name.
JSON representation |
---|
{
"name": string,
"namedRanges": [
{
object ( |
فیلدها | |
---|---|
name | The name that all the |
namedRanges[] | The |
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 ( |
فیلدها | |
---|---|
namedRangeId | The ID of the named range. |
name | The name of the named range. |
ranges[] | 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 | The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. |
startIndex | 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 | 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 | The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab:
In a document containing multiple tabs:
|
InlineObject
An object that appears inline with text. An InlineObject contains an EmbeddedObject
such as an image.
JSON representation |
---|
{ "objectId": string, "inlineObjectProperties": { object ( |
فیلدها | |
---|---|
objectId | The ID of this inline object. Can be used to update an object's properties. |
inlineObjectProperties | The properties of this inline object. |
suggestedInlineObjectPropertiesChanges | The suggested changes to the inline object properties, keyed by suggestion ID. |
suggestedInsertionId | The suggested insertion ID. If empty, then this is not a suggested insertion. |
suggestedDeletionIds[] | 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 | The embedded object of this inline object. |
EmbeddedObject
An embedded object in the document.
JSON representation |
---|
{ "title": string, "description": string, "embeddedObjectBorder": { object ( |
فیلدها | |
---|---|
title | The title of the embedded object. The |
description | The description of the embedded object. The |
embeddedObjectBorder | The border of the embedded object. |
size | The visible size of the image after cropping. |
marginTop | The top margin of the embedded object. |
marginBottom | The bottom margin of the embedded object. |
marginRight | The right margin of the embedded object. |
marginLeft | The left margin of the embedded 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 | The properties of an embedded drawing. |
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 ( |
فیلدها | |
---|---|
contentUri | 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 | The source URI is the URI used to insert the image. The source URI can be empty. |
brightness | The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. |
contrast | The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. |
transparency | 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 | The crop properties of the image. |
angle | 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 | 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 | 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 | 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 | 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 | 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 ( |
فیلدها | |
---|---|
color | The color of the border. |
width | The width of the border. |
dashStyle | The dash style of the border. |
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 |
فیلدها | |
---|---|
Union field reference . The reference specific to the type of linked content. reference can be only one of the following: | |
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 | The ID of the Google Sheets spreadsheet that contains the source chart. |
chartId | 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 | An |
inlineObjectPropertiesSuggestionState | A mask that indicates which of the fields on the base |
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 | A mask that indicates which of the fields in |
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 | A mask that indicates which of the fields in |
imagePropertiesSuggestionState | A mask that indicates which of the fields in |
titleSuggested | Indicates if there was a suggested change to |
descriptionSuggested | Indicates if there was a suggested change to |
embeddedObjectBorderSuggestionState | A mask that indicates which of the fields in |
sizeSuggestionState | A mask that indicates which of the fields in |
marginLeftSuggested | Indicates if there was a suggested change to |
marginRightSuggested | Indicates if there was a suggested change to |
marginTopSuggested | Indicates if there was a suggested change to |
marginBottomSuggested | Indicates if there was a suggested change to |
linkedContentReferenceSuggestionState | A mask that indicates which of the fields in |
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 ( |
فیلدها | |
---|---|
contentUriSuggested | Indicates if there was a suggested change to |
sourceUriSuggested | Indicates if there was a suggested change to [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri]. |
brightnessSuggested | Indicates if there was a suggested change to [brightness] [google.apps.docs.v1.EmbeddedObject.brightness]. |
contrastSuggested | Indicates if there was a suggested change to [contrast] [google.apps.docs.v1.EmbeddedObject.contrast]. |
transparencySuggested | Indicates if there was a suggested change to [transparency] [google.apps.docs.v1.EmbeddedObject.transparency]. |
cropPropertiesSuggestionState | A mask that indicates which of the fields in |
angleSuggested | 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 | Indicates if there was a suggested change to |
offsetRightSuggested | Indicates if there was a suggested change to |
offsetTopSuggested | Indicates if there was a suggested change to |
offsetBottomSuggested | Indicates if there was a suggested change to |
angleSuggested | Indicates if there was a suggested change to |
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 | Indicates if there was a suggested change to [color] [google.apps.docs.v1.EmbeddedBorderObject.color]. |
widthSuggested | Indicates if there was a suggested change to [width] [google.apps.docs.v1.EmbeddedBorderObject.width]. |
dashStyleSuggested | Indicates if there was a suggested change to [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style]. |
propertyStateSuggested | 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 | A mask that indicates which of the fields in |
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 | Indicates if there was a suggested change to |
chartIdSuggested | Indicates if there was a suggested change to |
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 ( |
فیلدها | |
---|---|
objectId | The ID of this positioned object. |
positionedObjectProperties | The properties of this positioned object. |
suggestedPositionedObjectPropertiesChanges | The suggested changes to the positioned object properties, keyed by suggestion ID. |
suggestedInsertionId | The suggested insertion ID. If empty, then this is not a suggested insertion. |
suggestedDeletionIds[] | The suggested deletion IDs. If empty, then there are no suggested deletions of this content. |
PositionedObjectProperties
Properties of a PositionedObject
.
JSON representation |
---|
{ "positioning": { object ( |
فیلدها | |
---|---|
positioning | The positioning of this positioned object relative to the newline of the |
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 ( |
فیلدها | |
---|---|
layout | The layout of this positioned object. |
leftOffset | The offset of the left edge of the positioned object relative to the beginning of the |
topOffset | The offset of the top edge of the positioned object relative to the beginning of the |
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 | A |
positionedObjectPropertiesSuggestionState | A mask that indicates which of the fields on the base |
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 ( |
فیلدها | |
---|---|
positioningSuggestionState | A mask that indicates which of the fields in |
embeddedObjectSuggestionState | A mask that indicates which of the fields in |
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 | Indicates if there was a suggested change to |
leftOffsetSuggested | Indicates if there was a suggested change to |
topOffsetSuggested | Indicates if there was a suggested change to |
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. |
روش ها | |
---|---|
| Applies one or more updates to the document. |
| Creates a blank document using the title given in the request. |
| Gets the latest version of the specified document. |