- منبع: سند
- بدن
- عنصر ساختاری
- پاراگراف
- عنصر پاراگراف
- TextRun
- TextStyle
- رنگ اختیاری
- رنگ
- RgbColor
- بعد، ابعاد، اندازه
- واحد
- WeightedFontFamily
- آفست پایه
- ارتباط دادن
- SuggestedTextStyle
- TextStyleSuggestionState
- متن خودکار
- تایپ کنید
- Page Break
- ColumnBreak
- پانوشت مرجع
- قانون افقی
- معادله
- InlineObjectElement
- شخص
- ویژگی های شخص
- RichLink
- RichLinkProperties
- سبک پاراگراف
- NamedStyleType
- هم ترازی
- جهت محتوا
- فاصله فاصله
- ParagraphBorder
- DashStyle
- TabStop
- TabStopAlignment
- سایه زدن
- سبک پاراگراف پیشنهادی
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- گلوله
- Bullet Suggested
- BulletSuggestionState
- ObjectReferences
- بخش شکست
- بخش سبک
- SectionColumnProperties
- ColumnSeparatorStyle
- نوع بخش
- جدول
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- تراز محتوا
- SuggestedTableCellStyle
- TableCellStyleSuggestionState
- TableRowStyle
- پیشنهاد TableRowStyle
- TableRowStyleSuggestionState
- TableStyle
- TableColumnProperties
- WidthType
- فهرست مطالب
- سرتیتر
- پاورقی
- پاورقی
- DocumentStyle
- زمینه
- اندازه
- SuggestedDocumentStyle
- DocumentStyleSuggestionState
- پس زمینه پیشنهاد دولت
- SizeSuggestionState
- NamedStyles
- NamedStyle
- SuggestedNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- فهرست کنید
- ListProperties
- NestingLevel
- گلوله تراز
- GlyphType
- Properties SuggestedList
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- Named Ranges
- Named Range
- دامنه
- SuggestionsViewMode
- 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
- مواد و روش ها
منبع: سند
یک سند Google Docs.
نمایندگی JSON |
---|
{ "documentId": string, "title": string, "body": { object ( |
زمینه های | |
---|---|
documentId | فقط خروجی شناسه سند. |
title | عنوان سند. |
body | فقط خروجی بدنه اصلی سند. |
headers | فقط خروجی سرصفحه های موجود در سند، با شناسه سرصفحه کلید شده اند. |
footers | فقط خروجی پاورقی های موجود در سند، با شناسه پاورقی کلید زده می شوند. |
footnotes | فقط خروجی پاورقی های موجود در سند، با شناسه پاورقی کلید زده شده اند. |
documentStyle | فقط خروجی سبک سند. |
suggestedDocumentStyleChanges | فقط خروجی تغییرات پیشنهادی در سبک سند، با شناسه پیشنهاد کلید زده شده است. |
namedStyles | فقط خروجی سبک های نامگذاری شده سند. |
suggestedNamedStylesChanges | فقط خروجی تغییرات پیشنهادی در سبک های نامگذاری شده سند، با شناسه پیشنهاد کلید زده شده است. |
lists | فقط خروجی فهرستهای موجود در سند، با شناسه فهرست کلید زده میشوند. |
namedRanges | فقط خروجی محدوده های نامگذاری شده در سند، با نام کلید شده است. |
revisionId | فقط خروجی شناسه ویرایش سند. میتواند در درخواستهای بهروزرسانی استفاده شود تا مشخص شود که در کدام یک از ویرایشهای یک سند، بهروزرسانیها اعمال شود و اگر سند از آن تجدیدنظر ویرایش شده است، چگونه باید رفتار کند. فقط در صورتی پر می شود که کاربر دسترسی ویرایش به سند داشته باشد. شناسه تجدیدنظر یک عدد متوالی نیست بلکه یک رشته مات است. قالب شناسه بازبینی ممکن است در طول زمان تغییر کند. شناسه بازگردانی شده فقط تا 24 ساعت پس از بازگرداندن آن تضمین شده است که اعتبار دارد و نمیتوان آن را بین کاربران به اشتراک گذاشت. اگر شناسه بازبینی بین تماس ها تغییر نکرده باشد، سند تغییر نکرده است. برعکس، شناسه تغییر یافته (برای همان سند و کاربر) معمولاً به این معنی است که سند به روز شده است. با این حال، تغییر شناسه می تواند به دلیل عوامل داخلی مانند تغییر فرمت شناسه نیز باشد. |
suggestionsViewMode | فقط خروجی حالت نمایش پیشنهادات روی سند اعمال شد. توجه: هنگام ویرایش یک سند، تغییرات باید بر اساس سندی با |
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 خارجی |
bookmarkId | شناسه یک نشانک در این سند. |
headingId | شناسه یک عنوان در این سند. |
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[] | فهرستی از برگه ها برای این پاراگراف متوقف می شود. لیستی از tab stop ها به ارث نمی رسد. این ویژگی فقط خواندنی است. |
keepLinesTogether | در صورت امکان، تمام خطوط پاراگراف باید در یک صفحه یا ستون قرار داده شوند یا خیر. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد. |
keepWithNext | در صورت امکان حداقل بخشی از این پاراگراف باید در همان صفحه یا ستون پاراگراف بعدی قرار گیرد یا خیر. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد. |
avoidWidowAndOrphan | آیا برای پاراگراف از زنان بیوه و یتیم اجتناب شود. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد. |
shading | سایه زنی پاراگراف. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد. |
pageBreakBefore | آیا پاراگراف فعلی باید همیشه از ابتدای یک صفحه شروع شود یا خیر. اگر تنظیم نشده باشد، مقدار از والد به ارث می رسد. تلاش برای بهروزرسانی |
NamedStyleType
انواع سبک های نامگذاری شده
Enums | |
---|---|
NAMED_STYLE_TYPE_UNSPECIFIED | نوع سبک نامگذاری شده نامشخص است. |
NORMAL_TEXT | متن معمولی |
TITLE | عنوان. |
SUBTITLE | عنوان فرعی. |
HEADING_1 | سرفصل 1. |
HEADING_2 | سرفصل 2. |
HEADING_3 | سرفصل 3. |
HEADING_4 | سرفصل 4. |
HEADING_5 | سرفصل 5. |
HEADING_6 | سرفصل 6. |
هم ترازی
انواع تراز متن برای یک پاراگراف
Enums | |
---|---|
ALIGNMENT_UNSPECIFIED | تراز پاراگراف از والد به ارث می رسد. |
START | پاراگراف با شروع خط تراز شده است. تراز چپ برای متن LTR، در غیر این صورت تراز راست. |
CENTER | پاراگراف در مرکز قرار دارد. |
END | پاراگراف تا آخر خط تراز شده است. تراز راست برای متن LTR، در غیر این صورت تراز چپ. |
JUSTIFIED | پاراگراف توجیه شده است. |
جهت محتوا
جهتهایی که محتوا میتواند در آن جریان یابد.
Enums | |
---|---|
CONTENT_DIRECTION_UNSPECIFIED | جهت محتوا مشخص نشده است. |
LEFT_TO_RIGHT | محتوا از چپ به راست می رود. |
RIGHT_TO_LEFT | محتوا از راست به چپ می رود. |
فاصله فاصله
حالت های مختلف برای فاصله پاراگراف.
Enums | |
---|---|
SPACING_MODE_UNSPECIFIED | حالت فاصله از والد به ارث رسیده است. |
NEVER_COLLAPSE | فاصله پاراگراف ها همیشه ارائه می شود. |
COLLAPSE_LISTS | فاصله پاراگراف بین عناصر لیست حذف می شود. |
ParagraphBorder
یک حاشیه در اطراف یک پاراگراف.
نمایندگی JSON |
---|
{ "color": { object ( |
زمینه های | |
---|---|
color | رنگ حاشیه. |
width | عرض حاشیه. |
padding | لایه بندی حاشیه. |
dashStyle | سبک خط تیره حاشیه. |
DashStyle
انواع خط تیره هایی که هندسه خطی را می توان با آنها ارائه کرد. این مقادیر بر اساس نوع ساده "ST_PresetLineDashVal" شرح داده شده در بخش 20.1.10.48 "فرمتهای فایل XML باز آفیس - مبانی و مرجع زبان نشانهگذاری"، بخش 1 از ویرایش چهارم ECMA-376 هستند.
Enums | |
---|---|
DASH_STYLE_UNSPECIFIED | سبک خط تیره نامشخص. |
SOLID | خط توپر. مربوط به ECMA-376 ST_PresetLineDashVal مقدار 'solid' است. این سبک خط تیره پیش فرض است. |
DOT | خط نقطه چین. مربوط به ECMA-376 ST_PresetLineDashVal مقدار 'dot' است. |
DASH | خط بریده بریده. با مقدار ECMA-376 ST_PresetLineDashVal 'dash' مطابقت دارد. |
TabStop
توقف برگه در یک پاراگراف.
نمایندگی JSON |
---|
{ "offset": { object ( |
زمینه های | |
---|---|
offset | فاصله بین این tab stop و حاشیه شروع. |
alignment | تراز این برگه متوقف می شود. اگر تنظیم نشود، مقدار پیشفرض روی |
TabStopAlignment
ترازبندی نقطه زبانه.
Enums | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED | ترازبندی tab stop نامشخص است. |
START | tab stop با شروع خط تراز شده است. این پیش فرض است. |
CENTER | نقطه برگه در مرکز خط تراز شده است. |
END | tab stop تا انتهای خط تراز شده است. |
سایه زدن
سایه زدن یک پاراگراف
نمایندگی JSON |
---|
{
"backgroundColor": {
object ( |
زمینه های | |
---|---|
backgroundColor | رنگ پس زمینه این پاراگراف سایه می زند. |
سبک پاراگراف پیشنهادی
یک تغییر پیشنهادی به یک ParagraphStyle
.
نمایندگی JSON |
---|
{ "paragraphStyle": { object ( |
زمینه های | |
---|---|
paragraphStyle | یک |
paragraphStyleSuggestionState | ماسکی که نشان میدهد کدام یک از فیلدهای |
ParagraphStyleSuggestionState
ماسکی که نشان میدهد کدام یک از فیلدهای ParagraphStyle
در این پیشنهاد تغییر کرده است. برای هر فیلدی که روی true تنظیم شده است، یک مقدار پیشنهادی جدید وجود دارد.
نمایندگی JSON |
---|
{
"headingIdSuggested": boolean,
"namedStyleTypeSuggested": boolean,
"alignmentSuggested": boolean,
"lineSpacingSuggested": boolean,
"directionSuggested": boolean,
"spacingModeSuggested": boolean,
"spaceAboveSuggested": boolean,
"spaceBelowSuggested": boolean,
"borderBetweenSuggested": boolean,
"borderTopSuggested": boolean,
"borderBottomSuggested": boolean,
"borderLeftSuggested": boolean,
"borderRightSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"indentEndSuggested": boolean,
"keepLinesTogetherSuggested": boolean,
"keepWithNextSuggested": boolean,
"avoidWidowAndOrphanSuggested": boolean,
"shadingSuggestionState": {
object ( |
زمینه های | |
---|---|
headingIdSuggested | نشان می دهد که آیا تغییر پیشنهادی برای |
namedStyleTypeSuggested | نشان می دهد که آیا تغییر پیشنهادی برای |
alignmentSuggested | نشان می دهد که آیا تغییر پیشنهادی برای |
lineSpacingSuggested | نشان می دهد که آیا تغییر پیشنهادی برای |
directionSuggested | نشان می دهد که آیا تغییر |
spacingModeSuggested | نشان میدهد که آیا تغییر پیشنهادی در |
spaceAboveSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
spaceBelowSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
borderBetweenSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
borderTopSuggested | نشان می دهد که آیا تغییری در |
borderBottomSuggested | نشان می دهد که آیا تغییری به |
borderLeftSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
borderRightSuggested | نشان می دهد که آیا تغییری به |
indentFirstLineSuggested | نشان می دهد که آیا تغییر پیشنهادی برای |
indentStartSuggested | نشان می دهد که آیا تغییر پیشنهادی برای |
indentEndSuggested | نشان می دهد که آیا تغییری برای |
keepLinesTogetherSuggested | نشان می دهد که آیا تغییر پیشنهادی برای |
keepWithNextSuggested | نشان می دهد که آیا تغییری برای |
avoidWidowAndOrphanSuggested | نشان می دهد که آیا تغییر پیشنهادی برای |
shadingSuggestionState | ماسکی که نشان می دهد کدام یک از فیلدهای |
pageBreakBeforeSuggested | نشان می دهد که آیا تغییر پیشنهادی به |
ShadingSuggestionState
ماسکی که نشان میدهد در این تغییر پیشنهادی کدام یک از فیلدهای روی پایه Shading
تغییر کرده است. برای هر فیلدی که روی true تنظیم شده است، یک مقدار پیشنهادی جدید وجود دارد.
نمایندگی JSON |
---|
{ "backgroundColorSuggested": boolean } |
زمینه های | |
---|---|
backgroundColorSuggested | نشان می دهد که آیا تغییر پیشنهادی در |
گلوله
گلوله یک پاراگراف را توصیف می کند.
نمایندگی JSON |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
زمینه های | |
---|---|
listId | شناسه فهرستی که این پاراگراف به آن تعلق دارد. |
nestingLevel | سطح تودرتو این پاراگراف در لیست. |
textStyle | سبک متن خاص پاراگراف برای این گلوله اعمال می شود. |
گلوله پیشنهادی
یک تغییر پیشنهادی به یک Bullet
.
نمایندگی JSON |
---|
{ "bullet": { object ( |
زمینه های | |
---|---|
bullet | |
bulletSuggestionState | ماسکی که نشان می دهد کدام یک از فیلدهای |
BulletSuggestionState
A mask that indicates which of the fields on the base Bullet
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON representation |
---|
{
"listIdSuggested": boolean,
"nestingLevelSuggested": boolean,
"textStyleSuggestionState": {
object ( |
زمینه های | |
---|---|
listIdSuggested | Indicates if there was a suggested change to the |
nestingLevelSuggested | Indicates if there was a suggested change to the |
textStyleSuggestionState | A mask that indicates which of the fields in |
ObjectReferences
A collection of object IDs.
JSON representation |
---|
{ "objectIds": [ string ] } |
زمینه های | |
---|---|
objectIds[] | The object IDs. |
SectionBreak
A StructuralElement
representing a section break. A section is a range of content that has the same SectionStyle
. A section break represents the start of a new section, and the section style applies to the section after the section break.
The document body always begins with a section break.
JSON representation |
---|
{
"suggestedInsertionIds": [
string
],
"suggestedDeletionIds": [
string
],
"sectionStyle": {
object ( |
زمینه های | |
---|---|
suggestedInsertionIds[] | The suggested insertion IDs. A |
suggestedDeletionIds[] | The suggested deletion IDs. If empty, then there are no suggested deletions of this content. |
sectionStyle | The style of the section after this section break. |
SectionStyle
The styling that applies to a section.
JSON representation |
---|
{ "columnProperties": [ { object ( |
زمینه های | |
---|---|
columnProperties[] | The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. |
columnSeparatorStyle | The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
contentDirection | The content direction of this section. If unset, the value defaults to When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
marginTop | The top page margin of the section. If unset, the value defaults to When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
marginBottom | The bottom page margin of the section. If unset, the value defaults to When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
marginRight | The right page margin of the section. If unset, the value defaults to When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
marginLeft | The left page margin of the section. If unset, the value defaults to When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
marginHeader | The header margin of the section. If unset, the value defaults to When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
marginFooter | The footer margin of the section. If unset, the value defaults to When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
sectionType | فقط خروجی The type of section. |
defaultHeaderId | The ID of the default header. If unset, the value inherits from the previous This property is read-only. |
defaultFooterId | The ID of the default footer. If unset, the value inherits from the previous This property is read-only. |
firstPageHeaderId | The ID of the header used only for the first page of the section. If This property is read-only. |
firstPageFooterId | The ID of the footer used only for the first page of the section. If This property is read-only. |
evenPageHeaderId | The ID of the header used only for even pages. If the value of DocumentStyle's This property is read-only. |
evenPageFooterId | The ID of the footer used only for even pages. If the value of DocumentStyle's This property is read-only. |
useFirstPageHeaderFooter | Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
pageNumberStart | The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
flipPageOrientation | اختیاری. Indicates whether to flip the dimensions of DocumentStyle's When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
SectionColumnProperties
Properties that apply to a section's column.
JSON representation |
---|
{ "width": { object ( |
زمینه های | |
---|---|
width | فقط خروجی The width of the column. |
paddingEnd | The padding at the end of the column. |
ColumnSeparatorStyle
The style of column separators between columns.
Enums | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED | An unspecified column separator style. |
NONE | No column separator lines between columns. |
BETWEEN_EACH_COLUMN | Renders a column separator line between each column. |
SectionType
Represents how the start of the current section is positioned relative to the previous section.
Enums | |
---|---|
SECTION_TYPE_UNSPECIFIED | The section type is unspecified. |
CONTINUOUS | The section starts immediately after the last paragraph of the previous section. |
NEXT_PAGE | The section starts on the next page. |
Table
A StructuralElement
representing a table.
JSON representation |
---|
{ "rows": integer, "columns": integer, "tableRows": [ { object ( |
زمینه های | |
---|---|
rows | Number of rows in the table. |
columns | Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. |
tableRows[] | The contents and style of each row. |
suggestedInsertionIds[] | The suggested insertion IDs. A |
suggestedDeletionIds[] | The suggested deletion IDs. If empty, then there are no suggested deletions of this content. |
tableStyle | The style of the table. |
TableRow
The contents and style of a row in a Table
.
JSON representation |
---|
{ "startIndex": integer, "endIndex": integer, "tableCells": [ { object ( |
زمینه های | |
---|---|
startIndex | The zero-based start index of this row, in UTF-16 code units. |
endIndex | The zero-based end index of this row, exclusive, in UTF-16 code units. |
tableCells[] | The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. |
suggestedInsertionIds[] | The suggested insertion IDs. A |
suggestedDeletionIds[] | The suggested deletion IDs. If empty, then there are no suggested deletions of this content. |
tableRowStyle | The style of the table row. |
suggestedTableRowStyleChanges | The suggested style changes to this row, keyed by suggestion ID. |
TableCell
The contents and style of a cell in a Table
.
JSON representation |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
زمینه های | |
---|---|
startIndex | The zero-based start index of this cell, in UTF-16 code units. |
endIndex | The zero-based end index of this cell, exclusive, in UTF-16 code units. |
content[] | The content of the cell. |
tableCellStyle | The style of the cell. |
suggestedInsertionIds[] | The suggested insertion IDs. A |
suggestedDeletionIds[] | The suggested deletion IDs. If empty, then there are no suggested deletions of this content. |
suggestedTableCellStyleChanges | The suggested changes to the table cell style, keyed by suggestion ID. |
TableCellStyle
The style of a TableCell
.
Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style.
JSON representation |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
زمینه های | |
---|---|
rowSpan | The row span of the cell. This property is read-only. |
columnSpan | The column span of the cell. This property is read-only. |
backgroundColor | The background color of the cell. |
borderLeft | The left border of the cell. |
borderRight | The right border of the cell. |
borderTop | The top border of the cell. |
borderBottom | The bottom border of the cell. |
paddingLeft | The left padding of the cell. |
paddingRight | The right padding of the cell. |
paddingTop | The top padding of the cell. |
paddingBottom | The bottom padding of the cell. |
contentAlignment | The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. |
TableCellBorder
A border around a table cell.
Table cell borders cannot be transparent. To hide a table cell border, make its width 0.
JSON representation |
---|
{ "color": { object ( |
زمینه های | |
---|---|
color | The color of the border. This color cannot be transparent. |
width | The width of the border. |
dashStyle | The dash style of the border. |
ContentAlignment
The types of content alignment.
Derived from a subset of the values of the "ST_TextAnchoringType" simple type in section 20.1.10.59 of "Office Open XML File Formats - Fundamentals and Markup Language Reference", part 1 of ECMA-376 4th edition .
Enums | |
---|---|
CONTENT_ALIGNMENT_UNSPECIFIED | An unspecified content alignment. The content alignment is inherited from the parent if one exists. |
CONTENT_ALIGNMENT_UNSUPPORTED | An unsupported content alignment. |
TOP | An alignment that aligns the content to the top of the content holder. Corresponds to ECMA-376 ST_TextAnchoringType 't'. |
MIDDLE | An alignment that aligns the content to the middle of the content holder. Corresponds to ECMA-376 ST_TextAnchoringType 'ctr'. |
BOTTOM | An alignment that aligns the content to the bottom of the content holder. Corresponds to ECMA-376 ST_TextAnchoringType 'b'. |
SuggestedTableCellStyle
A suggested change to a TableCellStyle
.
JSON representation |
---|
{ "tableCellStyle": { object ( |
زمینه های | |
---|---|
tableCellStyle | A |
tableCellStyleSuggestionState | A mask that indicates which of the fields on the base |
TableCellStyleSuggestionState
A mask that indicates which of the fields on the base TableCellStyle
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON representation |
---|
{ "rowSpanSuggested": boolean, "columnSpanSuggested": boolean, "backgroundColorSuggested": boolean, "borderLeftSuggested": boolean, "borderRightSuggested": boolean, "borderTopSuggested": boolean, "borderBottomSuggested": boolean, "paddingLeftSuggested": boolean, "paddingRightSuggested": boolean, "paddingTopSuggested": boolean, "paddingBottomSuggested": boolean, "contentAlignmentSuggested": boolean } |
زمینه های | |
---|---|
rowSpanSuggested | Indicates if there was a suggested change to |
columnSpanSuggested | Indicates if there was a suggested change to |
backgroundColorSuggested | Indicates if there was a suggested change to |
borderLeftSuggested | Indicates if there was a suggested change to |
borderRightSuggested | Indicates if there was a suggested change to |
borderTopSuggested | Indicates if there was a suggested change to |
borderBottomSuggested | Indicates if there was a suggested change to |
paddingLeftSuggested | Indicates if there was a suggested change to |
paddingRightSuggested | Indicates if there was a suggested change to |
paddingTopSuggested | Indicates if there was a suggested change to |
paddingBottomSuggested | Indicates if there was a suggested change to |
contentAlignmentSuggested | Indicates if there was a suggested change to |
TableRowStyle
Styles that apply to a table row.
JSON representation |
---|
{
"minRowHeight": {
object ( |
زمینه های | |
---|---|
minRowHeight | The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. |
tableHeader | Whether the row is a table header. |
preventOverflow | Whether the row cannot overflow across page or column boundaries. |
SuggestedTableRowStyle
A suggested change to a TableRowStyle
.
JSON representation |
---|
{ "tableRowStyle": { object ( |
زمینه های | |
---|---|
tableRowStyle | A |
tableRowStyleSuggestionState | A mask that indicates which of the fields on the base |
TableRowStyleSuggestionState
A mask that indicates which of the fields on the base TableRowStyle
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON representation |
---|
{ "minRowHeightSuggested": boolean } |
زمینه های | |
---|---|
minRowHeightSuggested | Indicates if there was a suggested change to |
TableStyle
Styles that apply to a table.
JSON representation |
---|
{
"tableColumnProperties": [
{
object ( |
زمینه های | |
---|---|
tableColumnProperties[] | The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's |
TableColumnProperties
The properties of a column in a table.
JSON representation |
---|
{ "widthType": enum ( |
زمینه های | |
---|---|
widthType | The width type of the column. |
width | The width of the column. Set when the column's |
WidthType
The type of width of the column.
Enums | |
---|---|
WIDTH_TYPE_UNSPECIFIED | The column width type is unspecified. |
EVENLY_DISTRIBUTED | The column width is evenly distributed among the other evenly distributed columns. The width of the column is automatically determined and will have an equal portion of the width remaining for the table after accounting for all columns with specified widths. |
FIXED_WIDTH | A fixed column width. The [width][ google.apps.docs.v1.TableColumnProperties.width property contains the column's width. |
TableOfContents
A StructuralElement
representing a table of contents.
JSON representation |
---|
{
"content": [
{
object ( |
زمینه های | |
---|---|
content[] | The content of the table of contents. |
suggestedInsertionIds[] | The suggested insertion IDs. A |
suggestedDeletionIds[] | The suggested deletion IDs. If empty, then there are no suggested deletions of this content. |
Header
A document header.
JSON representation |
---|
{
"headerId": string,
"content": [
{
object ( |
زمینه های | |
---|---|
headerId | The ID of the header. |
content[] | The contents of the header. The indexes for a header's content begin at zero. |
Footnote
A document footnote.
JSON representation |
---|
{
"footnoteId": string,
"content": [
{
object ( |
زمینه های | |
---|---|
footnoteId | The ID of the footnote. |
content[] | The contents of the footnote. The indexes for a footnote's content begin at zero. |
DocumentStyle
The style of the document.
JSON representation |
---|
{ "background": { object ( |
زمینه های | |
---|---|
background | The background of the document. Documents cannot have a transparent background color. |
defaultHeaderId | The ID of the default header. If not set, there's no default header. This property is read-only. |
defaultFooterId | The ID of the default footer. If not set, there's no default footer. This property is read-only. |
evenPageHeaderId | The ID of the header used only for even pages. The value of This property is read-only. |
evenPageFooterId | The ID of the footer used only for even pages. The value of This property is read-only. |
firstPageHeaderId | The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of This property is read-only. |
firstPageFooterId | The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of This property is read-only. |
useFirstPageHeaderFooter | Indicates whether to use the first page header / footer IDs for the first page. |
useEvenPageHeaderFooter | Indicates whether to use the even page header / footer IDs for the even pages. |
pageNumberStart | The page number from which to start counting the number of pages. |
marginTop | The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. |
marginBottom | The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. |
marginRight | The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. |
marginLeft | The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. |
pageSize | The size of a page in the document. |
marginHeader | The amount of space between the top of the page and the contents of the header. |
marginFooter | The amount of space between the bottom of the page and the contents of the footer. |
useCustomHeaderFooterMargins | Indicates whether DocumentStyle This property is read-only. |
flipPageOrientation | اختیاری. Indicates whether to flip the dimensions of the |
Background
Represents the background of a document.
JSON representation |
---|
{
"color": {
object ( |
زمینه های | |
---|---|
color | The background color. |
Size
A width and height.
JSON representation |
---|
{ "height": { object ( |
زمینه های | |
---|---|
height | The height of the object. |
width | The width of the object. |
SuggestedDocumentStyle
A suggested change to the DocumentStyle
.
JSON representation |
---|
{ "documentStyle": { object ( |
زمینه های | |
---|---|
documentStyle | A |
documentStyleSuggestionState | A mask that indicates which of the fields on the base |
DocumentStyleSuggestionState
A mask that indicates which of the fields on the base DocumentStyle
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON representation |
---|
{ "backgroundSuggestionState": { object ( |
زمینه های | |
---|---|
backgroundSuggestionState | A mask that indicates which of the fields in |
defaultHeaderIdSuggested | Indicates if there was a suggested change to |
defaultFooterIdSuggested | Indicates if there was a suggested change to |
evenPageHeaderIdSuggested | Indicates if there was a suggested change to |
evenPageFooterIdSuggested | Indicates if there was a suggested change to |
firstPageHeaderIdSuggested | Indicates if there was a suggested change to |
firstPageFooterIdSuggested | Indicates if there was a suggested change to |
useFirstPageHeaderFooterSuggested | Indicates if there was a suggested change to |
useEvenPageHeaderFooterSuggested | Indicates if there was a suggested change to |
pageNumberStartSuggested | 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 |
marginRightSuggested | Indicates if there was a suggested change to |
marginLeftSuggested | Indicates if there was a suggested change to |
pageSizeSuggestionState | A mask that indicates which of the fields in [size] [google.apps.docs.v1.DocumentStyle.size] have been changed in this suggestion. |
marginHeaderSuggested | Indicates if there was a suggested change to |
marginFooterSuggested | Indicates if there was a suggested change to |
useCustomHeaderFooterMarginsSuggested | Indicates if there was a suggested change to |
flipPageOrientationSuggested | اختیاری. Indicates if there was a suggested change to |
BackgroundSuggestionState
A mask that indicates which of the fields on the base Background
have been changed in this suggestion. For any field set to true, the Backgound
has a new suggested value.
JSON representation |
---|
{ "backgroundColorSuggested": boolean } |
زمینه های | |
---|---|
backgroundColorSuggested | Indicates whether the current background color has been modified in this suggestion. |
SizeSuggestionState
A mask that indicates which of the fields on the base Size
have been changed in this suggestion. For any field set to true, the Size
has a new suggested value.
JSON representation |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
زمینه های | |
---|---|
heightSuggested | Indicates if there was a suggested change to |
widthSuggested | Indicates if there was a suggested change to |
NamedStyles
The named styles. Paragraphs in the document can inherit their TextStyle
and ParagraphStyle
from these named styles.
JSON representation |
---|
{
"styles": [
{
object ( |
زمینه های | |
---|---|
styles[] | The named styles. There's an entry for each of the possible |
NamedStyle
A named style. Paragraphs in the document can inherit their TextStyle
and ParagraphStyle
from this named style when they have the same named style type.
JSON representation |
---|
{ "namedStyleType": enum ( |
زمینه های | |
---|---|
namedStyleType | The type of this named style. |
textStyle | The text style of this named style. |
paragraphStyle | The paragraph style of this named style. |
SuggestedNamedStyles
A suggested change to the NamedStyles
.
JSON representation |
---|
{ "namedStyles": { object ( |
زمینه های | |
---|---|
namedStyles | A |
namedStylesSuggestionState | A mask that indicates which of the fields on the base |
NamedStylesSuggestionState
The suggestion state of a NamedStyles
message.
JSON representation |
---|
{
"stylesSuggestionStates": [
{
object ( |
زمینه های | |
---|---|
stylesSuggestionStates[] | A mask that indicates which of the fields on the corresponding The order of these named style suggestion states matches the order of the corresponding named style within the |
NamedStyleSuggestionState
A suggestion state of a NamedStyle
message.
JSON representation |
---|
{ "namedStyleType": enum ( |
زمینه های | |
---|---|
namedStyleType | The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding |
textStyleSuggestionState | A mask that indicates which of the fields in |
paragraphStyleSuggestionState | A mask that indicates which of the fields in |
List
A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet
.
JSON representation |
---|
{ "listProperties": { object ( |
زمینه های | |
---|---|
listProperties | The properties of the list. |
suggestedListPropertiesChanges | The suggested changes to the list 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 list. |
ListProperties
The properties of a list
that describe the look and feel of bullets belonging to paragraphs associated with a list.
JSON representation |
---|
{
"nestingLevels": [
{
object ( |
زمینه های | |
---|---|
nestingLevels[] | Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. |
NestingLevel
Contains properties describing the look and feel of a list bullet at a given level of nesting.
JSON representation |
---|
{ "bulletAlignment": enum ( |
زمینه های | |
---|---|
bulletAlignment | The alignment of the bullet within the space allotted for rendering the bullet. |
glyphFormat | The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the For example, the glyph format 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 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 | 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 | 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. |
Range
Specifies a contiguous range of text.
JSON representation |
---|
{ "segmentId": string, "startIndex": integer, "endIndex": integer } |
زمینه های | |
---|---|
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. |
SuggestionsViewMode
The suggestions view mode applied to the document that indicates how suggested changes are represented. It provides options for reading the document with all suggestions inline, accepted, or rejected.
Enums | |
---|---|
DEFAULT_FOR_CURRENT_ACCESS | The SuggestionsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, PREVIEW_WITHOUT_SUGGESTIONS is applied. Otherwise, SUGGESTIONS_INLINE is applied. This is the default suggestions view mode. |
SUGGESTIONS_INLINE | The returned document has suggestions inline. Suggested changes will be differentiated from base content within the document. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes. |
PREVIEW_SUGGESTIONS_ACCEPTED | The returned document is a preview with all suggested changes accepted. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes. |
PREVIEW_WITHOUT_SUGGESTIONS | The returned document is a preview with all suggested changes rejected if there are any suggestions in the document. |
InlineObject
An object that appears inline with text. An InlineObject contains an EmbeddedObject
such as an image.
JSON representation |
---|
{ "objectId": string, "inlineObjectProperties": { object ( |
زمینه های | |
---|---|
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
این نوع هیچ فیلدی ندارد.
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. This is the default value. |
NOT_RENDERED | If a property's state is NOT_RENDERED, then the element does not have the corresponding property when rendered in the document. |
LinkedContentReference
A reference to the external linked source content.
JSON representation |
---|
{ // Union field |
زمینه های | |
---|---|
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
این نوع هیچ فیلدی ندارد.
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 |
مواد و روش ها | |
---|---|
| 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. |