الطلب
تعديل واحد لتطبيقه على مستند
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الربط
request . الطلب المحدّد الذي تريد تقديمه. يجب ملء حقل واحد بالضبط.
request
يمكن أن تكون إحدى القيم التالية فقط:
|
|
replace
|
استبدال جميع تكرارات النص المحدّد |
insert
|
لإدراج نص في الموضع المحدّد |
update
|
تعديل نمط النص في النطاق المحدّد |
create
|
لإنشاء نقاط في الفقرات |
delete
|
لحذف النقاط من الفقرات |
create
|
تنشئ نطاقًا مُعنوَنًا. |
delete
|
لحذف نطاق مُعنوَن |
update
|
تعديل نمط الفقرة في النطاق المحدّد |
delete
|
لحذف محتوى من المستند |
insert
|
لإدراج صورة مضمّنة في الموضع المحدّد. |
insert
|
تُدرج جدولاً في الموضع المحدّد. |
insert
|
لإدراج صف فارغ في جدول |
insert
|
لإدراج عمود فارغ في جدول |
delete
|
لحذف صف من جدول |
delete
|
لحذف عمود من جدول |
insert
|
تُدرج فاصل صفحة في الموضع المحدّد. |
delete
|
لحذف عنصر تم وضعه في مكان معيّن من المستند |
update
|
تعديل خصائص الأعمدة في جدول |
update
|
تعديل نمط خلايا الجدول |
update
|
تعديل نمط الصف في جدول |
replace
|
استبدال صورة في المستند |
update
|
تعديل نمط المستند |
merge
|
دمج الخلايا في جدول |
unmerge
|
تؤدي هذه العملية إلى إلغاء دمج الخلايا في الجدول. |
create
|
لإنشاء عنوان |
create
|
لإنشاء تذييل |
create
|
لإنشاء حاشية سفلية |
replace
|
لاستبدال المحتوى في نطاق مُعنوَن |
update
|
تعديل نمط القسم للنطاق المحدّد |
insert
|
تُدرج فاصل أقسام في الموضع المحدّد. |
delete
|
لحذف عنوان من المستند |
delete
|
لحذف تذييل من المستند |
pin
|
تعديل عدد صفوف العناوين المثبَّتة في جدول |
ReplaceAllTextRequest
استبدال جميع مثيلات النص التي تتطابق مع معايير باستخدام
replace text
تمثيل JSON |
---|
{ "replaceText": string, "tabsCriteria": { object ( |
الحقول | |
---|---|
replace
|
النص الذي سيحلّ محلّ النص المطابق. |
tabs
|
اختيارية: المعايير المستخدَمة لتحديد علامات التبويب التي يحدث فيها الاستبدال عند حذف هذا الحقل، يتم تطبيق القيمة البديلة على جميع علامات التبويب. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
حقل الربط
criteria . المعايير المستخدَمة لمطابقة النص المطلوب استبداله
criteria
يمكن أن تكون إحدى القيم التالية فقط:
|
|
contains
|
للعثور على نص في المستند يتطابق مع هذه السلسلة الفرعية. |
SubstringMatchCriteria
معايير تتطابق مع سلسلة نصية معيّنة في المستند
تمثيل JSON |
---|
{ "text": string, "matchCase": boolean } |
الحقول | |
---|---|
text
|
النص المطلوب البحث عنه في المستند |
match
|
يشير إلى ما إذا كان يجب أن يراعي البحث حالة الأحرف:
|
TabsCriteria
معايير تحدّد علامات التبويب التي يتم تنفيذ الطلب فيها
تمثيل JSON |
---|
{ "tabIds": [ string ] } |
الحقول | |
---|---|
tab
|
قائمة أرقام تعريف علامات التبويب التي يتم تنفيذ الطلب فيها |
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
|
لإدراج النص في فهرس معيّن في المستند
يجب إدراج النص داخل حدود
|
end
|
تُستخدَم هذه العلامة لإدراج النص في نهاية عنوان أو تذييل أو حاشية سفلية أو نص المستند. |
الموقع الجغرافي
موقع معيّن في المستند
تمثيل JSON |
---|
{ "segmentId": string, "index": integer, "tabId": string } |
الحقول | |
---|---|
segment
|
معرّف الرأس أو التذييل أو الحاشية السفلية الذي يتضمّن الموقع الجغرافي. يشير رقم تعريف المقطع الفارغ إلى نص المستند. |
index
|
الفهرس المستند إلى الصفر، بوحدات ترميز UTF-16
يكون الفهرس نسبيًا لبداية الجزء المحدّد باستخدام
|
tab
|
علامة التبويب التي يقع فيها الموقع الجغرافي عند حذف هذا العنصر، يتم تطبيق الطلب على علامة التبويب الأولى. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
EndOfSegmentLocation
الموضع في نهاية نص أو عنوان أو تذييل أو حاشية سفلية يقع الموضع مباشرةً قبل السطر الجديد الأخير في جزء المستند.
تمثيل JSON |
---|
{ "segmentId": string, "tabId": string } |
الحقول | |
---|---|
segment
|
معرّف الرأس أو التذييل أو الحاشية السفلية الذي يتضمّن الموقع الجغرافي. يشير رقم تعريف المقطع الفارغ إلى نص المستند. |
tab
|
علامة التبويب التي يقع فيها الموقع الجغرافي عند حذف هذا العنصر، يتم تطبيق الطلب على علامة التبويب الأولى. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
UpdateTextStyleRequest
عدِّل تنسيق النص.
تمثيل JSON |
---|
{ "textStyle": { object ( |
الحقول | |
---|---|
text
|
الأنماط المطلوب ضبطها على النص إذا كانت قيمة نمط معيّن تتطابق مع قيمة النمط الرئيسي، سيتم ضبط هذا النمط على اكتساب.
قد تؤدي تغييرات معيّنة على نمط النص إلى تغييرات أخرى لمطابقة سلوك محرِّر "مستندات Google". يمكنك الاطّلاع على مستندات
|
fields
|
الحقول التي يجب تعديلها
يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر
على سبيل المثال، لتعديل نمط النص إلى نص غامق، اضبط
لإعادة ضبط خاصيّة على قيمتها التلقائية، أدرِج اسم الحقل في قناع الحقل، ولكن اترك الحقل نفسه غير محدّد. |
حقل الربط
insertion_location . نوع النطاق المستخدَم الذي سيتم فيه تعديل نمط النص
insertion_location
يمكن أن تكون إحدى القيم التالية فقط:
|
|
range
|
نطاق النص الذي سيتم تطبيق النمط عليه يمكن توسيع النطاق ليشمل الأسطر الجديدة المجاورة. إذا كان النطاق يتضمّن فقرة بالكامل تنتمي إلى قائمة، يتم أيضًا تعديل علامة الفقرة باستخدام نمط النص المطابق. لا يمكن إدراج النطاقات داخل UpdateTextStyleRequest نسبي. |
CreateParagraphBulletsRequest
تُنشئ هذه الدالة نقاطًا في كل الفقرات التي تتداخل مع النطاق المحدَّد.
سيتم تحديد مستوى التداخل لكل فقرة من خلال احتساب علامات التبويب التي تسبق كل فقرة. لتجنّب ترك مسافة زائدة بين النقطة والفقرة المقابلة لها، تتم إزالة علامات التبويب البادئة هذه من خلال هذا الطلب. وقد يؤدي ذلك إلى تغيير فهارس أجزاء من النص.
إذا كانت الفقرة التي تسبق الفقرات التي يتم تعديلها مباشرةً في قائمة تتضمّن إعدادًا مُسبَقًا مطابقًا، تتم إضافة الفقرات التي يتم تعديلها إلى هذه القائمة السابقة.
تمثيل JSON |
---|
{ "range": { object ( |
الحقول | |
---|---|
range
|
النطاق الذي سيتم تطبيق الإعداد المُسبَق للرمز النقطي عليه. |
bullet
|
أنواع الرموز التصويرية للنقاط التي سيتم استخدامها |
BulletGlyphPreset
أنماط مُعدّة مسبقًا للرموز النقطية للقوائم
تستخدِم هذه الأنماط أنواع النقاط التالية:
-
ARROW
: سهم، يتوافق مع موضع الرمز يونيكود U+2794 -
ARROW3D
: سهم مع تظليل ثلاثي الأبعاد، يتوافق مع موضع رمز يونيكود U+27a2 -
CHECKBOX
: مربّع مجوف، يتوافق مع موضع الرمز يونيكود U+274f -
CIRCLE
: دائرة مجوفة، تتوافق مع موضع الرمز يونيكود U+25cb -
DIAMOND
: مربّع مُربّع صلب، يتوافق مع موضع الرمز يونيكود U+25c6 -
DIAMONDX
: مربّع ماسية يتضمّن حرف x، ويتوافق مع موضع الرمز يونيكود U+2756 -
HOLLOWDIAMOND
: رمز معيّن مجوف يتوافق مع موضع الرمز يونيكود U+25c7 -
DISC
: دائرة صلبة، تتوافق مع موضع الرمز يونيكود U+25cf -
SQUARE
: مربّع صلب، يتوافق مع موضع الرمز يونيكود U+25a0 -
STAR
: نجمة، تتوافق مع موضع الرمز يونيكود U+2605 -
ALPHA
: حرف صغير، مثل "أ" أو "ب" أو "ج". -
UPPERALPHA
: حرف كبير، مثل "أ" أو "ب" أو "ج". -
DECIMAL
: رقم، مثل 1 أو 2 أو 3 -
ZERODECIMAL
: رقم يتمّ وضع الصفر قبل الأرقام الأحادية، مثل 01 أو 02 أو 03. لا يتمّ وضع صفر قبل الأرقام التي تتألّف من أكثر من رقم واحد. -
ROMAN
: رقم روماني صغير، مثل "i" أو "ii" أو "iii". -
UPPERROMAN
: رقم روماني كبير، مثل "I" أو "II" أو "III" -
LEFTTRIANGLE
: مثلث يشير إلى اليسار، يتوافق مع موضع الرمز يونيكود U+25c4
عمليات التعداد | |
---|---|
BULLET_GLYPH_PRESET_UNSPECIFIED
|
لم يتم تحديد الإعداد المُسبَق للرموز الرسومية للنقاط. |
BULLET_DISC_CIRCLE_SQUARE
|
قائمة نقطية تتضمّن رمزي علامة تمييز DISC
وCIRCLE
وSQUARE
للمستويات الثلاثة الأولى من تداخل القوائم
|
BULLET_DIAMONDX_ARROW3D_SQUARE
|
قائمة نقطية تتضمّن رمز علامة تمييز الفقرات
DIAMONDX ،
ARROW3D
و
SQUARE
للمستويات الثلاثة الأولى من تداخل القوائم
|
BULLET_CHECKBOX
|
قائمة ذات تعداد نقطي تتضمّن
CHECKBOX
رموز النقاط لجميع مستويات دمج القوائم
|
BULLET_ARROW_DIAMOND_DISC
|
قائمة نقطية تتضمّن رمز علامة تمييز ARROW
وDIAMOND
وDISC
للمستويات الثلاثة الأولى من تداخل القوائم
|
BULLET_STAR_CIRCLE_SQUARE
|
قائمة نقطية تتضمّن رمزي علامة تمييز STAR
وCIRCLE
وSQUARE
للمستويات الثلاثة الأولى من تداخل القوائم
|
BULLET_ARROW3D_CIRCLE_SQUARE
|
قائمة نقطية تتضمّن رمز علامة تمييز الفقرات
ARROW3D ،
CIRCLE
و
SQUARE
للمستويات الثلاثة الأولى من تداخل القوائم
|
BULLET_LEFTTRIANGLE_DIAMOND_DISC
|
قائمة نقطية تتضمّن رمزي علامة تمييز LEFTTRIANGLE
وDIAMOND
وDISC
للمستويات الثلاثة الأولى من تداخل القوائم
|
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE
|
قائمة نقطية تحتوي على رمز علامة تمييز
DIAMONDX ،
HOLLOWDIAMOND
و
SQUARE
للمستويات الثلاثة الأولى من تداخل القوائم
|
BULLET_DIAMOND_CIRCLE_SQUARE
|
قائمة نقطية تتضمّن رمز علامة تمييز DIAMOND
وCIRCLE
وSQUARE
للمستويات الثلاثة الأولى من تداخل القوائم
|
NUMBERED_DECIMAL_ALPHA_ROMAN
|
قائمة مرقّمة تحتوي على العلامات الرقمية
DECIMAL ،
ALPHA
و
ROMAN
للمستويات الثلاثة الأولى من تداخل القوائم، متبوعة بنقاط.
|
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS
|
قائمة مرقّمة تحتوي على رمزَي DECIMAL وALPHA وROMAN للمستويات الثلاثة الأولى من تداخل القوائم، متبوعة بقوسَين
|
NUMBERED_DECIMAL_NESTED
|
قائمة مرقّمة تحتوي على
DECIMAL
رموز رقمية مفصولة بفواصل، حيث يستخدم كل مستوى تداخل الرمز الرموز الرقمية للمستوى السابق للتداخل كبادئة. على سبيل المثال: "1."، '1.1.', '2.', '2.2.'.
|
NUMBERED_UPPERALPHA_ALPHA_ROMAN
|
قائمة مرقّمة تحتوي على العلامات الرقمية
UPPERALPHA ،
ALPHA
و
ROMAN
للمستويات الثلاثة الأولى من تداخل القوائم، متبوعة بنقاط.
|
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL
|
قائمة مرقّمة تحتوي على العلامات الرقمية
UPPERROMAN ،
UPPERALPHA
و
DECIMAL
للمستويات الثلاثة الأولى من تداخل القوائم، متبوعة بنقاط.
|
NUMBERED_ZERODECIMAL_ALPHA_ROMAN
|
قائمة مرقّمة تحتوي على العلامات الرقمية
ZERODECIMAL ،
ALPHA
و
ROMAN
للمستويات الثلاثة الأولى من تداخل القوائم، متبوعة بنقاط.
|
DeleteParagraphBulletsRequest
تحذف هذه الدالة النقاط من جميع الفقرات التي تتداخل مع النطاق المحدّد.
سيتم الاحتفاظ بمستوى التداخل لكل فقرة بشكل مرئي من خلال إضافة مسافة بادئة إلى بداية الفقرة المقابلة.
تمثيل JSON |
---|
{
"range": {
object (
|
الحقول | |
---|---|
range
|
النطاق المطلوب حذف النقاط من خلاله |
CreateNamedRangeRequest
تنشئ دالة NamedRange
إشارة إلى النطاق المحدَّد.
تمثيل JSON |
---|
{
"name": string,
"range": {
object (
|
الحقول | |
---|---|
name
|
اسم NamedRange ولا يلزم أن تكون الأسماء فريدة. يجب أن تتألف الأسماء من حرف واحد على الأقل ولا يزيد عدد أحرفها عن 256 حرفًا، ويتم قياسها بوحدات ترميز UTF-16. |
range
|
النطاق الذي سيتم تطبيق الاسم عليه |
DeleteNamedRangeRequest
لحذف
NamedRange
تمثيل JSON |
---|
{ "tabsCriteria": { object ( |
الحقول | |
---|---|
tabs
|
اختيارية: المعايير المستخدَمة لتحديد علامات التبويب التي يجب أن يحدث فيها حذف النطاق عند حذفها، يتم تطبيق حذف النطاق على جميع علامات التبويب. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
حقل الربط
named_range_reference . القيمة التي تحدّد النطاقات التي يجب حذفها يجب تحديد قيمة واحدة فقط.
named_range_reference
يمكن أن تكون إحدى القيم التالية فقط:
|
|
named
|
رقم تعريف النطاق المُعنوَن المطلوب حذفه. |
name
|
اسم النطاقات المطلوب حذفها سيتم حذف جميع النطاقات المُعنوَنة التي تحمل الاسم المحدَّد. |
UpdateParagraphStyleRequest
تعديل تنسيق جميع الفقرات التي تتداخل مع النطاق المحدَّد
تمثيل JSON |
---|
{ "paragraphStyle": { object ( |
الحقول | |
---|---|
paragraph
|
الأنماط التي سيتم ضبطها على الفقرات
قد تؤدي بعض التغييرات في نمط الفقرة إلى إجراء تغييرات أخرى لمطابقة سلوك محرِّر "مستندات Google". يمكنك الاطّلاع على مستندات
|
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.
يجب أن يكون معرّف الموارد المتسلسل المقدَّم متاحًا للجميع وألا يزيد طوله عن 2 كيلوبايت. يتم حفظ عنوان URL نفسه مع الصورة، ويتم عرضه من خلال الحقل
|
object
|
الحجم الذي يجب أن تظهر به الصورة في المستند هذه السمة اختيارية ويتم تحديد الحجم النهائي للصورة في المستند من خلال القواعد التالية: * إذا لم يتم تحديد العرض أو الارتفاع، يتم احتساب حجم تلقائي للصورة استنادًا إلى دقتها. * في حال تحديد سمة واحدة، يتم احتساب السمة الأخرى للحفاظ على نسبة العرض إلى الارتفاع للصورة. * في حال تحديد كل من العرض والارتفاع، يتم تصغير الصورة لتلائم الأبعاد المقدَّمة مع الحفاظ على نسبة العرض إلى الارتفاع. |
حقل الربط
insertion_location . الموقع الذي سيتم إدراج الصورة فيه
insertion_location
يمكن أن تكون إحدى القيم التالية فقط:
|
|
location
|
لإدراج الصورة في فهرس معيّن في المستند
يجب إدراج الصورة داخل حدود
لا يمكن إدراج الصور المضمّنة داخل تعليق سفلي أو معادلة. |
end
|
تُستخدَم لإدراج النص في نهاية الرأس أو التذييل أو نص المستند. لا يمكن إدراج الصور المضمّنة داخل حاشية سفلية. |
InsertTableRequest
تُستخدَم لإدراج جدول في الموضع المحدّد.
سيتم إدراج حرف سطر جديد قبل الجدول المُدرَج.
تمثيل JSON |
---|
{ "rows": integer, "columns": integer, // Union field |
الحقول | |
---|---|
rows
|
عدد الصفوف في الجدول |
columns
|
عدد الأعمدة في الجدول |
حقل الربط
insertion_location . الموقع الذي سيتم إدراج الجدول فيه
insertion_location
يمكن أن تكون إحدى القيم التالية فقط:
|
|
location
|
تُدرج هذه الدالة الجدول في فهرس نموذج معيّن. سيتم إدراج حرف سطر جديد قبل الجدول المُدرَج، وبالتالي سيكون فهرس بداية الجدول في فهرس الموقع المحدّد + 1.
يجب إدراج الجدول داخل حدود
لا يمكن إدراج الجداول داخل تعليق سفلي أو معادلة. |
end
|
تُدرج هذه الدالة الجدول في نهاية الرأس أو التذييل أو نص المستند المحدَّد. سيتم إدراج حرف سطر جديد قبل الجدول المُدرَج. لا يمكن إدراج الجداول داخل حاشية سفلية. |
InsertTableRowRequest
لإدراج صف فارغ في جدول
تمثيل JSON |
---|
{
"tableCellLocation": {
object (
|
الحقول | |
---|---|
table
|
موقع خلية الجدول المرجعي الذي سيتم إدراج الصفوف منه. سيتم إدراج صف جديد فوق (أو تحت) الصف الذي تتوفّر فيه الخلية المرجعية. إذا كانت الخلية المرجعية هي خلية مدمَجة، سيتم إدراج صف جديد فوق (أو تحت) الخلية المدمَجة. |
insert
|
ما إذا كان سيتم إدراج صف جديد أسفل موقع الخلية المرجعية
|
TableCellLocation
الموقع الجغرافي لخلية واحدة داخل جدول
تمثيل JSON |
---|
{
"tableStartLocation": {
object (
|
الحقول | |
---|---|
table
|
الموقع الذي يبدأ فيه الجدول في المستند |
row
|
فهرس الصف الذي يبدأ من الصفر على سبيل المثال، يحتوي الصف الثاني في الجدول على فهرس صف هو 1. |
column
|
فهرس العمود الذي يبدأ من الصفر على سبيل المثال، يحتوي العمود الثاني في الجدول على فهرس عمود 1. |
InsertTableColumnRequest
لإدراج عمود فارغ في جدول
تمثيل JSON |
---|
{
"tableCellLocation": {
object (
|
الحقول | |
---|---|
table
|
موقع خلية الجدول المرجعي الذي سيتم إدراج الأعمدة منه. سيتم إدراج عمود جديد على يمين (أو يمين) العمود الذي تتوفّر فيه الخلية المرجعية. إذا كانت الخلية المرجعية خلية مُدمَجة، سيتم إدراج عمود جديد على يمين (أو يمين) الخلية المدمَجة. |
insert
|
ما إذا كان سيتم إدراج عمود جديد على يمين موقع الخلية المرجعية.
|
DeleteTableRowRequest
لحذف صف من جدول
تمثيل JSON |
---|
{
"tableCellLocation": {
object (
|
الحقول | |
---|---|
table
|
موقع خلية الجدول المرجعي الذي سيتم حذف الصف منه. سيتم حذف الصف الذي تمتد إليه هذه الخلية. إذا كانت هذه خلية مُدمَجة تمتد على عدة صفوف، سيتم حذف جميع الصفوف التي تمتد عليها الخلية. إذا لم يتبقّ أي صفوف في الجدول بعد هذا الحذف، يتم حذف الجدول بأكمله. |
DeleteTableColumnRequest
لحذف عمود من جدول
تمثيل JSON |
---|
{
"tableCellLocation": {
object (
|
الحقول | |
---|---|
table
|
موقع خلية الجدول المرجعي الذي سيتم حذف العمود منه سيتم حذف العمود الذي تمتد إليه هذه الخلية. إذا كانت هذه خلية مدمجة تمتد على أعمدة متعددة، سيتم حذف جميع الأعمدة التي تمتد عليها الخلية. إذا لم يتبقّ أي أعمدة في الجدول بعد هذا الحذف، يتم حذف الجدول بأكمله. |
InsertPageBreakRequest
تُدرج هذه العلامة فاصل صفحة متبوعًا بسطر جديد في الموضع المحدّد.
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الربط
insertion_location . الموقع الذي سيتم فيه إدراج فاصل الصفحة.
insertion_location
يمكن أن تكون إحدى القيم التالية فقط:
|
|
location
|
تُدرج فاصل الصفحة في فهرس معيّن في المستند.
يجب إدراج فاصل الصفحة داخل حدود
لا يمكن إدراج فواصل الصفحات داخل جدول أو معادلة أو حواشي سفلية أو عنوان أو تذييل. بما أنّه لا يمكن إدراج فواصل الصفحات إلّا داخل النص، يجب أن يكون الحقل
|
end
|
تُدرج فاصل الصفحة في نهاية نص المستند.
لا يمكن إدراج فواصل صفحات داخل حاشية سفلية أو عنوان أو تذييل. بما أنّه لا يمكن إدراج فواصل الصفحات إلّا داخل النص، يجب أن يكون الحقل
|
DeletePositionedObjectRequest
لحذف
PositionedObject
من المستند
تمثيل JSON |
---|
{ "objectId": string, "tabId": string } |
الحقول | |
---|---|
object
|
معرّف العنصر الذي تمّ وضعه لحذفه. |
tab
|
علامة التبويب التي يتضمّن فيها العنصر المحدَّد للحذف عند حذف هذا العنصر، يتم تطبيق الطلب على علامة التبويب الأولى. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
UpdateTableColumnPropertiesRequest
تعديل
TableColumnProperties
للأعمدة في جدول
تمثيل JSON |
---|
{ "tableStartLocation": { object ( |
الحقول | |
---|---|
table
|
الموقع الذي يبدأ فيه الجدول في المستند |
column
|
قائمة بمؤشرات الأعمدة المستندة إلى الصفر التي يجب تعديل خاصيتها في حال عدم تحديد أيّ فهارس، سيتمّ تعديل جميع الأعمدة. |
table
|
خصائص أعمدة الجدول المطلوب تعديلها
إذا كانت قيمة
|
fields
|
الحقول التي يجب تعديلها
يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر
على سبيل المثال، لتعديل عرض العمود، اضبط
|
UpdateTableCellStyleRequest
تعديل نمط نطاق من خلايا الجدول
تمثيل JSON |
---|
{ "tableCellStyle": { object ( |
الحقول | |
---|---|
table
|
النمط الذي سيتم ضبطه على خلايا الجدول. عند تعديل الحدود، إذا كانت الخلية تشترك في حدود مع خلية مجاورة، يتم تعديل خاصية الحدود المقابلة للخلية المجاورة أيضًا. لا يتم تعديل الحدود المدمجة وغير المرئية. بما أنّ تعديل حدود مشتركة بين خلايا مجاورة في الطلب نفسه قد يؤدي إلى حدوث تعارض في تعديلات الحدود، يتم تطبيق تعديلات الحدود بالترتيب التالي:
|
fields
|
الحقول التي يجب تعديلها
يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر
على سبيل المثال، لتعديل لون خلفية خلية الجدول، اضبط
لإعادة ضبط خاصيّة على قيمتها التلقائية، أدرِج اسم الحقل في قناع الحقل، ولكن اترك الحقل نفسه غير محدّد. |
حقل الربط
cells . الخلايا التي سيتم تعديلها
cells
يمكن أن تكون إحدى القيم التالية فقط:
|
|
table
|
نطاق الجدول الذي يمثّل المجموعة الفرعية من الجدول التي يتم تطبيق التعديلات عليها. |
table
|
الموقع الذي يبدأ فيه الجدول في المستند عند تحديدها، يتم تطبيق التعديلات على جميع الخلايا في الجدول. |
TableRange
يمثّل نطاق الجدول إشارة إلى مجموعة فرعية من الجدول.
تجدر الإشارة إلى أنّ الخلايا المحدّدة بنطاق جدول لا تشكل بالضرورة مستطيلاً. على سبيل المثال، لنفترض أنّ لدينا جدولًا أبعاده 3 x 3 تم دمج جميع خلايا الصف الأخير فيه. يظهر الجدول على النحو التالي:
[ ][ ][ ]
[ ][ ][ ]
[ ]
يحدِّد نطاق الجدول الذي يكون فيه موقع خلية الجدول = (tableStartLocation، الصف = 0، العمود = 0)، وامتداد الصف = 3، وامتداد العمود = 2 الخلايا التالية:
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
تمثيل JSON |
---|
{
"tableCellLocation": {
object (
|
الحقول | |
---|---|
table
|
موقع الخلية الذي يبدأ منه نطاق الجدول. |
row
|
نطاق الصفوف لنطاق الجدول |
column
|
نطاق الأعمدة لنطاق الجدول |
UpdateTableRowStyleRequest
تعديل
TableRowStyle
الصفوف في جدول
تمثيل JSON |
---|
{ "tableStartLocation": { object ( |
الحقول | |
---|---|
table
|
الموقع الذي يبدأ فيه الجدول في المستند |
row
|
قائمة فهارس الصفوف المستندة إلى الصفر التي يجب تعديل أسلوبها في حال عدم تحديد أيّ فهارس، سيتمّ تعديل جميع الصفوف. |
table
|
الأنماط التي سيتم ضبطها على الصفوف |
fields
|
الحقول التي يجب تعديلها
يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر
على سبيل المثال، لتعديل الحد الأدنى لارتفاع الصف، اضبط
|
ReplaceImageRequest
استبدال صورة حالية بصورة جديدة
يؤدي استبدال صورة إلى إزالة بعض
image effects
من الصورة الحالية لعكس سلوك محرِّر "مستندات Google".
تمثيل JSON |
---|
{
"imageObjectId": string,
"uri": string,
"imageReplaceMethod": enum (
|
الحقول | |
---|---|
image
|
رقم تعريف الصورة الحالية التي سيتم استبدالها. يمكن استرداد رقم التعريف من ردّ طلب الحصول. |
uri
|
معرّف الموارد المنتظم (URI) للصورة الجديدة يتم جلب الصورة مرة واحدة في وقت الإدراج ويتم تخزين نسخة منها لعرضها داخل المستند. يجب أن يكون حجم الصور أقل من 50 ميغابايت، وألّا يزيد عن 25 ميغابكسل، ويجب أن تكون بتنسيق PNG أو JPEG أو GIF.
لا يمكن أن يتجاوز طول معرّف الموارد المنتظم (URI) المقدَّم 2 كيلوبايت. يتم حفظ عنوان URL مع الصورة، ويتم عرضه من خلال الحقل
|
image
|
طريقة الاستبدال |
tab
|
علامة التبويب التي تظهر فيها الصورة المطلوب استبدالها. عند حذف هذا العنصر، يتم تطبيق الطلب على علامة التبويب الأولى. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
ImageReplaceMethod
طريقة استبدال الصورة.
عمليات التعداد | |
---|---|
IMAGE_REPLACE_METHOD_UNSPECIFIED
|
طريقة استبدال الصورة غير محدّدة. يجب عدم استخدام هذه القيمة. |
CENTER_CROP
|
يتم تكبير الصورة وتوسيعها في منتصف الشاشة لملء حدود الصورة الأصلية. قد يتم اقتصاص الصورة لملء حدود الصورة الأصلية. سيكون حجم الصورة المعروض هو نفسه حجم الصورة الأصلية. |
UpdateDocumentStyleRequest
تعديلات على
DocumentStyle
تمثيل JSON |
---|
{
"documentStyle": {
object (
|
الحقول | |
---|---|
document
|
الأنماط التي سيتم ضبطها على المستند
قد تؤدي بعض التغييرات في أسلوب المستند إلى حدوث تغييرات أخرى لمطابقة سلوك محرِّر "مستندات Google". يمكنك الاطّلاع على مستندات
|
fields
|
الحقول التي يجب تعديلها
يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر
على سبيل المثال، لتعديل الخلفية، اضبط
|
tab
|
علامة التبويب التي تحتوي على النمط المطلوب تعديله عند حذف هذا العنصر، ينطبق الطلب على علامة التبويب الأولى. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
MergeTableCellsRequest
دمج الخلايا في
Table
تمثيل JSON |
---|
{
"tableRange": {
object (
|
الحقول | |
---|---|
table
|
نطاق الجدول الذي يحدّد خلايا الجدول المطلوب دمجها سيتم تسلسل أي نص في الخلايا التي تتم دمجها وتخزينه في خلية "الرأس" للنطاق. هذه هي الخلية العلوية اليسرى من النطاق عندما يكون اتجاه المحتوى من اليسار إلى اليمين، والخلية العلوية اليمنى من النطاق في الحالات الأخرى. إذا كان النطاق غير مستطيل (يمكن أن يحدث ذلك في بعض الحالات التي يغطي فيها النطاق خلايا تم دمجها من قبل أو عندما يكون الجدول غير مستطيل)، يتم عرض خطأ 400 "الطلب غير صالح". |
UnmergeTableCellsRequest
إلغاء دمج الخلايا في
Table
تمثيل JSON |
---|
{
"tableRange": {
object (
|
الحقول | |
---|---|
table
|
نطاق الجدول الذي يحدِّد خلايا الجدول المطلوب إلغاء دمجها سيتم إلغاء دمج جميع الخلايا المدمجة في هذا النطاق، ولن تتأثر الخلايا التي سبق إلغاء دمجها. إذا لم يتضمّن النطاق أي خلايا تم دمجها، لن يؤدي الطلب إلى أي إجراء. إذا كان هناك نص في أي من الخلايا المدمجة، سيظل النص في خلية "الرأس" للكتلة الناتجة من الخلايا غير المدمجة. تكون خلية "العنوان" هي الخلية في أعلى يمين الصفحة عندما يكون اتجاه المحتوى من اليسار إلى اليمين، وتكون في أعلى يسار الصفحة في الحالات الأخرى. |
CreateHeaderRequest
لإنشاء
Header
. يتم تطبيق العنوان الجديد على
SectionStyle
في موضع
SectionBreak
إذا تم تحديده، وإلا يتم تطبيقه على
DocumentStyle
.
إذا كان هناك عنوان من النوع المحدّد متوفّرًا، يتم عرض خطأ 400 "الخطأ 400: طلب غير صالح".
تمثيل JSON |
---|
{ "type": enum ( |
الحقول | |
---|---|
type
|
نوع العنوان المطلوب إنشاؤه. |
section
|
الموقع الجغرافي لعلامة
|
CreateFootnoteRequest
تُنشئ هذه الدالة شريحة
Footnote
وتُدرج فيها
FootnoteReference
جديدًا في الموضع المحدّد.
سيحتوي الجزء الجديد
Footnote
على مسافة متبوعة بحرف سطر جديد.
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الربط
footnote_reference_location . الموقع الذي تريد إدراج مرجع الحاشية السفلية فيه
footnote_reference_location
يمكن أن تكون إحدى القيم التالية فقط:
|
|
location
|
تُدرج إشارة الحاشية السفلية في فهرس معيّن في المستند.
يجب إدراج مرجع الحاشية السفلية داخل حدود
لا يمكن إدراج مراجع الحواشي السفلية داخل معادلة أو عنوان أو تذييل أو حاشية سفلية. بما أنّه لا يمكن إدراج مراجع الحواشي السفلية إلا في النص، يجب أن يكون الحقل
|
end
|
تُدرج هذه الوسيطة مرجع الحاشية السفلية في نهاية نص المستند.
لا يمكن إدراج مراجع الحواشي السفلية داخل عنوان أو تذييل أو حاشية سفلية. بما أنّه لا يمكن إدراج مراجع الحواشي السفلية إلا في النص، يجب أن يكون الحقل
|
ReplaceNamedRangeContentRequest
تستبدل هذه الدالة محتوى العنصر المحدد
NamedRange
أو
NamedRanges
بالمحتوى البديل المحدَّد.
يُرجى العِلم أنّه يمكن أن يتألّف كل NamedRange
من عدة
ranges
متقطّعة. في هذه الحالة، سيتم استبدال المحتوى في النطاق الأول فقط. سيتم حذف النطاقات الأخرى ومحتوياتها.
في الحالات التي يؤدي فيها استبدال أي نطاقات أو حذفها إلى بنية مستند غير صالحة، يتم عرض خطأ 400 (خطأ طلب غير صالح).
تمثيل JSON |
---|
{ "tabsCriteria": { object ( |
الحقول | |
---|---|
tabs
|
اختيارية: المعايير المستخدَمة لتحديد علامات التبويب التي يحدث فيها الاستبدال عند حذف هذا الحقل، يتم تطبيق القيمة البديلة على جميع علامات التبويب. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
حقل الربط
replacement_content . المحتوى الذي سيتم استبدال المحتوى الحالي للنطاق المُعنوَن به
replacement_content
يمكن أن تكون إحدى القيم التالية فقط:
|
|
text
|
لاستبدال محتوى النطاقات المحدّدة المُسمّاة بالنص المحدّد. |
حقل الربط
named_range_reference . إشارة إلى النطاقات المُعنوَنة التي سيتم استبدال محتواها
named_range_reference
يمكن أن تكون إحدى القيم التالية فقط:
|
|
named
|
معرّف النطاق المُعنوَن الذي سيتم استبدال محتواه. إذا لم يكن هناك نطاق مُعنوَن برقم التعريف المحدّد، يتم عرض خطأ 400 (الخطأ "طلب غير صالح"). |
named
|
اسم
إذا كانت هناك عدة
|
UpdateSectionStyleRequest
تعديلات على
SectionStyle
تمثيل JSON |
---|
{ "range": { object ( |
الحقول | |
---|---|
range
|
النطاق الذي يتداخل مع الأقسام المطلوب تطبيق النمط عليها
وبما أنّه لا يمكن إدراج فواصل الأقسام إلا داخل النص، يجب أن يكون الحقل
|
section
|
الأنماط التي سيتم ضبطها على القسم
قد تؤدي تغييرات معيّنة في نمط القسم إلى تغييرات أخرى لمطابقة سلوك محرِّر "مستندات Google". يمكنك الاطّلاع على مستندات
|
fields
|
الحقول التي يجب تعديلها
يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر
على سبيل المثال، لتعديل الهامش الأيسر، اضبط
|
InsertSectionBreakRequest
تُدرج فاصل قسم في الموضع المحدَّد.
سيتم إدراج حرف سطر جديد قبل فاصل القسم.
تمثيل JSON |
---|
{ "sectionType": enum ( |
الحقول | |
---|---|
section
|
نوع القسم المطلوب إدراجه |
حقل الربط
insertion_location . الموضع الذي سيتم إدراج الفاصل فيه
insertion_location
يمكن أن تكون إحدى القيم التالية فقط:
|
|
location
|
تُدرج سطرًا جديدًا وفاصل قسم في فهرس معيّن في المستند.
يجب إدراج فاصل القسم داخل حدود
لا يمكن إدراج فواصل أقسام داخل جدول أو معادلة أو حاشية سفلية أو عنوان أو تذييل. بما أنّه لا يمكن إدراج فواصل الأقسام إلا داخل النص، يجب أن يكون الحقل
|
end
|
تُدخِل سطرًا جديدًا وفاصلًا بين الأقسام في نهاية نص المستند.
لا يمكن إدراج فواصل الأقسام داخل حاشية سفلية أو عنوان أو تذييل. وبما أنّه لا يمكن إدراج فواصل الأقسام إلا داخل النص، يجب أن يكون الحقل
|
DeleteHeaderRequest
لحذف
Header
من المستند
تمثيل JSON |
---|
{ "headerId": string, "tabId": string } |
الحقول | |
---|---|
header
|
رقم تعريف العنوان المطلوب حذفه. إذا تم تحديد هذا العنوان في
|
tab
|
علامة التبويب التي تحتوي على العنوان المطلوب حذفه عند حذف هذا العنصر، يتم تطبيق الطلب على علامة التبويب الأولى. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
PinTableHeaderRowsRequest
تعديل عدد صفوف عناوين الجداول المثبَّتة في جدول
تمثيل JSON |
---|
{
"tableStartLocation": {
object (
|
الحقول | |
---|---|
table
|
الموقع الذي يبدأ فيه الجدول في المستند |
pinned
|
عدد صفوف الجدول المطلوب تثبيتها، حيث يشير الصفر إلى أنّه تم إلغاء تثبيت جميع الصفوف. |