REST Resource: documents

منبع: سند

سند «سندنگار Google».

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

string

فقط برونداد. شناسه سند.
title

string

عنوان سند.
tabs[]

object (Tab)

فقط برونداد. برگه‌هایی که بخشی از سند هستند.

زبانه می‌تواند حاوی زبانه فرزند باشد، یعنی زبانه درون زبانه دیگر. برگه‌های فرزند با فیلد Tab.childTabs نشان داده می‌شوند.
revisionId

string

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

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

enum (SuggestionsViewMode)

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

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

enum (CommentsViewMode)

فقط برونداد. حالت مشاهده نظرات روی سند اعمال شد.
comments[]

object (CommentThread)

فقط برونداد. نظرات مرتبط با سند. فقط درصورتی درج می‌شود که پارامتر commentsViewMode روی الزام به نظر دادن تنظیم شده باشد (مثل COMMENTS_VIEW_MODE_INCLUDED).
suggestions[]

object (SuggestionThread)

فقط برونداد. پیشنهادهای مرتبط با سند. فقط درصورتی درج می‌شود که پارامتر commentsViewMode روی الزام به نظر دادن تنظیم شده باشد (مثل COMMENTS_VIEW_MODE_INCLUDED).
body

object (Body)

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

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

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

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

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

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

فقط برونداد. پانویس‌های سند، کلیدشده براساس شناسه پانویس.

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

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

فقط برونداد. پانویس‌های سند، با کلید شناسه پانویس.

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

object (DocumentStyle)

فقط برونداد. سبک سند.

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

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

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

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

object (NamedStyles)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

زبانه

زبانه در سند.

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

  "documentTab": {
    object (DocumentTab)
  }
}
فیلدها
tabProperties

object (TabProperties)

ویژگی‌های برگه، مثل شناسه و عنوان.
childTabs[]

object (Tab)

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

object (DocumentTab)

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

TabProperties

خصوصیات زبانه.

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

string

شناسه تغییرناپذیر برگه.
title

string

نام قابل‌مشاهده کاربر برای برگه.
parentTabId

string

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

integer

نمایه صفرپایه زبانه در والد.
nestingLevel

integer

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

string

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

اگر اموجی نامعتبر باشد، خطای درخواست بد ۴۰۰ برگردانده می‌شود.

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

DocumentTab

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

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

object (Body)

بدنه اصلی زبانه سند.
headers

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

سرصفحه‌های موجود در زبانه سند، با کلید شناسه سرصفحه.
footers

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

پاورقی‌های برگه سند، با کلید شناسه پاورقی.
footnotes

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

پاورقی‌های موجود در زبانه سند، با کلید شناسه پاورقی.
documentStyle

object (DocumentStyle)

سبک زبانه سند.
suggestedDocumentStyleChanges

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

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

object (NamedStyles)

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

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

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

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

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

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

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

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

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

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

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

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

نظرات در برگه سند، با شناسه پیوند کلیدگذاری شده است. فقط درصورتی درج می‌شود که پارامتر commentsViewMode روی الزام به نظر دادن تنظیم شده باشد (مثل COMMENTS_VIEW_MODE_INCLUDED).
dropdownDefinitions

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

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

بدن

بدنه سند.

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

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

object (StructuralElement)

محتوای بدنه.

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

StructuralElement

«عنصر ساختاری» محتوایی را توصیف می‌کند که ساختار سند را فراهم می‌کند.

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

  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
}
فیلدها
startIndex

integer

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

integer

نمایه پایانی این عنصر ساختاری براساس صفر، انحصاری، در واحدهای کد UTF-16.
محتوای عنصر ساختاری. فهرست زیر شامل فیلدهای متقابلاً انحصاری است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
paragraph

object (Paragraph)

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

object (SectionBreak)

نوعی جداکننده بخش از عنصر ساختاری.
table

object (Table)

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

object (TableOfContents)

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

پاراگراف

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

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

object (ParagraphElement)

محتوای پاراگراف، تجزیه‌شده به بخش‌های تشکیل‌دهنده آن.
paragraphStyle

object (ParagraphStyle)

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

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

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

object (Bullet)

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

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

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

string

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

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

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

ParagraphElement

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

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

  "textRun": {
    object (TextRun)
  },
  "autoText": {
    object (AutoText)
  },
  "pageBreak": {
    object (PageBreak)
  },
  "columnBreak": {
    object (ColumnBreak)
  },
  "footnoteReference": {
    object (FootnoteReference)
  },
  "horizontalRule": {
    object (HorizontalRule)
  },
  "equation": {
    object (Equation)
  },
  "inlineObjectElement": {
    object (InlineObjectElement)
  },
  "person": {
    object (Person)
  },
  "richLink": {
    object (RichLink)
  },
  "dateElement": {
    object (DateElement)
  },
  "dropdown": {
    object (Dropdown)
  }
}
فیلدها
startIndex

integer

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

integer

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

object (TextRun)

عنصر پاراگراف اجرای نوشتار.
autoText

object (AutoText)

عنصر پاراگراف نوشتار خودکار.
pageBreak

object (PageBreak)

عنصر پاراگراف جداساز صفحه.
columnBreak

object (ColumnBreak)

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

object (FootnoteReference)

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

object (HorizontalRule)

عنصر پاراگراف خط افقی.
equation

object (Equation)

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

object (InlineObjectElement)

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

object (Person)

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

object (DateElement)

عنصر پاراگرافی که نشان‌دهنده تاریخ است.
dropdown

object (Dropdown)

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

TextRun

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

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

string

نوشتار این اجرا.

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

string

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

string

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

object (TextStyle)

سبک نوشتار این اجرا.
suggestedTextStyleChanges

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

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

سبک نوشتار

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

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

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

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

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

boolean

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

boolean

اینکه نوشتار مورب است یا نه.
underline

boolean

نوشتار زیرخط‌دار است یا نه.
strikethrough

boolean

نوشتار خط‌خورده است یا نه.
smallCaps

boolean

اینکه آیا نوشتار با حروف کوچک بزرگ نوشته شده است یا نه.
backgroundColor

object (OptionalColor)

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

object (OptionalColor)

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

object (Dimension)

اندازه قلم نوشتار.
weightedFontFamily

object (WeightedFontFamily)

خانواده قلم و وزن پردازش‌شده نوشتار.

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

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

اگر weightedFontFamily تنظیم شده است، weightedFontFamily#fontFamily نیز باید با مقدار غیرخالی تنظیم شود. درغیراین‌صورت، خطای درخواست بد ۴۰۰ برگردانده می‌شود.
baselineOffset

enum (BaselineOffset)

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

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

OptionalColor

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

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

object (Color)

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

رنگ

رنگ یکدست.

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

object (RgbColor)

مقدار رنگ RGB.

RgbColor

رنگ RGB.

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

number

عنصر قرمز رنگ، از ۰٫۰ تا ۱٫۰.
green

number

عنصر سبز رنگ، از ۰٫۰ تا ۱٫۰.
blue

number

عنصر آبی رنگ، از ۰٫۰ تا ۱٫۰.

ابعاد

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

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

number

بزرگی.
unit

enum (Unit)

واحد بزرگی.

واحد

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

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

WeightedFontFamily

نشان‌دهنده خانواده قلم و وزن نوشتار است.

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

string

خانواده قلم نوشتار.

خانواده قلم می‌تواند هر قلمی از منو «قلم» در «سندنگار» یا از قلم‌های Google باشد. اگر نام قلم شناخته نشود، نوشتار در Arial ارائه می‌شود.
weight

integer

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

مقدار پیش‌فرض 400 («معمولی») است.

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

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

BaselineOffset

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

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

SuggestedTextStyle

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

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

object (TextStyle)

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

object (TextStyleSuggestionState)

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

TextStyleSuggestionState

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

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

boolean

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

boolean

نشان می‌دهد که آیا تغییری برای italic پیشنهاد شده است یا نه.
underlineSuggested

boolean

نشان می‌دهد که آیا تغییری برای underline پیشنهاد شده است یا نه.
strikethroughSuggested

boolean

نشان می‌دهد که آیا تغییری برای strikethrough پیشنهاد شده است یا نه.
smallCapsSuggested

boolean

نشان می‌دهد که آیا تغییری برای smallCaps پیشنهاد شده است یا نه.
backgroundColorSuggested

boolean

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

boolean

نشان می‌دهد که آیا تغییری برای foregroundColor پیشنهاد شده است یا نه.
fontSizeSuggested

boolean

نشان می‌دهد که آیا تغییری برای fontSize پیشنهاد شده است یا نه.
weightedFontFamilySuggested

boolean

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

boolean

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

AutoText

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

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

enum (Type)

نوع این نوشتار خودکار.
suggestedInsertionIds[]

string

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

string

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

object (TextStyle)

سبک نوشتار این «نوشتار خودکار».
suggestedTextStyleChanges

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

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

نوع

انواع نوشتار خودکار.

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

PageBreak

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

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

string

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

string

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

object (TextStyle)

سبک نوشتار این «صفحه‌شکنی».

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

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

سبک نوشتار پیشنهادی به این «صفحه‌شکنی» تغییر می‌کند و با شناسه پیشنهاد کلیدگذاری می‌شود.

ColumnBreak

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

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

string

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

string

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

object (TextStyle)

سبک نوشتار این «ستون‌شکنی».

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

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

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

FootnoteReference

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

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

string

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

string

تعداد ارائه این پانویس.
suggestedInsertionIds[]

string

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

string

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

object (TextStyle)

سبک نوشتار این «ارجاع به پانویس».
suggestedTextStyleChanges

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

سبک نوشتار پیشنهادی به این «ارجاع به پانویس» تغییر می‌کند و با شناسه پیشنهاد کلیدگذاری می‌شود.

HorizontalRule

ParagraphElement نشان‌دهنده خط افقی.

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

string

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

string

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

object (TextStyle)

سبک نوشتار این «خط افقی».

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

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

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

معادله

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

نمایش JSON 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
فیلدها
suggestedInsertionIds[]

string

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

string

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

InlineObjectElement

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

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

string

شناسه InlineObject که این عنصر دربردارد.
suggestedInsertionIds[]

string

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

string

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

object (TextStyle)

سبک نوشتار این InlineObjectElement.

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

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

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

شخص

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

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

string

فقط برونداد. شناسه یکتای این پیوند.
suggestedInsertionIds[]

string

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

string

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

object (TextStyle)

سبک نوشتار این Person.
suggestedTextStyleChanges

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

سبک نوشتار پیشنهادی به این Person تغییر می‌کند، که با شناسه پیشنهاد کلیدگذاری شده است.
personProperties

object (PersonProperties)

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

PersonProperties

دارایی‌های خاص مربوط به Person پیوندشده.

نمایش JSON 
{
  "name": string,
  "email": string
}
فیلدها
name

string

نام شخص اگر به‌جای نشانی ایمیل شخص در نوشتار پیوند نمایش داده شود.
email

string

نشانی ایمیل پیوندشده به این Person. این فیلد همیشه وجود دارد.

RichLinkProperties

دارایی‌های مختص RichLink.

نمایش JSON 
{
  "title": string,
  "uri": string,
  "mimeType": string
}
فیلدها
title

string

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

string

‫URI به RichLink. این همیشه وجود دارد.
mimeType

string

نوع MIME RichLink، درصورت وجود (برای مثال، وقتی فایل در Drive باشد).

DateElement

نمونه‌ای از تاریخ که در سند ذکر شده است.

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

string

فقط برونداد. شناسه یکتای این تاریخ.
suggestedInsertionIds[]

string

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

string

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

object (TextStyle)

سبک نوشتار این «عنصر تاریخ».
suggestedTextStyleChanges

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

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

object (DateElementProperties)

خصوصیات این «عنصر تاریخ».
suggestedDateElementPropertiesChanges

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

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

DateElementProperties

خصوصیات DateElement.

نمایش JSON 
{
  "timestamp": string,
  "timeZoneId": string,
  "locale": string,
  "dateFormat": enum (DateFormat),
  "timeFormat": enum (TimeFormat),
  "displayText": string
}
فیلدها
timestamp

string (Timestamp format)

نقطه زمانی برای نمایش، برحسب ثانیه و نانوثانیه از تاریخ یونیکس: ۱ ژانویه ۱۹۷۰ ساعت ۱۲ شب به وقت ساعت هماهنگ جهانی.

انتظار می‌رود مُهر زمان به زمان هماهنگ جهانی (UTC) باشد. اگر timeZoneId تنظیم شده باشد، مُهر زمان براساس منطقه زمانی تنظیم می‌شود. برای مثال، مُهر زمان 18000 با قالب تاریخ DATE_FORMAT_ISO8601 و قالب زمان TIME_FORMAT_HOUR_MINUTE به‌صورت 1970-01-01 5:00 AM نمایش داده می‌شود. مُهر زمان 18000 با قالب تاریخ DATE_FORMAT_ISO8601، قالب زمان TIME_FORMAT_HOUR_MINUTE، و منطقه زمانی تنظیم‌شده روی America/New_York به‌جای آن 1970-01-01 12:00 AM خواهد بود.
timeZoneId

string

منطقه زمانی DateElement، همان‌گونه که توسط پروژه «مخزن داده‌های مکان مشترک یونیکد» (CLDR) تعریف شده است. برای مثال، America/New_York. اگر تنظیم نشده باشد، منطقه زمانی پیش‌فرض etc/UTC است.
locale

string

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

محدود به زبان‌های زیر: af، am، ar، as، az، be، bg، bn، ca، cs، da، de، el، en، en-CA، en-GB، es، es-419، et، eu، fa، fi، fil، fr، fr-CA، gl، gu، hi، hr، hu، hy، id، is، it، iw، ja، ka، kk، km، kn، ko، lo، lt، lv، mk، ml، mn، mr، ms، ne، nl، no، or، pa، pl، pt-BR، pt-PT، ro، ru، si، sk، sl، sq، sr، sv، sw، ta، te، th، tr، uk، ur، uz، vi، zh-CN، zh-HK، zh-TW، zu، cy، my.
dateFormat

enum (DateFormat)

تعیین می‌کند بخش تاریخ «عنصر تاریخ» چگونه در سند نمایش داده شود.

اگر تنظیم نشده باشد، مقدار پیش‌فرض DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED است که نشان می‌دهد DateElement به‌صورت MMM d, y در en، یا معادل خاص منطقه، قالب‌بندی خواهد شد.
timeFormat

enum (TimeFormat)

تعیین می‌کند که بخش زمان «عنصر تاریخ» چگونه در سند نمایش داده شود.

اگر تنظیم نشده باشد، مقدار پیش‌فرض TIME_FORMAT_DISABLED است که نشان می‌دهد هیچ زمانی نباید نشان داده شود.
displayText

string

فقط برونداد. نشان می‌دهد که DateElement چگونه در سند نمایش داده می‌شود.

DateFormat

قالب‌های تاریخ احتمالی DateElement.

شمارشی‌ها
DATE_FORMAT_UNSPECIFIED قالب تاریخ مشخص نشده است.
DATE_FORMAT_CUSTOM فقط برونداد. قالب تاریخ از منبع خارجی وارد شده است.
DATE_FORMAT_MONTH_DAY_ABBREVIATED قالب تاریخ به‌صورت ماه مخفف و سپس روز است. برای مثال، «۱ ژانویه».
DATE_FORMAT_MONTH_DAY_FULL قالب تاریخ به‌صورت ماه و سپس روز است. برای مثال، «ژانویه ۰۱».
DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED قالب تاریخ به‌صورت ماه مخفف و پس‌از آن روز و سال است. برای مثال، «۱ ژانویه ۱۹۷۰».
DATE_FORMAT_ISO8601 قالب تاریخ در قالب ISO 8601 است. برای مثال، «1970-01-01».

TimeFormat

قالب‌های زمان ممکن برای DateElement.

شمارشی‌ها
TIME_FORMAT_UNSPECIFIED قالب زمان مشخص نشده است.
TIME_FORMAT_DISABLED نشان می‌دهد که تاریخ زمان ندارد.
TIME_FORMAT_HOUR_MINUTE قالب زمان ساعت و دقیقه را نشان می‌دهد. برای مثال، «Jan 1, 1970 12:00 PM».
TIME_FORMAT_HOUR_MINUTE_TIMEZONE قالب زمان ساعت، دقیقه، و منطقه زمانی را نشان می‌دهد. برای مثال، «۱ ژانویه ۱۹۷۰، ۱۲:۰۰ ظهر به وقت ساعت هماهنگ جهانی».

SuggestedDateElementProperties

تغییر پیشنهادی در DateElementProperties.

نمایش JSON 
{
  "dateElementProperties": {
    object (DateElementProperties)
  },
  "dateElementPropertiesSuggestionState": {
    object (DateElementPropertiesSuggestionState)
  }
}
فیلدها
dateElementProperties

object (DateElementProperties)

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

object (DateElementPropertiesSuggestionState)

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

DateElementPropertiesSuggestionState

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

نمایش JSON 
{
  "timestampSuggested": boolean,
  "timeZoneIdSuggested": boolean,
  "localeSuggested": boolean,
  "dateFormatSuggested": boolean,
  "timeFormatSuggested": boolean
}
فیلدها
timestampSuggested

boolean

نشان می‌دهد که آیا تغییری برای timestamp پیشنهاد شده است یا نه.
timeZoneIdSuggested

boolean

نشان می‌دهد که آیا تغییری برای timeZoneId پیشنهاد شده است یا نه.
localeSuggested

boolean

نشان می‌دهد که آیا تغییری برای locale پیشنهاد شده است یا نه.
dateFormatSuggested

boolean

نشان می‌دهد که آیا تغییری برای dateFormat پیشنهاد شده است یا نه.
timeFormatSuggested

boolean

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

SuggestedDropdownProperties

تغییر پیشنهادی در خصوصیات کرکره‌ای.

نمایش JSON 
{
  "dropdownProperties": {
    object (DropdownProperties)
  },
  "dropdownPropertiesSuggestionState": {
    object (DropdownPropertiesSuggestionState)
  }
}
فیلدها
dropdownProperties

object (DropdownProperties)

DropdownProperties که فقط شامل تغییرات ایجادشده در این پیشنهاد است. می‌توان از این همراه با dropdownPropertiesSuggestionState استفاده کرد تا ببینید کدام فیلدها تغییر کرده‌اند و مقادیر جدید آن‌ها چیست.
dropdownPropertiesSuggestionState

object (DropdownPropertiesSuggestionState)

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

ParagraphStyle

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

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

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

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

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

string

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

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

enum (NamedStyleType)

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

ازآنجایی‌که به‌روزرسانی نوع سبک نام‌گذاری‌شده بر ویژگی‌های دیگر در «سبک پاراگراف» تأثیر می‌گذارد، نوع سبک نام‌گذاری‌شده قبل‌از به‌روزرسانی ویژگی‌های دیگر اعمال می‌شود.
alignment

enum (Alignment)

تراز نوشتار برای این پاراگراف.
lineSpacing

number

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

enum (ContentDirection)

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

enum (SpacingMode)

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

object (Dimension)

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

object (Dimension)

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

object (ParagraphBorder)

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

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

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

object (ParagraphBorder)

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

وقتی پاراگراف بالا دارای خصوصیات حاشیه و تورفتگی متفاوتی باشد، حاشیه بالا پرداز می‌شود.

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

object (ParagraphBorder)

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

وقتی پاراگراف زیر دارای خصوصیات حاشیه و تورفتگی متفاوتی باشد، حاشیه پایین رندر می‌شود.

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

object (ParagraphBorder)

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

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

object (ParagraphBorder)

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

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

object (Dimension)

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

object (Dimension)

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

object (Dimension)

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

object (TabStop)

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

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

boolean

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

boolean

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

boolean

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

object (Shading)

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

boolean

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

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

NamedStyleType

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

شمارشی‌ها
NAMED_STYLE_TYPE_UNSPECIFIED نوع سبک نام‌گذاری‌شده مشخص نشده است.
NORMAL_TEXT نوشتار عادی.
TITLE عنوان.
SUBTITLE زیرنویس.
HEADING_1 سرفصل ۱.
HEADING_2 سرفصل ۲.
HEADING_3 سرفصل ۳.
HEADING_4 سرفصل ۴.
HEADING_5 سرفصل ۵.
HEADING_6 سرفصل ۶.

تراز کردن

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

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

ContentDirection

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

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

SpacingMode

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

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

ParagraphBorder

حاشیه‌ای دور پاراگراف.

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

object (OptionalColor)

رنگ حاشیه.
width

object (Dimension)

عرض حاشیه.
padding

object (Dimension)

لایه‌گذاری حاشیه.
dashStyle

enum (DashStyle)

سبک خط فاصله حاشیه.

DashStyle

انواع خط‌چین‌هایی که با آن‌ها هندسه خطی می‌تواند پرداز شود. این مقادیر براساس نوع ساده «ST_PresetLineDashVal» که در بخش ۲۰.۱.۱۰.۴۹ از «قالب‌های فایل Office Open XML - اصول و مرجع زبان نشانه‌گذاری»، بخش ۱ از ECMA-376 نسخه ۵ شرح داده شده است.

شمارشی‌ها
DASH_STYLE_UNSPECIFIED سبک خط فاصله نامشخص.
SOLID خط توپر. با مقدار ECMA-376 ST_PresetLineDashVal «یکپارچه» مطابقت دارد. این سبک پیش‌فرض خط فاصله است.
DOT خط نقطه‌چین. با مقدار ECMA-376 ST_PresetLineDashVal «نقطه» مطابقت دارد.
DASH خط‌چین. با مقدار ECMA-376 ST_PresetLineDashVal «خط تیره» مطابقت دارد.

TabStop

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

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

object (Dimension)

فاصله بین این توقف زبانه و حاشیه شروع.
alignment

enum (TabStopAlignment)

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

TabStopAlignment

تراز توقف زبانه.

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

سایه‌زنی

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

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

object (OptionalColor)

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

SuggestedParagraphStyle

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

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

object (ParagraphStyle)

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

object (ParagraphStyleSuggestionState)

پوششی که نشان می‌دهد کدام‌یک از فیلدهای 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 (ShadingSuggestionState)
  },
  "pageBreakBeforeSuggested": boolean
}
فیلدها
headingIdSuggested

boolean

نشان می‌دهد که آیا تغییری برای headingId پیشنهاد شده است یا نه.
namedStyleTypeSuggested

boolean

نشان می‌دهد که آیا تغییری برای namedStyleType پیشنهاد شده است یا نه.
alignmentSuggested

boolean

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

boolean

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

boolean

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

boolean

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

boolean

نشان می‌دهد که آیا تغییری برای spaceAbove پیشنهاد شده است یا نه.
spaceBelowSuggested

boolean

نشان می‌دهد که آیا تغییری برای spaceBelow پیشنهاد شده است یا نه.
borderBetweenSuggested

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

نشان می‌دهد که آیا تغییری برای avoidWidowAndOrphan پیشنهاد شده است یا نه.
shadingSuggestionState

object (ShadingSuggestionState)

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

boolean

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

ShadingSuggestionState

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

نمایش JSON 
{
  "backgroundColorSuggested": boolean
}
فیلدها
backgroundColorSuggested

boolean

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

بولت

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

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

string

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

integer

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

object (TextStyle)

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

SuggestedBullet

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

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

object (Bullet)

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

object (BulletSuggestionState)

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

BulletSuggestionState

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

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

boolean

نشان می‌دهد که آیا تغییری برای listId پیشنهاد شده است یا نه.
nestingLevelSuggested

boolean

نشان می‌دهد که آیا تغییری برای nestingLevel پیشنهاد شده است یا نه.
textStyleSuggestionState

object (TextStyleSuggestionState)

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

ObjectReferences

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

نمایش JSON 
{
  "objectIds": [
    string
  ]
}
فیلدها
objectIds[]

string

شناسه‌های شیء.

SectionBreak

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

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

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

string

شناسه‌های درج پیشنهادی. یک SectionBreak ممکن است چندین شناسه درج داشته باشد اگر تغییر پیشنهادی تودرتو باشد. اگر خالی باشد، یعنی این یک درج پیشنهادی نیست.
suggestedDeletionIds[]

string

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

object (SectionStyle)

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

SectionStyle

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

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

object (SectionColumnProperties)

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

اگر خالی باشد، بخش حاوی یک ستون با دارایی‌های پیش‌فرض در ویرایشگر «سندنگار» است. بخش می‌تواند به‌روزرسانی شود تا حداکثر ۳ ستون داشته باشد.

هنگام به‌روزرسانی این دارایی، تنظیم مقدار مشخص الزامی است. لغو تنظیم این دارایی منجر به خطای درخواست بد ۴۰۰ می‌شود.
columnSeparatorStyle

enum (ColumnSeparatorStyle)

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

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

هنگام به‌روزرسانی این دارایی، تنظیم مقدار مشخص الزامی است. لغو تنظیم این دارایی منجر به خطای درخواست بد ۴۰۰ می‌شود.
contentDirection

enum (ContentDirection)

جهت محتوای این بخش. اگر تنظیم نشده باشد، مقدار به‌طور پیش‌فرض روی LEFT_TO_RIGHT تنظیم می‌شود.

هنگام به‌روزرسانی این دارایی، تنظیم مقدار مشخص الزامی است. لغو تنظیم این دارایی منجر به خطای درخواست بد ۴۰۰ می‌شود.
marginTop

object (Dimension)

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

هنگام به‌روزرسانی این دارایی، تنظیم مقدار مشخص الزامی است. لغو تنظیم این دارایی منجر به خطای درخواست بد ۴۰۰ می‌شود.
marginBottom

object (Dimension)

حاشیه پایین صفحه بخش. اگر تنظیم نشده باشد، مقدار به‌طور پیش‌فرض از DocumentStyle به marginBottom تغییر می‌کند.

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

هنگام به‌روزرسانی این دارایی، تنظیم مقدار مشخص الزامی است. لغو تنظیم این دارایی منجر به خطای درخواست بد ۴۰۰ می‌شود.
marginRight

object (Dimension)

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

هنگام به‌روزرسانی این دارایی، تنظیم مقدار مشخص الزامی است. لغو تنظیم این دارایی منجر به خطای درخواست بد ۴۰۰ می‌شود.
marginLeft

object (Dimension)

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

هنگام به‌روزرسانی این دارایی، تنظیم مقدار مشخص الزامی است. لغو تنظیم این دارایی منجر به خطای درخواست بد ۴۰۰ می‌شود.
marginHeader

object (Dimension)

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

هنگام به‌روزرسانی این دارایی، تنظیم مقدار مشخص الزامی است. لغو تنظیم این دارایی منجر به خطای درخواست بد ۴۰۰ می‌شود.
sectionType

enum (SectionType)

فقط برونداد. نوع بخش.
defaultHeaderId

string

شناسه سرایند پیش‌فرض. اگر تنظیم نشده باشد، مقدار از SectionBreak's SectionStyle قبلی به‌ارث می‌رسد. اگر مقدار در اولین «شکست بخش» تنظیم نشده باشد، از defaultHeaderId «سبک سند» به‌ارث می‌برد.

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

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

string

شناسه سرایندی که فقط برای صفحه اول بخش استفاده می‌شود. اگر useFirstPageHeaderFooter درست باشد، این مقدار برای سرایند در صفحه اول بخش استفاده می‌شود. اگر نادرست باشد، سرایند در صفحه اول بخش از defaultHeaderId استفاده می‌کند. اگر تنظیم نشده باشد، مقدار از SectionBreak's SectionStyle قبلی به‌ارث می‌رسد. اگر مقدار در اولین «شکست بخش» تنظیم نشده باشد، از firstPageHeaderId «سبک سند» به‌ارث می‌برد.

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

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

string

شناسه پاصفحه که فقط برای صفحه اول بخش استفاده می‌شود. اگر useFirstPageHeaderFooter درست باشد، این مقدار برای پانویس در صفحه اول بخش استفاده می‌شود. اگر نادرست باشد، پاصفحه در صفحه اول بخش از defaultFooterId استفاده می‌کند. اگر تنظیم نشده باشد، مقدار از SectionBreak's SectionStyle قبلی به‌ارث می‌رسد. اگر مقدار در اولین «شکست بخش» تنظیم نشده باشد، از firstPageFooterId «سبک سند» به‌ارث می‌برد.

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

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

string

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

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

string

شناسه پانویس فقط برای صفحه‌های زوج استفاده می‌شود. اگر مقدار useEvenPageHeaderFooter در DocumentStyle درست باشد، این مقدار برای پانویس‌های صفحات زوج در بخش استفاده می‌شود. اگر نادرست باشد، پانویس‌های صفحه‌های زوج از defaultFooterId استفاده می‌کنند. اگر تنظیم نشده باشد، مقدار از SectionBreak's SectionStyle قبلی به‌ارث می‌رسد. اگر مقدار در اولین «شکست بخش» تنظیم نشده باشد، از evenPageFooterId «سبک سند» به‌ارث می‌برد.

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

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

boolean

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

هنگام به‌روزرسانی این دارایی، تنظیم مقدار مشخص الزامی است. لغو تنظیم این دارایی منجر به خطای درخواست بد ۴۰۰ می‌شود.
pageNumberStart

integer

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

هنگام به‌روزرسانی این دارایی، تنظیم مقدار مشخص الزامی است. لغو تنظیم این دارایی منجر به خطای درخواست بد ۴۰۰ می‌شود.
flipPageOrientation

boolean

اختیاری. نشان می‌دهد که آیا ابعاد pageSize «سبک سند» برای این بخش معکوس شود یا نه، که امکان تغییر جهت صفحه بین عمودی و افقی را فراهم می‌کند. اگر تنظیم نشده باشد، مقدار از flipPageOrientation «سبک سند» به‌ارث می‌رسد.

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

هنگام به‌روزرسانی این دارایی، تنظیم مقدار مشخص الزامی است. لغو تنظیم این دارایی منجر به خطای درخواست بد ۴۰۰ می‌شود.

SectionColumnProperties

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

نمایش JSON 
{
  "width": {
    object (Dimension)
  },
  "paddingEnd": {
    object (Dimension)
  }
}
فیلدها
width

object (Dimension)

فقط برونداد. عرض ستون.
paddingEnd

object (Dimension)

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

ColumnSeparatorStyle

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

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

SectionType

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

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

جدول

‫StructuralElement نشان‌دهنده جدول.

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

integer

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

integer

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

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

object (TableRow)

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

string

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

string

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

object (TableStyle)

سبک جدول.

TableRow

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

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

integer

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

integer

شاخص پایانی این ردیف براساس صفر، انحصاری، در واحدهای کد UTF-16.
tableCells[]

object (TableCell)

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

ممکن است جدول مستطیلی نباشد، بنابراین برخی‌از ردیف‌ها ممکن است تعداد سلول‌های متفاوتی نسبت‌به ردیف‌های دیگر در همان جدول داشته باشند.
suggestedInsertionIds[]

string

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

string

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

object (TableRowStyle)

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

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

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

TableCell

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

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

integer

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

integer

نمایه پایانی این سلول براساس صفر، انحصاری، در واحدهای کد UTF-16.
content[]

object (StructuralElement)

محتوای سلول.
tableCellStyle

object (TableCellStyle)

سبک سلول.
suggestedInsertionIds[]

string

شناسه‌های درج پیشنهادی. یک TableCell ممکن است چندین شناسه درج داشته باشد اگر تغییر پیشنهادی تودرتو باشد. اگر خالی باشد، یعنی این یک درج پیشنهادی نیست.
suggestedDeletionIds[]

string

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

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

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

TableCellStyle

سبک TableCell.

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

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

integer

گستره ردیف سلول.

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

integer

گستره ستون سلول.

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

object (OptionalColor)

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

object (TableCellBorder)

حاشیه چپ سلول.
borderRight

object (TableCellBorder)

حاشیه راست سلول.
borderTop

object (TableCellBorder)

حاشیه بالای سلول.
borderBottom

object (TableCellBorder)

حاشیه پایین سلول.
paddingLeft

object (Dimension)

حاشیه سمت چپ سلول.
paddingRight

object (Dimension)

حاشیه راست سلول.
paddingTop

object (Dimension)

حاشیه‌گذاری بالای سلول.
paddingBottom

object (Dimension)

حاشیه پایین سلول.
contentAlignment

enum (ContentAlignment)

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

TableCellBorder

حاشیه‌ای دور سلول جدول.

مرزهای سلول جدول نمی‌تواند شفاف باشد. برای پنهان کردن حاشیه سلول جدول، عرض آن را روی ۰ تنظیم کنید.

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

object (OptionalColor)

رنگ حاشیه.

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

object (Dimension)

عرض حاشیه.
dashStyle

enum (DashStyle)

سبک خط فاصله حاشیه.

ContentAlignment

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

مشتق‌شده از زیرمجموعه‌ای از مقادیر نوع ساده «ST_TextAnchoringType» در بخش ۲۰.۱.۱۰.۶۰ از «قالب‌های فایل Office Open XML - اصول و مرجع زبان نشانه‌گذاری»، بخش ۱ از ECMA-376 نسخه ۵.

شمارشی‌ها
CONTENT_ALIGNMENT_UNSPECIFIED تراز محتوای نامشخص. تراز محتوا از عنصر والد به ارث می‌رسد، درصورتی‌که عنصر والد وجود داشته باشد.
CONTENT_ALIGNMENT_UNSUPPORTED تراز محتوای پشتیبانی‌نشده.
TOP ترازی که محتوا را با بالای نگهدارنده محتوا تراز می‌کند. با ECMA-376 ST_TextAnchoringType «t» مطابقت دارد.
MIDDLE ترازی که محتوا را در وسط نگهدارنده محتوا تراز می‌کند. با ECMA-376 ST_TextAnchoringType «ctr» مطابقت دارد.
BOTTOM ترازی که محتوا را با پایین نگهدارنده محتوا تراز می‌کند. با ECMA-376 ST_TextAnchoringType «b» مطابقت دارد.

SuggestedTableCellStyle

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

نمایش JSON 
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "tableCellStyleSuggestionState": {
    object (TableCellStyleSuggestionState)
  }
}
فیلدها
tableCellStyle

object (TableCellStyle)

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

object (TableCellStyleSuggestionState)

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

boolean

نشان می‌دهد که آیا تغییری برای rowSpan پیشنهاد شده است یا نه.
columnSpanSuggested

boolean

نشان می‌دهد که آیا تغییری برای columnSpan پیشنهاد شده است یا نه.
backgroundColorSuggested

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

نشان می‌دهد که آیا تغییری برای paddingLeft پیشنهاد شده است یا نه.
paddingRightSuggested

boolean

نشان می‌دهد که آیا تغییری برای paddingRight پیشنهاد شده است یا نه.
paddingTopSuggested

boolean

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

boolean

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

boolean

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

TableRowStyle

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

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

object (Dimension)

حداقل ارتفاع ردیف. این ردیف در ویرایشگر «سندنگار» با ارتفاعی برابر یا بیشتر از این مقدار پرداز می‌شود تا همه محتوای سلول‌های ردیف نشان داده شود.
tableHeader

boolean

آیا ردیف سرصفحه جدول است یا نه.
preventOverflow

boolean

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

SuggestedTableRowStyle

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

نمایش JSON 
{
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}
فیلدها
tableRowStyle

object (TableRowStyle)

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

object (TableRowStyleSuggestionState)

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

TableRowStyleSuggestionState

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

نمایش JSON 
{
  "minRowHeightSuggested": boolean
}
فیلدها
minRowHeightSuggested

boolean

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

TableStyle

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

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

object (TableColumnProperties)

ویژگی‌های هر ستون.

توجه داشته باشید که در «سندنگار»، جدول‌ها حاوی ردیف و ردیف‌ها حاوی سلول هستند، مشابه HTML. بنابراین ویژگی‌های ردیف را می‌توانید در tableRowStyle ردیف پیدا کنید.

TableColumnProperties

ویژگی‌های ستون در جدول.

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

enum (WidthType)

نوع عرض ستون.
width

object (Dimension)

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

WidthType

نوع عرض ستون.

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

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

عرض ستون به‌طور خودکار تعیین می‌شود و پس‌از درنظر گرفتن همه ستون‌های دارای عرض مشخص، سهمی برابر از عرض باقی‌مانده برای جدول خواهد داشت.
FIXED_WIDTH عرض ستون ثابت. خصوصیت [عرض][google.apps.docs.v1.TableColumnProperties.width حاوی عرض ستون است.

TableOfContents

StructuralElement نشان‌دهنده فهرست مطالب.

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

object (StructuralElement)

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

string

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

string

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

پانویس

پانویس سند.

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

string

شناسه پانویس.
content[]

object (StructuralElement)

محتوای پانویس.

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

DocumentStyle

سبک سند.

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

object (Background)

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

string

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

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

string

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

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

string

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

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

string

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

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

string

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.

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

boolean

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.
useEvenPageHeaderFooter

boolean

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.
pageNumberStart

integer

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.
marginTop

object (Dimension)

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

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.
marginBottom

object (Dimension)

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

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.
marginRight

object (Dimension)

حاشیه راست صفحه.

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.
marginLeft

object (Dimension)

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

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.
pageSize

object (Size)

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.
marginHeader

object (Dimension)

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.
flipPageOrientation

boolean

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

اگر [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] روی PAGELESS تنظیم شده باشد، این دارایی پرداز نمی‌شود.
documentFormat

object (DocumentFormat)

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

پس‌زمینه

نشان‌دهنده پس‌زمینه سند است.

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

object (OptionalColor)

رنگ پس‌زمینه.

اندازه

عرض و ارتفاع.

نمایش JSON 
{
  "height": {
    object (Dimension)
  },
  "width": {
    object (Dimension)
  }
}
فیلدها
height

object (Dimension)

ارتفاع شیء.
width

object (Dimension)

عرض شیء.

DocumentFormat

نشان‌دهنده تنظیمات قالب سطح سند است.

نمایش JSON 
{
  "documentMode": enum (DocumentMode)
}
فیلدها
documentMode

enum (DocumentMode)

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

DocumentMode

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

شمارشی‌ها
DOCUMENT_MODE_UNSPECIFIED حالت سند مشخص نشده است.
PAGES سند صفحه دارد.
PAGELESS سند بدون صفحه‌بندی است.

SuggestedDocumentStyle

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

نمایش JSON 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "documentStyleSuggestionState": {
    object (DocumentStyleSuggestionState)
  }
}
فیلدها
documentStyle

object (DocumentStyle)

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

object (DocumentStyleSuggestionState)

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

DocumentStyleSuggestionState

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

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

object (BackgroundSuggestionState)

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

boolean

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

boolean

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

boolean

نشان می‌دهد که آیا تغییری برای evenPageFooterId پیشنهاد شده است یا نه.
firstPageHeaderIdSuggested

boolean

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

boolean

نشان می‌دهد که آیا تغییری برای firstPageFooterId پیشنهاد شده است یا نه.
useFirstPageHeaderFooterSuggested

boolean

نشان می‌دهد که آیا تغییری برای useFirstPageHeaderFooter پیشنهاد شده است یا نه.
useEvenPageHeaderFooterSuggested

boolean

نشان می‌دهد که آیا تغییری برای useEvenPageHeaderFooter پیشنهاد شده است یا نه.
pageNumberStartSuggested

boolean

نشان می‌دهد که آیا تغییری برای pageNumberStart پیشنهاد شده است یا نه.
marginTopSuggested

boolean

نشان می‌دهد که آیا تغییری برای marginTop پیشنهاد شده است یا نه.
marginBottomSuggested

boolean

نشان می‌دهد که آیا تغییری برای marginBottom پیشنهاد شده است یا نه.
marginRightSuggested

boolean

نشان می‌دهد که آیا تغییری برای marginRight پیشنهاد شده است یا نه.
marginLeftSuggested

boolean

نشان می‌دهد که آیا تغییری برای marginLeft پیشنهاد شده است یا نه.
pageSizeSuggestionState

object (SizeSuggestionState)

پوششی که نشان می‌دهد کدام‌یک از فیلدهای [اندازه] [google.apps.docs.v1.DocumentStyle.size] در این پیشنهاد تغییر کرده است.
marginHeaderSuggested

boolean

نشان می‌دهد که آیا تغییری برای marginHeader پیشنهاد شده است یا نه.
flipPageOrientationSuggested

boolean

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

BackgroundSuggestionState

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

نمایش JSON 
{
  "backgroundColorSuggested": boolean
}
فیلدها
backgroundColorSuggested

boolean

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

SizeSuggestionState

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

نمایش JSON 
{
  "heightSuggested": boolean,
  "widthSuggested": boolean
}
فیلدها
heightSuggested

boolean

نشان می‌دهد که آیا تغییری برای height پیشنهاد شده است یا نه.
widthSuggested

boolean

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

NamedStyles

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

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

object (NamedStyle)

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

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

NamedStyle

سبک بانام. وقتی پاراگراف‌های سند نوع سبک نام‌گذاری‌شده یکسانی داشته باشند، می‌توانند TextStyle و ParagraphStyle را از این سبک نام‌گذاری‌شده به‌ارث ببرند.

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

enum (NamedStyleType)

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

object (TextStyle)

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

object (ParagraphStyle)

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

SuggestedNamedStyles

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

نمایش JSON 
{
  "namedStyles": {
    object (NamedStyles)
  },
  "namedStylesSuggestionState": {
    object (NamedStylesSuggestionState)
  }
}
فیلدها
namedStyles

object (NamedStyles)

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

object (NamedStylesSuggestionState)

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

NamedStylesSuggestionState

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

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

object (NamedStyleSuggestionState)

پوششی که نشان می‌دهد کدام‌یک از فیلدهای NamedStyle مربوطه در styles در این پیشنهاد تغییر کرده است.

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

NamedStyleSuggestionState

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

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

enum (NamedStyleType)

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

این فیلد برای راحتی تطبیق دادن NamedStyleSuggestionState با NamedStyle مربوط به آن ارائه شده است.
textStyleSuggestionState

object (TextStyleSuggestionState)

پوششی که نشان می‌دهد کدام‌یک از فیلدهای text style در این پیشنهاد تغییر کرده است.
paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

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

فهرست

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

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

object (ListProperties)

خصوصیات فهرست.
suggestedListPropertiesChanges

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

تغییرات پیشنهادی در دارایی‌های فهرست، با کلید شناسه پیشنهاد.
suggestedInsertionId

string

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

string

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

ListProperties

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

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

object (NestingLevel)

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

فهرست حداکثر ۹ سطح درونی دارد که سطح درونی ۰ مربوط به بالاترین سطح و سطح درونی ۸ مربوط به درونی‌ترین سطح است. سطوح تودرتو به‌ترتیب صعودی برگردانده می‌شوند و کمترین سطح تودرتو اول برگردانده می‌شود.

NestingLevel

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

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

  "glyphType": enum (GlyphType),
  "glyphSymbol": string
}
فیلدها
bulletAlignment

enum (BulletAlignment)

تراز گلوله در فضای اختصاص‌یافته برای پرداز کردن گلوله.
glyphFormat

string

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

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

برای مثال، قالب گلیک %0. نشان می‌دهد که گلیک پردازش‌شده جای‌بان را با گلیک مربوط به سطح تودرتوی ۰ جایگزین می‌کند و سپس یک نقطه به‌عنوان پسوند اضافه می‌کند. بنابراین فهرستی با نوع علامت UPPER_ALPHA و قالب علامت %0. در سطح درونی ۰ منجر به فهرستی با علامت‌های پردازش‌شده می‌شود

A.

B.

C.

قالب گلیک می‌تواند حاوی جای‌بان‌هایی برای سطح تودرتوی فعلی و همچنین جای‌بان‌هایی برای سطوح تودرتوی والد باشد. برای مثال، فهرست می‌تواند در سطح درونی ۰ قالب گلیک %0. و در سطح درونی ۱ قالب گلیک %0.%1. داشته باشد. با فرض اینکه هر دو سطح تودرتو DECIMAL نوع گلیک دارند، این کار منجر به فهرستی با گلیک‌های رندرشده می‌شود

1.

2.

2.1.

2.2.

3.

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

object (Dimension)

مقدار تورفتگی برای خط اول پاراگراف‌ها در این سطح از تودرتویی.
indentStart

object (Dimension)

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

object (TextStyle)

سبک نوشتار گلوله‌ها در این سطح از لانه.
startNumber

integer

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

مقدار ۰ برای فهرست‌های حروف الفبا و فهرست‌های اعداد رومی به‌عنوان مقدار ۱ درنظر گرفته می‌شود. برای مقادیر ۰ و ۱، فهرست‌های حروف الفبا و اعداد رومی به‌ترتیب از a و i شروع می‌شوند.

این مقدار برای سطوح تودرتو با گلیک‌های نامرتب نادیده گرفته می‌شود.
نوع گلیف استفاده‌شده توسط گلوله‌ها. این مورد گلوله‌ای را که جایگزین جای‌بان‌ها در glyph_format می‌شود تعریف می‌کند. فهرست زیر شامل فیلدهای متقابلاً انحصاری است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
glyphType

enum (GlyphType)

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

نوع گلیک تعیین می‌کند که از چه نوع گلیکی برای جایگزین کردن جای‌بان‌ها در glyphFormat استفاده شود وقتی پاراگراف‌های این سطح از تودرتویی مرتب می‌شوند. برای مثال، اگر سطح تودرتو ۰ باشد، glyphFormat برابر با %0. باشد، و نوع گلیک DECIMAL باشد، گلیک پردازش‌شده جای‌بان %0 را در قالب گلیک با عددی که نشان‌دهنده ترتیب عنصر فهرست در فهرست است جایگزین می‌کند.
glyphSymbol

string

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

نماد گلیف جایگزین جای‌بان‌ها در glyphFormat می‌شود. برای مثال، اگر glyphSymbol دایره توپر متناظر با نقطه کد Unicode U+25cf باشد و glyphFormat برابر با %0 باشد، گلیک رندرشده دایره توپر خواهد بود.
پایان فیلدهای متقابلاً انحصاری.

BulletAlignment

انواع تراز برای گلوله.

شمارشی‌ها
BULLET_ALIGNMENT_UNSPECIFIED تراز گلوله مشخص نشده است.
START گلوله با شروع فضای اختصاص‌داده‌شده برای پرداز کردن گلوله هم‌راستا می‌شود. برای نوشتار چپ‌به‌راست، چپ‌تراز و درغیراین‌صورت راست‌تراز است.
CENTER گلوله با مرکز فضای اختصاص‌داده‌شده برای پرداز کردن گلوله تراز می‌شود.
END گلوله به انتهای فضای اختصاص‌داده‌شده برای پردازاندن گلوله تراز می‌شود. برای نوشتار چپ‌به‌راست، راست‌تراز و درغیراین‌صورت چپ‌تراز است.

GlyphType

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

شمارشی‌ها
GLYPH_TYPE_UNSPECIFIED نوع گلایف مشخص نشده است یا پشتیبانی نمی‌شود.
NONE رشته‌ای خالی.
DECIMAL عددی مثل 1، 2، یا 3.
ZERO_DECIMAL عددی که در آن اعداد تک‌رقمی با صفر پیشوندگذاری می‌شوند، مثل 01، 02، یا 03. اعداد بیشتر از یک رقم با صفر پیشوند نمی‌گیرند.
UPPER_ALPHA حرف بزرگ، مثل A،‏ B، یا C.
ALPHA حرف کوچک، مثل a،‏ b، یا c.
UPPER_ROMAN عدد رومی با حروف بزرگ، مانند I، II، یا III.
ROMAN عدد رومی کوچک، مانند i، ii، یا iii.

SuggestedListProperties

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

نمایش JSON 
{
  "listProperties": {
    object (ListProperties)
  },
  "listPropertiesSuggestionState": {
    object (ListPropertiesSuggestionState)
  }
}
فیلدها
listProperties

object (ListProperties)

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

object (ListPropertiesSuggestionState)

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

ListPropertiesSuggestionState

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

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

object (NestingLevelSuggestionState)

پوششی که نشان می‌دهد کدام‌یک از فیلدهای NestingLevel مربوطه در nestingLevels در این پیشنهاد تغییر کرده است.

پیشنهاد سطح تودرتو بودن وضعیت‌ها به‌ترتیب صعودی سطح تودرتو بودن برگردانده می‌شود و کمترین تودرتو بودن در ابتدا برگردانده می‌شود.

NestingLevelSuggestionState

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

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

boolean

نشان می‌دهد که آیا تغییری برای bulletAlignment پیشنهاد شده است یا نه.
glyphTypeSuggested

boolean

نشان می‌دهد که آیا تغییری برای glyphType پیشنهاد شده است یا نه.
glyphFormatSuggested

boolean

نشان می‌دهد که آیا تغییری برای glyphFormat پیشنهاد شده است یا نه.
glyphSymbolSuggested

boolean

نشان می‌دهد که آیا تغییری برای glyphSymbol پیشنهاد شده است یا نه.
indentFirstLineSuggested

boolean

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

boolean

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

object (TextStyleSuggestionState)

پوششی که نشان می‌دهد کدام‌یک از فیلدهای text style در این پیشنهاد تغییر کرده است.
startNumberSuggested

boolean

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

NamedRanges

مجموعه‌ای از همه NamedRangeهای موجود در سند که نام یکسانی دارند.

نمایش JSON 
{
  "name": string,
  "namedRanges": [
    {
      object (NamedRange)
    }
  ]
}
فیلدها
name

string

نامی که همه named ranges با آن مشترک هستند.
namedRanges[]

object (NamedRange)

NamedRangeهایی که نام یکسانی دارند.

NamedRange

مجموعه‌ای از Range با شناسه محدوده نام‌گذاری‌شده یکسان.

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

گستره نام‌گذاری‌شده با یک Range ایجاد می‌شود و محتوای درج‌شده در گستره نام‌گذاری‌شده معمولاً آن گستره را ازهم باز می‌کند. بااین‌حال، تغییرات خاصی در سند می‌تواند باعث شود که محدوده به چند محدوده تقسیم شود.

محدوده‌های نام‌گذاری‌شده خصوصی نیستند. همه برنامه‌ها و مشارکت‌کنندگانی که به سند دسترسی دارند می‌توانند محدوده‌های نام‌گذاری‌شده آن را ببینند.

نمایش JSON 
{
  "namedRangeId": string,
  "name": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
فیلدها
namedRangeId

string

شناسه محدوده نام‌گذاری‌شده.
name

string

نام محدوده نام‌گذاری‌شده.
ranges[]

object (Range)

محدوده‌هایی که به این محدوده نام‌گذاری‌شده تعلق دارند.

بُرد

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

نمایش JSON 
{
  "segmentId": string,
  "startIndex": integer,
  "endIndex": integer,
  "tabId": string
}
فیلدها
segmentId

string

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

integer

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

در همه موارد استفاده کنونی، باید نمایه شروع ارائه شود. این فیلد Int32Value است تا بتواند موارد استفاده آینده را با محدوده‌های باز دربر بگیرد.
endIndex

integer

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

در همه موارد استفاده کنونی، باید شاخص پایانی ارائه شود. این فیلد Int32Value است تا بتواند موارد استفاده آینده را با محدوده‌های باز دربر بگیرد.
tabId

string

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

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

  • درصورت ارائه، باید با شناسه برگه تکی مطابقت داشته باشد.

  • اگر حذف شود، درخواست برای برگه تکی اعمال می‌شود.

در سندی که حاوی چندین برگه است:

  • اگر ارائه شود، درخواست برای برگه مشخص‌شده اعمال می‌شود.

  • اگر حذف شود، درخواست برای اولین زبانه در سند اعمال می‌شود.

InlineObject

شیئی که به‌خط با نوشتار نشان داده می‌شود. ‫InlineObject حاوی EmbeddedObject مثل تصویر است.

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

string

شناسه این شیء درون‌خطی. می‌تواند برای به‌روزرسانی ویژگی‌های یک شیء استفاده شود.
inlineObjectProperties

object (InlineObjectProperties)

خصوصیات این شیء درون‌خطی.
suggestedInlineObjectPropertiesChanges

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

تغییرات پیشنهادی در خصوصیات شیء درون‌خطی، کلیدگذاری‌شده براساس شناسه پیشنهاد.
suggestedInsertionId

string

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

string

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

InlineObjectProperties

خصوصیات InlineObject.

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

object (EmbeddedObject)

شیء جاسازی‌شده این شیء درون‌خطی.

EmbeddedObject

شیء جاسازی‌شده در سند.

نمایش JSON 
{
  "title": string,
  "description": string,
  "embeddedObjectBorder": {
    object (EmbeddedObjectBorder)
  },
  "size": {
    object (Size)
  },
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "linkedContentReference": {
    object (LinkedContentReference)
  },

  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
}
فیلدها
title

string

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

string

شرح شیء جاسازی‌شده. title و description هر دو با هم ترکیب می‌شوند تا متن جایگزین را نمایش دهند.
embeddedObjectBorder

object (EmbeddedObjectBorder)

حاشیه شیء جاسازی‌شده.
size

object (Size)

اندازه قابل‌مشاهده تصویر پس‌از برش.
marginTop

object (Dimension)

حاشیه بالای شیء جاسازی‌شده.
marginBottom

object (Dimension)

حاشیه پایین شیء جاسازی‌شده.
marginRight

object (Dimension)

حاشیه راست شیء جاسازی‌شده.
marginLeft

object (Dimension)

حاشیه چپ شیء جاسازی‌شده.
linkedContentReference

object (LinkedContentReference)

ارجاع به محتوای منبع پیوندشده خارجی. برای مثال، وقتی شیء جاسازی‌شده نمودار پیوندی باشد، حاوی مرجعی به نمودار منبع «کاربرگ‌نگار Google» است.

اگر تنظیم نشده باشد، شیء جاسازی‌شده پیوند داده نمی‌شود.
ویژگی‌هایی که مختص هر نوع شیء جاسازی‌شده است. فهرست زیر شامل فیلدهای متقابلاً انحصاری است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
embeddedDrawingProperties

object (EmbeddedDrawingProperties)

ویژگی‌های یک طراحی جاسازی‌شده.
imageProperties

object (ImageProperties)

ویژگی‌های تصویر.
پایان فیلدهای متقابلاً انحصاری.

EmbeddedDrawingProperties

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

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

ImageProperties

ویژگی‌های تصویر.

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

string

نشانی وب تصویر با طول عمر پیش‌فرض ۳۰ دقیقه. این نشانی وب با حساب درخواست‌کننده برچسب‌گذاری شده است. هر کسی که نشانی وب را داشته باشد عملاً به‌عنوان درخواست‌کننده اصلی به تصویر دسترسی پیدا می‌کند. اگر تنظیمات هم‌رسانی سند تغییر کند، ممکن است دسترسی به تصویر ازدست برود.
sourceUri

string

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

number

جلوه روشنایی تصویر. این مقدار باید در بازه [-۱.۰، ۱.۰] باشد، که در آن ۰ به معنای بدون اثر است.
contrast

number

جلوه کنتراست تصویر. این مقدار باید در بازه [-۱.۰، ۱.۰] باشد، که در آن ۰ به معنای بدون اثر است.
transparency

number

جلوه شفافیت تصویر. این مقدار باید در بازه [۰٫۰، ۱٫۰] باشد، که در آن ۰ به معنی بدون اثر و ۱ به معنی شفاف است.
cropProperties

object (CropProperties)

ویژگی‌های برش تصویر.
angle

number

زاویه چرخش ساعت‌گرد تصویر، برحسب رادیان.

CropProperties

ویژگی‌های برش تصویر.

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

  • اگر انحراف در بازه (۰، ۱) باشد، لبه مربوطه مستطیل برش در داخل مستطیل محدودکننده اصلی تصویر قرار می‌گیرد.
  • اگر جبران منفی یا بزرگ‌تر از ۱ باشد، لبه مربوطه مستطیل برش در خارج از مستطیل محدودکننده اصلی تصویر قرار می‌گیرد.
  • اگر همه انحراف‌ها و زاویه‌های چرخش ۰ باشد، تصویر برش داده نمی‌شود.
نمایش JSON 
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
فیلدها
offsetLeft

number

مقدار جابه‌جایی مشخص می‌کند که لبه چپ مستطیل برش به‌صورت کسری از پهنای محتوای اصلی چقدر از لبه چپ محتوای اصلی به‌سمت داخل است.
offsetRight

number

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

number

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

number

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

number

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

EmbeddedObjectBorder

حاشیه‌ای دور EmbeddedObject.

نمایش JSON 
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle),
  "propertyState": enum (PropertyState)
}
فیلدها
color

object (OptionalColor)

رنگ حاشیه.
width

object (Dimension)

عرض حاشیه.
dashStyle

enum (DashStyle)

سبک خط فاصله حاشیه.
propertyState

enum (PropertyState)

وضعیت دارایی دارایی مرز.

PropertyState

وضعیت‌های ممکن یک ملک.

شمارشی‌ها
RENDERED اگر وضعیت دارایی «پردازش‌شده» باشد، عنصر هنگام پردازش در سند دارای دارایی مربوطه است. این مقدار پیش‌فرض است.
NOT_RENDERED اگر وضعیت دارایی NOT_RENDERED باشد، عنصر هنگام پرداز در سند دارایی مربوطه را ندارد.

LinkedContentReference

ارجاع به محتوای منبع پیوندشده خارجی.

نمایش JSON 
{

  "sheetsChartReference": {
    object (SheetsChartReference)
  }
}
فیلدها
مرجع خاص نوع محتوای پیوندشده. فهرست زیر شامل فیلدهای متقابلاً انحصاری است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
sheetsChartReference

object (SheetsChartReference)

ارجاع به نمودار پیوندشده.
پایان فیلدهای متقابلاً انحصاری.

SheetsChartReference

ارجاع به نمودار پیوندشده‌ای که از «کاربرگ‌نگار Google» جاسازی شده است.

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

string

شناسه صفحه‌گسترده «کاربرگ‌نگار Google» که حاوی نمودار منبع است.
chartId

integer

شناسه نمودار خاص در صفحه‌گسترده «کاربرگ‌نگار Google» که جاسازی شده است.

SuggestedInlineObjectProperties

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

نمایش JSON 
{
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "inlineObjectPropertiesSuggestionState": {
    object (InlineObjectPropertiesSuggestionState)
  }
}
فیلدها
inlineObjectProperties

object (InlineObjectProperties)

InlineObjectProperties که فقط شامل تغییرات ایجادشده در این پیشنهاد است. می‌توان از این همراه با inlineObjectPropertiesSuggestionState استفاده کرد تا ببینید کدام فیلدها تغییر کرده‌اند و مقادیر جدید آن‌ها چیست.
inlineObjectPropertiesSuggestionState

object (InlineObjectPropertiesSuggestionState)

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

InlineObjectPropertiesSuggestionState

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

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

object (EmbeddedObjectSuggestionState)

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

EmbeddedObjectSuggestionState

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

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

object (EmbeddedDrawingPropertiesSuggestionState)

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

object (ImagePropertiesSuggestionState)

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

boolean

نشان می‌دهد که آیا تغییری برای title پیشنهاد شده است یا نه.
descriptionSuggested

boolean

نشان می‌دهد که آیا تغییری برای description پیشنهاد شده است یا نه.
embeddedObjectBorderSuggestionState

object (EmbeddedObjectBorderSuggestionState)

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

object (SizeSuggestionState)

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

boolean

نشان می‌دهد که آیا تغییری برای marginLeft پیشنهاد شده است یا نه.
marginRightSuggested

boolean

نشان می‌دهد که آیا تغییری برای marginRight پیشنهاد شده است یا نه.
marginTopSuggested

boolean

نشان می‌دهد که آیا تغییری برای marginTop پیشنهاد شده است یا نه.
marginBottomSuggested

boolean

نشان می‌دهد که آیا تغییری برای marginBottom پیشنهاد شده است یا نه.
linkedContentReferenceSuggestionState

object (LinkedContentReferenceSuggestionState)

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

EmbeddedDrawingPropertiesSuggestionState

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

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

ImagePropertiesSuggestionState

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

نمایش JSON 
{
  "contentUriSuggested": boolean,
  "sourceUriSuggested": boolean,
  "brightnessSuggested": boolean,
  "contrastSuggested": boolean,
  "transparencySuggested": boolean,
  "cropPropertiesSuggestionState": {
    object (CropPropertiesSuggestionState)
  },
  "angleSuggested": boolean
}
فیلدها
contentUriSuggested

boolean

نشان می‌دهد که آیا تغییری برای contentUri پیشنهاد شده است یا نه.
sourceUriSuggested

boolean

نشان می‌دهد که آیا تغییری در [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri] پیشنهاد شده است یا نه.
brightnessSuggested

boolean

نشان می‌دهد که آیا تغییری برای [brightness] [google.apps.docs.v1.EmbeddedObject.brightness] پیشنهاد شده است یا نه.
contrastSuggested

boolean

نشان می‌دهد که آیا تغییری برای [تضاد] [google.apps.docs.v1.EmbeddedObject.contrast] پیشنهاد شده است یا نه.
transparencySuggested

boolean

نشان می‌دهد که آیا تغییری برای [شفافیت] [google.apps.docs.v1.EmbeddedObject.transparency] پیشنهاد شده است یا نه.
cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

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

boolean

نشان می‌دهد که آیا تغییری برای [angle] [google.apps.docs.v1.EmbeddedObject.angle] پیشنهاد شده است یا نه.

CropPropertiesSuggestionState

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

نمایش JSON 
{
  "offsetLeftSuggested": boolean,
  "offsetRightSuggested": boolean,
  "offsetTopSuggested": boolean,
  "offsetBottomSuggested": boolean,
  "angleSuggested": boolean
}
فیلدها
offsetLeftSuggested

boolean

نشان می‌دهد که آیا تغییری برای offsetLeft پیشنهاد شده است یا نه.
offsetRightSuggested

boolean

نشان می‌دهد که آیا تغییری برای offsetRight پیشنهاد شده است یا نه.
offsetTopSuggested

boolean

نشان می‌دهد که آیا تغییری برای offsetTop پیشنهاد شده است یا نه.
offsetBottomSuggested

boolean

نشان می‌دهد که آیا تغییری برای offsetBottom پیشنهاد شده است یا نه.
angleSuggested

boolean

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

EmbeddedObjectBorderSuggestionState

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

نمایش JSON 
{
  "colorSuggested": boolean,
  "widthSuggested": boolean,
  "dashStyleSuggested": boolean,
  "propertyStateSuggested": boolean
}
فیلدها
colorSuggested

boolean

نشان می‌دهد که آیا تغییری برای [color] [google.apps.docs.v1.EmbeddedBorderObject.color] پیشنهاد شده است یا نه.
widthSuggested

boolean

نشان می‌دهد که آیا تغییری برای [عرض] [google.apps.docs.v1.EmbeddedBorderObject.width] پیشنهاد شده است یا نه.
dashStyleSuggested

boolean

نشان می‌دهد که آیا تغییری برای [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style] پیشنهاد شده است یا نه.
propertyStateSuggested

boolean

نشان می‌دهد که آیا تغییر پیشنهادی برای [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state] وجود داشته است یا نه.

LinkedContentReferenceSuggestionState

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

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

object (SheetsChartReferenceSuggestionState)

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

SheetsChartReferenceSuggestionState

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

نمایش JSON 
{
  "spreadsheetIdSuggested": boolean,
  "chartIdSuggested": boolean
}
فیلدها
spreadsheetIdSuggested

boolean

نشان می‌دهد که آیا تغییری برای spreadsheetId پیشنهاد شده است یا نه.
chartIdSuggested

boolean

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

PositionedObject

شیئی که به Paragraph متصل است و نسبت‌به ابتدای پاراگراف در موقعیت قرار می‌گیرد. ‫PositionedObject حاوی EmbeddedObject مثل تصویر است.

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

string

شناسه این شیء موقعیت‌دار.
positionedObjectProperties

object (PositionedObjectProperties)

ویژگی‌های این شیء موقعیت‌دار.
suggestedPositionedObjectPropertiesChanges

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

تغییرات پیشنهادی در ویژگی‌های شیء موقعیت‌دار، کلیدگذاری‌شده براساس شناسه پیشنهاد.
suggestedInsertionId

string

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

string

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

PositionedObjectProperties

خصوصیات PositionedObject.

نمایش JSON 
{
  "positioning": {
    object (PositionedObjectPositioning)
  },
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
فیلدها
positioning

object (PositionedObjectPositioning)

موقعیت این شیء موقعیت‌دار نسبت‌به خط جدید Paragraph که به این شیء موقعیت‌دار ارجاع می‌دهد.
embeddedObject

object (EmbeddedObject)

شیء جاسازی‌شده این شیء موقعیت‌دار.

PositionedObjectPositioning

جایگاه PositionedObject. شیء موقعیت‌دار نسبت‌به ابتدای Paragraph که به آن متصل است موقعیت‌دهی می‌شود.

نمایش JSON 
{
  "layout": enum (PositionedObjectLayout),
  "leftOffset": {
    object (Dimension)
  },
  "topOffset": {
    object (Dimension)
  }
}
فیلدها
layout

enum (PositionedObjectLayout)

چیدمان این شیء موقعیت‌دار.
leftOffset

object (Dimension)

آفست لبه چپ شیء موقعیت‌دار نسبت‌به ابتدای Paragraph که به آن متصل است. موقعیت دقیق شیء می‌تواند به محتوای دیگر در سند و سبک سند بستگی داشته باشد.
topOffset

object (Dimension)

انحراف لبه بالای شیء موقعیت‌دار نسبت‌به ابتدای Paragraph که به آن متصل است. موقعیت دقیق شیء می‌تواند به محتوای دیگر در سند و سبک سند بستگی داشته باشد.

PositionedObjectLayout

چیدمان‌های ممکن [PositionedObject][google.aps.docs.v1.PositionedObject].

شمارشی‌ها
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED چیدمان مشخص نشده است.
WRAP_TEXT نوشتار دور شیء جای‌گذاری‌شده می‌پیچد.
BREAK_LEFT متن را به‌گونه‌ای می‌شکند که شیء جای‌گذاری‌شده در سمت راست و متن در سمت چپ قرار می‌گیرد.
BREAK_RIGHT متن را به‌گونه‌ای می‌شکند که شیء جای‌گذاری‌شده در سمت راست و متن در سمت چپ قرار می‌گیرد.
BREAK_LEFT_RIGHT متن را به‌گونه‌ای می‌شکند که در سمت چپ یا راست شیء جای‌گذاری‌شده هیچ متنی وجود نداشته باشد.
IN_FRONT_OF_TEXT شیء جای‌گذاری‌شده جلوی نوشتار است.
BEHIND_TEXT شیء موقعیت‌دار پشت نوشتار است.

SuggestedPositionedObjectProperties

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

نمایش JSON 
{
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "positionedObjectPropertiesSuggestionState": {
    object (PositionedObjectPropertiesSuggestionState)
  }
}
فیلدها
positionedObjectProperties

object (PositionedObjectProperties)

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

object (PositionedObjectPropertiesSuggestionState)

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

PositionedObjectPropertiesSuggestionState

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

نمایش JSON 
{
  "positioningSuggestionState": {
    object (PositionedObjectPositioningSuggestionState)
  },
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
فیلدها
positioningSuggestionState

object (PositionedObjectPositioningSuggestionState)

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

object (EmbeddedObjectSuggestionState)

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

PositionedObjectPositioningSuggestionState

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

نمایش JSON 
{
  "layoutSuggested": boolean,
  "leftOffsetSuggested": boolean,
  "topOffsetSuggested": boolean
}
فیلدها
layoutSuggested

boolean

نشان می‌دهد که آیا تغییری برای layout پیشنهاد شده است یا نه.
leftOffsetSuggested

boolean

نشان می‌دهد که آیا تغییری برای leftOffset پیشنهاد شده است یا نه.
topOffsetSuggested

boolean

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

CommentAnchor

یک یا چند مکان در سند که به CommentThreads با anchorId یکسان پیوند داده شده است. توجه: چندین نقطه اتکا ممکن است به یک مکان اشاره کنند.

نمایش JSON 
{
  "anchorId": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
فیلدها
anchorId

string

شناسه لنگر نظر.
ranges[]

object (Range)

مجموعه‌ای از Range در سند که به این لنگر متصل هستند.

SuggestedDropdownDefinitionProperties

تغییر پیشنهادی در دارایی‌های تعریف منو کرکره‌ای.

نمایش JSON 
{
  "dropdownDefinitionProperties": {
    object (DropdownDefinitionProperties)
  },
  "dropdownDefinitionPropertiesSuggestionState": {
    object (DropdownDefinitionPropertiesSuggestionState)
  }
}
فیلدها
dropdownDefinitionProperties

object (DropdownDefinitionProperties)

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

object (DropdownDefinitionPropertiesSuggestionState)

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

SuggestionsViewMode

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

شمارشی‌ها
DEFAULT_FOR_CURRENT_ACCESS «حالت نمایش پیشنهادها» اعمال‌شده بر سند برگشتی به سطح دسترسی فعلی کاربر بستگی دارد. اگر کاربر فقط دسترسی مشاهده داشته باشد، PREVIEW_WITHOUT_SUGGESTIONS اعمال می‌شود. درغیراین‌صورت، SUGGESTIONS_INLINE اعمال می‌شود. این حالت نمای پیشنهادهای پیش‌فرض است.
SUGGESTIONS_INLINE

سند برگشتی پیشنهادهای درون‌خطی دارد. تغییرات پیشنهادی در سند از محتوای پایه متمایز خواهد شد.

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

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

درخواست‌های بازیابی سند بااستفاده از این حالت، اگر کاربر اجازه مشاهده تغییرات پیشنهادی را نداشته باشد، خطای ۴۰۳ برمی‌گرداند.
PREVIEW_WITHOUT_SUGGESTIONS سند برگشتی پیش‌نمایشی است که در آن همه تغییرات پیشنهادی رد شده است (اگر پیشنهادی در سند وجود داشته باشد).

CommentsViewMode

حالت نمای نظرات روی سندی اعمال می‌شود که نشان می‌دهد آیا نظرات اضافه شده‌اند یا نه. این گزینه امکان خواندن سند با یا بدون نظرات و لنگرهای نظر را فراهم می‌کند.

اگر commentsViewMode را روی هر مقداری تنظیم کنید، باید includeTabsContent را نیز روی true تنظیم کنید یا از پوشش فیلدی استفاده کنید که به فیلد Document.tabs (یا هر فیلد فرعی) ارجاع می‌دهد.

نظرات فقط درصورتی برگردانده می‌شود که پیشنهادها به‌صورت به‌خط برگردانده شود. اگر commentsViewMode را روی COMMENTS_VIEW_MODE_INCLUDED یا COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS تنظیم کنید، فقط می‌توانید suggestionsViewMode را روی PREVIEW_WITHOUT_SUGGESTIONS یا PREVIEW_SUGGESTIONS_ACCEPTED تنظیم کنید.

شمارشی‌ها
COMMENTS_VIEW_MODE_UNSPECIFIED «حالت نمای نظرات» مشخص نشده است. ‫COMMENTS_VIEW_MODE_OMITTED اعمال می‌شود.
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS «حالت مشاهده نظرات» اعمال‌شده در سند برگشتی به سطح دسترسی فعلی کاربر بستگی دارد. اگر کاربر فقط دسترسی مشاهده داشته باشد، COMMENTS_VIEW_MODE_OMITTED اعمال می‌شود. درغیراین‌صورت، COMMENTS_VIEW_MODE_INCLUDED اعمال می‌شود.
COMMENTS_VIEW_MODE_OMITTED نظرات سند برگشتی حذف شده است.
COMMENTS_VIEW_MODE_INCLUDED

سند برگشتی حاوی نظر است.

درخواست‌های بازیابی سند بااستفاده از این حالت، اگر کاربر اجازه مشاهده نظرات را نداشته باشد، خطای ۴۰۳ برمی‌گرداند.

وقتی تنظیم شد، suggestionsViewMode نیز باید روی SUGGESTIONS_INLINE تنظیم شود. درغیراین‌صورت، خطای درخواست بد ۴۰۰ برمی‌گرداند.

CommentThread

نشان‌دهنده یک رشته نظر است.

نمایش JSON 
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
فیلدها
commentId

string

شناسه یکتای رشته نظر.
anchorId

string

شناسه CommentAnchor در سندی که این رشته به آن پیوند داده شده است. چندین رشته نظر ممکن است به یک CommentAnchor یکسان متصل شوند.
headPost

object (Post)

اولین پست در رشته.
replies[]

object (Post)

به پست اصلی پاسخ می‌دهد.
status

enum (Status)

باز یا حل‌وفصل شدن رشته.
نوشتار نقل‌شده از سند در زمان ایجاد نظر. فهرست زیر شامل فیلدهای متقابلاً انحصاری است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
plainTextQuote

string

نوشتار نقل‌شده از سند در زمان ایجاد نظر، قالب‌بندی‌شده به‌عنوان نوشتار ساده.
پایان فیلدهای متقابلاً انحصاری.

پست

نشان‌دهنده یک پست در رشته نظر یا پیشنهاد است.

نمایش JSON 
{
  "postId": string,
  "content": string,
  "contentHtml": string,
  "author": {
    object (PostAuthor)
  },
  "createTime": string,
  "updateTime": string,
  "deleted": boolean,
  "fromImportedDocument": boolean,
  "fromCopiedDocument": boolean,
  "fromDocumentComparison": boolean,
  "assigneeEmail": string,

  "commentAction": enum (CommentActionType),
  "suggestionAction": enum (SuggestionActionType)
}
فیلدها
postId

string

فقط برونداد. شناسه یکتای پست.
content

string

محتوای پست.

اگر commentAction برابر با RESOLVE یا REOPEN نباشد، باید غیرخالی باشد.

این محتوای نوشتاری مشابه نظرات ایجادشده در ویرایشگر «سندنگار» مدیریت خواهد شد. این ویژگی در قالب‌بندی، اعلان‌ها، و غیره رفتارهای مشابهی خواهد داشت.

نباید از ۲۰۴۸ واحد کد UTF-8 فراتر برود.
contentHtml

string

فقط برونداد. محتوای پست به‌صورت HTML.
author

object (PostAuthor)

فقط برونداد. کاربری که پست را ایجاد کرده است.
createTime

string (Timestamp format)

فقط برونداد. زمان ایجاد پست.
updateTime

string (Timestamp format)

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

boolean

فقط برونداد. اینکه پست حذف شده است یا نه. اگر true، فیلدهای content و author خالی خواهد بود.
fromImportedDocument

boolean

فقط برونداد. آیا پست از یک سند واردشده است. تماس‌گیرندگان نمی‌توانند این فیلد را مستقیماً تنظیم کنند.
fromCopiedDocument

boolean

فقط برونداد. اینکه پست از یک سند کپی‌شده باشد. تماس‌گیرندگان نمی‌توانند این فیلد را مستقیماً تنظیم کنند.
fromDocumentComparison

boolean

فقط برونداد. اینکه پست از مقایسه سند باشد. تماس‌گیرندگان نمی‌توانند این فیلد را مستقیماً تنظیم کنند.
assigneeEmail

string

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

درصورت بروز موارد زیر، خطای درخواست بد ۴۰۰ برمی‌گرداند:

  • رشته والد CommentThread است که headPost آن واگذارشده ندارد.

  • رشته اصلی SuggestionThread است.

  • ‫commentAction به‌عنوان RESOLVE یا REOPEN مشخص شده است.

  • ‫assigneeEmail از ۲۰۴۸ واحد کد UTF-8 فراتر رفته است.
کنش انجام‌شده به‌عنوان بخشی از ایجاد پست. فهرست زیر شامل فیلدهای متقابلاً انحصاری است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
commentAction

enum (CommentActionType)

اختیاری. نوع کنش برای پست‌های نظر.
suggestionAction

enum (SuggestionActionType)

فقط برونداد. نوع کنش برای پست‌های پیشنهادی.
پایان فیلدهای متقابلاً انحصاری.

PostAuthor

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

نمایش JSON 
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
فیلدها
displayName

string

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

boolean

اینکه آیا کاربر، کاربر اصالت‌سنجی‌شده‌ای است که درخواست را ارسال می‌کند.
anonymous

boolean

اینکه کاربر ناشناس است یا نه.
user

string

نام منبع کاربر نویسنده پست که همچنین می‌تواند برای شناسایی کاربر در Google People API استفاده شود. قالب: users/{user}. اگر فیلد ناشناس true باشد یا اگر پست از سند واردشده باشد، پر نخواهد شد.

CommentActionType

اقدام انجام‌شده با این پاسخ به رشته نظر.

شمارشی‌ها
COMMENT_ACTION_TYPE_UNSPECIFIED مقدار پیش‌فرض. از این مقدار استفاده نمی‌شود.
NO_COMMENT_ACTION_CHANGE هیچ تغییری در کنش این پست وجود ندارد.
RESOLVE این پست رشته را حل می‌کند.
REOPEN این پست رشته را دوباره باز می‌کند.

SuggestionActionType

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

شمارشی‌ها
SUGGESTION_ACTION_TYPE_UNSPECIFIED مقدار پیش‌فرض. از این مقدار استفاده نمی‌شود.
NO_SUGGESTION_ACTION_CHANGE هیچ تغییری در کنش این پست وجود ندارد.
ACCEPT این پست پیشنهاد را می‌پذیرد.
REJECT این پست پیشنهاد را رد می‌کند.

وضعیت

گزینه‌های وضعیت رشته نظر.

شمارشی‌ها
STATUS_UNSPECIFIED مقدار پیش‌فرض. از این مقدار استفاده نمی‌شود.
OPEN رشته نظر باز است.
RESOLVED رشتهٔ نظرات حل شد.

SuggestionThread

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

نمایش JSON 
{
  "suggestionId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),
  "summaryText": string,
  "summaryHtml": string
}
فیلدها
suggestionId

string

شناسه یکتای پیشنهاد.
headPost

object (Post)

اولین پست در رشته.
replies[]

object (Post)

به پست اصلی پاسخ می‌دهد.
status

enum (Status)

رشته باز، پذیرفته‌شده، یا ردشده باشد.
summaryText

string

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

string

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

وضعیت

گزینه‌های وضعیت رشته پیشنهاد.

شمارشی‌ها
STATUS_UNSPECIFIED مقدار پیش‌فرض. از این مقدار استفاده نمی‌شود.
OPEN رشته پیشنهاد باز است.
ACCEPTED رشته پیشنهاد پذیرفته شد.
REJECTED رشته پیشنهاد رد می‌شود.

روش‌ها

batchUpdate

 یک یا چند به‌روزرسانی را روی سند اعمال می‌کند.

create

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

get

 جدیدترین نسخه سند مشخص‌شده را دریافت می‌کند.