طلب
تعديل واحد يتم تطبيقه على مستند
| تمثيل 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
|
تعدّل هذه الدالة عدد صفوف العناوين المثبّتة في جدول. |
insertPerson
|
تُدرج هذه السمة إشارة إلى مستخدم. |
ReplaceAllTextRequest
يستبدل جميع مثيلات النص المطابق لمعيار معيّن بالقيمة replace text.
| تمثيل JSON |
|---|
{ "replaceText": string, "tabsCriteria": { object ( |
| الحقول | |
|---|---|
replaceText
|
النص الذي سيتم استبدال النص المطابق به. |
tabsCriteria
|
اختيارية: المعايير المستخدَمة لتحديد علامات التبويب التي سيتم فيها الاستبدال في حال عدم تضمينها، ينطبق الاستبدال على جميع علامات التبويب. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
حقل الدمج
criteria. المعايير المستخدَمة لمطابقة النص المطلوب استبداله
criteria
يمكن أن تكون إحدى القيم التالية فقط:
|
|
containsText
|
للعثور على نص في المستند يطابق هذه السلسلة الفرعية. |
SubstringMatchCriteria
معيار يتطابق مع سلسلة نصية معيّنة في المستند
| تمثيل JSON |
|---|
{ "text": string, "matchCase": boolean, "searchByRegex": boolean } |
| الحقول | |
|---|---|
text
|
النص المطلوب البحث عنه في المستند. |
matchCase
|
تشير إلى ما إذا كان يجب أن يراعي البحث حالة الأحرف:
|
searchByRegex
|
اختيارية: يتم ضبط القيمة على "صحيح" إذا كان يجب التعامل مع قيمة البحث كتعبير عادي. يجب تخطّي أي شرطات مائلة عكسية في النمط.
|
TabsCriteria
معيار يحدّد علامات التبويب التي يتم فيها تنفيذ الطلب.
| تمثيل JSON |
|---|
{ "tabIds": [ string ] } |
| الحقول | |
|---|---|
tabIds[]
|
قائمة بأرقام تعريف علامات التبويب التي يتم تنفيذ الطلب فيها. |
InsertTextRequest
تُدرِج هذه الطريقة النص في الموقع الجغرافي المحدّد.
| تمثيل JSON |
|---|
{ "text": string, // Union field |
| الحقول | |
|---|---|
text
|
النص المطلوب إدراجه
سيؤدي إدراج حرف سطر جديد ضمنيًا إلى إنشاء
سيتم تحديد أنماط النص المُدرَج تلقائيًا، مع الحفاظ بشكل عام على نمط النص المجاور. في معظم الحالات، سيتطابق نمط النص المُدرَج مع النص الذي يسبق فهرس الإدراج مباشرةً. سيتم إزالة بعض أحرف التحكّم (U+0000-U+0008 وU+000C-U+001F) والأحرف من منطقة الاستخدام الخاص في "الخطة الأساسية متعددة اللغات" لترميز يونيكود (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 في Unicode -
CHECKBOX: مربّع فارغ، يتوافق مع نقطة الرمز U+274f في يونيكود -
CIRCLE: دائرة مفرغة، تتوافق مع نقطة الرمز U+25cb في يونيكود -
DIAMOND: ماسة مصمتة، تتوافق مع قيمة موضع الرمز U+25c6 في يونيكود -
DIAMONDX: ماسة تتضمّن الحرف "x"، وتتوافق مع قيمة موضع الرمز U+2756 في Unicode -
HOLLOWDIAMOND: معيّن مجوّف، يتوافق مع نقطة الرمز U+25c7 في يونيكود -
DISC: دائرة مصمتة، تتوافق مع نقطة الرمز U+25cf في يونيكود -
SQUARE: مربّع مصمت، يتوافق مع نقطة الرمز U+25a0 في يونيكود -
STAR: نجمة، تتوافق مع نقطة الرمز U+2605 في Unicode -
ALPHA: حرف صغير، مثل "أ" أو "ب" أو "ت". -
UPPERALPHA: حرف كبير، مثل "أ" أو "ب" أو "ت". -
DECIMAL: رقم، مثل "1" أو "2" أو "3". -
ZERODECIMAL: رقم يتم فيه إضافة صفر قبل الأرقام المكوّنة من خانة واحدة، مثل "01" أو "02" أو "03". لا تتم إضافة صفر قبل الأرقام التي تتضمّن أكثر من رقم واحد. -
ROMAN: رقم روماني صغير، مثل "i" أو "ii" أو "iii" -
UPPERROMAN: رقم روماني بأحرف كبيرة، مثل I أو II أو III -
LEFTTRIANGLE: مثلث يشير إلى اليسار، ويتوافق مع نقطة الرمز U+25c4 في Unicode
| عمليات التعداد | |
|---|---|
BULLET_GLYPH_PRESET_UNSPECIFIED
|
لم يتم تحديد الإعداد المُسبَق لرمز التعداد النقطي. |
BULLET_DISC_CIRCLE_SQUARE
|
قائمة نقطية تتضمّن رموزًا نقطية
DISC وCIRCLE وSQUARE
لمستويات التداخل الثلاثة الأولى في القائمة.
|
BULLET_DIAMONDX_ARROW3D_SQUARE
|
قائمة نقطية تتضمّن رموزًا نقطية
DIAMONDX وARROW3D وSQUARE
لمستويات التداخل الثلاثة الأولى في القائمة.
|
BULLET_CHECKBOX
|
قائمة ذات تعداد نقطي تتضمّن
CHECKBOX
رموزًا نقطية لجميع مستويات الدمج في القائمة
|
BULLET_ARROW_DIAMOND_DISC
|
قائمة نقطية تتضمّن رموزًا نقطية
ARROW وDIAMOND وDISC
لمستويات التداخل الثلاثة الأولى في القائمة.
|
BULLET_STAR_CIRCLE_SQUARE
|
قائمة نقطية تتضمّن رموزًا نقطية
STAR وCIRCLE وSQUARE
لمستويات التداخل الثلاثة الأولى في القائمة.
|
BULLET_ARROW3D_CIRCLE_SQUARE
|
قائمة نقطية تتضمّن رموزًا نقطية
ARROW3D وCIRCLE وSQUARE
لمستويات التداخل الثلاثة الأولى في القائمة.
|
BULLET_LEFTTRIANGLE_DIAMOND_DISC
|
قائمة نقطية تتضمّن رموزًا نقطية
LEFTTRIANGLE وDIAMOND وDISC
لمستويات التداخل الثلاثة الأولى في القائمة.
|
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE
|
قائمة نقطية تتضمّن رموزًا نقطية
DIAMONDX وHOLLOWDIAMOND وSQUARE
لمستويات التداخل الثلاثة الأولى في القائمة.
|
BULLET_DIAMOND_CIRCLE_SQUARE
|
قائمة نقطية تتضمّن رموزًا نقطية
DIAMOND وCIRCLE وSQUARE
لمستويات التداخل الثلاثة الأولى في القائمة.
|
NUMBERED_DECIMAL_ALPHA_ROMAN
|
قائمة مرقّمة تتضمّن رموزًا رقمية DECIMAL وALPHA وROMAN لمستويات التداخل الثلاثة الأولى في القائمة، متبوعة بنقاط.
|
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS
|
قائمة مرقّمة تتضمّن رموزًا رقمية DECIMAL وALPHA وROMAN لمستويات التداخل الثلاثة الأولى في القائمة، متبوعة بأقواس
|
NUMBERED_DECIMAL_NESTED
|
قائمة مرقّمة تتضمّن
DECIMAL
رموزًا رقمية مفصولة بنقاط، حيث يستخدم كل مستوى تداخل رمز مستوى التداخل السابق كبادئة. على سبيل المثال: '1.'، '1.1.', '2.', '2.2.'.
|
NUMBERED_UPPERALPHA_ALPHA_ROMAN
|
قائمة مرقّمة تتضمّن رموزًا رقمية UPPERALPHA وALPHA وROMAN لمستويات التداخل الثلاثة الأولى في القائمة، متبوعة بنقاط.
|
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL
|
قائمة مرقّمة تتضمّن رموزًا رقمية UPPERROMAN وUPPERALPHA وDECIMAL لمستويات التداخل الثلاثة الأولى في القائمة، متبوعة بنقاط.
|
NUMBERED_ZERODECIMAL_ALPHA_ROMAN
|
قائمة مرقّمة تتضمّن رموزًا رقمية ZERODECIMAL وALPHA وROMAN لمستويات التداخل الثلاثة الأولى في القائمة، متبوعة بنقاط.
|
DeleteParagraphBulletsRequest
يحذف هذا الإجراء الرموز النقطية من جميع الفقرات التي تتداخل مع النطاق المحدّد.
سيتم الحفاظ على مستوى التداخل لكل فقرة بشكل مرئي من خلال إضافة مسافة بادئة إلى بداية الفقرة المقابلة.
| تمثيل JSON |
|---|
{
"range": {
object ( |
| الحقول | |
|---|---|
range
|
النطاق المطلوب حذف الرموز النقطية منه. |
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
|
تمثّل هذه السمة الأنماط التي سيتم ضبطها على الفقرات.
قد تؤدي بعض التغييرات في نمط الفقرة إلى تغييرات أخرى من أجل محاكاة سلوك محرر "مستندات Google". لمزيد من المعلومات، يُرجى الاطّلاع على مستندات
|
fields
|
الحقول التي يجب تعديلها
يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر
على سبيل المثال، لتعديل سمة المحاذاة الخاصة بنمط الفقرة، اضبط
لإعادة ضبط إحدى السمات على قيمتها التلقائية، أدرِج اسم الحقل في قناع الحقل ولكن اترُك الحقل نفسه بدون ضبط. |
حقل الدمج
insertion_location. نوع النطاق المستخدَم حيث سيتم تعديل نمط الفقرة.
insertion_location
يمكن أن تكون إحدى القيم التالية فقط:
|
|
range
|
النطاق الذي يتداخل مع الفقرات المطلوب تنسيقها |
DeleteContentRangeRequest
لحذف محتوى من المستند
| تمثيل JSON |
|---|
{
"range": {
object ( |
| الحقول | |
|---|---|
range
|
نطاق المحتوى المطلوب حذفه قد يؤدي حذف نص يتجاوز حدود الفقرة إلى تغييرات في أنماط الفقرات والقوائم والكائنات الموضّعة والإشارات المرجعية، وذلك لأنّه يتم دمج الفقرتين. قد تؤدي محاولة حذف نطاقات معيّنة إلى بنية مستند غير صالحة، وفي هذه الحالة يتم عرض رسالة الخطأ 400 Bad Request. في ما يلي بعض الأمثلة على طلبات الحذف غير الصالحة:
|
InsertInlineImageRequest
تُدرج هذه الدالة
InlineObject
يحتوي على صورة في الموقع الجغرافي المحدّد.
| تمثيل JSON |
|---|
{ "uri": string, "objectSize": { object ( |
| الحقول | |
|---|---|
uri
|
معرّف الموارد المنتظم (URI) الخاص بالصورة يتم جلب الصورة مرة واحدة عند إدراجها ويتم تخزين نسخة منها لعرضها داخل المستند. يجب ألا يزيد حجم الصور عن 50 ميغابايت، وألا تتجاوز 25 ميغابكسل، وأن تكون بتنسيق PNG أو JPEG أو GIF.
يجب أن يكون معرّف الموارد الموحّد المقدَّم متاحًا للجميع وألا يزيد طوله عن 2 كيلوبايت. يتم حفظ معرّف الموارد الموحّد مع الصورة، ويتم عرضه من خلال الحقل |
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
من الصورة الحالية لمحاكاة سلوك محرّر "مستندات Google".
| تمثيل JSON |
|---|
{
"imageObjectId": string,
"uri": string,
"imageReplaceMethod": enum ( |
| الحقول | |
|---|---|
imageObjectId
|
معرّف الصورة الحالية التي سيتم استبدالها يمكن استرداد رقم التعريف من ردّ على طلب GET. |
uri
|
معرّف URI للصورة الجديدة يتم جلب الصورة مرة واحدة عند إدراجها ويتم تخزين نسخة منها لعرضها داخل المستند. يجب أن يكون حجم الصور أقل من 50 ميغابايت، وألا تتجاوز 25 ميغابكسل، وأن تكون بتنسيق PNG أو JPEG أو GIF.
يجب ألا يتجاوز طول معرّف الموارد المنتظم (URI) المقدَّم 2 كيلوبايت. يتم حفظ معرّف الموارد الموحّد مع الصورة، ويتم عرضه من خلال الحقل |
imageReplaceMethod
|
طريقة الاستبدال |
tabId
|
علامة التبويب التي تتضمّن الصورة المطلوب استبدالها في حال عدم تحديدها، يتم تطبيق الطلب على علامة التبويب الأولى. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
ImageReplaceMethod
طريقة استبدال الصورة
| عمليات التعداد | |
|---|---|
IMAGE_REPLACE_METHOD_UNSPECIFIED
|
طريقة استبدال الصورة غير محدّدة. يجب عدم استخدام هذه القيمة. |
CENTER_CROP
|
يتم تغيير حجم الصورة وتوسيطها لملء حدود الصورة الأصلية. قد يتم قص الصورة لملء حدود الصورة الأصلية. سيكون حجم الصورة المعروضة هو نفسه حجم الصورة الأصلية. |
UpdateDocumentStyleRequest
تعدّل هذه السمة
DocumentStyle.
| تمثيل JSON |
|---|
{
"documentStyle": {
object ( |
| الحقول | |
|---|---|
documentStyle
|
تمثّل هذه السمة الأنماط التي سيتم ضبطها في المستند.
قد تؤدي بعض التغييرات في نمط المستند إلى تغييرات أخرى من أجل محاكاة سلوك محرر "مستندات Google". لمزيد من المعلومات، يُرجى الاطّلاع على مستندات
|
fields
|
الحقول التي يجب تعديلها
يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر
على سبيل المثال، لتعديل الخلفية، اضبط
|
tabId
|
علامة التبويب التي تحتوي على النمط المطلوب تعديله في حال عدم تحديدها، ينطبق الطلب على علامة التبويب الأولى. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
MergeTableCellsRequest
يدمج هذا الإجراء الخلايا في Table.
| تمثيل JSON |
|---|
{
"tableRange": {
object ( |
| الحقول | |
|---|---|
tableRange
|
نطاق الجدول الذي يحدّد خلايا الجدول المطلوب دمجها. سيتم ربط أي نص في الخلايا التي يتم دمجها وتخزينه في الخلية "الرئيسية" للنطاق. هذه هي الخلية أعلى اليمين في النطاق عندما يكون اتجاه المحتوى من اليمين إلى اليسار، والخلية أعلى اليسار في النطاق في الحالات الأخرى. إذا كان النطاق غير مستطيل (وهو ما يمكن أن يحدث في بعض الحالات التي يغطي فيها النطاق خلايا سبق أن تم دمجها أو عندما يكون الجدول غير مستطيل)، يتم عرض الخطأ 400 bad request. |
UnmergeTableCellsRequest
يلغي دمج الخلايا في
Table.
| تمثيل JSON |
|---|
{
"tableRange": {
object ( |
| الحقول | |
|---|---|
tableRange
|
نطاق الجدول الذي يحدّد خلايا الجدول المطلوب إلغاء دمجها سيتم إلغاء دمج جميع الخلايا المدمَجة في هذا النطاق، ولن تتأثر الخلايا التي تم إلغاء دمجها من قبل. إذا لم يكن النطاق يحتوي على خلايا مدمجة، لن يؤدي الطلب إلى أي إجراء. إذا كان هناك نص في أي من الخلايا المدمجة، سيظل النص في خلية "الرأس" لمجموعة الخلايا غير المدمجة الناتجة. خلية "العنوان" هي الخلية أعلى اليمين عندما يكون اتجاه المحتوى من اليمين إلى اليسار، والخلية أعلى اليسار في الحالات الأخرى. |
CreateHeaderRequest
تنشئ هذه الطريقة Header. يتم تطبيق العنوان الجديد على
SectionStyle
في موقع
SectionBreak
إذا تم تحديده، وإلا يتم تطبيقه على
DocumentStyle.
إذا كان هناك عنوان من النوع المحدّد، سيظهر الخطأ 400 Bad Request.
| تمثيل 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 Bad Request.
| تمثيل JSON |
|---|
{ "tabsCriteria": { object ( |
| الحقول | |
|---|---|
tabsCriteria
|
اختيارية: المعايير المستخدَمة لتحديد علامات التبويب التي سيتم فيها الاستبدال في حال عدم تضمينها، ينطبق الاستبدال على جميع علامات التبويب. في مستند يحتوي على علامة تبويب واحدة:
في مستند يحتوي على علامات تبويب متعددة:
|
حقل الدمج
replacement_content. المحتوى الذي سيتم استخدامه لاستبدال المحتوى الحالي للنطاق المسمّى
replacement_content
يمكن أن تكون إحدى القيم التالية فقط:
|
|
text
|
يستبدل محتوى النطاقات المسماة المحددة بالنص المقدَّم. |
حقل الدمج
named_range_reference. مرجع إلى النطاقات المُعنوَنة التي سيتم استبدال محتواها
named_range_reference
يمكن أن تكون إحدى القيم التالية فقط:
|
|
namedRangeId
|
معرّف النطاق المسمّى الذي سيتم استبدال محتواه. إذا لم يكن هناك نطاق مسمّى بالمعرّف المحدّد، سيتم عرض رسالة خطأ 400 Bad Request. |
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 إلى أنّ جميع الصفوف غير مثبّتة. |
InsertPersonRequest
تُدرج هذه السمة إشارة إلى مستخدم.
| تمثيل JSON |
|---|
{ "personProperties": { object ( |
| الحقول | |
|---|---|
personProperties
|
خصائص الإشارة إلى المستخدم المطلوب إدراجها. |
حقل الدمج
insertion_location. الموقع الجغرافي الذي ستتم فيه الإشارة إلى المستخدم
insertion_location
يمكن أن تكون إحدى القيم التالية فقط:
|
|
location
|
تُدرج هذه الدالة الإشارة إلى المستخدم في فهرس معيّن في المستند.
يجب إدراج الإشارة إلى الشخص داخل حدود لا يمكن إدراج إشارات إلى أشخاص داخل معادلة. |
endOfSegmentLocation
|
تُدرج الإشارة إلى الشخص في نهاية الرأس أو التذييل أو الحاشية السفلية أو نص المستند. |