الطلب
تعديل واحد لتطبيقه على مستند
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الاتحاد
request الطلب المحدّد الذي تريد تقديمه. يجب ملء حقل واحد بالضبط.
request
واحد فقط مما يلي:
|
|
replaceAllText
|
استبدال جميع تكرارات النص المحدّد |
insertText
|
لإدراج نص في الموضع المحدّد |
updateTextStyle
|
لتعديل نمط النص في النطاق المحدد. |
createParagraphBullets
|
لإنشاء رموز نقطية للفقرات |
deleteParagraphBullets
|
لحذف النقاط من الفقرات |
createNamedRange
|
تنشئ نطاقًا مُعنوَنًا. |
deleteNamedRange
|
لحذف نطاق مُعنوَن |
updateParagraphStyle
|
تعديل نمط الفقرة في النطاق المحدّد |
deleteContentRange
|
لحذف المحتوى من المستند. |
insertInlineImage
|
إدراج صورة مضمّنة في الموقع المحدد. |
insertTable
|
إدراج جدول في الموقع المحدد |
insertTableRow
|
لإدراج صف فارغ في جدول |
insertTableColumn
|
إدراج عمود فارغ في جدول |
deleteTableRow
|
لحذف صف من الجدول. |
deleteTableColumn
|
لحذف عمود من جدول |
insertPageBreak
|
تُدرج فاصل صفحة في الموضع المحدّد. |
deletePositionedObject
|
لحذف عنصر في موضع من المستند. |
updateTableColumnProperties
|
تعديل خصائص الأعمدة في جدول |
updateTableCellStyle
|
تعديل نمط خلايا الجدول |
updateTableRowStyle
|
تعديل نمط الصف في جدول |
replaceImage
|
لاستبدال صورة في المستند. |
updateDocumentStyle
|
تعديل نمط المستند |
mergeTableCells
|
يدمج الخلايا في الجدول. |
unmergeTableCells
|
تؤدي هذه العملية إلى إلغاء دمج الخلايا في الجدول. |
createHeader
|
لإنشاء عنوان |
createFooter
|
لإنشاء تذييل. |
createFootnote
|
لإنشاء حاشية سفلية |
replaceNamedRangeContent
|
لاستبدال المحتوى في نطاق مُعنوَن |
updateSectionStyle
|
تعديل نمط القسم للنطاق المحدّد |
insertSectionBreak
|
تُدرج فاصل أقسام في الموضع المحدّد. |
deleteHeader
|
لحذف عنوان من المستند |
deleteFooter
|
لحذف تذييل من المستند |
pinTableHeaderRows
|
تعديل عدد صفوف العناوين المثبَّتة في جدول |
ReplaceAllTextRequest
لاستبدال جميع مثيلات النص المطابق لمعايير ما
replace text
تمثيل JSON |
---|
{ "replaceText": string, "tabsCriteria": { object ( |
الحقول | |
---|---|
replaceText
|
النص الذي سيحل محل النص المتطابق. |
tabsCriteria
|
اختياريّ. المعايير المستخدَمة لتحديد علامات التبويب التي يحدث فيها الاستبدال عند إسقاط العلامة، يتم تطبيق الاستبدال على جميع علامات التبويب. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
حقل الاتحاد
criteria المعايير المستخدمة لمطابقة النص المراد استبداله.
criteria
واحد فقط مما يلي:
|
|
containsText
|
للعثور على نص في المستند المطابق لهذه السلسلة الفرعية |
SubstringMatchCriteria
يشير ذلك المصطلح إلى معيار يطابق سلسلة معيّنة من النص في المستند.
تمثيل JSON |
---|
{ "text": string, "matchCase": boolean } |
الحقول | |
---|---|
text
|
النص المطلوب البحث عنه في المستند |
matchCase
|
يشير إلى ما إذا كان يجب أن يراعي البحث حالة الأحرف:
|
TabsCriteria
معايير تحدّد علامات التبويب التي يتم تنفيذ الطلب فيها
تمثيل JSON |
---|
{ "tabIds": [ string ] } |
الحقول | |
---|---|
tabIds[]
|
قائمة بأرقام تعريف علامات التبويب التي يتم تنفيذ الطلب فيها |
InsertTextRequest
لإدراج نص في الموضع المحدّد
تمثيل JSON |
---|
{ "text": string, // Union field |
الحقول | |
---|---|
text
|
النص الذي سيتم إدراجه
سيؤدي إدراج حرف جديد ضمنًا إلى إنشاء حرف جديد.
سيتم تحديد أنماط النص للنص المدرج تلقائيًا، مع الحفاظ بشكل عام على نمط النص المجاور. في معظم الحالات، سيطابق نمط النص للنص المدرج النص الموجود قبل فهرس الإدراج مباشرةً. سيتمّ إزالة بعض أحرف التحكّم (U+0000-U+0008 وU+000C-U+001F) والأحرف من منطقة الاستخدام الخاص في المستوى الأساسي المتعدّد اللغات في Unicode (U+E000-U+F8FF) من النص المُدرَج. |
حقل الربط
insertion_location . الموضع الذي سيتم إدراج النص فيه.
insertion_location
يمكن أن يكون أحد القيم التالية فقط:
|
|
location
|
لإدراج النص في فهرس معين في المستند.
يجب إدراج النص داخل حدود
|
endOfSegmentLocation
|
لإدراج النص في نهاية الرأس أو التذييل أو الحاشية السفلية أو نص المستند. |
الموقع الجغرافي
موقع معيّن في المستند.
تمثيل JSON |
---|
{ "segmentId": string, "index": integer, "tabId": string } |
الحقول | |
---|---|
segmentId
|
رقم تعريف الرأس أو التذييل أو الحاشية السفلية التي يقع فيها الموقع. يشير رقم تعريف المقطع الفارغ إلى نص المستند. |
index
|
الفهرس المستند إلى صفر، بوحدات رموز UTF-16.
ويكون الفهرس نسبةً إلى بداية الشريحة التي حددتها من خلال
|
tabId
|
علامة التبويب التي يقع فيها الموقع الجغرافي عند حذف هذا العنصر، يتم تطبيق الطلب على علامة التبويب الأولى. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
EndOfSegmentLocation
الموضع في نهاية نص أو عنوان أو تذييل أو حاشية سفلية يقع الموقع الجغرافي مباشرةً قبل السطر الجديد الأخير في مقطع المستند.
تمثيل JSON |
---|
{ "segmentId": string, "tabId": string } |
الحقول | |
---|---|
segmentId
|
رقم تعريف الرأس أو التذييل أو الحاشية السفلية التي يقع فيها الموقع. يشير رقم تعريف المقطع الفارغ إلى نص المستند. |
tabId
|
علامة التبويب التي يظهر فيها الموقع الجغرافي عند حذف هذا العنصر، يتم تطبيق الطلب على علامة التبويب الأولى. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
UpdateTextStyleRequest
عدِّل تنسيق النص.
تمثيل JSON |
---|
{ "textStyle": { object ( |
الحقول | |
---|---|
textStyle
|
الأنماط التي تريد تعيينها على النص. إذا تطابقت قيمة نمط معين مع قيمة النمط الرئيسي، فسيتم تعيين هذا النمط ليتم اكتسابه.
قد تؤدي تغييرات معيّنة في نمط النص إلى تغييرات أخرى لمطابقة سلوك محرِّر "مستندات Google". انظر وثائق
|
fields
|
الحقول التي يجب تعديلها
يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر
على سبيل المثال، لتعديل نمط النص إلى نص غامق، اضبط
لإعادة ضبط خاصيّة على قيمتها التلقائية، أدرِج اسم الحقل في قناع الحقل، ولكن اترك الحقل نفسه غير محدّد. |
حقل الاتحاد
insertion_location نوع النطاق المستخدم حيث سيتم تحديث نمط النص.
insertion_location
يمكن أن تكون إحدى القيم التالية فقط:
|
|
range
|
نطاق النص المراد نمطه. يمكن توسيع النطاق ليشمل أسطرًا جديدة متجاورة. إذا كان النطاق يحتوي بالكامل على فقرة تنتمي إلى قائمة، فسيتم أيضًا تحديث التعداد النقطي للفقرة بنمط النص المطابق. لا يمكن إدراج النطاقات داخل UpdateTextStyleRequest نسبي. |
CreateParagraphBulletsRequest
تنشئ رموزًا نقطية لكل الفقرات التي تتداخل مع النطاق المحدّد.
سيتم تحديد مستوى التداخل لكل فقرة عن طريق حساب علامات التبويب البادئة أمام كل فقرة. لتجنُّب المسافة الزائدة بين الرمز النقطي والفقرة المقابلة، تتم إزالة علامات التبويب البادئة من خلال هذا الطلب. وقد يؤدي ذلك إلى تغيير فهارس أجزاء من النص.
إذا كانت الفقرة قبل تحديث الفقرات مباشرةً في قائمة ذات إعداد مسبق مطابق، تُضاف الفقرات التي يتم تحديثها إلى القائمة السابقة.
تمثيل JSON |
---|
{ "range": { object ( |
الحقول | |
---|---|
range
|
النطاق الذي سيتم تطبيق الإعداد النقطي عليه مسبقًا. |
bulletPreset
|
أنواع الرموز التصويرية للنقاط التي سيتم استخدامها |
BulletGlyphPreset
أنماط معدة مسبقًا من الرموز النقطية للقوائم.
تستخدم هذه الأنماط الأنواع التالية من الرموز النقطية:
-
ARROW
: سهم، يتوافق مع موضع الرمز يونيكود U+2794 -
ARROW3D
: سهم مع تظليل ثلاثي الأبعاد، يتوافق مع موضع رمز يونيكود U+27a2 -
CHECKBOX
: مربّع مجوف، يتوافق مع موضع الرمز يونيكود U+274f -
CIRCLE
: دائرة مجوفة تتجاوب مع نقطة رمز Unicode U+25cb -
DIAMOND
: معيّن صلب، يتوافق مع نقطة رمز Unicode U+25c6 -
DIAMONDX
: مربّع ماسية يتضمّن حرف "x"، ويتوافق مع موضع الرمز يونيكود U+2756 -
HOLLOWDIAMOND
: معيّن مجوف، يتوافق مع نقطة رمز Unicode U+25c7 -
DISC
: دائرة متصلة، تتجاوب مع نقطة رمز Unicode U+25cf -
SQUARE
: مربع ثابت يقابل نقطة رمز Unicode U+25a0 -
STAR
: نجمة، تتجاوب مع نقطة رمز Unicode U+2605 -
ALPHA
: حرف صغير، مثل "أ" أو "ب" أو "ج". -
UPPERALPHA
: حرف كبير، مثل "أ" أو "ب" أو "ج". -
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
|
النطاق المطلوب حذف النقاط من خلاله |
CreateNamedRangeRequest
تنشئ دالة NamedRange
إشارة إلى النطاق المحدَّد.
تمثيل JSON |
---|
{
"name": string,
"range": {
object (
|
الحقول | |
---|---|
name
|
اسم النطاق NamedRange. ولا يلزم أن تكون الأسماء فريدة. يجب أن تتألف الأسماء من حرف واحد على الأقل وألا تزيد عن 256 حرفًا، وتُقاس بوحدات رمز UTF-16. |
range
|
النطاق الذي تريد تطبيق الاسم عليه. |
DeleteNamedRangeRequest
يؤدي هذا الإجراء إلى حذف
NamedRange
تمثيل JSON |
---|
{ "tabsCriteria": { object ( |
الحقول | |
---|---|
tabsCriteria
|
اختياريّ. المعايير المستخدمة لتحديد علامات التبويب التي يجب أن يحدث فيها حذف النطاق. عند الحذف، يتم تطبيق حذف النطاق على جميع علامات التبويب. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
حقل الاتحاد
named_range_reference القيمة التي تحدّد النطاقات التي يجب حذفها يجب تعيين واحد بالضبط.
named_range_reference
واحد فقط مما يلي:
|
|
namedRangeId
|
رقم تعريف النطاق المعنوَن المطلوب حذفه. |
name
|
اسم النطاقات المطلوب حذفها سيتم حذف جميع النطاقات المُعنونة التي تحمل الاسم المحدّد. |
UpdateParagraphStyleRequest
تعديل نمط جميع الفقرات التي تتداخل مع النطاق المحدّد.
تمثيل JSON |
---|
{ "paragraphStyle": { object ( |
الحقول | |
---|---|
paragraphStyle
|
الأنماط المراد تعيينها على الفقرات.
قد تتسبب تغييرات معينة في نمط الفقرة في حدوث تغييرات أخرى بهدف محاكاة سلوك محرّر المستندات. يمكنك الاطّلاع على مستندات
|
fields
|
الحقول التي يجب تعديلها.
يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر
فعلى سبيل المثال، لتحديث خاصية محاذاة نمط الفقرة، اضبط
لإعادة ضبط خاصيّة على قيمتها التلقائية، أدرِج اسم الحقل في قناع الحقل ولكن اترك الحقل نفسه غير محدّد. |
حقل الاتحاد
insertion_location نوع النطاق المستخدم حيث سيتم تحديث نمط الفقرة.
insertion_location
واحد فقط مما يلي:
|
|
range
|
النطاق الذي يتداخل مع نمط الفقرات. |
DeleteContentRangeRequest
لحذف المحتوى من المستند.
تمثيل JSON |
---|
{
"range": {
object (
|
الحقول | |
---|---|
range
|
نطاق المحتوى الذي تريد حذفه. قد يؤدي حذف النص الذي يتخطى حدود الفقرة إلى حدوث تغييرات في أنماط الفقرات والقوائم والكائنات الموضوعة والإشارات المرجعية أثناء دمج الفقرتين. يمكن أن تؤدي محاولة حذف نطاقات معيّنة إلى بنية مستند غير صالحة، وفي هذه الحالة يتم عرض خطأ 400 "الخطأ 400: طلب غير صالح". في ما يلي بعض الأمثلة على طلبات الحذف غير الصالحة:
|
InsertInlineImageRequest
تُستخدَم لإدراج رمز
InlineObject
يحتوي على صورة في الموضع المحدّد.
تمثيل JSON |
---|
{ "uri": string, "objectSize": { object ( |
الحقول | |
---|---|
uri
|
معرّف الموارد المنتظم (URI) للصورة يتم جلب الصورة مرة واحدة في وقت الإدراج ويتم تخزين نسخة منها لعرضها داخل المستند. يجب أن يكون حجم الصور أقل من 50 ميغابايت، وألّا يزيد عن 25 ميغابكسل، ويجب أن تكون بتنسيق PNG أو JPEG أو GIF.
يجب أن يكون معرّف الموارد المنتظم (URI) المقدّم متاحًا للجميع، ويجب ألّا يزيد طوله عن 2 كيلوبايت. يتم حفظ عنوان URL نفسه مع الصورة، ويتم عرضه من خلال الحقل
|
objectSize
|
الحجم الذي يجب أن تظهر به الصورة في المستند هذه السمة اختيارية ويتم تحديد الحجم النهائي للصورة في المستند من خلال القواعد التالية: * إذا لم يتم تحديد العرض أو الارتفاع، سيتم احتساب حجم تلقائي للصورة استنادًا إلى دقتها. * في حال تحديد سمة واحدة، يتم احتساب السمة الأخرى للحفاظ على نسبة العرض إلى الارتفاع للصورة. * في حال تحديد كل من العرض والارتفاع، يتم تغيير حجم الصورة لتلائم الأبعاد المقدّمة مع الحفاظ على نسبة العرض إلى الارتفاع. |
حقل الاتحاد
insertion_location الموقع الذي سيتم إدراج الصورة فيه
insertion_location
يمكن أن يكون أحد القيم التالية فقط:
|
|
location
|
إدراج الصورة في فهرس معين في المستند.
يجب إدراج الصورة داخل حدود
لا يمكن إدراج الصور المضمّنة داخل حاشية سفلية أو معادلة. |
endOfSegmentLocation
|
لإدراج النص في نهاية الرأس أو التذييل أو نص المستند. لا يمكن إدراج الصور المضمّنة داخل حاشية سفلية. |
InsertTableRequest
تُستخدَم لإدراج جدول في الموضع المحدّد.
سيتم إدراج حرف سطر جديد قبل الجدول المُدرَج.
تمثيل JSON |
---|
{ "rows": integer, "columns": integer, // Union field |
الحقول | |
---|---|
rows
|
عدد الصفوف في الجدول |
columns
|
عدد الأعمدة في الجدول |
حقل الاتحاد
insertion_location الموقع الذي سيتم إدراج الجدول فيه
insertion_location
يمكن أن تكون إحدى القيم التالية فقط:
|
|
location
|
لإدراج الجدول في فهرس نموذج معيّن. سيتم إدراج حرف سطر جديد قبل الجدول المُدرَج، وبالتالي سيكون فهرس بداية الجدول في فهرس الموقع المحدّد + 1.
يجب إدراج الجدول داخل حدود جدول في
لا يمكن إدراج الجداول داخل حاشية سفلية أو معادلة. |
endOfSegmentLocation
|
تُدرج هذه الدالة الجدول في نهاية الرأس أو التذييل أو نص المستند المحدَّد. سيتم إدراج حرف سطر جديد قبل الجدول المُدرَج. لا يمكن إدراج الجداول داخل حاشية سفلية. |
InsertTableRowRequest
لإدراج صف فارغ في جدول.
تمثيل JSON |
---|
{
"tableCellLocation": {
object (
|
الحقول | |
---|---|
tableCellLocation
|
موقع خلية الجدول المرجعي الذي سيتم إدراج الصفوف منه. سيتم إدراج صف جديد أعلى (أو أسفل) الصف الذي توجد به خلية المرجع. إذا كانت الخلية المرجعية هي خلية مدمجة، فسيتم إدراج صف جديد أعلى (أو أسفل) الخلية المدمجة. |
insertBelow
|
ما إذا كان سيتم إدراج صف جديد أسفل موقع الخلية المرجعية
|
TableCellLocation
موقع خلية واحدة داخل جدول.
تمثيل JSON |
---|
{
"tableStartLocation": {
object (
|
الحقول | |
---|---|
tableStartLocation
|
تمثّل هذه السمة مكان بدء الجدول في المستند. |
rowIndex
|
فهرس الصفوف القائم على صفر. على سبيل المثال، يحتوي الصف الثاني في الجدول على فهرس الصف 1. |
columnIndex
|
فهرس العمود الذي يبدأ من الصفر على سبيل المثال، يحتوي العمود الثاني في الجدول على فهرس عمود 1. |
InsertTableColumnRequest
لإدراج عمود فارغ في جدول
تمثيل JSON |
---|
{
"tableCellLocation": {
object (
|
الحقول | |
---|---|
tableCellLocation
|
موقع خلية الجدول المرجعي الذي سيتم إدراج الأعمدة منه. سيتم إدراج عمود جديد على يمين (أو يسار) العمود الذي تتوفّر فيه الخلية المرجعية. إذا كانت الخلية المرجعية خلية مُدمَجة، سيتم إدراج عمود جديد على يمين (أو يسار) الخلية المدمَجة. |
insertRight
|
لتحديد ما إذا كان سيتم إدراج عمود جديد إلى يمين موقع خلية المرجع.
|
DeleteTableRowRequest
لحذف صف من جدول
تمثيل JSON |
---|
{
"tableCellLocation": {
object (
|
الحقول | |
---|---|
tableCellLocation
|
موقع خلية الجدول المرجعي الذي سيتم حذف الصف منه. سيتم حذف الصف الذي تمتد هذه الخلية فيه. إذا كانت هذه خلية مدمجة تمتد عبر صفوف متعددة، فسيتم حذف جميع الصفوف التي تمتد الخلية بها. إذا لم يتبقّ أي صفوف في الجدول بعد هذا الحذف، يتم حذف الجدول بأكمله. |
DeleteTableColumnRequest
لحذف عمود من جدول
تمثيل JSON |
---|
{
"tableCellLocation": {
object (
|
الحقول | |
---|---|
tableCellLocation
|
موقع خلية الجدول المرجعي الذي سيتم حذف العمود منه سيتم حذف العمود الذي تمتد إليه هذه الخلية. إذا كانت هذه خلية مدمجة تمتد على أعمدة متعددة، سيتم حذف جميع الأعمدة التي تمتد عليها الخلية. إذا لم يتبقّ أي أعمدة في الجدول بعد هذا الحذف، يتم حذف الجدول بأكمله. |
InsertPageBreakRequest
إدراج فاصل صفحة متبوعًا بسطر جديد في الموقع المحدد.
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الاتحاد
insertion_location المكان الذي سيتم إدراج فاصل الصفحة فيه.
insertion_location
واحد فقط مما يلي:
|
|
location
|
لإدراج فاصل الصفحة في فهرس معيّن في المستند.
يجب إدراج فاصل الصفحة داخل حدود
لا يمكن إدراج فواصل الصفحات داخل جدول أو معادلة أو حواشي سفلية أو عنوان أو تذييل. ونظرًا لأنه لا يمكن إدراج فواصل الصفحات إلا داخل النص الأساسي، فإن
|
endOfSegmentLocation
|
تُدرج فاصل الصفحة في نهاية نص المستند.
لا يمكن إدراج فواصل صفحات داخل حاشية سفلية أو عنوان أو تذييل. بما أنّه لا يمكن إدراج فواصل الصفحات إلا داخل النص، يجب أن يكون الحقل
|
DeletePositionedObjectRequest
يؤدي هذا الإجراء إلى حذف
PositionedObject
من المستند.
تمثيل JSON |
---|
{ "objectId": string, "tabId": string } |
الحقول | |
---|---|
objectId
|
رقم تعريف العنصر المطلوب حذفه |
tabId
|
علامة التبويب التي يتضمّن فيها العنصر المحدَّد للحذف وعند حذفه، يتم تطبيق الطلب على علامة التبويب الأولى. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
UpdateTableColumnPropertiesRequest
لتعديل
TableColumnProperties
الأعمدة في الجدول.
تمثيل JSON |
---|
{ "tableStartLocation": { object ( |
الحقول | |
---|---|
tableStartLocation
|
الموقع الذي يبدأ فيه الجدول في المستند |
columnIndices[]
|
قائمة فهارس الأعمدة الصفرية التي يجب تحديث موقعها. في حال عدم تحديد أيّ فهارس، سيتمّ تعديل جميع الأعمدة. |
tableColumnProperties
|
خصائص أعمدة الجدول المطلوب تعديلها
إذا كانت قيمة
|
fields
|
الحقول التي يجب تعديلها.
يجب تحديد حقل واحد على الأقل. الجذر
على سبيل المثال، لتعديل عرض العمود، اضبط
|
UpdateTableCellStyleRequest
لتعديل نمط نطاق من خلايا الجدول.
تمثيل JSON |
---|
{ "tableCellStyle": { object ( |
الحقول | |
---|---|
tableCellStyle
|
النمط المطلوب تعيينه على خلايا الجدول. عند تحديث الحدود، إذا كانت الخلية تشترك في الحد مع خلية مجاورة، يتم تحديث خاصية الحد المقابلة للخلية المجاورة. لا يتم تحديث الحدود المدمجة وغير المرئية. بما أنّ تعديل الحد الذي تشاركه الخلايا المجاورة في الطلب نفسه قد يؤدي إلى تعارض تحديثات الحدود، يتم تطبيق تعديلات الحدود بالترتيب التالي:
|
fields
|
الحقول التي يجب تعديلها
يجب تحديد حقل واحد على الأقل. الجذر
على سبيل المثال، لتعديل لون خلفية خلية الجدول، اضبط
لإعادة ضبط سمة إلى قيمتها التلقائية، يجب تضمين اسم الحقل في قناع الحقل مع ترك الحقل نفسه بدون ضبط. |
حقل الاتحاد
cells الخلايا التي سيتم تعديلها
cells
يمكن أن يكون أحد القيم التالية فقط:
|
|
tableRange
|
نطاق الجدول الذي يمثّل المجموعة الفرعية من الجدول التي يتم تطبيق التعديلات عليها |
tableStartLocation
|
تمثّل هذه السمة مكان بدء الجدول في المستند. عند تحديدها، يتم تطبيق التعديلات على جميع الخلايا في الجدول. |
TableRange
يمثّل نطاق الجدول مرجعًا إلى مجموعة فرعية من الجدول.
من المهمّ ملاحظة أنّ الخلايا المحدّدة بنطاق جدول لا تشكل بالضرورة مستطيلاً. لنفترض على سبيل المثال أن لدينا جدولاً 3 × 3 تم فيه دمج جميع خلايا الصف الأخير معًا. يظهر الجدول على النحو التالي:
[ ][ ][ ]
[ ][ ][ ]
[ ]
يحدِّد نطاق الجدول الذي يكون فيه موقع خلية الجدول = (tableStartLocation، الصف = 0، العمود = 0)، وامتداد الصف = 3، وامتداد العمود = 2 الخلايا التالية:
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
تمثيل JSON |
---|
{
"tableCellLocation": {
object (
|
الحقول | |
---|---|
tableCellLocation
|
موقع الخلية الذي يبدأ منه نطاق الجدول. |
rowSpan
|
نطاق الصفوف لنطاق الجدول |
columnSpan
|
نطاق الأعمدة لنطاق الجدول |
UpdateTableRowStyleRequest
تعديل
TableRowStyle
الصفوف في جدول
تمثيل JSON |
---|
{ "tableStartLocation": { object ( |
الحقول | |
---|---|
tableStartLocation
|
تمثّل هذه السمة مكان بدء الجدول في المستند. |
rowIndices[]
|
قائمة فهارس الصفوف المستندة إلى الصفر التي يجب تعديل أسلوبها في حال عدم تحديد أيّ فهارس، سيتمّ تعديل جميع الصفوف. |
tableRowStyle
|
الأنماط التي سيتم ضبطها على الصفوف |
fields
|
الحقول التي يجب تعديلها
يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر
على سبيل المثال، لتعديل الحد الأدنى لارتفاع الصف، اضبط
|
ReplaceImageRequest
استبدال صورة حالية بصورة جديدة
يؤدي استبدال صورة إلى إزالة بعض
image effects
من الصورة الحالية من أجل أن يعكس سلوك أداة تحرير المستندات.
تمثيل JSON |
---|
{
"imageObjectId": string,
"uri": string,
"imageReplaceMethod": enum (
|
الحقول | |
---|---|
imageObjectId
|
رقم تعريف الصورة الحالية التي سيتم استبدالها. يمكن استرداد رقم التعريف من ردّ طلب الحصول. |
uri
|
معرّف الموارد المنتظم (URI) للصورة الجديدة. يتم استرجاع الصورة مرة واحدة في وقت الإدراج وتخزين نسخة لعرضها داخل المستند. يجب أن يكون حجم الصور أقل من 50 ميغابايت، وألّا يزيد عن 25 ميغابكسل، ويجب أن تكون بتنسيق PNG أو JPEG أو GIF.
لا يمكن أن يتجاوز طول معرّف الموارد المنتظم (URI) المقدَّم 2 كيلوبايت. يتم حفظ عنوان URL مع الصورة، ويتم عرضه من خلال الحقل
|
imageReplaceMethod
|
طريقة الاستبدال. |
tabId
|
علامة التبويب التي تريد استبدال الصورة بها. عند حذف هذا العنصر، يتم تطبيق الطلب على علامة التبويب الأولى. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
ImageReplaceMethod
طريقة استبدال الصورة.
عمليات التعداد | |
---|---|
IMAGE_REPLACE_METHOD_UNSPECIFIED
|
طريقة استبدال الصورة غير محدّدة. يجب عدم استخدام هذه القيمة. |
CENTER_CROP
|
يتم تكبير الصورة وتوسيعها في منتصف الشاشة لملء حدود الصورة الأصلية. يمكن اقتصاص الصورة لملء حدود الصورة الأصلية. سيكون حجم الصورة المعروض مطابقًا لحجم الصورة الأصلية. |
UpdateDocumentStyleRequest
لتعديل
DocumentStyle
تمثيل JSON |
---|
{
"documentStyle": {
object (
|
الحقول | |
---|---|
documentStyle
|
الأنماط التي سيتم تعيينها على المستند.
قد تؤدي بعض التغييرات في أسلوب المستند إلى حدوث تغييرات أخرى لمطابقة سلوك محرِّر "مستندات Google". انظر وثائق
|
fields
|
الحقول التي يجب تعديلها.
يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر
على سبيل المثال، لتحديث الخلفية، اضبط
|
tabId
|
علامة التبويب التي تحتوي على النمط المطلوب تعديله عند حذف هذا العنصر، ينطبق الطلب على علامة التبويب الأولى. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
MergeTableCellsRequest
دمج الخلايا في
Table
تمثيل JSON |
---|
{
"tableRange": {
object (
|
الحقول | |
---|---|
tableRange
|
نطاق الجدول الذي يحدد خلايا الجدول المطلوب دمجها. أي نص في الخلايا التي يتم دمجها سيتم تسلسله وتخزينها في "head" خلية النطاق. هذه هي الخلية العلوية اليسرى من النطاق عندما يكون اتجاه المحتوى من اليسار إلى اليمين، وتكون الخلية العلوية اليمنى من النطاق في الحالات الأخرى. إذا كان النطاق غير مستطيل (يمكن أن يحدث ذلك في بعض الحالات التي يغطي فيها النطاق خلايا تم دمجها من قبل أو عندما يكون الجدول غير مستطيل)، يتم عرض خطأ 400 "الطلب غير صالح". |
UnmergeTableCellsRequest
تُلغي دمج الخلايا في
Table
.
تمثيل JSON |
---|
{
"tableRange": {
object (
|
الحقول | |
---|---|
tableRange
|
نطاق الجدول الذي يحدد خلايا الجدول المطلوب إلغاء دمجها. سيتم إلغاء دمج جميع الخلايا المدمجة في هذا النطاق، ولن تتأثر الخلايا التي سبق إلغاء دمجها. وإذا لم يكن النطاق يحتوي على خلايا مدمَجة، لن يؤدي الطلب إلى تنفيذ أي إجراء. إذا كان هناك نص في أي من الخلايا المدمجة، فسيظل النص في "العنوان" الخلية الناتجة من كتلة الخلايا غير المدمجة. "الرأس" الخلية هي الخلية العلوية اليسرى عندما يكون اتجاه المحتوى من اليسار إلى اليمين، والخلية العلوية اليمنى بخلاف ذلك. |
CreateHeaderRequest
لإنشاء
Header
. تم تطبيق الرأس الجديد على
SectionStyle
في موقع
SectionBreak
إذا تم تحديدها، وإلا فسيتم تطبيقها على
DocumentStyle
إذا كان هناك عنوان من النوع المحدّد، سيتم عرض رسالة الخطأ 400 الخاصة بالطلب غير صالح.
تمثيل JSON |
---|
{ "type": enum ( |
الحقول | |
---|---|
type
|
نوع العنوان الذي تريد إنشاؤه. |
sectionBreakLocation
|
موضع
|
CreateFootnoteRequest
تُنشئ هذه الدالة شريحة
Footnote
وتُدرج فيها
FootnoteReference
جديدًا في الموضع المحدّد.
سيحتوي الجزء الجديد
Footnote
على مسافة متبوعة بحرف سطر جديد.
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الاتحاد
footnote_reference_location الموقع الذي تريد إدراج مرجع الحاشية السفلية فيه
footnote_reference_location
يمكن أن تكون إحدى القيم التالية فقط:
|
|
location
|
لإدراج مرجع الحاشية السفلية في فهرس معيّن في المستند.
يجب إدراج مرجع الحاشية السفلية داخل حدود
لا يمكن إدراج مراجع الحواشي السفلية داخل معادلة أو رأس أو تذييل أو حاشية سفلية. ونظرًا لأنه لا يمكن إدراج مراجع الحواشي السفلية إلا في النص،
|
endOfSegmentLocation
|
تُدرج هذه الوسيطة مرجع الحاشية السفلية في نهاية نص المستند.
لا يمكن إدراج مراجع الحواشي السفلية داخل عنوان أو تذييل أو حاشية سفلية. ونظرًا لأنه لا يمكن إدراج مراجع الحواشي السفلية إلا في النص،
|
ReplaceNamedRangeContentRequest
تستبدل هذه الدالة محتوى العنصر المحدد
NamedRange
أو
NamedRanges
بالمحتوى البديل المحدَّد.
لاحظ أن الفرد
NamedRange
قد تتكون من عدة نتائج
ranges
في هذه الحالة، سيتم استبدال المحتوى في النطاق الأول فقط. سيتم حذف النطاقات الأخرى ومحتواها.
في الحالات التي يؤدي فيها استبدال أي نطاقات أو حذفها إلى بنية مستند غير صالحة، يتم عرض خطأ 400 خطأ الطلب غير صالح.
تمثيل JSON |
---|
{ "tabsCriteria": { object ( |
الحقول | |
---|---|
tabsCriteria
|
اختياريّ. المعايير المستخدَمة لتحديد علامات التبويب التي يحدث فيها الاستبدال عند حذف هذا الحقل، يتم تطبيق القيمة البديلة على جميع علامات التبويب. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
حقل الربط
replacement_content . المحتوى المطلوب استبدال المحتوى الحالي للنطاق المعنوَن به.
replacement_content
واحد فقط مما يلي:
|
|
text
|
لاستبدال محتوى النطاقات المحدّدة المُسمّاة بالنص المحدّد. |
حقل الربط
named_range_reference . إشارة إلى النطاقات المُعنوَنة التي سيتم استبدال محتواها
named_range_reference
يمكن أن تكون إحدى القيم التالية فقط:
|
|
namedRangeId
|
معرّف النطاق المُعنوَن الذي سيتم استبدال محتواه. إذا لم يكن هناك نطاق مُعنوَن بالمعرّف المحدّد، سيتم عرض خطأ 400 في الطلب غير صالح. |
namedRangeName
|
اسم
إذا كانت هناك عدة
|
UpdateSectionStyleRequest
لتعديل
SectionStyle
تمثيل JSON |
---|
{ "range": { object ( |
الحقول | |
---|---|
range
|
يتداخل النطاق مع الأقسام في النمط.
وبما أنّه لا يمكن إدراج فواصل الأقسام إلا داخل النص، يجب أن يكون الحقل
|
sectionStyle
|
الأنماط التي سيتم ضبطها على القسم
قد تؤدي تغييرات معيّنة في نمط القسم إلى تغييرات أخرى لمطابقة سلوك محرِّر "مستندات Google". انظر وثائق
|
fields
|
الحقول التي يجب تعديلها.
يجب تحديد حقل واحد على الأقل. الجذر
على سبيل المثال، لتعديل الهامش الأيسر، اضبط
|
InsertSectionBreakRequest
تُدرج فاصل قسم في الموضع المحدَّد.
سيتم إدراج حرف سطر جديد قبل فاصل القسم.
تمثيل JSON |
---|
{ "sectionType": enum ( |
الحقول | |
---|---|
sectionType
|
نوع القسم المطلوب إدراجه. |
حقل الاتحاد
insertion_location الموضع الذي سيتم إدراج الفاصل فيه.
insertion_location
يمكن أن يكون أحد القيم التالية فقط:
|
|
location
|
تُدرج سطرًا جديدًا وفاصل قسم في فهرس معيّن في المستند.
يجب إدراج فاصل القسم داخل حدود
لا يمكن إدراج فواصل أقسام داخل جدول أو معادلة أو حاشية سفلية أو عنوان أو تذييل. بما أنّه لا يمكن إدراج فواصل الأقسام إلا داخل النص، يجب أن يكون الحقل
|
endOfSegmentLocation
|
تُدخِل سطرًا جديدًا وفاصلًا بين الأقسام في نهاية نص المستند.
لا يمكن إدراج فواصل الأقسام داخل حاشية سفلية أو رأس أو تذييل. وبما أنّه لا يمكن إدراج فواصل الأقسام إلا داخل النص، يجب أن يكون الحقل
|
DeleteHeaderRequest
لحذف
Header
من المستند
تمثيل JSON |
---|
{ "headerId": string, "tabId": string } |
الحقول | |
---|---|
headerId
|
رقم تعريف العنوان المطلوب حذفه. إذا تم تحديد هذا العنوان في
|
tabId
|
علامة التبويب التي تحتوي على العنوان المطلوب حذفه عند حذف هذا العنصر، يتم تطبيق الطلب على علامة التبويب الأولى. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
PinTableHeaderRowsRequest
تعديل عدد صفوف عناوين الجداول المثبَّتة في جدول
تمثيل JSON |
---|
{
"tableStartLocation": {
object (
|
الحقول | |
---|---|
tableStartLocation
|
تمثّل هذه السمة مكان بدء الجدول في المستند. |
pinnedHeaderRowsCount
|
عدد صفوف الجدول المطلوب تثبيتها، ويشير الرقم 0 إلى إزالة تثبيت جميع الصفوف. |