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) وأحرف الاستخدام الخاص لخطة يونيكود الأساسية المتعدّدة اللغات (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)

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

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

قد تؤدي تغييرات معينة في نمط النص إلى حدوث تغييرات أخرى حتى يتماشى مع سلوك أداة تحرير المستندات. انظر وثائق 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 : سهم، يتوافق مع نقطة رمز Unicode U+2794
  • ARROW3D : سهم بتظليل ثلاثي الأبعاد، يقابل نقطة رمز Unicode U+27a2
  • CHECKBOX : مربع مجوف، مطابق لنقطة رمز Unicode U+274f
  • CIRCLE : دائرة مجوفة تتجاوب مع نقطة رمز Unicode U+25cb
  • DIAMOND : معيَّن صلب، يتوافق مع نقطة رمز Unicode U+25c6
  • DIAMONDX : ماسة بها علامة "x"، تتجاوب مع نقطة رمز Unicode U+2756
  • HOLLOWDIAMOND : معيّن مجوف، يتوافق مع نقطة رمز Unicode U+25c7
  • DISC : دائرة متصلة، تتجاوب مع نقطة رمز Unicode U+25cf
  • SQUARE : مربع ثابت يقابل نقطة رمز Unicode U+25a0
  • STAR : نجمة، تتجاوب مع نقطة رمز Unicode U+2605
  • ALPHA : حرف صغير مثل "a" أو "b" أو "c".
  • UPPERALPHA : يجب أن تكون الأحرف كبيرة، مثل "A" أو "B" أو "C".
  • DECIMAL : رقم، مثل "1" أو "2" أو "3".
  • ZERODECIMAL : رقم تكون فيه الأرقام المكوَّنة من رقم واحد مسبوقة بصفر، مثل "01" أو "02" أو "03". الأرقام التي تحتوي على أكثر من رقم واحد لا تبدأ بصفر.
  • ROMAN : رقم روماني صغير، مثل 'i' أو 'ii' أو 'iii'.
  • UPPERROMAN : رقم روماني كبير، مثل 'I' أو 'II' أو 'III'.
  • LEFTTRIANGLE : مثلث يشير إلى اليسار، يقابل نقطة رمز Unicode 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 الطلب غير صالح.

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

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.

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

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

نطاق جدول يحتوي على موقع خلايا الجدول = (tableStartLocation، الصف = 0، العمود = 0)، امتداد الصف = 3 و span العمود = 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 من الصورة الحالية من أجل أن يعكس سلوك أداة تحرير المستندات.

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

string

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

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)

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

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

fields

string (FieldMask format)

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

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

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

tabId

string

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

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

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

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

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

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

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

MergeTableCellsRequest

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

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

object (TableRange)

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

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

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

UnmergeTableCellsRequest

يؤدي إلى إلغاء دمج الخلايا في Table

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

object (TableRange)

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

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

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

CreateHeaderRequest

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

إذا كان هناك عنوان من النوع المحدّد، سيتم عرض رسالة الخطأ 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)

الأنماط التي سيتم تعيينها في القسم.

قد تؤدي تغييرات معينة في أنماط الأقسام إلى حدوث تغييرات أخرى، وذلك بهدف محاكاة سلوك أداة تحرير المستندات. انظر وثائق 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

عدد صفوف الجدول المطلوب تثبيتها، ويشير الرقم 0 إلى إزالة تثبيت جميع الصفوف.