Requests

الطلب

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

تمثيل 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)
  }
  // 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)

لإنشاء عنوان

createFootnote

object (CreateFootnoteRequest)

لإنشاء حاشية سفلية

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

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

updateSectionStyle

object (UpdateSectionStyleRequest)

لتعديل نمط القسم للنطاق المحدّد.

insertSectionBreak

object (InsertSectionBreakRequest)

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

deleteHeader

object (DeleteHeaderRequest)

لحذف عنوان من المستند

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

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

ReplaceAllTextRequest

استبدال جميع مثيلات النص التي تتطابق مع معايير باستخدام replace text

تمثيل 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)

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

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

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

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

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

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

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

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

حقل الاتحاد criteria. المعايير المستخدمة لمطابقة النص المراد استبداله. criteria يمكن أن تكون إحدى القيم التالية فقط:
containsText

object (SubstringMatchCriteria)

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

SubstringMatchCriteria

يشير ذلك المصطلح إلى معيار يطابق سلسلة معيّنة من النص في المستند.

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

string

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

matchCase

boolean

يشير إلى ما إذا كان يجب أن يراعي البحث حالة الأحرف:

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

TabsCriteria

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

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

string

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

InsertTextRequest

لإدراج نص في الموضع المحدّد

تمثيل 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

النص الذي سيتم إدراجه

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

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

سيتمّ إزالة بعض أحرف التحكّم (U+0000-U+0008 وU+000C-U+001F) والأحرف من منطقة الاستخدام الخاص في المستوى الأساسي المتعدّد اللغات في Unicode (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

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

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

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

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

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

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

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

EndOfSegmentLocation

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

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

string

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

tabId

string

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

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

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

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

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

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

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

UpdateTextStyleRequest

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

تمثيل 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)

الأنماط التي تريد تعيينها على النص.

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

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

fields

string (FieldMask format)

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

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

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

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

حقل الربط insertion_location. نوع النطاق المستخدَم الذي سيتم فيه تعديل نمط النص يمكن أن تكون القيمة insertion_location واحدًا فقط مما يلي:
range

object (Range)

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

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

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

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

CreateParagraphBulletsRequest

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

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

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

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

object (Range)

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

bulletPreset

enum (BulletGlyphPreset)

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

BulletGlyphPreset

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

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

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

اسم النطاق NamedRange. ولا يلزم أن تكون الأسماء فريدة.

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

range

object (Range)

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

DeleteNamedRangeRequest

لحذف NamedRange

تمثيل 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)

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

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

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

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

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

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

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

حقل الربط named_range_reference. القيمة التي تحدد النطاق أو النطاقات المطلوب حذفها. يجب تحديد قيمة واحدة فقط. named_range_reference يمكن أن تكون إحدى القيم التالية فقط:
namedRangeId

string

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

name

string

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

UpdateParagraphStyleRequest

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

تمثيل 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)

الأنماط المراد تعيينها على الفقرات.

قد تتسبب تغييرات معينة في نمط الفقرة في حدوث تغييرات أخرى بهدف محاكاة سلوك محرّر المستندات. يمكنك الاطّلاع على مستندات ParagraphStyle للحصول على مزيد من المعلومات.

fields

string (FieldMask format)

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

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

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

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

حقل الربط insertion_location. نوع النطاق المستخدَم الذي سيتم فيه تعديل نمط الفقرة insertion_location يمكن أن تكون إحدى القيم التالية فقط:
range

object (Range)

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

DeleteContentRangeRequest

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

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

object (Range)

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

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

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

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

InsertInlineImageRequest

تُستخدَم لإدراج رمز InlineObject يحتوي على صورة في الموضع المحدّد.

تمثيل 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

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

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

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

objectSize

object (Size)

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

حقل الاتحاد insertion_location. الموضع الذي سيتم إدراج الصورة فيه. يمكن أن تكون القيمة insertion_location واحدًا فقط مما يلي:
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

InsertTableRequest

تُستخدَم لإدراج جدول في الموضع المحدّد.

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

تمثيل 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

عدد الأعمدة في الجدول.

حقل الربط insertion_location. الموضع الذي سيتم إدراج الجدول فيه. insertion_location يمكن أن تكون إحدى القيم التالية فقط:
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

فهرس الصف الذي يبدأ من الصفر على سبيل المثال، يحتوي الصف الثاني في الجدول على فهرس صف هو 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 
{

  // 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 فارغًا.

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 "الطلب غير صالح".

fields

string (FieldMask format)

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

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

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

UpdateTableCellStyleRequest

تعديل نمط نطاق من خلايا الجدول

تمثيل 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)

النمط الذي سيتم ضبطه على خلايا الجدول.

عند تحديث الحدود، إذا كانت الخلية تشترك في الحد مع خلية مجاورة، يتم تحديث خاصية الحد المقابلة للخلية المجاورة. لا يتم تعديل الحدود المدمجة وغير المرئية.

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

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

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

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

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

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

حقل الاتحاد cells. الخلايا التي سيتم تعديلها cells يمكن أن تكون إحدى القيم التالية فقط:
tableRange

object (TableRange)

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

tableStartLocation

object (Location)

تمثّل هذه السمة مكان بدء الجدول في المستند. عند تحديدها، يتم تطبيق التعديلات على جميع الخلايا في الجدول.

TableRange

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

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

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

نطاق الجدول الذي يحتوي على موقع خلايا الجدول = (tableStartLocation، الصف = 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

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

uri

string

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

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

لا يمكن أن يتجاوز طول معرّف الموارد المنتظم (URI) المقدَّم 2 كيلوبايت. يتم حفظ عنوان URL مع الصورة، ويتم عرضه من خلال الحقل 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 طلب غير صالح.

UnmergeTableCellsRequest

تُلغي هذه العملية دمج الخلايا في Table.

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

object (TableRange)

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

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

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

CreateHeaderRequest

لإنشاء Header. يتم تطبيق الرأس الجديد على SectionStyle في موقع SectionBreak إذا تم تحديده، وبخلاف ذلك، سيتم تطبيقه على DocumentStyle.

إذا كان هناك عنوان من النوع المحدّد متوفّرًا، يتم عرض خطأ 400 "الخطأ 400: طلب غير صالح".

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

enum (HeaderFooterType)

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

sectionBreakLocation

object (Location)

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

HeaderFooterType

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

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

CreateFooterRequest

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

إذا كان هناك تذييل من النوع المحدّد، يتم عرض خطأ 400 (الخطأ "الطلب غير صالح").

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

enum (HeaderFooterType)

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

sectionBreakLocation

object (Location)

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

CreateFootnoteRequest

تُنشئ هذه الدالة شريحة 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 فارغًا.

ReplaceNamedRangeContentRequest

تستبدل هذه الدالة محتوى العنصر المحدد NamedRange أو NamedRanges بالمحتوى البديل المحدَّد.

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

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

تمثيل 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)

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

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

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

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

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

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

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

حقل الربط replacement_content. المحتوى المطلوب استبدال المحتوى الحالي للنطاق المعنوَن به. replacement_content يمكن أن تكون إحدى القيم التالية فقط:
text

string

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

حقل الربط named_range_reference. إشارة إلى النطاقات المُعنوَنة التي سيتم استبدال محتواها named_range_reference يمكن أن تكون إحدى القيم التالية فقط:
namedRangeId

string

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

إذا لم يكن هناك نطاق مُعنوَن برقم التعريف المحدّد، يتم عرض خطأ 400 (الخطأ "طلب غير صالح").

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),

  // 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)

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

حقل الاتحاد insertion_location. الموضع الذي سيتم إدراج الفاصل فيه يمكن أن تكون القيمة insertion_location واحدًا فقط مما يلي:
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

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