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)
  },
  "insertDate": {
    object (InsertDateRequest)
  }
}
الحقول
حقل الربط 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)

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

addDocumentTab

object (AddDocumentTabRequest)

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

deleteTab

object (DeleteTabRequest)

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

updateDocumentTabProperties

object (UpdateDocumentTabPropertiesRequest)

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

insertPerson

object (InsertPersonRequest)

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

insertDate

object (InsertDateRequest)

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

ReplaceAllTextRequest

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

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

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

string

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

tabsCriteria

object (TabsCriteria)

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

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

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

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

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

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

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

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

حقل الربط criteria المعايير المستخدَمة لمطابقة النص المطلوب استبداله يمكن أن يكون criteria إحدى القيم التالية فقط:
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) من النص المُدرَج.

حقل الربط 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,

  "range": {
    object (Range)
  }
}
الحقول
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 في Unicode
  • CHECKBOX : مربّع فارغ، يتوافق مع نقطة الرمز U+274f في يونيكود
  • CIRCLE : دائرة مفرغة، تتوافق مع نقطة الرمز U+25cb في يونيكود
  • DIAMOND : ماسة مصمتة، تتوافق مع قيمة موضع الرمز U+25c6 في يونيكود
  • DIAMONDX : ماسة تتضمّن الحرف "x"، وتتوافق مع قيمة موضع الرمز U+2756 في Unicode
  • HOLLOWDIAMOND : معيّن مجوّف، يتوافق مع نقطة الرمز U+25c7 في يونيكود
  • 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 في Unicode
عمليات التعداد
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)
  },

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

object (TabsCriteria)

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

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

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

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

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

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

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

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

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

حقل الربط insertion_location نوع النطاق المستخدَم حيث سيتم تعديل نمط الفقرة. يمكن أن يكون insertion_location إحدى القيم التالية فقط:
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 كيلوبايت. يتم حفظ معرّف الموارد الموحّد مع الصورة، ويتم عرضه من خلال الحقل ImageProperties.content_uri.

objectSize

object (Size)

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

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

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

InsertTableRequest

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

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

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

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
الحقول
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 
{

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
الحقول
حقل الربط 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 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".

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

حقل الربط cells الخلايا التي سيتم تعديلها يمكن أن يكون cells إحدى القيم التالية فقط:
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)
  }
}
الحقول
حقل الربط footnote_reference_location الموقع الذي سيتم إدراج مرجع الحاشية السفلية فيه يمكن أن يكون footnote_reference_location إحدى القيم التالية فقط:
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)

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

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

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

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

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

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

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

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

string

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

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

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

حقل الربط 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

عدد صفوف الجدول التي سيتم تثبيتها، حيث يشير الرقم 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)

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

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

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

InsertDateRequest

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

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

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

object (DateElementProperties)

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

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

object (Location)

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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