این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Requests

درخواست

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

نمایش JSON

نمایش JSON
{ // Union field `request` can be only one of the following: "replaceAllText": { object (`ReplaceAllTextRequest`) }, "insertText": { object (`InsertTextRequest`) }, "updateTextStyle": { object (`UpdateTextStyleRequest`) }, "createParagraphBullets": { object (`CreateParagraphBulletsRequest`) }, "deleteParagraphBullets": { object (`DeleteParagraphBulletsRequest`) }, "createNamedRange": { object (`CreateNamedRangeRequest`) }, "deleteNamedRange": { object (`DeleteNamedRangeRequest`) }, "updateParagraphStyle": { object (`UpdateParagraphStyleRequest`) }, "deleteContentRange": { object (`DeleteContentRangeRequest`) }, "insertInlineImage": { object (`InsertInlineImageRequest`) }, "insertTable": { object (`InsertTableRequest`) }, "insertTableRow": { object (`InsertTableRowRequest`) }, "insertTableColumn": { object (`InsertTableColumnRequest`) }, "deleteTableRow": { object (`DeleteTableRowRequest`) }, "deleteTableColumn": { object (`DeleteTableColumnRequest`) }, "insertPageBreak": { object (`InsertPageBreakRequest`) }, "deletePositionedObject": { object (`DeletePositionedObjectRequest`) }, "updateTableColumnProperties": { object (`UpdateTableColumnPropertiesRequest`) }, "updateTableCellStyle": { object (`UpdateTableCellStyleRequest`) }, "updateTableRowStyle": { object (`UpdateTableRowStyleRequest`) }, "replaceImage": { object (`ReplaceImageRequest`) }, "updateDocumentStyle": { object (`UpdateDocumentStyleRequest`) }, "mergeTableCells": { object (`MergeTableCellsRequest`) }, "unmergeTableCells": { object (`UnmergeTableCellsRequest`) }, "createHeader": { object (`CreateHeaderRequest`) }, "createFooter": { object (`CreateFooterRequest`) }, "createFootnote": { object (`CreateFootnoteRequest`) }, "replaceNamedRangeContent": { object (`ReplaceNamedRangeContentRequest`) }, "updateSectionStyle": { object (`UpdateSectionStyleRequest`) }, "insertSectionBreak": { object (`InsertSectionBreakRequest`) }, "deleteHeader": { object (`DeleteHeaderRequest`) }, "deleteFooter": { object (`DeleteFooterRequest`) }, "pinTableHeaderRows": { object (`PinTableHeaderRowsRequest`) }, "insertPerson": { object (`InsertPersonRequest`) } // End of list of possible types for union field `request`. }

{

  // Union field request can be only one of the following:
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "createNamedRange": {
    object (CreateNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "deleteContentRange": {
    object (DeleteContentRangeRequest)
  },
  "insertInlineImage": {
    object (InsertInlineImageRequest)
  },
  "insertTable": {
    object (InsertTableRequest)
  },
  "insertTableRow": {
    object (InsertTableRowRequest)
  },
  "insertTableColumn": {
    object (InsertTableColumnRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "insertPageBreak": {
    object (InsertPageBreakRequest)
  },
  "deletePositionedObject": {
    object (DeletePositionedObjectRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableCellStyle": {
    object (UpdateTableCellStyleRequest)
  },
  "updateTableRowStyle": {
    object (UpdateTableRowStyleRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateDocumentStyle": {
    object (UpdateDocumentStyleRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "createHeader": {
    object (CreateHeaderRequest)
  },
  "createFooter": {
    object (CreateFooterRequest)
  },
  "createFootnote": {
    object (CreateFootnoteRequest)
  },
  "replaceNamedRangeContent": {
    object (ReplaceNamedRangeContentRequest)
  },
  "updateSectionStyle": {
    object (UpdateSectionStyleRequest)
  },
  "insertSectionBreak": {
    object (InsertSectionBreakRequest)
  },
  "deleteHeader": {
    object (DeleteHeaderRequest)
  },
  "deleteFooter": {
    object (DeleteFooterRequest)
  },
  "pinTableHeaderRows": {
    object (PinTableHeaderRowsRequest)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  }
  // End of list of possible types for union field request.
}

فیلدها
`request` فیلد مشترک. درخواست خاص برای اعمال. دقیقاً یک فیلد مورد نیاز است. `request` می‌تواند فقط یکی از موارد زیر باشد:
`replaceAllText`	`object ( ReplaceAllTextRequest )` تمام نمونه‌های متن مشخص شده را جایگزین می‌کند.
`insertText`	`object ( InsertTextRequest )` متن را در محل مشخص شده درج می‌کند.
`updateTextStyle`	`object ( UpdateTextStyleRequest )` سبک متن را در محدوده مشخص شده به‌روزرسانی می‌کند.
`createParagraphBullets`	`object ( CreateParagraphBulletsRequest )` برای پاراگراف‌ها بولت ایجاد می‌کند.
`deleteParagraphBullets`	`object ( DeleteParagraphBulletsRequest )` بولت‌ها را از پاراگراف‌ها حذف می‌کند.
`createNamedRange`	`object ( CreateNamedRangeRequest )` یک محدوده نامگذاری شده ایجاد می‌کند.
`deleteNamedRange`	`object ( DeleteNamedRangeRequest )` یک محدوده نامگذاری شده را حذف می‌کند.
`updateParagraphStyle`	`object ( UpdateParagraphStyleRequest )` سبک پاراگراف را در محدوده مشخص شده به‌روزرسانی می‌کند.
`deleteContentRange`	`object ( DeleteContentRangeRequest )` محتوا را از سند حذف می‌کند.
`insertInlineImage`	`object ( InsertInlineImageRequest )` یک تصویر درون خطی را در مکان مشخص شده درج می‌کند.
`insertTable`	`object ( InsertTableRequest )` یک جدول را در محل مشخص شده درج می‌کند.
`insertTableRow`	`object ( InsertTableRowRequest )` یک ردیف خالی را در جدول درج می‌کند.
`insertTableColumn`	`object ( InsertTableColumnRequest )` یک ستون خالی را در جدول درج می‌کند.
`deleteTableRow`	`object ( DeleteTableRowRequest )` یک ردیف را از جدول حذف می‌کند.
`deleteTableColumn`	`object ( DeleteTableColumnRequest )` یک ستون را از جدول حذف می‌کند.
`insertPageBreak`	`object ( InsertPageBreakRequest )` یک شکست صفحه در محل مشخص شده درج می‌کند.
`deletePositionedObject`	`object ( DeletePositionedObjectRequest )` یک شیء موقعیت‌یابی‌شده را از سند حذف می‌کند.
`updateTableColumnProperties`	`object ( UpdateTableColumnPropertiesRequest )` ویژگی‌های ستون‌های یک جدول را به‌روزرسانی می‌کند.
`updateTableCellStyle`	`object ( UpdateTableCellStyleRequest )` سبک سلول‌های جدول را به‌روزرسانی می‌کند.
`updateTableRowStyle`	`object ( UpdateTableRowStyleRequest )` سبک ردیف را در یک جدول به‌روزرسانی می‌کند.
`replaceImage`	`object ( ReplaceImageRequest )` جایگزین تصویر در سند می‌شود.
`updateDocumentStyle`	`object ( UpdateDocumentStyleRequest )` سبک سند را به‌روزرسانی می‌کند.
`mergeTableCells`	`object ( MergeTableCellsRequest )` سلول‌های یک جدول را ادغام می‌کند.
`unmergeTableCells`	`object ( UnmergeTableCellsRequest )` سلول‌های جدول را از حالت ادغام خارج می‌کند.
`createHeader`	`object ( CreateHeaderRequest )` یک سربرگ ایجاد می‌کند.
`createFooter`	`object ( CreateFooterRequest )` یک پاورقی ایجاد می‌کند.
`createFootnote`	`object ( CreateFootnoteRequest )` یک پاورقی ایجاد می‌کند.
`replaceNamedRangeContent`	`object ( ReplaceNamedRangeContentRequest )` محتوای یک محدوده نامگذاری شده را جایگزین می‌کند.
`updateSectionStyle`	`object ( UpdateSectionStyleRequest )` سبک بخش محدوده مشخص شده را به‌روزرسانی می‌کند.
`insertSectionBreak`	`object ( InsertSectionBreakRequest )` یک بخش جدید در محل مشخص شده درج می‌کند.
`deleteHeader`	`object ( DeleteHeaderRequest )` یک سربرگ را از سند حذف می‌کند.
`deleteFooter`	`object ( DeleteFooterRequest )` یک پاورقی را از سند حذف می‌کند.
`pinTableHeaderRows`	`object ( PinTableHeaderRowsRequest )` تعداد ردیف‌های سربرگ پین‌شده در یک جدول را به‌روزرسانی می‌کند.
`insertPerson`	`object ( InsertPersonRequest )` ذکر نام یک شخص را درج می‌کند.

درخواست جایگزینی همه متن

تمام نمونه‌های متنی که با یک معیار مطابقت دارند را با replace text جایگزین می‌کند.

نمایش JSON

نمایش JSON
{ "replaceText": string, "tabsCriteria": { object (`TabsCriteria`) }, // Union field `criteria` can be only one of the following: "containsText": { object (`SubstringMatchCriteria`) } // End of list of possible types for union field `criteria`. }

{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}

فیلدها
`replaceText`	`string` متنی که جایگزین متن تطبیق داده شده خواهد شد.
`tabsCriteria`	`object ( TabsCriteria )` اختیاری. معیارهایی که برای مشخص کردن اینکه جایگزینی در کدام تب‌ها انجام می‌شود، استفاده می‌شوند. در صورت حذف، جایگزینی برای همه تب‌ها اعمال می‌شود. در سندی که شامل یک تب واحد است: در صورت ارائه، باید با شناسه‌ی تک‌برگه‌ی مورد نظر مطابقت داشته باشد. در صورت حذف، جایگزین برای تب مفرد اعمال می‌شود. در سندی که شامل چندین تب است: در صورت ارائه، جایگزینی برای برگه‌های مشخص‌شده اعمال می‌شود. در صورت حذف، جایگزینی برای همه تب‌ها اعمال می‌شود.
`criteria` فیلد Union. معیارهایی که برای تطبیق متن جهت جایگزینی استفاده می‌شوند. `criteria` می‌توانند فقط یکی از موارد زیر باشند:
`containsText`	`object ( SubstringMatchCriteria )` متنی را در سند پیدا می‌کند که با این زیررشته مطابقت دارد.

معیارهای تطبیق زیررشته

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

نمایش JSON
{ "text": string, "matchCase": boolean, "searchByRegex": boolean }

فیلدها

فیلدها
`text`	`string` متنی که قرار است در سند جستجو شود.
`matchCase`	`boolean` نشان می‌دهد که آیا جستجو باید به بزرگی و کوچکی حروف توجه کند یا خیر: `True` : جستجو به حروف بزرگ و کوچک حساس است. `False` : جستجو به حروف بزرگ و کوچک حساس نیست.
`searchByRegex`	`boolean` اختیاری. اگر مقدار find باید به عنوان یک عبارت منظم در نظر گرفته شود، صحیح است. هرگونه بک اسلش در الگو باید escape شود. `True` : متن جستجو به عنوان یک عبارت منظم در نظر گرفته می‌شود. `False` : متن جستجو برای تطبیق به عنوان یک زیررشته در نظر گرفته می‌شود.

text

string

متنی که قرار است در سند جستجو شود.

matchCase

boolean

نشان می‌دهد که آیا جستجو باید به بزرگی و کوچکی حروف توجه کند یا خیر:

True : جستجو به حروف بزرگ و کوچک حساس است.
False : جستجو به حروف بزرگ و کوچک حساس نیست.

searchByRegex

boolean

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

True : متن جستجو به عنوان یک عبارت منظم در نظر گرفته می‌شود.
False : متن جستجو برای تطبیق به عنوان یک زیررشته در نظر گرفته می‌شود.

تب‌هامعیارها

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

نمایش JSON
{ "tabIds": [ string ] }

فیلدها

فیلدها
`tabIds[]`	`string` فهرست شناسه‌های برگه‌ای که درخواست در آنها اجرا می‌شود.

tabIds[]

string

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

درخواست درج متن

متن را در محل مشخص شده درج می‌کند.

نمایش JSON

نمایش JSON
{ "text": string, // Union field `insertion_location` can be only one of the following: "location": { object (`Location`) }, "endOfSegmentLocation": { object (`EndOfSegmentLocation`) } // End of list of possible types for union field `insertion_location`. }

{
  "text": string,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

فیلدها
`text`	`string` متنی که قرار است درج شود. درج یک کاراکتر خط جدید، به طور ضمنی یک `Paragraph` جدید در آن فهرست ایجاد می‌کند. سبک پاراگراف پاراگراف جدید، شامل لیست‌ها و بولت‌ها، از پاراگراف در فهرست درج فعلی کپی می‌شود. سبک‌های متن برای متن درج‌شده به‌طور خودکار تعیین می‌شوند و به‌طورکلی سبک متن مجاور را حفظ می‌کنند. در بیشتر موارد، سبک متن برای متن درج‌شده با متنی که بلافاصله قبل از فهرست درج قرار دارد، مطابقت خواهد داشت. برخی از کاراکترهای کنترلی (U+0000-U+0008، U+000C-U+001F) و کاراکترهای ناحیه استفاده خصوصی صفحه چندزبانه پایه یونیکد (U+E000-U+F8FF) از متن درج شده حذف خواهند شد.
فیلد یونیون `insertion_location` . مکانی که متن در آن درج خواهد شد. `insertion_location` فقط می‌تواند یکی از موارد زیر باشد:
`location`	`object ( Location )` متن را در یک فهرست خاص در سند درج می‌کند. متن باید درون مرزهای یک `Paragraph` موجود درج شود. برای مثال، متن را نمی‌توان در اندیس شروع جدول (یعنی بین جدول و پاراگراف قبلی آن) درج کرد. متن باید در پاراگراف قبلی درج شود.
`endOfSegmentLocation`	`object ( EndOfSegmentLocation )` متن را در انتهای سربرگ، پاورقی، پاورقی یا بدنه سند درج می‌کند.

مکان

یک مکان خاص در سند.

نمایش JSON
{ "segmentId": string, "index": integer, "tabId": string }

فیلدها

فیلدها
`segmentId`	`string` شناسه‌ی سربرگ، پاصفحه یا پاورقی که مکان در آن قرار دارد. یک شناسه‌ی بخش خالی، نشان‌دهنده‌ی بدنه‌ی سند است.
`index`	`integer` شاخص مبتنی بر صفر، در واحدهای کد UTF-16. این شاخص نسبت به ابتدای قطعه مشخص شده توسط `segmentId` است.
`tabId`	`string` تبی که مکان در آن قرار دارد. در صورت حذف، درخواست به تب اول اعمال می‌شود. در سندی که شامل یک تب واحد است: در صورت ارائه، باید با شناسه‌ی تک‌برگه‌ی مورد نظر مطابقت داشته باشد. در صورت حذف، درخواست به همان تب اعمال می‌شود. در سندی که شامل چندین تب است: در صورت ارائه، درخواست به برگه مشخص شده اعمال می‌شود. اگر حذف شود، درخواست به اولین برگه در سند اعمال می‌شود.

segmentId

string

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

index

integer

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

این شاخص نسبت به ابتدای قطعه مشخص شده توسط segmentId است.

tabId

string

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

در سندی که شامل یک تب واحد است:

در صورت ارائه، باید با شناسه‌ی تک‌برگه‌ی مورد نظر مطابقت داشته باشد.
در صورت حذف، درخواست به همان تب اعمال می‌شود.

در سندی که شامل چندین تب است:

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

موقعیت مکانی EndOfSegment

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

نمایش JSON
{ "segmentId": string, "tabId": string }

فیلدها

فیلدها
`segmentId`	`string` شناسه‌ی سربرگ، پاصفحه یا پاورقی که مکان در آن قرار دارد. یک شناسه‌ی بخش خالی، نشان‌دهنده‌ی بدنه‌ی سند است.
`tabId`	`string` تبی که مکان در آن قرار دارد. در صورت حذف، درخواست به تب اول اعمال می‌شود. در سندی که شامل یک تب واحد است: در صورت ارائه، باید با شناسه‌ی تک‌برگه‌ی مورد نظر مطابقت داشته باشد. در صورت حذف، درخواست به همان تب اعمال می‌شود. در سندی که شامل چندین تب است: در صورت ارائه، درخواست به برگه مشخص شده اعمال می‌شود. اگر حذف شود، درخواست به اولین برگه در سند اعمال می‌شود.

segmentId

string

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

tabId

string

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

در سندی که شامل یک تب واحد است:

در صورت ارائه، باید با شناسه‌ی تک‌برگه‌ی مورد نظر مطابقت داشته باشد.
در صورت حذف، درخواست به همان تب اعمال می‌شود.

در سندی که شامل چندین تب است:

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

درخواست به‌روزرسانی سبک متن

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

نمایش JSON

نمایش JSON
{ "textStyle": { object (`TextStyle`) }, "fields": string, // Union field `insertion_location` can be only one of the following: "range": { object (`Range`) } // End of list of possible types for union field `insertion_location`. }

{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}

فیلدها
`textStyle`	`object ( TextStyle )` سبک‌هایی که باید روی متن تنظیم شوند. اگر مقدار یک استایل خاص با مقدار استایل والد مطابقت داشته باشد، آن استایل به صورت ارث‌بری تنظیم می‌شود. تغییرات خاص در سبک متن ممکن است باعث تغییرات دیگری شود تا رفتار ویرایشگر Docs را منعکس کند. برای اطلاعات بیشتر به مستندات `TextStyle` مراجعه کنید.
`fields`	`string ( FieldMask format)` فیلدهایی که باید به‌روزرسانی شوند. حداقل یک فیلد باید مشخص شود. `textStyle` ریشه ضمنی است و نباید مشخص شود. می‌توان از یک `"*"` به عنوان اختصار برای فهرست کردن هر فیلد استفاده کرد. برای مثال، برای به‌روزرسانی سبک متن به حالت پررنگ، `fields` روی `"bold"` تنظیم کنید. برای تنظیم مجدد یک ویژگی به مقدار پیش‌فرض، نام فیلد آن را در ماسک فیلد قرار دهید اما خود فیلد را بدون تغییر رها کنید.
فیلد یونیون `insertion_location` . نوع محدوده‌ای که در آن سبک متن به‌روزرسانی می‌شود. `insertion_location` فقط می‌تواند یکی از موارد زیر باشد:
`range`	`object ( Range )` محدوده متن برای سبک‌دهی. این محدوده می‌تواند گسترش یابد تا شامل خطوط جدید مجاور نیز بشود. اگر محدوده به طور کامل شامل یک پاراگراف متعلق به یک لیست باشد، بولت پاراگراف نیز با سبک متن منطبق به‌روزرسانی می‌شود. محدوده‌ها را نمی‌توان درون یک UpdateTextStyleRequest نسبی وارد کرد.

درخواست ایجادBulletsParagraph

برای تمام پاراگراف‌هایی که با محدوده داده شده همپوشانی دارند، علامت‌های راهنما (bullet) ایجاد می‌کند.

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

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

نمایش JSON
{ "range": { object (`Range`) }, "bulletPreset": enum (`BulletGlyphPreset`) }

فیلدها

فیلدها
`range`	`object ( Range )` محدوده‌ای که قرار است تنظیمات پیش‌فرض گلوله روی آن اعمال شود.
`bulletPreset`	`enum ( BulletGlyphPreset )` انواع گلیف‌های گلوله‌ای که باید استفاده شوند.

range

object ( Range )

محدوده‌ای که قرار است تنظیمات پیش‌فرض گلوله روی آن اعمال شود.

bulletPreset

enum ( BulletGlyphPreset )

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

BulletGlyphPreset

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

این الگوها از این نوع گلوله‌ها استفاده می‌کنند:

ARROW : یک فلش، مربوط به یک کد پوینت یونیکد U+2794
ARROW3D : یک پیکان با سایه سه‌بعدی، مربوط به یک کد پوینت یونیکد U+27a2
CHECKBOX : یک مربع توخالی، مربوط به یک کد پوینت یونیکد U+274f
CIRCLE : یک دایره توخالی، مربوط به یک کد پوینت یونیکد U+25cb
DIAMOND : یک الماس جامد، مربوط به کد پوینت یونیکد U+25c6
DIAMONDX : یک لوزی با 'x' که مربوط به یک کد پوینت یونیکد U+2756 است.
HOLLOWDIAMOND : یک الماس توخالی، مربوط به کد پوینت یونیکد U+25c7
DISC : یک دایره توپر، مربوط به یک نقطه کد یونیکد U+25cf
SQUARE : یک مربع توپر، مربوط به یک کد پوینت یونیکد U+25a0
STAR : یک ستاره، مربوط به یک کد پوینت یونیکد U+2605
ALPHA : یک حرف کوچک، مانند «a»، «b» یا «c».
حروف بزرگ UPPERALPHA ): یک حرف بزرگ، مانند 'A'، 'B' یا 'C'.
DECIMAL : عددی مانند '1'، '2' یا '3'.
ZERODECIMAL : عددی که در آن اعداد تک رقمی با صفر شروع می‌شوند، مانند '01'، '02' یا '03'. اعدادی که بیش از یک رقم دارند، با صفر شروع نمی‌شوند.
ROMAN : یک عدد رومی کوچک، مانند «i»، «ii» یا «iii».
عدد رومی UPPERROMAN : یک عدد رومی با حروف بزرگ، مانند «I»، «II» یا «III».
LEFTTRIANGLE : مثلثی که به سمت چپ اشاره دارد و مربوط به نقطه کد یونیکد U+25c4 است.

انوم‌ها
`BULLET_GLYPH_PRESET_UNSPECIFIED`	پیش‌تنظیم علامت گلوله مشخص نشده است.
`BULLET_DISC_CIRCLE_SQUARE`	یک لیست نقطه‌ای با علامت‌های `DISC` ، `CIRCLE` و `SQUARE` برای سه سطح اول تودرتوی لیست.
`BULLET_DIAMONDX_ARROW3D_SQUARE`	یک لیست نقطه‌ای با علامت‌های `DIAMONDX` ، `ARROW3D` و `SQUARE` برای سه سطح اول تودرتوی لیست.
`BULLET_CHECKBOX`	یک لیست نقطه‌دار با علامت‌های نقطه‌ای `CHECKBOX` برای تمام سطوح تودرتوی لیست.
`BULLET_ARROW_DIAMOND_DISC`	یک لیست نقطه‌ای با علامت‌های `ARROW` ، `DIAMOND` و `DISC` برای سه سطح اول تودرتوی لیست.
`BULLET_STAR_CIRCLE_SQUARE`	یک لیست نقطه‌ای با علامت‌های `STAR` ، `CIRCLE` و `SQUARE` برای سه سطح اول تودرتوی لیست.
`BULLET_ARROW3D_CIRCLE_SQUARE`	یک لیست نقطه‌ای با علامت‌های `ARROW3D` ، `CIRCLE` و `SQUARE` برای سه سطح اول تودرتوی لیست.
`BULLET_LEFTTRIANGLE_DIAMOND_DISC`	یک لیست نقطه‌ای با علامت‌های مثلث `LEFTTRIANGLE` ، `DIAMOND` و `DISC` برای سه سطح اول تودرتوی لیست.
`BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE`	یک لیست نقطه‌ای با علامت‌های نقطه‌ای `DIAMONDX` ، `HOLLOWDIAMOND` و `SQUARE` برای سه سطح اول تودرتوی لیست.
`BULLET_DIAMOND_CIRCLE_SQUARE`	یک لیست نقطه‌ای با گلیف‌های `DIAMOND` ، `CIRCLE` و `SQUARE` برای سه سطح اول تودرتوی لیست.
`NUMBERED_DECIMAL_ALPHA_ROMAN`	یک لیست شماره‌گذاری شده با گلیف‌های عددی `DECIMAL` ، `ALPHA` و `ROMAN` برای ۳ سطح اول تودرتوی لیست، و پس از آن نقطه.
`NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS`	یک لیست شماره‌گذاری شده با گلیف‌های عددی `DECIMAL` ، `ALPHA` و `ROMAN` برای ۳ سطح اول تودرتوی لیست، و به دنبال آن پرانتز.
`NUMBERED_DECIMAL_NESTED`	یک لیست شماره‌گذاری شده با گلیف‌های عددی `DECIMAL` که با نقطه از هم جدا شده‌اند، که در آن هر سطح تودرتو از گلیف سطح تودرتوی قبلی به عنوان پیشوند استفاده می‌کند. برای مثال: '1.'، '1.1.'، '2.'، '2.2.'.
`NUMBERED_UPPERALPHA_ALPHA_ROMAN`	یک لیست شماره‌گذاری شده با حروف عددی `UPPERALPHA` ، `ALPHA` و `ROMAN` برای سه سطح اول تودرتوی لیست، و پس از آن نقطه.
`NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL`	یک لیست شماره‌گذاری شده با گلیف‌های عددی `UPPERROMAN` ، `UPPERALPHA` و `DECIMAL` برای سه سطح اول تودرتوی لیست، و پس از آن نقطه.
`NUMBERED_ZERODECIMAL_ALPHA_ROMAN`	یک لیست شماره‌گذاری شده با گلیف‌های عددی `ZERODECIMAL` ، `ALPHA` و `ROMAN` برای سه سطح اول تودرتوی لیست، و پس از آن نقطه.

درخواست حذف پاراگراف

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

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

نمایش JSON
{ "range": { object (`Range`) } }

فیلدها

فیلدها
`range`	`object ( Range )` محدوده‌ای که باید بولت‌ها را از آن حذف کنید.

range

object ( Range )

محدوده‌ای که باید بولت‌ها را از آن حذف کنید.

درخواست CreateNamedRange

یک NamedRange ایجاد می‌کند که به محدوده داده شده اشاره دارد.

نمایش JSON
{ "name": string, "range": { object (`Range`) } }

فیلدها

فیلدها
`name`	`string` نام NamedRange. نام‌ها نیازی به منحصر به فرد بودن ندارند. نام‌ها باید حداقل ۱ کاراکتر و حداکثر ۲۵۶ کاراکتر باشند که با واحدهای کد UTF-16 اندازه‌گیری می‌شوند.
`range`	`object ( Range )` محدوده‌ای که قرار است نام به آن اعمال شود.

name

string

نام NamedRange. نام‌ها نیازی به منحصر به فرد بودن ندارند.

نام‌ها باید حداقل ۱ کاراکتر و حداکثر ۲۵۶ کاراکتر باشند که با واحدهای کد UTF-16 اندازه‌گیری می‌شوند.

range

object ( Range )

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

درخواست حذف محدوده نام‌گذاری‌شده

یک NamedRange حذف می‌کند.

نمایش JSON

نمایش JSON
{ "tabsCriteria": { object (`TabsCriteria`) }, // Union field `named_range_reference` can be only one of the following: "namedRangeId": string, "name": string // End of list of possible types for union field `named_range_reference`. }

{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}

فیلدها
`tabsCriteria`	`object ( TabsCriteria )` اختیاری. معیارهایی که برای مشخص کردن تب(های) حذف محدوده استفاده می‌شوند. در صورت حذف، حذف محدوده روی همه تب‌ها اعمال می‌شود. در سندی که شامل یک تب واحد است: در صورت ارائه، باید با شناسه‌ی تک‌برگه‌ی مورد نظر مطابقت داشته باشد. در صورت حذف، حذف محدوده برای تب منفرد اعمال می‌شود. در سندی که شامل چندین تب است: در صورت ارائه، حذف محدوده برای برگه‌های مشخص شده اعمال می‌شود. اگر ارائه نشود، حذف محدوده برای همه برگه‌ها اعمال می‌شود.
فیلد اتحادیه `named_range_reference` . مقداری که تعیین می‌کند کدام محدوده یا محدوده‌ها حذف شوند. دقیقاً یکی باید تنظیم شود. `named_range_reference` فقط می‌تواند یکی از موارد زیر باشد:
`namedRangeId`	`string` شناسه‌ی محدوده‌ی نامگذاری شده برای حذف.
`name`	`string` نام محدوده (محدوده‌هایی) که باید حذف شوند. تمام محدوده‌های نامگذاری شده با نام داده شده حذف خواهند شد.

درخواست به‌روزرسانی سبک پاراگراف

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

نمایش JSON

نمایش JSON
{ "paragraphStyle": { object (`ParagraphStyle`) }, "fields": string, // Union field `insertion_location` can be only one of the following: "range": { object (`Range`) } // End of list of possible types for union field `insertion_location`. }

{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}

فیلدها
`paragraphStyle`	`object ( ParagraphStyle )` سبک‌هایی که باید روی پاراگراف‌ها تنظیم شوند. برخی تغییرات در سبک پاراگراف ممکن است باعث تغییرات دیگری شود تا رفتار ویرایشگر Docs را منعکس کند. برای اطلاعات بیشتر به مستندات `ParagraphStyle` مراجعه کنید.
`fields`	`string ( FieldMask format)` فیلدهایی که باید به‌روزرسانی شوند. حداقل یک فیلد باید مشخص شود. `paragraphStyle` ریشه ضمنی است و نباید مشخص شود. می‌توان از یک `"*"` به عنوان اختصار برای فهرست کردن هر فیلد استفاده کرد. برای مثال، برای به‌روزرسانی ویژگی ترازبندی سبک پاراگراف، `fields` روی `"alignment"` تنظیم کنید. برای تنظیم مجدد یک ویژگی به مقدار پیش‌فرض، نام فیلد آن را در ماسک فیلد قرار دهید اما خود فیلد را بدون تغییر رها کنید.
فیلد یونیون `insertion_location` . نوع محدوده‌ای که در آن سبک پاراگراف به‌روزرسانی می‌شود. `insertion_location` فقط می‌تواند یکی از موارد زیر باشد:
`range`	`object ( Range )` محدوده‌ای که پاراگراف‌ها را برای استایل‌دهی همپوشانی می‌کند.

درخواست محدوده محتوا (DeleteContentRangeRequest)

محتوا را از سند حذف می‌کند.

نمایش JSON
{ "range": { object (`Range`) } }

فیلدها

فیلدها
`range`	`object ( Range )` محدوده محتوایی که باید حذف شود. حذف متنی که از مرز پاراگراف عبور می‌کند، ممکن است منجر به تغییراتی در سبک‌های پاراگراف، فهرست‌ها، اشیاء موقعیت‌یابی شده و نشانک‌ها هنگام ادغام دو پاراگراف شود. تلاش برای حذف محدوده‌های خاص می‌تواند منجر به ساختار سند نامعتبر شود که در این صورت خطای درخواست بد ۴۰۰ بازگردانده می‌شود. برخی از نمونه‌های درخواست‌های حذف نامعتبر عبارتند از: حذف یک واحد کد از یک جفت جایگزین. حذف آخرین کاراکتر خط جدید از `Body` ، `Header` ، `Footer` ، `Footnote` ، `TableCell` یا `TableOfContents` . حذف شروع یا پایان یک `Table` ، `TableOfContents` یا `Equation` بدون حذف کل عنصر. حذف کاراکتر خط جدید قبل از یک `Table` ، `TableOfContents` یا `SectionBreak` بدون حذف عنصر. حذف سطرها یا سلول‌های تکی یک جدول. حذف محتوای درون یک سلول جدول مجاز است.

range

object ( Range )

محدوده محتوایی که باید حذف شود.

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

تلاش برای حذف محدوده‌های خاص می‌تواند منجر به ساختار سند نامعتبر شود که در این صورت خطای درخواست بد ۴۰۰ بازگردانده می‌شود.

برخی از نمونه‌های درخواست‌های حذف نامعتبر عبارتند از:

حذف یک واحد کد از یک جفت جایگزین.
حذف آخرین کاراکتر خط جدید از Body ، Header ، Footer ، Footnote ، TableCell یا TableOfContents .
حذف شروع یا پایان یک Table ، TableOfContents یا Equation بدون حذف کل عنصر.
حذف کاراکتر خط جدید قبل از یک Table ، TableOfContents یا SectionBreak بدون حذف عنصر.
حذف سطرها یا سلول‌های تکی یک جدول. حذف محتوای درون یک سلول جدول مجاز است.

درخواست درج تصویر در خط

یک InlineObject حاوی تصویر را در مکان داده شده درج می‌کند.

نمایش JSON

نمایش JSON
{ "uri": string, "objectSize": { object (`Size`) }, // Union field `insertion_location` can be only one of the following: "location": { object (`Location`) }, "endOfSegmentLocation": { object (`EndOfSegmentLocation`) } // End of list of possible types for union field `insertion_location`. }

{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

فیلدها
`uri`	`string` آدرس اینترنتی (URI) تصویر. تصویر یک بار در زمان درج دریافت می‌شود و یک کپی از آن برای نمایش در داخل سند ذخیره می‌شود. حجم تصاویر باید کمتر از ۵۰ مگابایت باشد، نمی‌تواند از ۲۵ مگاپیکسل بیشتر باشد و باید در یکی از قالب‌های PNG، JPEG یا GIF باشد. URI ارائه شده باید به صورت عمومی قابل دسترسی باشد و حداکثر ۲ کیلوبایت طول داشته باشد. خود URI به همراه تصویر ذخیره می‌شود و از طریق فیلد `ImageProperties.content_uri` نمایش داده می‌شود.
`objectSize`	`object ( Size )` اندازه‌ای که تصویر باید در سند نمایش داده شود. این ویژگی اختیاری است و اندازه نهایی تصویر در سند با قوانین زیر تعیین می‌شود: * اگر نه عرض و نه ارتفاع مشخص نشده باشد، اندازه پیش‌فرض تصویر بر اساس وضوح آن محاسبه می‌شود. * اگر یک بُعد مشخص شده باشد، بُعد دیگر برای حفظ نسبت ابعاد تصویر محاسبه می‌شود. * اگر هم عرض و هم ارتفاع مشخص شده باشند، تصویر برای قرار گرفتن در ابعاد ارائه شده و در عین حال حفظ نسبت ابعاد آن، مقیاس‌بندی می‌شود.
فیلد یونیون `insertion_location` . مکانی که تصویر در آن درج خواهد شد. `insertion_location` فقط می‌تواند یکی از موارد زیر باشد:
`location`	`object ( Location )` تصویر را در یک فهرست خاص در سند درج می‌کند. تصویر باید درون مرزهای یک `Paragraph` موجود درج شود. برای مثال، نمی‌توان آن را در اندیس شروع جدول (یعنی بین جدول و پاراگراف قبلی آن) درج کرد. تصاویر درون خطی را نمی‌توان داخل پاورقی یا معادله قرار داد.
`endOfSegmentLocation`	`object ( EndOfSegmentLocation )` متن را در انتهای سربرگ، پاورقی یا بدنه سند درج می‌کند. تصاویر درون‌خطی را نمی‌توان داخل پاورقی قرار داد.

درخواست درج جدول

یک جدول را در محل مشخص شده درج می‌کند.

یک کاراکتر خط جدید قبل از جدول درج شده درج خواهد شد.

نمایش JSON

نمایش JSON
{ "rows": integer, "columns": integer, // Union field `insertion_location` can be only one of the following: "location": { object (`Location`) }, "endOfSegmentLocation": { object (`EndOfSegmentLocation`) } // End of list of possible types for union field `insertion_location`. }

{
  "rows": integer,
  "columns": integer,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

فیلدها
`rows`	`integer` تعداد ردیف‌های جدول.
`columns`	`integer` تعداد ستون‌های جدول.
فیلد یونیون `insertion_location` . مکانی که جدول در آن درج خواهد شد. `insertion_location` فقط می‌تواند یکی از موارد زیر باشد:
`location`	`object ( Location )` جدول را در یک اندیس مدل خاص درج می‌کند. یک کاراکتر خط جدید قبل از جدول درج شده درج خواهد شد، بنابراین اندیس شروع جدول در اندیس مکان مشخص شده + ۱ قرار خواهد گرفت. جدول باید درون مرزهای یک `Paragraph` موجود درج شود. برای مثال، نمی‌توان آن را در اندیس شروع یک جدول (یعنی بین یک جدول موجود و پاراگراف قبلی آن) درج کرد. جداول را نمی‌توان داخل پاورقی یا معادله قرار داد.
`endOfSegmentLocation`	`object ( EndOfSegmentLocation )` جدول را در انتهای سربرگ، پاصفحه یا بدنه سند وارد می‌کند. یک کاراکتر خط جدید قبل از جدول وارد شده قرار می‌گیرد. جداول را نمی‌توان داخل پاورقی قرار داد.

درخواست درج سطر جدول

یک ردیف خالی را در جدول درج می‌کند.

نمایش JSON
{ "tableCellLocation": { object (`TableCellLocation`) }, "insertBelow": boolean }

فیلدها

فیلدها
`tableCellLocation`	`object ( TableCellLocation )` محل سلول جدول مرجع که سطرها از آن درج خواهند شد. یک ردیف جدید در بالا (یا پایین) ردیفی که سلول مرجع در آن قرار دارد، درج خواهد شد. اگر سلول مرجع یک سلول ادغام شده باشد، یک ردیف جدید در بالا (یا پایین) سلول ادغام شده درج خواهد شد.
`insertBelow`	`boolean` آیا سطر جدید زیر محل سلول مرجع درج شود یا خیر. `True` : زیر سلول درج شود. `False` : بالای سلول درج شود.

tableCellLocation

object ( TableCellLocation )

محل سلول جدول مرجع که سطرها از آن درج خواهند شد.

یک ردیف جدید در بالا (یا پایین) ردیفی که سلول مرجع در آن قرار دارد، درج خواهد شد. اگر سلول مرجع یک سلول ادغام شده باشد، یک ردیف جدید در بالا (یا پایین) سلول ادغام شده درج خواهد شد.

insertBelow

boolean

آیا سطر جدید زیر محل سلول مرجع درج شود یا خیر.

True : زیر سلول درج شود.
False : بالای سلول درج شود.

مکان سلول جدول

محل قرارگیری یک سلول در جدول.

نمایش JSON
{ "tableStartLocation": { object (`Location`) }, "rowIndex": integer, "columnIndex": integer }

فیلدها

tableStartLocation

object ( Location )

محل شروع جدول در سند.

rowIndex

integer

اندیس ردیف مبتنی بر صفر. برای مثال، ردیف دوم در جدول دارای اندیس ردیف ۱ است.

columnIndex

integer

اندیس ستون بر اساس صفر. برای مثال، ستون دوم در جدول دارای اندیس ستون ۱ است.

درخواست درج جدول ستونی

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

نمایش JSON
{ "tableCellLocation": { object (`TableCellLocation`) }, "insertRight": boolean }

فیلدها

فیلدها
`tableCellLocation`	`object ( TableCellLocation )` محل سلول جدول مرجع که ستون‌ها از آن درج خواهند شد. یک ستون جدید در سمت چپ (یا راست) ستونی که سلول مرجع در آن قرار دارد، درج خواهد شد. اگر سلول مرجع، یک سلول ادغام شده باشد، یک ستون جدید در سمت چپ (یا راست) سلول ادغام شده درج خواهد شد.
`insertRight`	`boolean` آیا ستون جدید در سمت راست محل سلول مرجع درج شود یا خیر. `True` : در سمت راست وارد شود. `False` : در سمت چپ وارد کنید.

tableCellLocation

object ( TableCellLocation )

محل سلول جدول مرجع که ستون‌ها از آن درج خواهند شد.

یک ستون جدید در سمت چپ (یا راست) ستونی که سلول مرجع در آن قرار دارد، درج خواهد شد. اگر سلول مرجع، یک سلول ادغام شده باشد، یک ستون جدید در سمت چپ (یا راست) سلول ادغام شده درج خواهد شد.

insertRight

boolean

آیا ستون جدید در سمت راست محل سلول مرجع درج شود یا خیر.

True : در سمت راست وارد شود.
False : در سمت چپ وارد کنید.

درخواست حذف ردیف جدول

یک ردیف را از جدول حذف می‌کند.

نمایش JSON
{ "tableCellLocation": { object (`TableCellLocation`) } }

فیلدها

فیلدها
`tableCellLocation`	`object ( TableCellLocation )` محل سلول جدول مرجع که سطر از آن حذف خواهد شد. ردیفی که این سلول در بر می‌گیرد حذف خواهد شد. اگر این یک سلول ادغام‌شده باشد که چندین ردیف را در بر می‌گیرد، تمام ردیف‌هایی که سلول در بر می‌گیرد حذف می‌شوند. اگر پس از این حذف هیچ ردیفی در جدول باقی نماند، کل جدول حذف می‌شود.

tableCellLocation

object ( TableCellLocation )

محل سلول جدول مرجع که سطر از آن حذف خواهد شد.

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

درخواست حذف جدول ستونی

یک ستون را از جدول حذف می‌کند.

نمایش JSON
{ "tableCellLocation": { object (`TableCellLocation`) } }

فیلدها

فیلدها
`tableCellLocation`	`object ( TableCellLocation )` محل سلول جدول مرجع که ستون از آن حذف خواهد شد. ستونی که این سلول در بر می‌گیرد حذف خواهد شد. اگر این یک سلول ادغام‌شده باشد که چندین ستون را در بر می‌گیرد، تمام ستون‌هایی که سلول در بر می‌گیرد حذف می‌شوند. اگر پس از این حذف هیچ ستونی در جدول باقی نماند، کل جدول حذف می‌شود.

tableCellLocation

object ( TableCellLocation )

محل سلول جدول مرجع که ستون از آن حذف خواهد شد.

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

درخواست شکستن صفحه (InsertPageBreakRequest)

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

نمایش JSON

نمایش JSON
{ // Union field `insertion_location` can be only one of the following: "location": { object (`Location`) }, "endOfSegmentLocation": { object (`EndOfSegmentLocation`) } // End of list of possible types for union field `insertion_location`. }

{

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

فیلدها

فیلدها
فیلد یونیون `insertion_location` . مکانی که شکست صفحه در آن درج خواهد شد. `insertion_location` فقط می‌تواند یکی از موارد زیر باشد:
`location`	`object ( Location )` شکست صفحه را در یک فهرست خاص در سند وارد می‌کند. شکست صفحه باید درون مرزهای یک `Paragraph` موجود درج شود. برای مثال، نمی‌توان آن را در اندیس شروع جدول (یعنی بین جدول و پاراگراف قبلی آن) درج کرد. نمی‌توان صفحه‌شکنی را درون جدول، معادله، پاورقی، سرصفحه یا پاورقی قرار داد. از آنجایی که صفحه‌شکنی فقط درون بدنه قابل انجام است، فیلد `segment ID` باید خالی باشد.
`endOfSegmentLocation`	`object ( EndOfSegmentLocation )` در انتهای بدنه سند، شکست صفحه را درج می‌کند. نمی‌توان صفحه‌شکن‌ها را داخل پاورقی، سرصفحه یا پاورقی قرار داد. از آنجایی که صفحه‌شکن‌ها فقط می‌توانند داخل بدنه قرار گیرند، فیلد `segment ID` باید خالی باشد.

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

location

object ( Location )

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

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

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

endOfSegmentLocation

object ( EndOfSegmentLocation )

در انتهای بدنه سند، شکست صفحه را درج می‌کند.

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

درخواست حذف شیء موقعیت‌یابی‌شده

یک PositionedObject از سند حذف می‌کند.

نمایش JSON
{ "objectId": string, "tabId": string }

فیلدها

فیلدها
`objectId`	`string` شناسه‌ی شیءِ موقعیت‌یابی‌شده‌ای که قرار است حذف شود.
`tabId`	`string` تبی که شیء موقعیت‌یابی‌شده برای حذف در آن قرار دارد. در صورت حذف، درخواست روی اولین تب اعمال می‌شود. در سندی که شامل یک تب واحد است: در صورت ارائه، باید با شناسه‌ی تک‌برگه‌ی مورد نظر مطابقت داشته باشد. در صورت حذف، درخواست به همان تب اعمال می‌شود. در سندی که شامل چندین تب است: در صورت ارائه، درخواست به برگه مشخص شده اعمال می‌شود. اگر حذف شود، درخواست به اولین برگه در سند اعمال می‌شود.

objectId

string

شناسه‌ی شیءِ موقعیت‌یابی‌شده‌ای که قرار است حذف شود.

tabId

string

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

در سندی که شامل یک تب واحد است:

در صورت ارائه، باید با شناسه‌ی تک‌برگه‌ی مورد نظر مطابقت داشته باشد.
در صورت حذف، درخواست به همان تب اعمال می‌شود.

در سندی که شامل چندین تب است:

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

درخواست به‌روزرسانی جدول ستون‌ها

TableColumnProperties ستون‌های یک جدول را به‌روزرسانی می‌کند.

نمایش JSON
{ "tableStartLocation": { object (`Location`) }, "columnIndices": [ integer ], "tableColumnProperties": { object (`TableColumnProperties`) }, "fields": string }

فیلدها
`tableStartLocation`	`object ( Location )` محل شروع جدول در سند.
`columnIndices[]`	`integer` فهرست شاخص‌های ستون مبتنی بر صفر که ویژگی آنها باید به‌روزرسانی شود. اگر هیچ شاخصی مشخص نشود، تمام ستون‌ها به‌روزرسانی خواهند شد.
`tableColumnProperties`	`object ( TableColumnProperties )` ویژگی‌های ستون‌های جدول که باید به‌روزرسانی شوند. اگر مقدار `tableColumnProperties#width` کمتر از 5 امتیاز (5/72 اینچ) باشد، خطای درخواست بد 400 بازگردانده می‌شود.
`fields`	`string ( FieldMask format)` فیلدهایی که باید به‌روزرسانی شوند. حداقل یک فیلد باید مشخص شود. جدول ریشه `tableColumnProperties` ضمنی است و نباید مشخص شود. می‌توان از یک `"*"` به عنوان اختصار برای فهرست کردن هر فیلد استفاده کرد. برای مثال، برای به‌روزرسانی عرض ستون، `fields` روی `"width"` تنظیم کنید.

درخواست به‌روزرسانی سبک سلول جدول

سبک (style) مجموعه‌ای از سلول‌های جدول را به‌روزرسانی می‌کند.

نمایش JSON

نمایش JSON
{ "tableCellStyle": { object (`TableCellStyle`) }, "fields": string, // Union field `cells` can be only one of the following: "tableRange": { object (`TableRange`) }, "tableStartLocation": { object (`Location`) } // End of list of possible types for union field `cells`. }

{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  // Union field cells can be only one of the following:
  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
  // End of list of possible types for union field cells.
}

فیلدها
`tableCellStyle`	`object ( TableCellStyle )` سبکی که باید روی سلول‌های جدول تنظیم شود. هنگام به‌روزرسانی حاشیه‌ها، اگر یک سلول با سلول مجاور خود حاشیه مشترک داشته باشد، ویژگی حاشیه مربوط به سلول مجاور نیز به‌روزرسانی می‌شود. حاشیه‌هایی که ادغام شده و نامرئی هستند، به‌روزرسانی نمی‌شوند. از آنجایی که به‌روزرسانی حاشیه‌ای که توسط سلول‌های مجاور در یک درخواست مشترک است، می‌تواند باعث به‌روزرسانی‌های حاشیه متناقض شود، به‌روزرسانی‌های حاشیه به ترتیب زیر اعمال می‌شوند: `borderRight` `borderLeft` `borderBottom` `borderTop`
`fields`	`string ( FieldMask format)` فیلدهایی که باید به‌روزرسانی شوند. حداقل یک فیلد باید مشخص شود. جدول ریشه (root `tableCellStyle` ضمنی است و نباید مشخص شود. می‌توان از یک `"*"` به عنوان اختصار برای فهرست کردن هر فیلد استفاده کرد. برای مثال، برای به‌روزرسانی رنگ پس‌زمینه‌ی سلول‌های جدول، `fields` روی `"backgroundColor"` تنظیم کنید. برای تنظیم مجدد یک ویژگی به مقدار پیش‌فرض، نام فیلد آن را در ماسک فیلد قرار دهید اما خود فیلد را بدون تغییر رها کنید.
`cells` فیلد Union. سلول‌هایی که به‌روزرسانی خواهند شد. `cells` می‌توانند فقط یکی از موارد زیر باشند:
`tableRange`	`object ( TableRange )` محدوده جدول که زیرمجموعه‌ای از جدول را نشان می‌دهد که به‌روزرسانی‌ها روی آن اعمال می‌شوند.
`tableStartLocation`	`object ( Location )` مکانی که جدول در سند از آنجا شروع می‌شود. در صورت مشخص شدن، به‌روزرسانی‌ها روی تمام سلول‌های جدول اعمال می‌شوند.

جدول محدوده

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

لازم به ذکر است که سلول‌های مشخص شده توسط یک محدوده جدول لزوماً یک مستطیل تشکیل نمی‌دهند. برای مثال، فرض کنید یک جدول ۳ در ۳ داریم که تمام سلول‌های ردیف آخر آن با هم ادغام شده‌اند. جدول به این شکل است:

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

یک محدوده جدول با table cell location = (tableStartLocation, row = 0, column = 0), row span = 3 و column span = 2، سلول‌های زیر را مشخص می‌کند:

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]

نمایش JSON
{ "tableCellLocation": { object (`TableCellLocation`) }, "rowSpan": integer, "columnSpan": integer }

فیلدها

tableCellLocation

object ( TableCellLocation )

محل سلولی که محدوده جدول از آن شروع می‌شود.

rowSpan

integer

طول ردیف‌های محدوده‌ی جدول.

columnSpan

integer

طول ستون‌های محدوده‌ی جدول.

درخواست به‌روزرسانی سبک ردیف جدول

TableRowStyle ردیف‌های یک جدول را به‌روزرسانی می‌کند.

نمایش JSON
{ "tableStartLocation": { object (`Location`) }, "rowIndices": [ integer ], "tableRowStyle": { object (`TableRowStyle`) }, "fields": string }

فیلدها
`tableStartLocation`	`object ( Location )` محل شروع جدول در سند.
`rowIndices[]`	`integer` فهرست اندیس‌های سطر مبتنی بر صفر که سبک آنها باید به‌روزرسانی شود. اگر هیچ اندیسی مشخص نشود، تمام سطرها به‌روزرسانی خواهند شد.
`tableRowStyle`	`object ( TableRowStyle )` سبک‌هایی که باید روی ردیف‌ها تنظیم شوند.
`fields`	`string ( FieldMask format)` فیلدهایی که باید به‌روزرسانی شوند. حداقل یک فیلد باید مشخص شود. `tableRowStyle` ریشه ضمنی است و نباید مشخص شود. می‌توان از یک `"*"` به عنوان اختصار برای فهرست کردن هر فیلد استفاده کرد. برای مثال، برای به‌روزرسانی حداقل ارتفاع ردیف، `fields` روی `"minRowHeight"` تنظیم کنید.

درخواست تصویر جایگزین

یک تصویر موجود را با یک تصویر جدید جایگزین می‌کند.

جایگزینی یک تصویر، برخی از image effects از تصویر موجود حذف می‌کند تا رفتار ویرایشگر اسناد را منعکس کند.

نمایش JSON
{ "imageObjectId": string, "uri": string, "imageReplaceMethod": enum (`ImageReplaceMethod`), "tabId": string }

فیلدها
`imageObjectId`	`string` شناسه تصویر موجودی که جایگزین خواهد شد. این شناسه را می‌توان از پاسخ یک درخواست get بازیابی کرد.
`uri`	`string` آدرس اینترنتی (URI) تصویر جدید. تصویر یک بار در زمان درج دریافت می‌شود و یک کپی از آن برای نمایش در داخل سند ذخیره می‌شود. تصاویر باید کمتر از ۵۰ مگابایت باشند، نمی‌توانند از ۲۵ مگاپیکسل بیشتر باشند و باید در قالب PNG، JPEG یا GIF باشند. طول URI ارائه شده نمی‌تواند از ۲ کیلوبایت بیشتر باشد. URI به همراه تصویر ذخیره می‌شود و از طریق فیلد `ImageProperties.source_uri` نمایش داده می‌شود.
`imageReplaceMethod`	`enum ( ImageReplaceMethod )` روش جایگزینی.
`tabId`	`string` تبی که تصویر مورد نظر برای جایگزینی در آن قرار دارد. در صورت حذف، درخواست به تب اول اعمال می‌شود. در سندی که شامل یک تب واحد است: در صورت ارائه، باید با شناسه‌ی تک‌برگه‌ی مورد نظر مطابقت داشته باشد. در صورت حذف، درخواست به همان تب اعمال می‌شود. در سندی که شامل چندین تب است: در صورت ارائه، درخواست به برگه مشخص شده اعمال می‌شود. اگر حذف شود، درخواست به اولین برگه در سند اعمال می‌شود.

متد جایگزینی تصویر

روش جایگزینی تصویر

انوم‌ها
`IMAGE_REPLACE_METHOD_UNSPECIFIED`	روش جایگزینی تصویر نامشخص است. این مقدار نباید استفاده شود.
`CENTER_CROP`	تصویر را مقیاس‌بندی و در مرکز قرار می‌دهد تا مرزهای تصویر اصلی را پر کند. تصویر را می‌توان برش داد تا مرزهای تصویر اصلی را پر کند. اندازه رندر شده تصویر مشابه تصویر اصلی خواهد بود.

درخواست UpdateDocumentStyle

DocumentStyle به‌روزرسانی می‌کند.

نمایش JSON
{ "documentStyle": { object (`DocumentStyle`) }, "fields": string, "tabId": string }

فیلدها

documentStyle

object ( DocumentStyle )

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

تغییرات خاص در سبک سند ممکن است باعث تغییرات دیگری شود تا رفتار ویرایشگر Docs را منعکس کند. برای اطلاعات بیشتر به مستندات DocumentStyle مراجعه کنید.

fields

string ( FieldMask format)

فیلدهایی که باید به‌روزرسانی شوند.

حداقل یک فیلد باید مشخص شود. documentStyle ریشه ضمنی است و نباید مشخص شود. می‌توان از یک "*" به عنوان اختصار برای فهرست کردن هر فیلد استفاده کرد.

برای مثال، برای به‌روزرسانی پس‌زمینه، fields روی "background" تنظیم کنید.

tabId

string

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

در سندی که شامل یک تب واحد است:

در صورت ارائه، باید با شناسه‌ی تک‌برگه‌ی مورد نظر مطابقت داشته باشد.
در صورت حذف، درخواست به همان تب اعمال می‌شود.

در سندی که شامل چندین تب است:

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

درخواست ادغام سلول‌های جدول

سلول‌ها را در یک Table ادغام می‌کند.

نمایش JSON
{ "tableRange": { object (`TableRange`) } }

فیلدها

tableRange

object ( TableRange )

محدوده جدول که مشخص می‌کند کدام سلول‌های جدول باید ادغام شوند.

هر متنی که در سلول‌هایی که ادغام می‌شوند وجود داشته باشد، به هم متصل شده و در سلول "head" محدوده ذخیره می‌شود. این سلول، سلول بالا سمت چپ محدوده است، زمانی که جهت محتوا از چپ به راست باشد، و در غیر این صورت، سلول بالا سمت راست محدوده است.

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

درخواست لغو ادغام سلول‌های جدول

سلول‌های Table را از حالت ادغام خارج می‌کند.

نمایش JSON
{ "tableRange": { object (`TableRange`) } }

فیلدها

tableRange

object ( TableRange )

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

تمام سلول‌های ادغام‌شده در این محدوده، ادغام‌نشده خواهند بود و سلول‌هایی که از قبل ادغام‌نشده‌اند، تحت تأثیر قرار نخواهند گرفت. اگر محدوده هیچ سلول ادغام‌شده‌ای نداشته باشد، درخواست هیچ کاری انجام نخواهد داد.

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

درخواست ایجاد سربرگ

یک Header ایجاد می‌کند. سرصفحه جدید در صورت مشخص شدن، روی SectionStyle در محل SectionBreak اعمال می‌شود، در غیر این صورت روی DocumentStyle اعمال می‌شود.

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

نمایش JSON
{ "type": enum (`HeaderFooterType`), "sectionBreakLocation": { object (`Location`) } }

فیلدها

type

enum ( HeaderFooterType )

نوع هدری که باید ایجاد شود.

sectionBreakLocation

object ( Location )

محل SectionBreak که بخشی را که این سربرگ باید به آن تعلق داشته باشد، آغاز می‌کند. اگر `sectionBreakLocation` تنظیم نشده باشد یا اگر به اولین شکست بخش در بدنه سند اشاره داشته باشد، سربرگ به DocumentStyle اعمال می‌شود.

نوع سربرگ و پابرگ

انواع سرصفحه‌ها و پاصفحه‌هایی که می‌توان ایجاد کرد.

انوم‌ها
`HEADER_FOOTER_TYPE_UNSPECIFIED`	نوع سربرگ/پاورقی مشخص نشده است.
`DEFAULT`	یک سربرگ/پاورقی پیش‌فرض.

درخواست ایجاد پاورقی

یک Footer ایجاد می‌کند. پاورقی جدید در صورت مشخص شدن، روی SectionStyle در محل SectionBreak اعمال می‌شود، در غیر این صورت روی DocumentStyle اعمال می‌شود.

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

نمایش JSON
{ "type": enum (`HeaderFooterType`), "sectionBreakLocation": { object (`Location`) } }

فیلدها

type

enum ( HeaderFooterType )

نوع پاورقی که باید ایجاد شود.

sectionBreakLocation

object ( Location )

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

درخواست ایجاد پاورقی

یک بخش Footnote ایجاد می‌کند و یک FootnoteReference جدید در محل داده شده به آن اضافه می‌کند.

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

نمایش JSON

{

  // Union field footnote_reference_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field footnote_reference_location.
}

فیلدها

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

location

object ( Location )

ارجاع پاورقی را در یک فهرست خاص در سند درج می‌کند.

ارجاع پاورقی باید درون مرزهای یک Paragraph موجود درج شود. برای مثال، نمی‌توان آن را در اندیس شروع جدول (یعنی بین جدول و پاراگراف قبلی آن) درج کرد.

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

endOfSegmentLocation

object ( EndOfSegmentLocation )

مرجع پاورقی را در انتهای بدنه سند درج می‌کند.

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

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

محتویات NamedRange یا NamedRanges مشخص شده را با محتوای جایگزین داده شده جایگزین می‌کند.

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

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

نمایش JSON

{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field replacement_content can be only one of the following:
  "text": string
  // End of list of possible types for union field replacement_content.

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}

فیلدها
`tabsCriteria`	`object ( TabsCriteria )` اختیاری. معیاری که برای مشخص کردن اینکه جایگزینی در کدام تب‌ها اتفاق می‌افتد، استفاده می‌شود. در صورت حذف، جایگزینی برای همه تب‌ها اعمال می‌شود. در سندی که شامل یک تب واحد است: در صورت ارائه، باید با شناسه‌ی تک‌برگه‌ی مورد نظر مطابقت داشته باشد. در صورت حذف، جایگزین برای تب مفرد اعمال می‌شود. در سندی که شامل چندین تب است: در صورت ارائه، جایگزینی برای برگه‌های مشخص‌شده اعمال می‌شود. در صورت حذف، جایگزینی برای همه تب‌ها اعمال می‌شود.
فیلد union به نام `replacement_content` . محتوایی که قرار است محتوای موجود در محدوده نامگذاری شده با آن جایگزین شود. `replacement_content` می‌تواند فقط یکی از موارد زیر باشد:
`text`	`string` محتوای محدوده(های) نامگذاری شده‌ی مشخص شده را با متن داده شده جایگزین می‌کند.
فیلد یونیون `named_range_reference` . ارجاعی به محدوده(های) نامگذاری شده که محتوای آنها جایگزین خواهد شد. `named_range_reference` فقط می‌تواند یکی از موارد زیر باشد:
`namedRangeId`	`string` شناسه‌ی محدوده‌ی نامگذاری‌شده‌ای که محتوای آن جایگزین خواهد شد. اگر هیچ محدوده نامگذاری شده‌ای با شناسه داده شده وجود نداشته باشد، خطای درخواست نامناسب ۴۰۰ بازگردانده می‌شود.
`namedRangeName`	`string` نام `NamedRanges` که محتوای آنها جایگزین خواهد شد. اگر چندین `named ranges` با نام داده شده وجود داشته باشد، محتوای هر کدام جایگزین می‌شود. اگر هیچ محدوده با نام داده شده وجود نداشته باشد، درخواست no-op خواهد بود.

درخواست UpdateSectionStyle

SectionStyle به‌روزرسانی می‌کند.

نمایش JSON
{ "range": { object (`Range`) }, "sectionStyle": { object (`SectionStyle`) }, "fields": string }

فیلدها

range

object ( Range )

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

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

sectionStyle

object ( SectionStyle )

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

تغییرات خاص در سبک بخش‌ها ممکن است باعث تغییرات دیگری شود تا رفتار ویرایشگر Docs را منعکس کند. برای اطلاعات بیشتر به مستندات SectionStyle مراجعه کنید.

fields

string ( FieldMask format)

فیلدهایی که باید به‌روزرسانی شوند.

حداقل یک فیلد باید مشخص شود. sectionStyle ریشه ضمنی است و نباید مشخص شود. می‌توان از یک "*" به عنوان اختصار برای فهرست کردن هر فیلد استفاده کرد.

برای مثال، برای به‌روزرسانی حاشیه چپ، fields روی "marginLeft" تنظیم کنید.

درخواست شکستن بخش درج

یک بخش جدید در محل داده شده وارد می‌کند.

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

نمایش JSON

{
  "sectionType": enum (SectionType),

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

فیلدها
`sectionType`	`enum ( SectionType )` نوع بخشی که باید درج شود.
Union field `insertion_location` . The location where the break will be inserted. `insertion_location` can be only one of the following:
`location`	`object ( Location )` Inserts a newline and a section break at a specific index in the document. The section break must be inserted inside the bounds of an existing `Paragraph` . For instance, it cannot be inserted at a table's start index (ie between the table and its preceding paragraph). Section breaks cannot be inserted inside a table, equation, footnote, header, or footer. Since section breaks can only be inserted inside the body, the `segment ID` field must be empty.
`endOfSegmentLocation`	`object ( EndOfSegmentLocation )` Inserts a newline and a section break at the end of the document body. Section breaks cannot be inserted inside a footnote, header or footer. Because section breaks can only be inserted inside the body, the `segment ID` field must be empty.

DeleteHeaderRequest

Deletes a Header from the document.

JSON representation
{ "headerId": string, "tabId": string }

فیلدها

headerId

string

The id of the header to delete. If this header is defined on DocumentStyle , the reference to this header is removed, resulting in no header of that type for the first section of the document. If this header is defined on a SectionStyle , the reference to this header is removed and the header of that type is now continued from the previous section.

tabId

string

The tab containing the header to delete. When omitted, the request is applied 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.

DeleteFooterRequest

Deletes a Footer from the document.

JSON representation
{ "footerId": string, "tabId": string }

فیلدها

footerId

string

The id of the footer to delete. If this footer is defined on DocumentStyle , the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle , the reference to this footer is removed and the footer of that type is now continued from the previous section.

tabId

string

The tab that contains the footer to delete. When omitted, the request is applied 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.

PinTableHeaderRowsRequest

Updates the number of pinned table header rows in a table.

JSON representation
{ "tableStartLocation": { object (`Location`) }, "pinnedHeaderRowsCount": integer }

فیلدها

tableStartLocation

object ( Location )

The location where the table starts in the document.

pinnedHeaderRowsCount

integer

The number of table rows to pin, where 0 implies that all rows are unpinned.

InsertPersonRequest

Inserts a person mention.

JSON representation

{
  "personProperties": {
    object (PersonProperties)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

فیلدها
`personProperties`	`object ( PersonProperties )` The properties of the person mention to insert.
Union field `insertion_location` . The location where the person mention will be inserted. `insertion_location` can be only one of the following:
`location`	`object ( Location )` Inserts the person mention at a specific index in the document. The person mention must be inserted inside the bounds of an existing `Paragraph` . For instance, it cannot be inserted at a table's start index (ie between the table and its preceding paragraph). Person mentions cannot be inserted inside an equation.
`endOfSegmentLocation`	`object ( EndOfSegmentLocation )` Inserts the person mention at the end of a header, footer, footnote or the document body.

Requests با مجموعه‌ها، منظم بمانید ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.

درخواست

درخواست جایگزینی همه متن

معیارهای تطبیق زیررشته

تب‌هامعیارها

درخواست درج متن

مکان

موقعیت مکانی EndOfSegment

درخواست به‌روزرسانی سبک متن

درخواست ایجادBulletsParagraph

BulletGlyphPreset

درخواست حذف پاراگراف

درخواست CreateNamedRange

درخواست حذف محدوده نام‌گذاری‌شده

درخواست به‌روزرسانی سبک پاراگراف

درخواست محدوده محتوا (DeleteContentRangeRequest)

درخواست درج تصویر در خط

درخواست درج جدول

درخواست درج سطر جدول

مکان سلول جدول

درخواست درج جدول ستونی

درخواست حذف ردیف جدول

درخواست حذف جدول ستونی

درخواست شکستن صفحه (InsertPageBreakRequest)

درخواست حذف شیء موقعیت‌یابی‌شده

درخواست به‌روزرسانی جدول ستون‌ها

درخواست به‌روزرسانی سبک سلول جدول

جدول محدوده

درخواست به‌روزرسانی سبک ردیف جدول

درخواست تصویر جایگزین

متد جایگزینی تصویر

درخواست UpdateDocumentStyle

درخواست ادغام سلول‌های جدول

درخواست لغو ادغام سلول‌های جدول

درخواست ایجاد سربرگ

نوع سربرگ و پابرگ

درخواست ایجاد پاورقی

درخواست ایجاد پاورقی

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

درخواست UpdateSectionStyle

درخواست شکستن بخش درج

DeleteHeaderRequest

DeleteFooterRequest

PinTableHeaderRowsRequest

InsertPersonRequest

Requests