Requests

طلب

تعديل واحد يتم تطبيقه على مستند.

تمثيل JSON 
{

  "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)
  },
  "addDocumentTab": {
    object (AddDocumentTabRequest)
  },
  "deleteTab": {
    object (DeleteTabRequest)
  },
  "updateDocumentTabProperties": {
    object (UpdateDocumentTabPropertiesRequest)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  },
  "updateNamedStyle": {
    object (UpdateNamedStyleRequest)
  },
  "insertRichLink": {
    object (InsertRichLinkRequest)
  },
  "insertDate": {
    object (InsertDateRequest)
  },
  "insertComment": {
    object (InsertCommentRequest)
  },
  "addCommentReply": {
    object (AddCommentReplyRequest)
  },
  "updateCommentPost": {
    object (UpdateCommentPostRequest)
  },
  "deleteComment": {
    object (DeleteCommentRequest)
  },
  "deleteCommentReply": {
    object (DeleteCommentReplyRequest)
  },
  "acceptSuggestion": {
    object (AcceptSuggestionRequest)
  },
  "rejectSuggestion": {
    object (RejectSuggestionRequest)
  },
  "deleteSuggestion": {
    object (DeleteSuggestionRequest)
  }
}
الحقول
الطلب المحدّد الذي تريد تقديمه يجب ملء حقل واحد بالضبط. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
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)

تنشئ هذه السمة عنوان صفحة.

createFootnote

object (CreateFootnoteRequest)

تُنشئ هذه الدالة حاشية سفلية.

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

يستبدل المحتوى في نطاق مُعنوَن.

updateSectionStyle

object (UpdateSectionStyleRequest)

تعدّل هذه السمة نمط القسم للنطاق المحدّد.

insertSectionBreak

object (InsertSectionBreakRequest)

تُدرِج هذه السمة فاصل أقسام في الموقع المحدّد.

deleteHeader

object (DeleteHeaderRequest)

يحذف هذا الإجراء عنوانًا من المستند.

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

تعدِّل هذه الطريقة عدد صفوف العناوين المثبَّتة في جدول.

addDocumentTab

object (AddDocumentTabRequest)

تضيف علامة تبويب في المستند.

deleteTab

object (DeleteTabRequest)

يحذف علامة تبويب في مستند.

updateDocumentTabProperties

object (UpdateDocumentTabPropertiesRequest)

تعديل خصائص علامة تبويب في المستند

insertPerson

object (InsertPersonRequest)

تُدرج هذه السمة إشارة إلى مستخدم.

updateNamedStyle

object (UpdateNamedStyleRequest)

تعديل نمط مُسمّى

insertDate

object (InsertDateRequest)

تُدرِج هذه الدالة تاريخًا.

insertComment

object (InsertCommentRequest)

يُدرج CommentThread في المستند.

addCommentReply

object (AddCommentReplyRequest)

تضيف هذه السمة ردًا إلى CommentThread أو SuggestionThread.

updateCommentPost

object (UpdateCommentPostRequest)

تعديل مشاركة حالية (مشاركة رئيسية أو رد) ضمن CommentThread أو SuggestionThread

deleteComment

object (DeleteCommentRequest)

يحذف هذا الإجراء CommentThread.

deleteCommentReply

object (DeleteCommentReplyRequest)

يحذف هذا الإجراء ردًا Post من CommentThread أو SuggestionThread.

acceptSuggestion

object (AcceptSuggestionRequest)

يقبل اقتراحًا.

rejectSuggestion

object (RejectSuggestionRequest)

لرفض اقتراح

deleteSuggestion

object (DeleteSuggestionRequest)

يحذف هذا الإجراء اقتراحًا.

نهاية الحقول التي يستبعد كلّ منها الآخر

ReplaceAllTextRequest

يستبدل كل مثيلات النص المطابق لمعيار معيّن بالقيمة replace text.

تمثيل JSON 
{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

  "containsText": {
    object (SubstringMatchCriteria)
  }
}
الحقول
replaceText

string

النص الذي سيحلّ محل النص المطابق

tabsCriteria

object (TabsCriteria)

اختيارية: المعايير المستخدَمة لتحديد علامات التبويب التي سيتم فيها الاستبدال

في حال عدم تضمينها، ينطبق الاستبدال على جميع علامات التبويب.

في مستند يحتوي على علامة تبويب واحدة:

  • في حال توفّره، يجب أن يتطابق مع رقم تعريف علامة التبويب المفردة.

  • في حال عدم إدخال قيمة، ينطبق الاستبدال على علامة التبويب المفردة.

في مستند يحتوي على علامات تبويب متعددة:

  • في حال توفُّرها، ينطبق الاستبدال على علامات التبويب المحدّدة.

  • في حال عدم إدخال قيمة، سيتم تطبيق الاستبدال على جميع علامات التبويب.

المعايير المستخدَمة لمطابقة النص المطلوب استبداله في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
containsText

object (SubstringMatchCriteria)

تعرض النص في المستند الذي يتطابق مع هذه السلسلة الفرعية.

نهاية الحقول التي يستبعد كلّ منها الآخر

SubstringMatchCriteria

معيار يتطابق مع سلسلة نصية معيّنة في المستند

تمثيل JSON 
{
  "text": string,
  "matchCase": boolean,
  "searchByRegex": boolean
}
الحقول
text

string

النص المطلوب البحث عنه في المستند

matchCase

boolean

تُستخدَم لتحديد ما إذا كان يجب أن يراعي البحث حالة الأحرف:

  • True : البحث حسّاس لحالة الأحرف.
  • False : البحث غير حسّاس لحالة الأحرف.
searchByRegex

boolean

اختيارية: تكون القيمة "صحيح" إذا كان يجب التعامل مع قيمة البحث كتعبير عادي. يجب تخطّي أي شرطات مائلة عكسية في النمط.

  • ‫True : يتم التعامل مع نص البحث على أنّه تعبير عادي.
  • ‫False : يتم التعامل مع نص البحث على أنّه سلسلة فرعية للمطابقة.

TabsCriteria

معيار يحدّد علامات التبويب التي يتم فيها تنفيذ الطلب.

تمثيل JSON 
{
  "tabIds": [
    string
  ]
}
الحقول
tabIds[]

string

قائمة بمعرّفات علامات التبويب التي يتم تنفيذ الطلب فيها.

InsertTextRequest

تُدرج هذه الطريقة نصًا في الموقع الجغرافي المحدّد.

تمثيل JSON 
{
  "text": string,

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
الحقول
text

string

النص المطلوب إدراجه

سيؤدي إدراج حرف سطر جديد إلى إنشاء Paragraph جديد ضمنيًا في هذا الفهرس. سيتم نسخ نمط الفقرة الجديدة من الفقرة في فهرس الإدراج الحالي، بما في ذلك القوائم والنقاط.

سيتم تحديد أنماط النص المُدرَج تلقائيًا، مع الحفاظ بشكل عام على نمط النص المجاور. في معظم الحالات، سيتطابق نمط النص المُدرَج مع النص الذي يسبق فهرس الإدراج مباشرةً.

سيتم إزالة بعض أحرف التحكّم (U+0000-U+0008 وU+000C-U+001F) والأحرف من "مساحة الاستخدام الخاص" في "الخطة الأساسية المتعددة اللغات" من Unicode (U+E000-U+F8FF) من النص المُدرَج.

الموقع الجغرافي الذي سيتم إدراج النص فيه في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
location

object (Location)

تُدرِج هذه الطريقة النص في فهرس معيّن في المستند.

يجب إدراج النص داخل حدود Paragraph حالي. على سبيل المثال، لا يمكن إدراج نص في فهرس بداية الجدول (أي بين الجدول والفقرة التي تسبقه). يجب إدراج النص في الفقرة السابقة.

endOfSegmentLocation

object (EndOfSegmentLocation)

يُدرج النص في نهاية الرأس أو التذييل أو الحاشية السفلية أو نص المستند.

نهاية الحقول التي يستبعد كلّ منها الآخر

الموقع الجغرافي

موقع جغرافي معيّن في المستند

تمثيل JSON 
{
  "segmentId": string,
  "index": integer,
  "tabId": string
}
الحقول
segmentId

string

تمثّل هذه السمة معرّف العنوان أو التذييل أو الحاشية السفلية التي يقع فيها الموقع الجغرافي. يشير رقم تعريف القسم الفارغ إلى نص المستند.

index

integer

الفهرس المستند إلى الصفر، بوحدات ترميز UTF-16

الفهرس نسبي إلى بداية الجزء المحدّد بواسطة segmentId.

tabId

string

علامة التبويب التي يظهر فيها الموقع الجغرافي في حال عدم تحديدها، يتم تطبيق الطلب على علامة التبويب الأولى.

في مستند يحتوي على علامة تبويب واحدة:

  • في حال توفّره، يجب أن يتطابق مع رقم تعريف علامة التبويب المفردة.

  • في حال عدم تحديدها، ينطبق الطلب على علامة التبويب المفردة.

في مستند يحتوي على علامات تبويب متعددة:

  • في حال توفّره، ينطبق الطلب على علامة التبويب المحدّدة.

  • في حال عدم تحديدها، ينطبق الطلب على علامة التبويب الأولى في المستند.

EndOfSegmentLocation

الموضع في نهاية النص أو العنوان أو التذييل أو الحاشية السفلية يكون الموقع الجغرافي قبل آخر سطر جديد مباشرةً في جزء المستند.

تمثيل JSON 
{
  "segmentId": string,
  "tabId": string
}
الحقول
segmentId

string

تمثّل هذه السمة معرّف العنوان أو التذييل أو الحاشية السفلية التي يقع فيها الموقع الجغرافي. يشير رقم تعريف القسم الفارغ إلى نص المستند.

tabId

string

علامة التبويب التي يظهر فيها الموقع الجغرافي في حال عدم تحديدها، يتم تطبيق الطلب على علامة التبويب الأولى.

في مستند يحتوي على علامة تبويب واحدة:

  • في حال توفّره، يجب أن يتطابق مع رقم تعريف علامة التبويب المفردة.

  • في حال عدم تحديدها، ينطبق الطلب على علامة التبويب المفردة.

في مستند يحتوي على علامات تبويب متعددة:

  • في حال توفّره، ينطبق الطلب على علامة التبويب المحدّدة.

  • في حال عدم تحديدها، ينطبق الطلب على علامة التبويب الأولى في المستند.

UpdateTextStyleRequest

تعديل نمط النص

تمثيل JSON 
{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  "range": {
    object (Range)
  }
}
الحقول
textStyle

object (TextStyle)

الأنماط التي سيتم ضبطها على النص

إذا كانت قيمة نمط معيّن تتطابق مع قيمة العنصر الرئيسي، سيتم ضبط هذا النمط على "الوراثة".

قد تؤدي بعض التغييرات في نمط النص إلى تغييرات أخرى من أجل محاكاة سلوك محرِّر "مستندات Google". يمكنك الاطّلاع على مستندات TextStyle لمزيد من المعلومات.

fields

string (FieldMask format)

الحقول التي يجب تعديلها

يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر textStyle ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

على سبيل المثال، لتعديل نمط النص إلى غامق، اضبط fields على "bold".

لإعادة ضبط إحدى السمات على قيمتها التلقائية، أدرِج اسم الحقل في قناع الحقل ولكن اترُك الحقل نفسه بدون ضبط.

نوع النطاق المستخدَم حيث سيتم تعديل نمط النص في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
range

object (Range)

نطاق النص الذي سيتم تنسيقه

يمكن توسيع النطاق ليشمل أسطرًا جديدة مجاورة.

إذا كان النطاق يحتوي بالكامل على فقرة تنتمي إلى قائمة، يتم أيضًا تعديل نقطة الفقرة النقطية باستخدام نمط النص المطابق.

لا يمكن إدراج نطاقات داخل UpdateTextStyleRequest نسبي.

نهاية الحقول التي يستبعد كلّ منها الآخر

CreateParagraphBulletsRequest

تنشئ هذه الدالة نقاطًا لكل الفقرات التي تتداخل مع النطاق المحدّد.

سيتم تحديد مستوى التداخل لكل فقرة من خلال احتساب علامات التبويب البادئة أمام كل فقرة. لتجنُّب المسافة الزائدة بين النقطة والفقرة المقابلة، تتم إزالة علامات الجدولة البادئة هذه من خلال هذا الطلب. قد يؤدي ذلك إلى تغيير فهارس أجزاء النص.

إذا كانت الفقرة التي تسبق الفقرات التي يتم تعديلها مباشرةً في قائمة تتضمّن إعدادًا مسبقًا مطابقًا، تتم إضافة الفقرات التي يتم تعديلها إلى تلك القائمة السابقة.

تمثيل JSON 
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
الحقول
range

object (Range)

النطاق الذي سيتم تطبيق الإعداد المُسبَق للنقاط عليه.

bulletPreset

enum (BulletGlyphPreset)

أنواع رموز التعداد النقطي التي سيتم استخدامها

BulletGlyphPreset

أنماط مُعدّة مسبقًا لرموز التعداد النقطي في القوائم

تستخدم هذه الأنماط أنواع النقاط التالية:

  • ARROW : سهم، يتوافق مع نقطة الرمز U+2794 في Unicode
  • ‫ARROW3D : سهم بتظليل ثلاثي الأبعاد، يتوافق مع نقطة الرمز U+27a2 في Unicode
  • CHECKBOX : مربّع فارغ، يتوافق مع نقطة الرمز U+274f في يونيكود
  • CIRCLE : دائرة مفرّغة، تتوافق مع نقطة الرمز U+25cb في يونيكود
  • DIAMOND : ماسة صلبة، تتوافق مع قيمة موضع الرمز U+25c6 في يونيكود
  • DIAMONDX : ماسة تتضمّن الحرف "x"، وهي تتوافق مع قيمة موضع الرمز U+2756 في يونيكود
  • HOLLOWDIAMOND : معيّن مجوّف، يتوافق مع نقطة الرمز U+25c7 في Unicode
  • DISC : دائرة مصمتة، تتوافق مع نقطة الرمز U+25cf في يونيكود
  • SQUARE : مربّع مصمت، يتوافق مع نقطة الرمز U+25a0 في يونيكود
  • STAR : نجمة، تتوافق مع نقطة الرمز U+2605 في Unicode
  • ‫ALPHA : حرف صغير، مثل "أ" أو "ب" أو "ت".
  • ‫UPPERALPHA : حرف كبير، مثل "أ" أو "ب" أو "ت".
  • 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 لمستويات الدمج الثلاثة الأولى في القائمة، متبوعة بنقاط.

DeleteParagraphBulletsRequest

تحذف هذه الطريقة الرموز النقطية من جميع الفقرات التي تتداخل مع النطاق المحدّد.

سيتم الحفاظ على مستوى التداخل لكل فقرة بشكل مرئي من خلال إضافة مسافة بادئة إلى بداية الفقرة المقابلة.

تمثيل JSON 
{
  "range": {
    object (Range)
  }
}
الحقول
range

object (Range)

النطاق المطلوب حذف النقاط منه.

CreateNamedRangeRequest

تنشئ هذه الدالة NamedRange مرجعًا للنطاق المحدّد.

تمثيل JSON 
{
  "name": string,
  "range": {
    object (Range)
  }
}
الحقول
name

string

تمثّل هذه السمة اسم النطاق المسمّى. ليس من الضروري أن تكون الأسماء فريدة.

يجب أن يتألف الاسم من حرف واحد على الأقل وألا يزيد عن 256 حرفًا، ويتم قياسه بوحدات ترميز UTF-16.

range

object (Range)

النطاق المطلوب تطبيق الاسم عليه

DeleteNamedRangeRequest

يحذف هذا الإجراء NamedRange.

تمثيل JSON 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  "namedRangeId": string,
  "name": string
}
الحقول
tabsCriteria

object (TabsCriteria)

اختيارية: المعايير المستخدَمة لتحديد علامات التبويب التي يجب أن يتم فيها حذف النطاق في حال عدم تضمينها، يتم تطبيق حذف النطاق على جميع علامات التبويب.

في مستند يحتوي على علامة تبويب واحدة:

  • في حال توفّره، يجب أن يتطابق مع رقم تعريف علامة التبويب المفردة.

  • في حال حذفها، ينطبق حذف النطاق على علامة التبويب المفردة.

في مستند يحتوي على علامات تبويب متعددة:

  • في حال توفّره، ينطبق حذف النطاق على علامات التبويب المحدّدة.

  • في حال عدم توفيرها، ينطبق حذف النطاق على جميع علامات التبويب.

القيمة التي تحدّد النطاق أو النطاقات التي سيتم حذفها. يجب ضبط قيمة واحدة فقط. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
namedRangeId

string

رقم تعريف النطاق المُعنوَن المطلوب حذفه.

name

string

اسم النطاقات التي سيتم حذفها سيتم حذف جميع النطاقات المُعنوَنة التي تحمل الاسم المحدّد.

نهاية الحقول التي يستبعد كلّ منها الآخر

UpdateParagraphStyleRequest

تعديل نمط جميع الفقرات التي تتداخل مع النطاق المحدّد

تمثيل JSON 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  "range": {
    object (Range)
  }
}
الحقول
paragraphStyle

object (ParagraphStyle)

تمثّل هذه السمة الأنماط التي سيتم ضبطها على الفقرات.

قد تؤدي بعض التغييرات في نمط الفقرة إلى تغييرات أخرى لمحاكاة سلوك محرر "مستندات Google". يمكنك الاطّلاع على مستندات ParagraphStyle لمزيد من المعلومات.

fields

string (FieldMask format)

الحقول التي يجب تعديلها

يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر paragraphStyle ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

على سبيل المثال، لتعديل سمة المحاذاة الخاصة بنمط الفقرة، اضبط fields على "alignment".

لإعادة ضبط إحدى السمات على قيمتها التلقائية، أدرِج اسم الحقل في قناع الحقل ولكن اترُك الحقل نفسه بدون ضبط.

نوع النطاق المستخدَم حيث سيتم تعديل نمط الفقرة. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
range

object (Range)

النطاق الذي يتداخل مع الفقرات المطلوب تنسيقها

نهاية الحقول التي يستبعد كلّ منها الآخر

DeleteContentRangeRequest

يحذف المحتوى من المستند.

تمثيل JSON 
{
  "range": {
    object (Range)
  }
}
الحقول
range

object (Range)

نطاق المحتوى المطلوب حذفه

قد تؤدي عملية حذف نص يتجاوز حدود الفقرة إلى تغييرات في أنماط الفقرات والقوائم والعناصر الموضّعة والإشارات المرجعية، وذلك لأنّه يتم دمج الفقرتين.

يمكن أن تؤدي محاولة حذف نطاقات معيّنة إلى بنية مستند غير صالحة، وفي هذه الحالة يتم عرض رسالة الخطأ 400 Bad Request.

في ما يلي بعض الأمثلة على طلبات الحذف غير الصالحة:

InsertInlineImageRequest

تُدرج هذه السمة InlineObject التي تحتوي على صورة في الموقع الجغرافي المحدّد.

تمثيل JSON 
{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
الحقول
uri

string

معرّف الموارد المنتظم (URI) للصورة

يتم استرداد الصورة مرة واحدة عند إدراجها ويتم تخزين نسخة منها لعرضها داخل المستند. يجب أن يكون حجم الصور أقل من 50 ميغابايت، وألا تتجاوز 25 ميغابكسل، وأن تكون بأحد التنسيقات PNG أو JPEG أو GIF.

يجب أن يكون معرّف الموارد الموحّد المقدَّم متاحًا للجميع وألا يزيد طوله عن 2 كيلوبايت. يتم حفظ معرّف الموارد المنتظم (URI) مع الصورة، ويتم عرضه من خلال الحقل ImageProperties.content_uri.

objectSize

object (Size)

الحجم الذي يجب أن تظهر به الصورة في المستند هذه السمة اختيارية، ويتم تحديد الحجم النهائي للصورة في المستند وفقًا للقواعد التالية: * إذا لم يتم تحديد العرض أو الارتفاع، يتم احتساب الحجم التلقائي للصورة استنادًا إلى درجة دقتها. * إذا تم تحديد أحد الأبعاد، يتم احتساب البُعد الآخر للحفاظ على نسبة العرض إلى الارتفاع للصورة. * إذا تم تحديد كل من العرض والارتفاع، يتم تغيير حجم الصورة لتلائم الأبعاد المتوفّرة مع الحفاظ على نسبة العرض إلى الارتفاع.

الموقع الجغرافي الذي سيتم إدراج الصورة فيه في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
location

object (Location)

تُدرج هذه الطريقة الصورة في فهرس معيّن في المستند.

يجب إدراج الصورة داخل حدود Paragraph حالي. على سبيل المثال، لا يمكن إدراجه في فهرس بداية الجدول (أي بين الجدول والفقرة التي تسبقه).

لا يمكن إدراج صور مضمّنة داخل حاشية سفلية أو معادلة.

endOfSegmentLocation

object (EndOfSegmentLocation)

يُدرج النص في نهاية الرأس أو التذييل أو نص المستند.

لا يمكن إدراج صور مضمّنة داخل حاشية سفلية.

نهاية الحقول التي يستبعد كلّ منها الآخر

InsertTableRequest

تُدرِج هذه الدالة جدولاً في الموقع الجغرافي المحدّد.

سيتم إدراج حرف سطر جديد قبل الجدول المُدرَج.

تمثيل JSON 
{
  "rows": integer,
  "columns": integer,

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
الحقول
rows

integer

عدد الصفوف في الجدول

columns

integer

تمثّل هذه السمة عدد الأعمدة في الجدول.

الموقع الجغرافي الذي سيتم إدراج الجدول فيه في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
location

object (Location)

يُدرج الجدول في فهرس نموذج معيّن.

سيتم إدراج حرف سطر جديد قبل الجدول المُدرَج، وبالتالي سيكون فهرس بداية الجدول هو فهرس الموقع الجغرافي المحدّد + 1.

يجب إدراج الجدول داخل حدود Paragraph حالي. على سبيل المثال، لا يمكن إدراجه في فهرس بداية جدول (أي بين جدول حالي والفقرة التي تسبقه).

لا يمكن إدراج الجداول داخل حاشية سفلية أو معادلة.

endOfSegmentLocation

object (EndOfSegmentLocation)

يُدرج الجدول في نهاية الرأس أو التذييل أو نص المستند المحدّد. سيتم إدراج حرف سطر جديد قبل الجدول المُدرَج.

لا يمكن إدراج جداول داخل حاشية سفلية.

نهاية الحقول التي يستبعد كلّ منها الآخر

InsertTableRowRequest

تُدرج هذه الدالة صفًا فارغًا في جدول.

تمثيل JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
الحقول
tableCellLocation

object (TableCellLocation)

موقع خلية الجدول المرجعية التي سيتم إدراج الصفوف منها

سيتم إدراج صف جديد فوق الصف الذي توجد فيه الخلية المرجعية (أو أسفله). وإذا كانت الخلية المرجعية خلية مدمَجة، سيتم إدراج صف جديد فوق الخلية المدمَجة (أو أسفلها).

insertBelow

boolean

تحديد ما إذا كان سيتم إدراج صف جديد أسفل موقع الخلية المرجعية

  • True : لإدراج صف أسفل الخلية
  • False : لإدراج صف فوق الخلية

TableCellLocation

موقع خلية واحدة داخل جدول

تمثيل JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
الحقول
tableStartLocation

object (Location)

الموقع الجغرافي الذي يبدأ فيه الجدول في المستند

rowIndex

integer

فهرس الصف الذي يبدأ من 0 على سبيل المثال، يحتوي الصف الثاني في الجدول على فهرس صف بقيمة 1.

columnIndex

integer

فهرس العمود الذي يبدأ من الصفر على سبيل المثال، يحمل العمود الثاني في الجدول فهرس العمود 1.

InsertTableColumnRequest

تُدرج هذه السمة عمودًا فارغًا في جدول.

تمثيل JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
الحقول
tableCellLocation

object (TableCellLocation)

موقع خلية الجدول المرجعية التي سيتم إدراج الأعمدة منها.

سيتم إدراج عمود جديد على يسار (أو يمين) العمود الذي توجد فيه الخلية المرجعية. وإذا كانت الخلية المرجعية عبارة عن خلية مدمجة، سيتم إدراج عمود جديد على يسار (أو يمين) الخلية المدمجة.

insertRight

boolean

تحديد ما إذا كان سيتم إدراج عمود جديد إلى يمين موقع الخلية المرجعية.

  • True : إدراج إلى اليمين
  • False : للإدراج إلى اليسار

DeleteTableRowRequest

تحذف هذه الدالة صفًا من جدول.

تمثيل JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
الحقول
tableCellLocation

object (TableCellLocation)

موقع خلية جدول المراجع الذي سيتم حذف الصف منه

سيتم حذف الصف الذي تمتد عليه هذه الخلية. إذا كانت هذه خلية مدمجة تمتد على عدة صفوف، سيتم حذف جميع الصفوف التي تمتد عليها الخلية. إذا لم تبقَ أي صفوف في الجدول بعد عملية الحذف هذه، سيتم حذف الجدول بأكمله.

DeleteTableColumnRequest

تحذف هذه الدالة عمودًا من جدول.

تمثيل JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
الحقول
tableCellLocation

object (TableCellLocation)

موقع خلية الجدول المرجعي الذي سيتم حذف العمود منه

سيتم حذف العمود الذي تمتد إليه هذه الخلية. إذا كانت هذه خلية مدمجة تمتد على عدة أعمدة، سيتم حذف جميع الأعمدة التي تمتد عليها الخلية. إذا لم تبقَ أي أعمدة في الجدول بعد عملية الحذف هذه، سيتم حذف الجدول بأكمله.

InsertPageBreakRequest

يُدرج فاصل صفحات متبوعًا بسطر جديد في الموقع المحدّد.

تمثيل JSON 
{

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
الحقول
الموقع الجغرافي الذي سيتم إدراج فاصل الصفحة فيه في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
location

object (Location)

يُدرج فاصل الصفحات في فهرس معيّن في المستند.

يجب إدراج فاصل الصفحات داخل حدود Paragraph حالي. على سبيل المثال، لا يمكن إدراجه في فهرس بداية الجدول (أي بين الجدول والفقرة التي تسبقه).

لا يمكن إدراج فواصل الصفحات داخل جدول أو معادلة أو حاشية سفلية أو رأس صفحة أو تذييل صفحة. بما أنّه لا يمكن إدراج فواصل الصفحات إلا داخل النص الأساسي، يجب أن يكون الحقل segment ID فارغًا.

endOfSegmentLocation

object (EndOfSegmentLocation)

يُدرج فاصل الصفحات في نهاية نص المستند.

لا يمكن إدراج فواصل صفحات داخل حاشية سفلية أو رأس صفحة أو تذييل صفحة. بما أنّه لا يمكن إدراج فواصل الصفحات إلا داخل النص الأساسي، يجب أن يكون الحقل segment ID فارغًا.

نهاية الحقول التي يستبعد كلّ منها الآخر

DeletePositionedObjectRequest

يحذف هذا الإجراء PositionedObject من المستند.

تمثيل JSON 
{
  "objectId": string,
  "tabId": string
}
الحقول
objectId

string

معرّف العنصر الذي تمّت موضَعته والمُراد حذفه.

tabId

string

علامة التبويب التي يتضمّن العنصر الموضّع المراد حذفه في حال عدم تحديدها، يتم تطبيق الطلب على علامة التبويب الأولى.

في مستند يحتوي على علامة تبويب واحدة:

  • في حال توفّره، يجب أن يتطابق مع رقم تعريف علامة التبويب المفردة.

  • في حال عدم تحديدها، ينطبق الطلب على علامة التبويب المفردة.

في مستند يحتوي على علامات تبويب متعددة:

  • في حال توفّره، ينطبق الطلب على علامة التبويب المحدّدة.

  • في حال عدم تحديدها، ينطبق الطلب على علامة التبويب الأولى في المستند.

UpdateTableColumnPropertiesRequest

تعدّل هذه الطريقة 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 Bad Request.

fields

string (FieldMask format)

الحقول التي يجب تعديلها

يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر tableColumnProperties ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

على سبيل المثال، لتعديل عرض العمود، اضبط fields على "width".

UpdateTableCellStyleRequest

تعدّل هذه السمة نمط نطاق من خلايا الجدول.

تمثيل JSON 
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
}
الحقول
tableCellStyle

object (TableCellStyle)

نمط خلايا الجدول

عند تعديل الحدود، إذا كانت إحدى الخلايا تشترك في حدّ مع خلية مجاورة، يتم تعديل خاصية الحدّ المقابلة للخلية المجاورة أيضًا. لا يتم تعديل الحدود التي تم دمجها وغير المرئية.

بما أنّ تعديل حدود مشترَكة بين خلايا متجاورة في الطلب نفسه قد يؤدي إلى حدوث تعارض في تعديلات الحدود، يتم تطبيق تعديلات الحدود بالترتيب التالي:

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

الحقول التي يجب تعديلها

يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر tableCellStyle ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

على سبيل المثال، لتعديل لون خلفية خلية الجدول، اضبط fields على "backgroundColor".

لإعادة ضبط إحدى السمات على قيمتها التلقائية، أدرِج اسم الحقل في قناع الحقل ولكن اترُك الحقل نفسه بدون ضبط.

الخلايا التي سيتم تعديلها في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
tableRange

object (TableRange)

نطاق الجدول الذي يمثّل المجموعة الفرعية من الجدول التي يتم تطبيق التعديلات عليها

tableStartLocation

object (Location)

الموقع الجغرافي الذي يبدأ فيه الجدول في المستند عند تحديدها، يتم تطبيق التعديلات على جميع الخلايا في الجدول.

نهاية الحقول التي يستبعد كلّ منها الآخر

TableRange

يمثّل نطاق الجدول مرجعًا إلى مجموعة فرعية من جدول.

من المهم ملاحظة أنّ الخلايا المحدّدة بنطاق جدول لا تشكّل بالضرورة مستطيلاً. على سبيل المثال، لنفترض أنّ لدينا جدولاً من 3 صفوف و3 أعمدة تم دمج جميع خلايا الصف الأخير فيه. يبدو الجدول على النحو التالي: 

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

يحدد نطاق الجدول الذي يتضمّن موقع خلية الجدول = (موقع بداية الجدول، الصف = 0، العمود = 0)، وامتداد الصف = 3 وامتداد العمود = 2 الخلايا التالية: 

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
تمثيل JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
الحقول
tableCellLocation

object (TableCellLocation)

موقع الخلية الذي تبدأ منه نطاق الجدول

rowSpan

integer

عدد الصفوف في نطاق الجدول

columnSpan

integer

تمثّل هذه السمة عدد الأعمدة التي يمتدّ عليها نطاق الجدول.

UpdateTableRowStyleRequest

تعدّل هذه السمة 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".

ReplaceImageRequest

يستبدل صورة حالية بصورة جديدة.

يؤدي استبدال صورة إلى إزالة بعض image effects من الصورة الحالية لمحاكاة سلوك محرر "مستندات Google".

تمثيل JSON 
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}
الحقول
imageObjectId

string

معرّف الصورة الحالية التي سيتم استبدالها يمكن استرداد رقم التعريف من ردّ على طلب GET.

uri

string

معرّف الموارد المنتظم (URI) للصورة الجديدة

يتم استرداد الصورة مرة واحدة عند إدراجها ويتم تخزين نسخة منها لعرضها داخل المستند. يجب أن يكون حجم الصور أقل من 50 ميغابايت، وألا تتجاوز 25 ميغابكسل، وأن تكون بتنسيق PNG أو JPEG أو GIF.

يجب ألا يتجاوز طول معرّف الموارد المنتظم (URI) المقدَّم 2 كيلوبايت. يتم حفظ معرّف الموارد المنتظم (URI) مع الصورة، ويتم عرضه من خلال الحقل ImageProperties.source_uri.

imageReplaceMethod

enum (ImageReplaceMethod)

طريقة الاستبدال

tabId

string

علامة التبويب التي تتضمّن الصورة المطلوب استبدالها في حال عدم تحديدها، يتم تطبيق الطلب على علامة التبويب الأولى.

في مستند يحتوي على علامة تبويب واحدة:

  • في حال توفّره، يجب أن يتطابق مع رقم تعريف علامة التبويب المفردة.

  • في حال عدم تحديدها، ينطبق الطلب على علامة التبويب المفردة.

في مستند يحتوي على علامات تبويب متعددة:

  • في حال توفّره، ينطبق الطلب على علامة التبويب المحدّدة.

  • في حال عدم تحديدها، ينطبق الطلب على علامة التبويب الأولى في المستند.

ImageReplaceMethod

طريقة استبدال الصورة

عمليات التعداد
IMAGE_REPLACE_METHOD_UNSPECIFIED طريقة استبدال الصورة غير محدّدة. يجب عدم استخدام هذه القيمة.
CENTER_CROP يتم تغيير حجم الصورة وتوسيطها لملء حدود الصورة الأصلية. قد يتم اقتصاص الصورة لملء حدود الصورة الأصلية. سيكون حجم الصورة المعروضة هو نفسه حجم الصورة الأصلية.

UpdateDocumentStyleRequest

تعدّل هذه السمة قيمة DocumentStyle.

تمثيل JSON 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}
الحقول
documentStyle

object (DocumentStyle)

الأنماط التي سيتم ضبطها على المستند

قد تؤدي بعض التغييرات في نمط المستند إلى تغييرات أخرى من أجل محاكاة سلوك محرر "مستندات Google". يمكنك الاطّلاع على مستندات DocumentStyle لمزيد من المعلومات.

fields

string (FieldMask format)

الحقول التي يجب تعديلها

يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر documentStyle ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

على سبيل المثال، لتعديل الخلفية، اضبط fields على "background".

tabId

string

علامة التبويب التي تحتوي على النمط المطلوب تعديله في حال عدم تحديدها، ينطبق الطلب على علامة التبويب الأولى.

في مستند يحتوي على علامة تبويب واحدة:

  • في حال توفّره، يجب أن يتطابق مع رقم تعريف علامة التبويب المفردة.

  • في حال عدم تحديدها، ينطبق الطلب على علامة التبويب المفردة.

في مستند يحتوي على علامات تبويب متعددة:

  • في حال توفّره، ينطبق الطلب على علامة التبويب المحدّدة.

  • في حال عدم توفيرها، ينطبق الطلب على علامة التبويب الأولى في المستند.

MergeTableCellsRequest

يدمج الخلايا في Table.

تمثيل JSON 
{
  "tableRange": {
    object (TableRange)
  }
}
الحقول
tableRange

object (TableRange)

نطاق الجدول الذي يحدّد خلايا الجدول المطلوب دمجها

سيتم ربط أي نص في الخلايا التي يتم دمجها وتخزينه في الخلية "الرئيسية" للنطاق. هذه هي الخلية أعلى اليمين في النطاق عندما يكون اتجاه المحتوى من اليمين إلى اليسار، والخلية أعلى اليسار في النطاق في الحالات الأخرى.

إذا كان النطاق غير مستطيل (وهو ما يمكن أن يحدث في بعض الحالات التي يغطي فيها النطاق خلايا سبق أن تم دمجها أو عندما يكون الجدول غير مستطيل)، سيتم عرض الخطأ 400 bad request.

UnmergeTableCellsRequest

يلغي دمج الخلايا في Table.

تمثيل JSON 
{
  "tableRange": {
    object (TableRange)
  }
}
الحقول
tableRange

object (TableRange)

نطاق الجدول الذي يحدّد خلايا الجدول المطلوب إلغاء دمجها.

سيتم إلغاء دمج جميع الخلايا المدمَجة في هذا النطاق، ولن تتأثر الخلايا التي تم إلغاء دمجها من قبل. إذا لم يكن النطاق يحتوي على خلايا مدمجة، لن يؤدي الطلب إلى أي إجراء.

إذا كان هناك نص في أي من الخلايا المدمجة، سيظل النص في الخلية "الرئيسية" لمجموعة الخلايا غير المدمجة الناتجة. خلية "العنوان" هي الخلية أعلى اليمين عندما يكون اتجاه المحتوى من اليمين إلى اليسار، والخلية أعلى اليسار في الحالات الأخرى.

CreateHeaderRequest

تنشئ هذه الطريقة Header. يتم تطبيق العنوان الجديد على SectionStyle في موقع SectionBreak إذا تم تحديده، وإلا يتم تطبيقه على DocumentStyle.

إذا كان هناك عنوان من النوع المحدّد، سيتم عرض رسالة خطأ ‎400 Bad Request.

تمثيل JSON 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
الحقول
type

enum (HeaderFooterType)

نوع العنوان المطلوب إنشاؤه

sectionBreakLocation

object (Location)

موقع SectionBreak الذي يبدأ القسم الذي يجب أن ينتمي إليه هذا العنوان إذا لم يتم ضبط `sectionBreakLocation' أو إذا كان يشير إلى فاصل الأقسام الأول في نص المستند، ينطبق العنوان على DocumentStyle

HeaderFooterType

أنواع الرؤوس والتذييلات التي يمكن إنشاؤها

عمليات التعداد
DEFAULT رأس/تذييل تلقائي

CreateFooterRequest

تنشئ هذه الطريقة Footer. يتم تطبيق التذييل الجديد على SectionStyle في موقع SectionBreak إذا تم تحديده، وإلا يتم تطبيقه على DocumentStyle.

إذا كان هناك تذييل من النوع المحدّد، سيتم عرض رسالة خطأ ‎400 Bad Request.

تمثيل JSON 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
الحقول
type

enum (HeaderFooterType)

نوع التذييل المطلوب إنشاؤه.

sectionBreakLocation

object (Location)

موقع SectionBreak الذي يسبق مباشرةً القسم الذي يجب أن يتبعه SectionStyle هذا التذييل إذا لم يتم ضبط هذا الخيار أو كان يشير إلى فاصل الأقسام الأول في المستند، ينطبق التذييل على نمط المستند.

CreateFootnoteRequest

تنشئ هذه الطريقة Footnote مقطعًا وتُدرج فيه FootnoteReference جديدًا في الموقع الجغرافي المحدّد.

سيتضمّن المقطع الجديد Footnote مسافة متبوعة بحرف سطر جديد.

تمثيل JSON 
{

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
الحقول
الموقع الجغرافي لإدراج مرجع الحاشية السفلية في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
location

object (Location)

يُدرِج مرجع الحاشية السفلية في فهرس معيّن في المستند.

يجب إدراج مرجع الحاشية السفلية داخل حدود Paragraph حالي. على سبيل المثال، لا يمكن إدراجه في فهرس بداية الجدول (أي بين الجدول والفقرة التي تسبقه).

لا يمكن إدراج مراجع الحواشي السفلية داخل معادلة أو رأس صفحة أو تذييل صفحة أو حاشية سفلية. بما أنّه لا يمكن إدراج مراجع الحواشي السفلية إلا في النص الأساسي، يجب أن يكون الحقل segment ID فارغًا.

endOfSegmentLocation

object (EndOfSegmentLocation)

يُدرج مرجع الحاشية السفلية في نهاية نص المستند.

لا يمكن إدراج مراجع الحواشي السفلية داخل رأس أو تذييل أو حاشية سفلية. بما أنّه لا يمكن إدراج مراجع الحواشي السفلية إلا في النص الأساسي، يجب أن يكون الحقل segment ID فارغًا.

نهاية الحقول التي يستبعد كلّ منها الآخر

ReplaceNamedRangeContentRequest

يستبدل هذا الإجراء محتوى NamedRange أو NamedRanges بالمحتوى البديل المحدّد.

يُرجى العِلم أنّ الفرد NamedRange قد يتألف من عدة ranges غير متجاورة. في هذه الحالة، سيتم استبدال المحتوى في النطاق الأول فقط. سيتم حذف النطاقات الأخرى ومحتواها.

في الحالات التي يؤدي فيها استبدال أي نطاقات أو حذفها إلى بنية مستند غير صالحة، يتم عرض رسالة الخطأ 400 Bad Request.

تمثيل JSON 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  "text": string

  "namedRangeId": string,
  "namedRangeName": string
}
الحقول
tabsCriteria

object (TabsCriteria)

اختيارية: المعايير المستخدَمة لتحديد علامات التبويب التي سيتم فيها الاستبدال في حال عدم تضمينها، ينطبق الاستبدال على جميع علامات التبويب.

في مستند يحتوي على علامة تبويب واحدة:

  • في حال توفّره، يجب أن يتطابق مع رقم تعريف علامة التبويب المفردة.

  • في حال عدم إدخال قيمة، ينطبق الاستبدال على علامة التبويب المفردة.

في مستند يحتوي على علامات تبويب متعددة:

  • في حال توفُّرها، ينطبق الاستبدال على علامات التبويب المحدّدة.

  • في حال عدم إدخال قيمة، سيتم تطبيق الاستبدال على جميع علامات التبويب.

المحتوى الذي سيتم استخدامه لاستبدال المحتوى الحالي للنطاق المُعنوَن في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
text

string

يستبدل محتوى النطاقات المُعنونة المحدّدة بالنص المحدّد.

نهاية الحقول التي يستبعد كلّ منها الآخر
مرجع إلى النطاق(النطاقات) المُعنوَن الذي سيتم استبدال محتواه في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
namedRangeId

string

معرّف النطاق المُعنوَن الذي سيتم استبدال محتواه.

إذا لم يكن هناك نطاق مُعنوَن بمعرّف معيّن، سيتم عرض رسالة خطأ ‎400 Bad Request.

namedRangeName

string

تمثّل هذه السمة اسم NamedRanges الذي سيتم استبدال محتواه.

إذا كان هناك عدة named ranges بالاسم المحدّد، سيتم استبدال محتوى كل منها. إذا لم تكن هناك نطاقات مُعنوَنة بالاسم المحدّد، سيكون الطلب بلا تأثير.

نهاية الحقول التي يستبعد كلّ منها الآخر

UpdateSectionStyleRequest

تعدّل هذه السمة قيمة SectionStyle.

تمثيل JSON 
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
الحقول
range

object (Range)

النطاق الذي يتداخل مع الأقسام المطلوب تنسيقها

بما أنّه لا يمكن إدراج فواصل الأقسام إلا داخل النص الأساسي، يجب أن يكون الحقل segment ID فارغًا.

sectionStyle

object (SectionStyle)

الأنماط التي سيتم ضبطها على القسم

قد تؤدي بعض التغييرات في نمط الأقسام إلى تغييرات أخرى من أجل محاكاة سلوك محرر "مستندات Google". يمكنك الاطّلاع على مستندات SectionStyle لمزيد من المعلومات.

fields

string (FieldMask format)

الحقول التي يجب تعديلها

يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر sectionStyle ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

على سبيل المثال، لتعديل الهامش الأيسر، اضبط fields على "marginLeft".

InsertSectionBreakRequest

يُدرِج فاصل أقسام في الموقع المحدّد.

سيتم إدراج حرف سطر جديد قبل فاصل الأقسام.

تمثيل JSON 
{
  "sectionType": enum (SectionType),

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
الحقول
sectionType

enum (SectionType)

نوع القسم المطلوب إدراجه

الموقع الذي سيتم إدراج الفاصل فيه في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
location

object (Location)

تُدرج هذه الطريقة سطرًا جديدًا وفاصل أقسام في فهرس معيّن في المستند.

يجب إدراج فاصل الأقسام داخل حدود Paragraph حالي. على سبيل المثال، لا يمكن إدراجه في فهرس بداية الجدول (أي بين الجدول والفقرة التي تسبقه).

لا يمكن إدراج فواصل أقسام داخل جدول أو معادلة أو حاشية سفلية أو رأس صفحة أو تذييل صفحة. بما أنّه لا يمكن إدراج فواصل الأقسام إلا داخل النص الأساسي، يجب أن يكون الحقل segment ID فارغًا.

endOfSegmentLocation

object (EndOfSegmentLocation)

يُدرج سطرًا جديدًا وفاصل أقسام في نهاية نص المستند.

لا يمكن إدراج فواصل أقسام داخل حاشية سفلية أو رأس أو تذييل. بما أنّه لا يمكن إدراج فواصل الأقسام إلا داخل النص الأساسي، يجب أن يكون الحقل segment ID فارغًا.

نهاية الحقول التي يستبعد كلّ منها الآخر

DeleteHeaderRequest

يحذف هذا الإجراء Header من المستند.

تمثيل JSON 
{
  "headerId": string,
  "tabId": string
}
الحقول
headerId

string

رقم تعريف العنوان المراد حذفه. إذا تم تحديد هذا العنوان على DocumentStyle، ستتم إزالة الإشارة إلى هذا العنوان، ما يؤدي إلى عدم توفّر عنوان من هذا النوع للجزء الأول من المستند. إذا تم تحديد هذا العنوان في SectionStyle، ستتم إزالة الإشارة إلى هذا العنوان وسيتم الآن مواصلة العنوان من هذا النوع من القسم السابق.

tabId

string

علامة التبويب التي تحتوي على العنوان المطلوب حذفه في حال عدم تحديدها، يتم تطبيق الطلب على علامة التبويب الأولى.

في مستند يحتوي على علامة تبويب واحدة:

  • في حال توفّره، يجب أن يتطابق مع رقم تعريف علامة التبويب المفردة.

  • في حال عدم تحديدها، ينطبق الطلب على علامة التبويب المفردة.

في مستند يحتوي على علامات تبويب متعددة:

  • في حال توفّره، ينطبق الطلب على علامة التبويب المحدّدة.

  • في حال عدم تحديدها، ينطبق الطلب على علامة التبويب الأولى في المستند.

DeleteFooterRequest

يحذف هذا الإجراء Footer من المستند.

تمثيل JSON 
{
  "footerId": string,
  "tabId": string
}
الحقول
footerId

string

رقم تعريف التذييل المطلوب حذفه. إذا تم تحديد هذا التذييل في DocumentStyle، ستتم إزالة الإشارة إلى هذا التذييل، ما يؤدي إلى عدم توفّر تذييل من هذا النوع للقسم الأول من المستند. إذا تم تحديد هذا التذييل في SectionStyle، تتم إزالة الإشارة إلى هذا التذييل ويتم الآن مواصلة التذييل من النوع نفسه من القسم السابق.

tabId

string

علامة التبويب التي تحتوي على التذييل المطلوب حذفه في حال عدم تحديدها، يتم تطبيق الطلب على علامة التبويب الأولى.

في مستند يحتوي على علامة تبويب واحدة:

  • في حال توفّره، يجب أن يتطابق مع رقم تعريف علامة التبويب المفردة.

  • في حال عدم تحديدها، ينطبق الطلب على علامة التبويب المفردة.

في مستند يحتوي على علامات تبويب متعددة:

  • في حال توفّره، ينطبق الطلب على علامة التبويب المحدّدة.

  • في حال عدم تحديدها، ينطبق الطلب على علامة التبويب الأولى في المستند.

PinTableHeaderRowsRequest

تعدّل هذه الدالة عدد صفوف عناوين الجدول المثبّتة في جدول.

تمثيل JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
الحقول
tableStartLocation

object (Location)

الموقع الجغرافي الذي يبدأ فيه الجدول في المستند

pinnedHeaderRowsCount

integer

عدد صفوف الجدول التي سيتم تثبيتها، حيث يشير الرقم 0 إلى أنّ جميع الصفوف غير مثبّتة.

AddDocumentTabRequest

تضيف علامة تبويب في المستند. عند إضافة علامة تبويب في فهرس معيّن، تتم زيادة فهارس جميع علامات التبويب اللاحقة.

تمثيل JSON 
{
  "tabProperties": {
    object (TabProperties)
  }
}
الحقول
tabProperties

object (TabProperties)

سمات علامة التبويب التي ستتم إضافتها. جميع السمات اختيارية.

DeleteTabRequest

يحذف علامة تبويب. إذا كانت علامة التبويب تحتوي على علامات تبويب فرعية، سيتم حذفها أيضًا.

تمثيل JSON 
{
  "tabId": string
}
الحقول
tabId

string

رقم تعريف علامة التبويب المطلوب حذفها.

UpdateDocumentTabPropertiesRequest

تعديل خصائص علامة تبويب في المستند

تمثيل JSON 
{
  "tabProperties": {
    object (TabProperties)
  },
  "fields": string
}
الحقول
tabProperties

object (TabProperties)

خصائص علامة التبويب المطلوب تعديلها.

fields

string (FieldMask format)

الحقول التي يجب تعديلها

يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر tabProperties ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

InsertPersonRequest

تُدرج هذه السمة إشارة إلى مستخدم.

تمثيل JSON 
{
  "personProperties": {
    object (PersonProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
الحقول
personProperties

object (PersonProperties)

خصائص الإشارة إلى المستخدم المطلوب إدراجها.

الموقع الجغرافي الذي ستتم فيه الإشارة إلى المستخدم في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
location

object (Location)

تُدرج هذه الدالة الإشارة إلى المستخدم في فهرس معيّن في المستند.

يجب إدراج الإشارة إلى الشخص داخل حدود Paragraph حالي. على سبيل المثال، لا يمكن إدراجه في فهرس بداية الجدول (أي بين الجدول والفقرة التي تسبقه).

لا يمكن إدراج إشارات إلى أشخاص داخل معادلة.

endOfSegmentLocation

object (EndOfSegmentLocation)

يُدرج الإشارة إلى المستخدم في نهاية الرأس أو التذييل أو الحاشية السفلية أو نص المستند.

نهاية الحقول التي يستبعد كلّ منها الآخر

UpdateNamedStyleRequest

تعديل نمط مُسمّى

تمثيل JSON 
{
  "namedStyle": {
    object (NamedStyle)
  },
  "fields": string,
  "tabId": string
}
الحقول
namedStyle

object (NamedStyle)

أسلوب المستند الذي تريد تعديله.

fields

string (FieldMask format)

حقول NamedStyle التي يجب تعديلها.

يجب تحديد namedStyleType على الأقل. يتم تضمين الجذر namedStyle ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

على سبيل المثال، لتعديل نمط النص إلى غامق، اضبط fields ليشمل "textStyle" و "textStyle.bold". لتعديل سمة المحاذاة الخاصة بنمط الفقرة، اضبط fields لتضمين "paragraphStyle" و "paragraphStyle.alignment".

لإعادة ضبط إحدى السمات على قيمتها التلقائية، أدرِج اسم الحقل في قناع الحقل ولكن اترُك الحقل نفسه بدون ضبط. سيؤدي تحديد "textStyle" أو "paragraphStyle" باستخدام TextStyle أو ParagraphStyle فارغَين إلى إعادة ضبط جميع الحقول المتداخلة.

tabId

string

علامة تبويب في المستند المطلوب تعديلها يتم تطبيق التعديل تلقائيًا على علامة التبويب الأولى.

InsertRichLinkRequest

يُدرج RichLink في الموقع الجغرافي المحدّد.

تمثيل JSON 
{
  "richLinkProperties": {
    object (RichLinkProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
الحقول
الموقع الجغرافي الذي سيتم إدراج الرابط المنسّق فيه في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
location

object (Location)

يُدرج هذا الإجراء الرابط الغني بصريًا في فهرس معيّن في المستند.

يجب إدراج الرابط المنسّق داخل حدود Paragraph حالي. على سبيل المثال، لا يمكن إدراجه في فهرس بداية الجدول (أي بين الجدول والفقرة التي تسبقه).

لا يمكن إدراج الرابط التفاعلي داخل معادلة.

endOfSegmentLocation

object (EndOfSegmentLocation)

يُدرج الرابط المنسّق في نهاية العنوان أو التذييل أو الحاشية السفلية أو نص المستند.

نهاية الحقول التي يستبعد كلّ منها الآخر

InsertDateRequest

يُدرج هذا الإجراء تاريخًا في الموقع الجغرافي المحدّد.

تمثيل JSON 
{
  "dateElementProperties": {
    object (DateElementProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
الحقول
dateElementProperties

object (DateElementProperties)

خصائص التاريخ المطلوب إدراجه

الموقع الجغرافي الذي سيتم إدراج التاريخ فيه في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
location

object (Location)

تُدرج هذه الدالة التاريخ في فهرس معيّن في المستند.

يجب إدراج التاريخ ضمن حدود Paragraph حالي. على سبيل المثال، لا يمكن إدراجه في فهرس بداية جدول (أي بين جدول حالي والفقرة التي تسبقه).

endOfSegmentLocation

object (EndOfSegmentLocation)

يُدرِج هذا العنصر التاريخ في نهاية الرأس أو التذييل أو نص المستند المحدّد.

نهاية الحقول التي يستبعد كلّ منها الآخر

InsertCommentRequest

تُدرج هذه السمة CommentThread في المستند.

تمثيل JSON 
{
  "content": string,
  "assigneeEmailAddress": string,

  "range": {
    object (Range)
  }
}
الحقول
content

string

تمثّل هذه السمة نص التعليق كنص عادي.

سيتم التعامل مع هذا المحتوى النصي بشكل مشابه للتعليقات التي يتم إنشاؤها في محرّر "مستندات Google". وسيكون لها سلوكيات مشابهة في ما يتعلّق بالتنسيق والإشعارات وما إلى ذلك.

لا يمكن أن يكون هذا الحقل فارغًا، ويجب ألا يتجاوز 2048 وحدة رموز UTF-8.

assigneeEmailAddress

string

اختيارية: عنوان البريد الإلكتروني للمستخدم المُسنَد إليه التعليق.

اترك الحقل فارغًا لتعليق غير مُعيّن.

يجب ألا يتجاوز 2,048 وحدة رمز UTF-8.

الموقع الجغرافي في المستند المرتبط بهذا التعليق في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
range

object (Range)

تمثّل هذه السمة Range في المستند المرتبط بهذا التعليق.

نهاية الحقول التي يستبعد كلّ منها الآخر

AddCommentReplyRequest

تُدرج هذه السمة ردًا Post في CommentThread أو SuggestionThread.

تمثيل JSON 
{
  "post": {
    object (Post)
  },

  "commentId": string,
  "suggestionId": string
}
الحقول
post

object (Post)

تمثّل Post الرد.

رقم تعريف سلسلة المحادثات التي يجب إضافة الردّ إليها في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
commentId

string

معرّف CommentThread الذي سيتم إضافة الردّ إليه.

suggestionId

string

معرّف SuggestionThread الذي سيتم إضافة الردّ إليه.

نهاية الحقول التي يستبعد كلّ منها الآخر

UpdateCommentPostRequest

تعدّل هذه السمة Post في CommentThread أو SuggestionThread.

تعرض هذه الطريقة رسالة الخطأ "400: طلب غير صالح" في الحالات التالية:

  • المنشور هو headPost من SuggestionThread.

  • المستخدم الذي يطلب التعديل ليس مؤلف المشاركة.

تمثيل JSON 
{
  "postId": string,
  "content": string,

  "commentId": string,
  "suggestionId": string
}
الحقول
postId

string

رقم تعريف المنشور الذي يتم تعديله.

content

string

تمثّل هذه السمة النص الجديد للتعليق، كنص عادي.

سيتم التعامل مع هذا المحتوى النصي بشكل مشابه للتعليقات التي يتم إنشاؤها في محرّر "مستندات Google". وسيكون لها سلوكيات مشابهة في ما يتعلّق بالتنسيق والإشعارات وما إلى ذلك.

لا يمكن أن يكون هذا الحقل فارغًا، ويجب ألا يتجاوز 2048 وحدة رموز UTF-8.

رقم تعريف سلسلة المحادثات التي تنتمي إليها المشاركة في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
commentId

string

تمثّل هذه السمة رقم تعريف CommentThread الذي تنتمي إليه المشاركة.

suggestionId

string

تمثّل هذه السمة رقم تعريف SuggestionThread الذي تنتمي إليه المشاركة.

نهاية الحقول التي يستبعد كلّ منها الآخر

DeleteCommentRequest

يحذف هذا الإجراء CommentThread.

تعرض هذه الطريقة الخطأ 400 Bad Request إذا لم يكن المستخدم الذي يرسل الطلب هو مؤلف headPost.

تمثيل JSON 
{
  "commentId": string
}
الحقول
commentId

string

معرّف CommentThread الذي سيتم حذفه.

DeleteCommentReplyRequest

لحذف ردّ Post من CommentThread أو SuggestionThread

تعرض هذه الطريقة رسالة الخطأ "400: طلب غير صالح" في الحالات التالية:

  • المستخدم الذي يطلب التعديل ليس مؤلف المشاركة.

  • تحتوي مشاركة الردّ على [action][google.apps.docs.v1.Post.action].

  • تتضمّن المشاركة الردّ assignee.

تمثيل JSON 
{
  "postId": string,

  "commentId": string,
  "suggestionId": string
}
الحقول
postId

string

معرّف الرد Post الذي سيتم حذفه.

رقم تعريف سلسلة المحادثات التي تنتمي إليها المشاركة في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
commentId

string

تمثّل هذه السمة رقم تعريف CommentThread الذي تنتمي إليه المشاركة.

suggestionId

string

تمثّل هذه السمة رقم تعريف SuggestionThread الذي تنتمي إليه المشاركة.

نهاية الحقول التي يستبعد كلّ منها الآخر

AcceptSuggestionRequest

يقبل اقتراحًا.

تعرض هذه الطريقة الخطأ 403 Forbidden إذا لم يكن لدى المستخدم الذي يطلب الوصول إذن بتعديل المستند.

تمثيل JSON 
{
  "suggestionId": string
}
الحقول
suggestionId

string

معرّف الاقتراح

RejectSuggestionRequest

لرفض اقتراح

تعرض هذه الطريقة الخطأ 403 Forbidden إذا لم يكن لدى المستخدم الذي يرسل الطلب إذن تعديل المستند ولم يكن هو مؤلف الاقتراح.

تمثيل JSON 
{
  "suggestionId": string
}
الحقول
suggestionId

string

معرّف الاقتراح

DeleteSuggestionRequest

يحذف هذا الإجراء اقتراحًا.

تعرض هذه الطريقة الخطأ 403 Forbidden إذا لم يكن المستخدم الذي يرسل الطلب هو مؤلف الاقتراح.

تمثيل JSON 
{
  "suggestionId": string
}
الحقول
suggestionId

string

معرّف الاقتراح