REST Resource: documents

منبع: سند

یک سند Google Docs.

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

string

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

title

string

عنوان سند.

tabs[]

object ( Tab )

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

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

revision Id

string

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

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

suggestions View Mode

enum ( SuggestionsViewMode )

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

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

body

object ( Body )

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

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

headers

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

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

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

footers

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

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

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

footnotes

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

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

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

document Style

object ( DocumentStyle )

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

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

suggested Document Style Changes

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

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

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

named Styles

object ( NamedStyles )

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

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

suggested Named Styles Changes

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 یا تنظیم نشده باشد، این قسمت حاوی اطلاعات مربوط به اولین برگه در سند است.

named Ranges

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

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

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

inline Objects

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

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

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

positioned Objects

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

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

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

Tab

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

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

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

object ( TabProperties )

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

child Tabs[]

object ( Tab )

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

content زمینه اتحادیه محتوای برگه. content فقط می تواند یکی از موارد زیر باشد:
document Tab

object ( DocumentTab )

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

TabProperties

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

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

string

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

title

string

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

parent Tab Id

string

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

index

integer

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

nesting Level

integer

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

DocumentTab

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

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

object ( Body )

بدنه اصلی برگه سند.

headers

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

سرصفحه ها در برگه سند، با شناسه سرصفحه کلید شده اند.

footers

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

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

footnotes

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

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

document Style

object ( DocumentStyle )

سبک برگه سند.

suggested Document Style Changes

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

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

named Styles

object ( NamedStyles )

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

suggested Named Styles Changes

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

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

lists

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

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

named Ranges

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

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

inline Objects

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

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

positioned Objects

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

اشیاء قرار داده شده در برگه سند، با شناسه شی کلید زده می شوند.

بدن

بدنه سند

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

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

object ( StructuralElement )

محتویات بدن.

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

عنصر ساختاری

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

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

  // Union field content can be only one of the following:
  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
  // End of list of possible types for union field content.
}
فیلدها
start Index

integer

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

end Index

integer

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

content زمینه اتحادیه محتوای عنصر ساختاری. content فقط می تواند یکی از موارد زیر باشد:
paragraph

object ( Paragraph )

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

section Break

object ( SectionBreak )

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

table

object ( Table )

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

table Of Contents

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 )

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

paragraph Style

object ( ParagraphStyle )

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

suggested Paragraph Style Changes

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

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

bullet

object ( Bullet )

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

suggested Bullet Changes

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

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

positioned Object Ids[]

string

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

suggested Positioned Object Ids

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

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

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

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

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

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

integer

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

end Index

integer

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

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

object ( TextRun )

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

auto Text

object ( AutoText )

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

page Break

object ( PageBreak )

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

column Break

object ( ColumnBreak )

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

footnote Reference

object ( FootnoteReference )

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

horizontal Rule

object ( HorizontalRule )

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

equation

object ( Equation )

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

inline Object Element

object ( InlineObjectElement )

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

person

object ( Person )

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

TextRun

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

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

string

متن این اجرا.

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

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

text Style

object ( TextStyle )

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

suggested Text Style Changes

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

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

TextStyle

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

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

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

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

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

boolean

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

italic

boolean

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

underline

boolean

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

strikethrough

boolean

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

small Caps

boolean

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

background Color

object ( OptionalColor )

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

foreground Color

object ( OptionalColor )

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

font Size

object ( Dimension )

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

weighted Font Family

object ( WeightedFontFamily )

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

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

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

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

baseline Offset

enum ( BaselineOffset )

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

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

رنگ اختیاری

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

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

object ( Color )

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

رنگ

یک رنگ ثابت

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

object ( RgbColor )

مقدار رنگ RGB

RgbColor

یک رنگ RGB

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

number

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

green

number

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

blue

number

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

بعد

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

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

number

بزرگی.

unit

enum ( Unit )

واحدهای قدر

واحد

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

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

WeightedFontFamily

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

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

string

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

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

weight

integer

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

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

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

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

آفست پایه

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

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

SuggestedTextStyle

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

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

object ( TextStyle )

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

text Style Suggestion State

object ( TextStyleSuggestionState )

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

TextStyleSuggestionState

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

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

boolean

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

italic Suggested

boolean

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

underline Suggested

boolean

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

strikethrough Suggested

boolean

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

small Caps Suggested

boolean

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

background Color Suggested

boolean

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

foreground Color Suggested

boolean

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

font Size Suggested

boolean

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

weighted Font Family Suggested

boolean

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

baseline Offset Suggested

boolean

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

متن خودکار

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

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

enum ( Type )

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

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

text Style

object ( TextStyle )

سبک متن این AutoText.

suggested Text Style Changes

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

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

تایپ کنید

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

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

Page Break

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

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

string

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

suggested Deletion Ids[]

string

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

text Style

object ( TextStyle )

سبک متن این PageBreak.

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

suggested Text Style Changes

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

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

ColumnBreak

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

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

string

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

suggested Deletion Ids[]

string

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

text Style

object ( TextStyle )

سبک متن این ColumnBreak.

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

suggested Text Style Changes

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

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

پانوشت مرجع

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

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

string

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

footnote Number

string

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

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

text Style

object ( TextStyle )

سبک متن این FootnoteReference.

suggested Text Style Changes

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

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

قانون افقی

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

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

string

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

suggested Deletion Ids[]

string

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

text Style

object ( TextStyle )

سبک متن این HorizontalRule.

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

suggested Text Style Changes

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

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

معادله

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

نمایندگی JSON 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
فیلدها
suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

InlineObjectElement

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

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

string

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

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

text Style

object ( TextStyle )

سبک متن این InlineObjectElement.

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

suggested Text Style Changes

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

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

شخص

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

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

string

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

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

text Style

object ( TextStyle )

سبک متن این Person .

suggested Text Style Changes

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

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

person Properties

object ( PersonProperties )

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

ویژگی های شخص

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

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

string

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

email

string

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

RichLinkProperties

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

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

string

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

uri

string

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

mime Type

string

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

سبک پاراگراف

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

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

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

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

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

string

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

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

named Style Type

enum ( NamedStyleType )

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

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

alignment

enum ( Alignment )

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

line Spacing

number

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

direction

enum ( ContentDirection )

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

spacing Mode

enum ( SpacingMode )

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

space Above

object ( Dimension )

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

space Below

object ( Dimension )

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

border Between

object ( ParagraphBorder )

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

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

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

border Top

object ( ParagraphBorder )

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

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

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

border Bottom

object ( ParagraphBorder )

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

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

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

border Left

object ( ParagraphBorder )

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

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

border Right

object ( ParagraphBorder )

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

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

indent First Line

object ( Dimension )

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

indent Start

object ( Dimension )

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

indent End

object ( Dimension )

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

tab Stops[]

object ( TabStop )

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

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

keep Lines Together

boolean

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

keep With Next

boolean

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

avoid Widow And Orphan

boolean

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

shading

object ( Shading )

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

page Break Before

boolean

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

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

NamedStyleType

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

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

تراز

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

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

جهت محتوا

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

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

فاصله فاصله

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

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

ParagraphBorder

یک حاشیه در اطراف یک پاراگراف.

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

object ( OptionalColor )

رنگ حاشیه.

width

object ( Dimension )

عرض حاشیه.

padding

object ( Dimension )

لایه بندی حاشیه.

dash Style

enum ( DashStyle )

سبک خط تیره حاشیه.

DashStyle

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

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

TabStop

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

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

object ( Dimension )

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

alignment

enum ( TabStopAlignment )

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

تبادل نظر

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

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

سایه زدن

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

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

object ( OptionalColor )

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

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

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

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

object ( ParagraphStyle )

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

paragraph Style Suggestion State

object ( ParagraphStyleSuggestionState )

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

پاراگراف

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

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

boolean

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

named Style Type Suggested

boolean

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

alignment Suggested

boolean

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

line Spacing Suggested

boolean

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

direction Suggested

boolean

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

spacing Mode Suggested

boolean

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

space Above Suggested

boolean

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

space Below Suggested

boolean

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

border Between Suggested

boolean

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

border Top Suggested

boolean

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

border Bottom Suggested

boolean

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

border Left Suggested

boolean

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

border Right Suggested

boolean

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

indent First Line Suggested

boolean

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

indent Start Suggested

boolean

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

indent End Suggested

boolean

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

keep Lines Together Suggested

boolean

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

keep With Next Suggested

boolean

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

avoid Widow And Orphan Suggested

boolean

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

shading Suggestion State

object ( ShadingSuggestionState )

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

page Break Before Suggested

boolean

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

ShadingsuggestionState

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

نمایندگی JSON 
{
  "backgroundColorSuggested": boolean
}
فیلدها
background Color Suggested

boolean

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

گلوله

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

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

string

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

nesting Level

integer

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

text Style

object ( TextStyle )

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

پیشنهاد شده

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

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

object ( Bullet )

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

bullet Suggestion State

object ( BulletSuggestionState )

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

BulletSuggestionState

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

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

boolean

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

nesting Level Suggested

boolean

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

text Style Suggestion State

object ( TextStyleSuggestionState )

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

عذاب

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

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

string

IDS Object.

بخشیدن

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

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

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

string

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

suggested Deletion Ids[]

string

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

section Style

object ( SectionStyle )

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

بخش

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

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

object ( SectionColumnProperties )

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

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

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

column Separator Style

enum ( ColumnSeparatorStyle )

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

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

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

content Direction

enum ( ContentDirection )

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

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

margin Top

object ( Dimension )

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

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

margin Bottom

object ( Dimension )

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

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

margin Right

object ( Dimension )

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

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

margin Left

object ( Dimension )

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

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

margin Header

object ( Dimension )

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

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

section Type

enum ( SectionType )

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

default Header Id

string

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

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

first Page Header Id

string

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

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

first Page Footer Id

string

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

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

even Page Header Id

string

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

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

even Page Footer Id

string

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

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

use First Page Header Footer

boolean

نشان می دهد که آیا می توانید از صفحه اول / شناسه صفحه / صفحه برای صفحه اول بخش استفاده کنید. در صورت عدم استفاده ، آن را برای بخش اول از DocumentStyle's useFirstPageHeaderFooter به ارث می برد. اگر مقدار برای بخش های بعدی غیرقانونی باشد ، باید به عنوان نادرست تعبیر شود.

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

page Number Start

integer

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

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

flip Page Orientation

boolean

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

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

بخش columnproperties

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

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

object ( Dimension )

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

padding End

object ( Dimension )

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

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

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

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

نوع

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

Enums
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

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

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

table Rows[]

object ( TableRow )

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

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

table Style

object ( TableStyle )

سبک جدول.

TableRow

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

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

integer

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

end Index

integer

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

table Cells[]

object ( TableCell )

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

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

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

table Row Style

object ( TableRowStyle )

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

suggested Table Row Style Changes

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)
    },
    ...
  }
}
فیلدها
start Index

integer

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

end Index

integer

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

content[]

object ( StructuralElement )

محتوای سلول

table Cell Style

object ( TableCellStyle )

سبک سلول

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

suggested Table Cell Style Changes

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

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

سفره سفالی

سبک یک TableCell .

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

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

integer

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

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

column Span

integer

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

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

background Color

object ( OptionalColor )

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

border Left

object ( TableCellBorder )

مرز چپ سلول.

border Right

object ( TableCellBorder )

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

border Top

object ( TableCellBorder )

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

border Bottom

object ( TableCellBorder )

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

padding Left

object ( Dimension )

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

padding Right

object ( Dimension )

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

padding Top

object ( Dimension )

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

padding Bottom

object ( Dimension )

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

content Alignment

enum ( ContentAlignment )

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

سفره سفالی

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

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

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

object ( OptionalColor )

رنگ مرز.

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

width

object ( Dimension )

عرض مرز.

dash Style

enum ( DashStyle )

سبک خط مرز.

محتوای محتوا

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

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

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

پیشنهاد شده

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

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

object ( TableCellStyle )

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

table Cell Style Suggestion State

object ( TableCellStyleSuggestionState )

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

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

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

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

boolean

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

column Span Suggested

boolean

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

background Color Suggested

boolean

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

border Left Suggested

boolean

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

border Right Suggested

boolean

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

border Top Suggested

boolean

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

border Bottom Suggested

boolean

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

padding Left Suggested

boolean

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

padding Right Suggested

boolean

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

padding Top Suggested

boolean

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

padding Bottom Suggested

boolean

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

content Alignment Suggested

boolean

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

سبک سفره

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

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

object ( Dimension )

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

table Header

boolean

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

prevent Overflow

boolean

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

پیشنهاد شده

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

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

object ( TableRowStyle )

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

table Row Style Suggestion State

object ( TableRowStyleSuggestionState )

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

TableRowstylesuggestState

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

نمایندگی JSON 
{
  "minRowHeightSuggested": boolean
}
فیلدها
min Row Height Suggested

boolean

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

سبک سفره

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

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

object ( TableColumnProperties )

خواص هر ستون.

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

سفره

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

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

enum ( WidthType )

نوع عرض ستون.

width

object ( Dimension )

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

نوع عرض

نوع عرض ستون.

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

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

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

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

میزهای جدول

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

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

object ( StructuralElement )

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

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

پاورقی

پاورقی سند.

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

string

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

content[]

object ( StructuralElement )

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

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

سبک نامه

سبک سند.

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

object ( Background )

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

default Header Id

string

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

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

even Page Header Id

string

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

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

even Page Footer Id

string

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

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

first Page Header Id

string

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

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

first Page Footer Id

string

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

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

use First Page Header Footer

boolean

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

use Even Page Header Footer

boolean

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

page Number Start

integer

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

margin Top

object ( Dimension )

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

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

margin Bottom

object ( Dimension )

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

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

margin Right

object ( Dimension )

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

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

margin Left

object ( Dimension )

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

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

page Size

object ( Size )

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

margin Header

object ( Dimension )

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

flip Page Orientation

boolean

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

پس زمینه

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

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

object ( OptionalColor )

رنگ پس زمینه.

اندازه

عرض و ارتفاع.

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

object ( Dimension )

ارتفاع شی.

width

object ( Dimension )

عرض شی.

پیشنهادی documentStyle

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

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

object ( DocumentStyle )

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

document Style Suggestion State

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
}
فیلدها
background Suggestion State

object ( BackgroundSuggestionState )

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

default Header Id Suggested

boolean

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

even Page Header Id Suggested

boolean

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

even Page Footer Id Suggested

boolean

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

first Page Header Id Suggested

boolean

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

first Page Footer Id Suggested

boolean

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

use First Page Header Footer Suggested

boolean

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

use Even Page Header Footer Suggested

boolean

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

page Number Start Suggested

boolean

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

margin Top Suggested

boolean

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

margin Bottom Suggested

boolean

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

margin Right Suggested

boolean

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

margin Left Suggested

boolean

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

page Size Suggestion State

object ( SizeSuggestionState )

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

margin Header Suggested

boolean

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

flip Page Orientation Suggested

boolean

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

پیش زمینه

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

نمایندگی JSON 
{
  "backgroundColorSuggested": boolean
}
فیلدها
background Color Suggested

boolean

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

اندازه های UgegestionState

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

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

boolean

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

width Suggested

boolean

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

نامگذاری شده

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

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

object ( NamedStyle )

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

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

نامگذاری شده

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

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

enum ( NamedStyleType )

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

text Style

object ( TextStyle )

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

paragraph Style

object ( ParagraphStyle )

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

نامگذاری شده

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

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

object ( NamedStyles )

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

named Styles Suggestion State

object ( NamedStylesSuggestionState )

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

نامگذاری شده

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

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

object ( NamedStyleSuggestionState )

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

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

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

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

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

enum ( NamedStyleType )

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

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

text Style Suggestion State

object ( TextStyleSuggestionState )

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

paragraph Style Suggestion State

object ( ParagraphStyleSuggestionState )

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

فهرست کنید

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

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

object ( ListProperties )

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

suggested List Properties Changes

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

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

suggested Insertion Id

string

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

suggested Deletion Ids[]

string

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

ListProperties

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

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

object ( NestingLevel )

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

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

با روکش سطحی

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

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

  // Union field glyph_kind can be only one of the following:
  "glyphType": enum (GlyphType),
  "glyphSymbol": string
  // End of list of possible types for union field glyph_kind.
}
فیلدها
bullet Alignment

enum ( BulletAlignment )

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

glyph Format

string

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

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

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

A.

B.

C.

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

1.

2.

2.1.

2.2.

3.

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

indent First Line

object ( Dimension )

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

indent Start

object ( Dimension )

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

text Style

object ( TextStyle )

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

start Number

integer

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

مقدار 0 به عنوان مقدار 1 برای لیست های نامه ای و لیست های اعداد رومی رفتار می شود. برای مقادیر هر دو لیست شماره های شماره 0 و 1 ، به ترتیب در a و i آغاز می شود.

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

Union Field glyph_kind . نوع گلیف که توسط گلوله ها استفاده می شود. این کار گلوله ای را که جایگزین متغیرهای موجود در glyph_format می شود ، تعریف می کند. glyph_kind تنها می تواند یکی از موارد زیر باشد:
glyph Type

enum ( GlyphType )

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

نوع گلیف نوع گلیف مورد استفاده برای جایگزینی متغیرهای موجود در glyphFormat را هنگام سفارش پاراگراف در این سطح از لانه سازی تعیین می کند. به عنوان مثال ، اگر سطح لانه سازی 0 باشد ، glyphFormat %0. و نوع گلیف DECIMAL است ، سپس گلیف ارائه شده جایگزین Place Holder %0 در قالب Glyph با شماره ای متناسب با سفارش مورد در لیست می شود.

glyph Symbol

string

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

نماد گلیف جایگزین متغیرهای موجود در glyphFormat می شود. به عنوان مثال ، اگر Glyphsymbol دایره جامد مربوط به نقطه کد Unicode U+25CF باشد و glyphFormat %0 باشد ، گلیف ارائه شده دایره جامد خواهد بود.

بولتن

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

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

گلی فتایپ

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

Enums
GLYPH_TYPE_UNSPECIFIED نوع گلیف نامشخص یا پشتیبانی نشده است.
NONE یک رشته خالی
DECIMAL یک عدد ، مانند 1 ، 2 یا 3 .
ZERO_DECIMAL عددی که شماره های تک رقمی با صفر ، مانند 01 ، 02 یا 03 پیشوند می شوند. اعداد با بیش از یک رقم با صفر پیشوند نیستند.
UPPER_ALPHA یک حرف بزرگ ، مانند A ، B یا C .
ALPHA یک حرف کوچک ، مانند a ، b یا c .
UPPER_ROMAN An uppercase Roman numeral, like I , II , or III .
ROMAN A lowercase Roman numeral, like i , ii , or iii .

SuggestedListProperties

A suggested change to ListProperties .

JSON representation 
{
  "listProperties": {
    object (ListProperties)
  },
  "listPropertiesSuggestionState": {
    object (ListPropertiesSuggestionState)
  }
}
فیلدها
list Properties

object ( ListProperties )

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

list Properties Suggestion State

object ( ListPropertiesSuggestionState )

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

ListPropertiesSuggestionState

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

JSON representation 
{
  "nestingLevelsSuggestionStates": [
    {
      object (NestingLevelSuggestionState)
    }
  ]
}
فیلدها
nesting Levels Suggestion States[]

object ( NestingLevelSuggestionState )

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

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

NestingLevelSuggestionState

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

JSON representation 
{
  "bulletAlignmentSuggested": boolean,
  "glyphTypeSuggested": boolean,
  "glyphFormatSuggested": boolean,
  "glyphSymbolSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "startNumberSuggested": boolean
}
فیلدها
bullet Alignment Suggested

boolean

Indicates if there was a suggested change to bulletAlignment .

glyph Type Suggested

boolean

Indicates if there was a suggested change to glyphType .

glyph Format Suggested

boolean

Indicates if there was a suggested change to glyphFormat .

glyph Symbol Suggested

boolean

Indicates if there was a suggested change to glyphSymbol .

indent First Line Suggested

boolean

Indicates if there was a suggested change to indentFirstLine .

indent Start Suggested

boolean

Indicates if there was a suggested change to indentStart .

text Style Suggestion State

object ( TextStyleSuggestionState )

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

start Number Suggested

boolean

Indicates if there was a suggested change to startNumber .

NamedRanges

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

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

string

The name that all the named ranges share.

named Ranges[]

object ( NamedRange )

The NamedRange s that share the same name.

NamedRange

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

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

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

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

JSON representation 
{
  "namedRangeId": string,
  "name": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
فیلدها
named Range Id

string

The ID of the named range.

name

string

The name of the named range.

ranges[]

object ( Range )

The ranges that belong to this named range.

محدوده

Specifies a contiguous range of text.

JSON representation 
{
  "segmentId": string,
  "startIndex": integer,
  "endIndex": integer,
  "tabId": string
}
فیلدها
segment Id

string

The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body.

start Index

integer

The zero-based start index of this range, in UTF-16 code units.

In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.

end Index

integer

The zero-based end index of this range, exclusive, in UTF-16 code units.

In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.

tab Id

string

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

In a document containing a single tab:

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

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

In a document containing multiple tabs:

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

  • If omitted, the request applies to the first tab in the document.

InlineObject

An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image.

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

string

The ID of this inline object. Can be used to update an object's properties.

inline Object Properties

object ( InlineObjectProperties )

The properties of this inline object.

suggested Inline Object Properties Changes

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

The suggested changes to the inline object properties, keyed by suggestion ID.

suggested Insertion Id

string

The suggested insertion ID. If empty, then this is not a suggested insertion.

suggested Deletion Ids[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

InlineObjectProperties

Properties of an InlineObject .

JSON representation 
{
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
فیلدها
embedded Object

object ( EmbeddedObject )

The embedded object of this inline object.

EmbeddedObject

An embedded object in the document.

JSON representation 
{
  "title": string,
  "description": string,
  "embeddedObjectBorder": {
    object (EmbeddedObjectBorder)
  },
  "size": {
    object (Size)
  },
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "linkedContentReference": {
    object (LinkedContentReference)
  },

  // Union field properties can be only one of the following:
  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
  // End of list of possible types for union field properties.
}
فیلدها
title

string

The title of the embedded object. The title and description are both combined to display alt text.

description

string

The description of the embedded object. The title and description are both combined to display alt text.

embedded Object Border

object ( EmbeddedObjectBorder )

The border of the embedded object.

size

object ( Size )

The visible size of the image after cropping.

margin Top

object ( Dimension )

The top margin of the embedded object.

margin Bottom

object ( Dimension )

The bottom margin of the embedded object.

margin Right

object ( Dimension )

The right margin of the embedded object.

margin Left

object ( Dimension )

The left margin of the embedded object.

linked Content Reference

object ( LinkedContentReference )

A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart.

If unset, then the embedded object is not linked.

Union field properties . The properties that are specific to each embedded object type. properties can be only one of the following:
embedded Drawing Properties

object ( EmbeddedDrawingProperties )

The properties of an embedded drawing.

image Properties

object ( ImageProperties )

The properties of an image.

EmbeddedDrawingProperties

This type has no fields.

The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported.

ImageProperties

The properties of an image.

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

string

A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.

source Uri

string

The source URI is the URI used to insert the image. The source URI can be empty.

brightness

number

The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.

contrast

number

The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.

transparency

number

The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.

crop Properties

object ( CropProperties )

The crop properties of the image.

angle

number

The clockwise rotation angle of the image, in radians.

CropProperties

The crop properties of an image.

The crop rectangle is represented using fractional offsets from the original content's 4 edges.

  • If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle.
  • If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle.
  • If all offsets and rotation angle are 0, the image is not cropped.
JSON representation 
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
فیلدها
offset Left

number

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

offset Right

number

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

offset Top

number

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

offset Bottom

number

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

angle

number

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

EmbeddedObjectBorder

A border around an EmbeddedObject .

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

object ( OptionalColor )

The color of the border.

width

object ( Dimension )

The width of the border.

dash Style

enum ( DashStyle )

The dash style of the border.

property State

enum ( PropertyState )

The property state of the border property.

PropertyState

The possible states of a property.

Enums
RENDERED If a property's state is RENDERED, then the element has the corresponding property when rendered in the document. این مقدار پیش فرض است.
NOT_RENDERED If a property's state is NOT_RENDERED, then the element does not have the corresponding property when rendered in the document.

LinkedContentReference

A reference to the external linked source content.

JSON representation 
{

  // Union field reference can be only one of the following:
  "sheetsChartReference": {
    object (SheetsChartReference)
  }
  // End of list of possible types for union field reference.
}
فیلدها
Union field reference . The reference specific to the type of linked content. reference can be only one of the following:
sheets Chart Reference

object ( SheetsChartReference )

A reference to the linked chart.

SheetsChartReference

A reference to a linked chart embedded from Google Sheets.

JSON representation 
{
  "spreadsheetId": string,
  "chartId": integer
}
فیلدها
spreadsheet Id

string

The ID of the Google Sheets spreadsheet that contains the source chart.

chart Id

integer

The ID of the specific chart in the Google Sheets spreadsheet that's embedded.

SuggestedInlineObjectProperties

A suggested change to InlineObjectProperties .

JSON representation 
{
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "inlineObjectPropertiesSuggestionState": {
    object (InlineObjectPropertiesSuggestionState)
  }
}
فیلدها
inline Object Properties

object ( InlineObjectProperties )

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

inline Object Properties Suggestion State

object ( InlineObjectPropertiesSuggestionState )

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

InlineObjectPropertiesSuggestionState

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

JSON representation 
{
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
فیلدها
embedded Object Suggestion State

object ( EmbeddedObjectSuggestionState )

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

EmbeddedObjectSuggestionState

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

JSON representation 
{
  "embeddedDrawingPropertiesSuggestionState": {
    object (EmbeddedDrawingPropertiesSuggestionState)
  },
  "imagePropertiesSuggestionState": {
    object (ImagePropertiesSuggestionState)
  },
  "titleSuggested": boolean,
  "descriptionSuggested": boolean,
  "embeddedObjectBorderSuggestionState": {
    object (EmbeddedObjectBorderSuggestionState)
  },
  "sizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginLeftSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "linkedContentReferenceSuggestionState": {
    object (LinkedContentReferenceSuggestionState)
  }
}
فیلدها
embedded Drawing Properties Suggestion State

object ( EmbeddedDrawingPropertiesSuggestionState )

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

image Properties Suggestion State

object ( ImagePropertiesSuggestionState )

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

title Suggested

boolean

Indicates if there was a suggested change to title .

description Suggested

boolean

Indicates if there was a suggested change to description .

embedded Object Border Suggestion State

object ( EmbeddedObjectBorderSuggestionState )

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

size Suggestion State

object ( SizeSuggestionState )

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

margin Left Suggested

boolean

Indicates if there was a suggested change to marginLeft .

margin Right Suggested

boolean

Indicates if there was a suggested change to marginRight .

margin Top Suggested

boolean

Indicates if there was a suggested change to marginTop .

margin Bottom Suggested

boolean

Indicates if there was a suggested change to marginBottom .

linked Content Reference Suggestion State

object ( LinkedContentReferenceSuggestionState )

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

EmbeddedDrawingPropertiesSuggestionState

This type has no fields.

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

ImagePropertiesSuggestionState

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

JSON representation 
{
  "contentUriSuggested": boolean,
  "sourceUriSuggested": boolean,
  "brightnessSuggested": boolean,
  "contrastSuggested": boolean,
  "transparencySuggested": boolean,
  "cropPropertiesSuggestionState": {
    object (CropPropertiesSuggestionState)
  },
  "angleSuggested": boolean
}
فیلدها
content Uri Suggested

boolean

Indicates if there was a suggested change to contentUri .

source Uri Suggested

boolean

Indicates if there was a suggested change to [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri].

brightness Suggested

boolean

Indicates if there was a suggested change to [brightness] [google.apps.docs.v1.EmbeddedObject.brightness].

contrast Suggested

boolean

Indicates if there was a suggested change to [contrast] [google.apps.docs.v1.EmbeddedObject.contrast].

transparency Suggested

boolean

Indicates if there was a suggested change to [transparency] [google.apps.docs.v1.EmbeddedObject.transparency].

crop Properties Suggestion State

object ( CropPropertiesSuggestionState )

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

angle Suggested

boolean

Indicates if there was a suggested change to [angle] [google.apps.docs.v1.EmbeddedObject.angle].

CropPropertiesSuggestionState

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

JSON representation 
{
  "offsetLeftSuggested": boolean,
  "offsetRightSuggested": boolean,
  "offsetTopSuggested": boolean,
  "offsetBottomSuggested": boolean,
  "angleSuggested": boolean
}
فیلدها
offset Left Suggested

boolean

Indicates if there was a suggested change to offsetLeft .

offset Right Suggested

boolean

Indicates if there was a suggested change to offsetRight .

offset Top Suggested

boolean

Indicates if there was a suggested change to offsetTop .

offset Bottom Suggested

boolean

Indicates if there was a suggested change to offsetBottom .

angle Suggested

boolean

Indicates if there was a suggested change to angle .

EmbeddedObjectBorderSuggestionState

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

JSON representation 
{
  "colorSuggested": boolean,
  "widthSuggested": boolean,
  "dashStyleSuggested": boolean,
  "propertyStateSuggested": boolean
}
فیلدها
color Suggested

boolean

Indicates if there was a suggested change to [color] [google.apps.docs.v1.EmbeddedBorderObject.color].

width Suggested

boolean

Indicates if there was a suggested change to [width] [google.apps.docs.v1.EmbeddedBorderObject.width].

dash Style Suggested

boolean

Indicates if there was a suggested change to [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style].

property State Suggested

boolean

Indicates if there was a suggested change to [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state].

LinkedContentReferenceSuggestionState

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

JSON representation 
{
  "sheetsChartReferenceSuggestionState": {
    object (SheetsChartReferenceSuggestionState)
  }
}
فیلدها
sheets Chart Reference Suggestion State

object ( SheetsChartReferenceSuggestionState )

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

SheetsChartReferenceSuggestionState

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

JSON representation 
{
  "spreadsheetIdSuggested": boolean,
  "chartIdSuggested": boolean
}
فیلدها
spreadsheet Id Suggested

boolean

Indicates if there was a suggested change to spreadsheetId .

chart Id Suggested

boolean

Indicates if there was a suggested change to chartId .

PositionedObject

An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image.

JSON representation 
{
  "objectId": string,
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "suggestedPositionedObjectPropertiesChanges": {
    string: {
      object (SuggestedPositionedObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
فیلدها
object Id

string

The ID of this positioned object.

positioned Object Properties

object ( PositionedObjectProperties )

The properties of this positioned object.

suggested Positioned Object Properties Changes

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

The suggested changes to the positioned object properties, keyed by suggestion ID.

suggested Insertion Id

string

The suggested insertion ID. If empty, then this is not a suggested insertion.

suggested Deletion Ids[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

PositionedObjectProperties

Properties of a PositionedObject .

JSON representation 
{
  "positioning": {
    object (PositionedObjectPositioning)
  },
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
فیلدها
positioning

object ( PositionedObjectPositioning )

The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object.

embedded Object

object ( EmbeddedObject )

The embedded object of this positioned object.

PositionedObjectPositioning

The positioning of a PositionedObject . The positioned object is positioned relative to the beginning of the Paragraph it's tethered to.

JSON representation 
{
  "layout": enum (PositionedObjectLayout),
  "leftOffset": {
    object (Dimension)
  },
  "topOffset": {
    object (Dimension)
  }
}
فیلدها
layout

enum ( PositionedObjectLayout )

The layout of this positioned object.

left Offset

object ( Dimension )

The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.

top Offset

object ( Dimension )

The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.

PositionedObjectLayout

The possible layouts of a [PositionedObject][google.aps.docs.v1.PositionedObject].

Enums
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED The layout is unspecified.
WRAP_TEXT The text wraps around the positioned object.
BREAK_LEFT Breaks text such that the positioned object is on the left and text is on the right.
BREAK_RIGHT Breaks text such that the positioned object is on the right and text is on the left.
BREAK_LEFT_RIGHT Breaks text such that there's no text on the left or right of the positioned object.
IN_FRONT_OF_TEXT The positioned object is in front of the text.
BEHIND_TEXT The positioned object is behind the text.

SuggestedPositionedObjectProperties

A suggested change to PositionedObjectProperties .

JSON representation 
{
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "positionedObjectPropertiesSuggestionState": {
    object (PositionedObjectPropertiesSuggestionState)
  }
}
فیلدها
positioned Object Properties

object ( PositionedObjectProperties )

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

positioned Object Properties Suggestion State

object ( PositionedObjectPropertiesSuggestionState )

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

PositionedObjectPropertiesSuggestionState

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

JSON representation 
{
  "positioningSuggestionState": {
    object (PositionedObjectPositioningSuggestionState)
  },
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
فیلدها
positioning Suggestion State

object ( PositionedObjectPositioningSuggestionState )

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

embedded Object Suggestion State

object ( EmbeddedObjectSuggestionState )

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

PositionedObjectPositioningSuggestionState

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

JSON representation 
{
  "layoutSuggested": boolean,
  "leftOffsetSuggested": boolean,
  "topOffsetSuggested": boolean
}
فیلدها
layout Suggested

boolean

Indicates if there was a suggested change to layout .

left Offset Suggested

boolean

Indicates if there was a suggested change to leftOffset .

top Offset Suggested

boolean

Indicates if there was a suggested change to topOffset .

SuggestionsViewMode

The suggestions view mode applied to the document that indicates how suggested changes are represented. It provides options for reading the document with all suggestions inline, accepted, or rejected.

Enums
DEFAULT_FOR_CURRENT_ACCESS The SuggestionsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, PREVIEW_WITHOUT_SUGGESTIONS is applied. Otherwise, SUGGESTIONS_INLINE is applied. This is the default suggestions view mode.
SUGGESTIONS_INLINE

The returned document has suggestions inline. Suggested changes will be differentiated from base content within the document.

Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.

PREVIEW_SUGGESTIONS_ACCEPTED

The returned document is a preview with all suggested changes accepted.

Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.

PREVIEW_WITHOUT_SUGGESTIONS The returned document is a preview with all suggested changes rejected if there are any suggestions in the document.

روش ها

batch Update

 Applies one or more updates to the document.

create

 Creates a blank document using the title given in the request.

get

 Gets the latest version of the specified document.