REST Resource: documents

المورد: مستند

مستند Google

تمثيل JSON
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
الحقول
documentId

string

النتائج فقط. رقم تعريف المستند

title

string

تمثّل هذه السمة عنوان المستند.

tabs[]

object (Tab)

علامات التبويب التي تشكّل جزءًا من مستند

يمكن أن تحتوي علامات التبويب على علامات تبويب فرعية، أي علامة تبويب مضمّنة في علامة تبويب أخرى. يتم تمثيل علامات التبويب الفرعية بالحقل Tab.childTabs.

revisionId

string

النتائج فقط. رقم تعريف مراجعة المستند. يمكن استخدامها في طلبات التعديل لتحديد النسخة التي سيتم تطبيق التعديلات عليها وكيفية عمل الطلب إذا تم تعديل المستند منذ تلك النسخة. لا تتم تعبئته إلا إذا كان لدى المستخدم إذن بتعديل المستند.

معرّف المراجعة ليس رقمًا تسلسليًا بل سلسلة مبهمة. قد يتغيّر تنسيق رقم تعريف المراجعة بمرور الوقت. لا يُضمن أن يكون رقم تعريف المراجعة الذي تم إرجاعه صالحًا إلا لمدة 24 ساعة بعد إرجاعه، ولا يمكن مشاركته مع مستخدمين آخرين. إذا لم يتغيّر معرّف المراجعة بين المكالمات، يعني ذلك أنّه لم يتم تغيير المستند. في المقابل، يشير رقم التعريف المتغيّر (للمستند والمستخدم نفسهما) عادةً إلى أنّه تم تعديل المستند. ومع ذلك، يمكن أن يكون رقم التعريف المتغيّر ناتجًا أيضًا عن عوامل داخلية، مثل تغييرات في تنسيق رقم التعريف.

suggestionsViewMode

enum (SuggestionsViewMode)

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

ملاحظة: عند تعديل مستند، يجب أن تستند التغييرات إلى مستند يتضمّن SUGGESTIONS_INLINE.

body

object (Body)

النتائج فقط. تمثّل هذه السمة النص الأساسي للمستند.

الحقل القديم: بدلاً من ذلك، استخدِم Document.tabs.documentTab.body الذي يعرض محتوى المستند الفعلي من جميع علامات التبويب عندما تكون قيمة المَعلمة includeTabsContent هي true. إذا كانت القيمة false أو لم يتم ضبطها، يحتوي هذا الحقل على معلومات حول علامة التبويب الأولى في المستند.

headers

map (key: string, value: object (Header))

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

الحقل القديم: بدلاً من ذلك، استخدِم Document.tabs.documentTab.headers الذي يعرض محتوى المستند الفعلي من جميع علامات التبويب عندما تكون قيمة المَعلمة includeTabsContent هي true. إذا كانت القيمة false أو لم يتم ضبطها، يحتوي هذا الحقل على معلومات حول علامة التبويب الأولى في المستند.

footers

map (key: string, value: object (Footer))

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

الحقل القديم: بدلاً من ذلك، استخدِم Document.tabs.documentTab.footers الذي يعرض محتوى المستند الفعلي من جميع علامات التبويب عندما تكون قيمة المَعلمة includeTabsContent هي true. إذا كانت القيمة false أو لم يتم ضبطها، يحتوي هذا الحقل على معلومات حول علامة التبويب الأولى في المستند.

footnotes

map (key: string, value: object (Footnote))

النتائج فقط. الحواشي السفلية في المستند، ويتم تحديد مفتاحها حسب رقم تعريف الحاشية السفلية

الحقل القديم: بدلاً من ذلك، استخدِم Document.tabs.documentTab.footnotes الذي يعرض محتوى المستند الفعلي من جميع علامات التبويب عندما تكون قيمة المَعلمة includeTabsContent هي true. إذا كانت القيمة false أو لم يتم ضبطها، يحتوي هذا الحقل على معلومات حول علامة التبويب الأولى في المستند.

documentStyle

object (DocumentStyle)

النتائج فقط. نمط المستند

الحقل القديم: بدلاً من ذلك، استخدِم Document.tabs.documentTab.documentStyle الذي يعرض محتوى المستند الفعلي من جميع علامات التبويب عندما تكون قيمة المَعلمة includeTabsContent هي true. إذا كانت القيمة false أو لم يتم ضبطها، يحتوي هذا الحقل على معلومات حول علامة التبويب الأولى في المستند.

suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

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

الحقل القديم: بدلاً من ذلك، استخدِم Document.tabs.documentTab.suggestedDocumentStyleChanges الذي يعرض محتوى المستند الفعلي من جميع علامات التبويب عندما تكون قيمة المَعلمة includeTabsContent هي true. إذا كانت القيمة false أو لم يتم ضبطها، يحتوي هذا الحقل على معلومات حول علامة التبويب الأولى في المستند.

namedStyles

object (NamedStyles)

النتائج فقط. أنماط المستند المُسمّاة

الحقل القديم: بدلاً من ذلك، استخدِم Document.tabs.documentTab.namedStyles الذي يعرض محتوى المستند الفعلي من جميع علامات التبويب عندما تكون قيمة المَعلمة includeTabsContent هي true. إذا كانت القيمة false أو لم يتم ضبطها، يحتوي هذا الحقل على معلومات حول علامة التبويب الأولى في المستند.

suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

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

الحقل القديم: بدلاً من ذلك، استخدِم Document.tabs.documentTab.suggestedNamedStylesChanges الذي يعرض محتوى المستند الفعلي من جميع علامات التبويب عندما تكون قيمة المَعلمة includeTabsContent هي true. إذا كانت القيمة false أو لم يتم ضبطها، يحتوي هذا الحقل على معلومات حول علامة التبويب الأولى في المستند.

lists

map (key: string, value: object (List))

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

الحقل القديم: بدلاً من ذلك، استخدِم Document.tabs.documentTab.lists الذي يعرض محتوى المستند الفعلي من جميع علامات التبويب عندما تكون قيمة المَعلمة includeTabsContent هي true. إذا كانت القيمة false أو لم يتم ضبطها، يحتوي هذا الحقل على معلومات حول علامة التبويب الأولى في المستند.

namedRanges

map (key: string, value: object (NamedRanges))

النتائج فقط. النطاقات المُعنوَنة في المستند، مع تحديد المفتاح حسب الاسم

الحقل القديم: بدلاً من ذلك، استخدِم Document.tabs.documentTab.namedRanges الذي يعرض محتوى المستند الفعلي من جميع علامات التبويب عندما تكون قيمة المَعلمة includeTabsContent هي true. إذا كانت القيمة false أو لم يتم ضبطها، يحتوي هذا الحقل على معلومات حول علامة التبويب الأولى في المستند.

inlineObjects

map (key: string, value: object (InlineObject))

النتائج فقط. العناصر المضمّنة في المستند، ويتم تحديد مفاتيحها حسب رقم تعريف العنصر

الحقل القديم: بدلاً من ذلك، استخدِم Document.tabs.documentTab.inlineObjects الذي يعرض محتوى المستند الفعلي من جميع علامات التبويب عندما تكون قيمة المَعلمة includeTabsContent هي true. إذا كانت القيمة false أو لم يتم ضبطها، يحتوي هذا الحقل على معلومات حول علامة التبويب الأولى في المستند.

positionedObjects

map (key: string, value: object (PositionedObject))

النتائج فقط. العناصر الموضّعة في المستند، ويتم تحديد مفاتيحها حسب رقم تعريف العنصر.

الحقل القديم: بدلاً من ذلك، استخدِم Document.tabs.documentTab.positionedObjects الذي يعرض محتوى المستند الفعلي من جميع علامات التبويب عندما تكون قيمة المَعلمة includeTabsContent هي true. إذا كانت القيمة false أو لم يتم ضبطها، يحتوي هذا الحقل على معلومات حول علامة التبويب الأولى في المستند.

علامة تبويب

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

تمثيل JSON
{
  "tabProperties": {
    object (TabProperties)
  },
  "childTabs": [
    {
      object (Tab)
    }
  ],

  // Union field content can be only one of the following:
  "documentTab": {
    object (DocumentTab)
  }
  // End of list of possible types for union field content.
}
الحقول
tabProperties

object (TabProperties)

خصائص علامة التبويب، مثل المعرّف والعنوان

childTabs[]

object (Tab)

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

حقل الدمج content محتوى علامة التبويب يمكن أن تكون content إحدى القيم التالية فقط:
documentTab

object (DocumentTab)

علامة تبويب تتضمّن محتوى المستند، مثل النصوص والصور

TabProperties

خصائص علامة تبويب

تمثيل JSON
{
  "tabId": string,
  "title": string,
  "parentTabId": string,
  "index": integer,
  "nestingLevel": integer
}
الحقول
tabId

string

النتائج فقط. معرّف علامة التبويب لا يمكن تغيير هذا الحقل.

title

string

اسم علامة التبويب الظاهر للمستخدم.

parentTabId

string

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

index

integer

الفهرس المبدوء من الصفر لعلامة التبويب ضمن العنصر الرئيسي

nestingLevel

integer

النتائج فقط. عمق علامة التبويب داخل المستند تبدأ علامات التبويب ذات المستوى الأعلى بالرقم 0.

DocumentTab

علامة تبويب تتضمّن محتوى المستند

تمثيل JSON
{
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
الحقول
body

object (Body)

تمثّل هذه السمة النص الأساسي لعلامة تبويب المستند.

headers

map (key: string, value: object (Header))

العناوين في علامة تبويب المستند، ويتم تحديد مفاتيحها حسب رقم تعريف العنوان

footers

map (key: string, value: object (Footer))

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

footnotes

map (key: string, value: object (Footnote))

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

documentStyle

object (DocumentStyle)

نمط علامة تبويب المستند

suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

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

namedStyles

object (NamedStyles)

الأنماط المسماة لعلامة تبويب المستند

suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

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

lists

map (key: string, value: object (List))

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

namedRanges

map (key: string, value: object (NamedRanges))

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

inlineObjects

map (key: string, value: object (InlineObject))

العناصر المضمّنة في علامة تبويب المستند، ويتم تحديد مفاتيحها حسب رقم تعريف العنصر

positionedObjects

map (key: string, value: object (PositionedObject))

العناصر الموضّحة في علامة التبويب "المستند"، ويتم تحديدها بمفتاح معرّف العنصر.

النص

نص المستند

يتضمّن النص عادةً محتوى المستند الكامل باستثناء headers وfooters وfootnotes.

تمثيل JSON
{
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
الحقول
content[]

object (StructuralElement)

محتوى النص الأساسي

تبدأ فهارس محتوى النص الأساسي من الصفر.

StructuralElement

يصف StructuralElement المحتوى الذي يوفّر بنية للمستند.

تمثيل JSON
{
  "startIndex": integer,
  "endIndex": integer,

  // Union field content can be only one of the following:
  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
  // End of list of possible types for union field content.
}
الحقول
startIndex

integer

فهرس البدء المستند إلى الصفر لهذا العنصر البنيوي، بوحدات رموز UTF-16

endIndex

integer

الفهرس النهائي المستند إلى الصفر لهذا العنصر البنيوي، باستثناء، في وحدات رموز UTF-16.

حقل الدمج content محتوى العنصر البنيوي يمكن أن تكون content إحدى القيم التالية فقط:
paragraph

object (Paragraph)

نوع فقرة من العناصر الهيكلية

sectionBreak

object (SectionBreak)

نوع فاصل أقسام من العناصر الهيكلية

table

object (Table)

نوع جدول من العناصر الهيكلية

tableOfContents

object (TableOfContents)

نوع جدول المحتويات من العناصر البنيوية

الفقرة

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

تمثيل JSON
{
  "elements": [
    {
      object (ParagraphElement)
    }
  ],
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "suggestedParagraphStyleChanges": {
    string: {
      object (SuggestedParagraphStyle)
    },
    ...
  },
  "bullet": {
    object (Bullet)
  },
  "suggestedBulletChanges": {
    string: {
      object (SuggestedBullet)
    },
    ...
  },
  "positionedObjectIds": [
    string
  ],
  "suggestedPositionedObjectIds": {
    string: {
      object (ObjectReferences)
    },
    ...
  }
}
الحقول
elements[]

object (ParagraphElement)

محتوى الفقرة، مقسّمًا إلى أجزائه المكوّنة

paragraphStyle

object (ParagraphStyle)

نمط هذه الفقرة

suggestedParagraphStyleChanges

map (key: string, value: object (SuggestedParagraphStyle))

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

bullet

object (Bullet)

النقطة في هذه الفقرة إذا لم يكن العنصر موجودًا، يعني ذلك أنّ الفقرة لا تنتمي إلى قائمة.

suggestedBulletChanges

map (key: string, value: object (SuggestedBullet))

التغييرات المقترَحة على النقطة في هذه الفقرة

positionedObjectIds[]

string

تمثّل هذه السمة أرقام تعريف العناصر الموضّعة المرتبطة بهذه الفقرة.

suggestedPositionedObjectIds

map (key: string, value: object (ObjectReferences))

معرّفات الكائنات الموضّحة التي يُقترح إرفاقها بهذه الفقرة، ويتم تحديد المفتاح حسب معرّف الاقتراح.

ParagraphElement

يصف ParagraphElement المحتوى ضمن Paragraph.

تمثيل JSON
{
  "startIndex": integer,
  "endIndex": integer,

  // Union field content can be only one of the following:
  "textRun": {
    object (TextRun)
  },
  "autoText": {
    object (AutoText)
  },
  "pageBreak": {
    object (PageBreak)
  },
  "columnBreak": {
    object (ColumnBreak)
  },
  "footnoteReference": {
    object (FootnoteReference)
  },
  "horizontalRule": {
    object (HorizontalRule)
  },
  "equation": {
    object (Equation)
  },
  "inlineObjectElement": {
    object (InlineObjectElement)
  },
  "person": {
    object (Person)
  },
  "richLink": {
    object (RichLink)
  }
  // End of list of possible types for union field content.
}
الحقول
startIndex

integer

فهرس البدء الصفري لعنصر الفقرة هذا، بوحدات رموز UTF-16

endIndex

integer

الفهرس النهائي المستند إلى الصفر لعنصر الفقرة هذا، باستثناء، في وحدات رموز UTF-16.

حقل الدمج content محتوى عنصر الفقرة. يمكن أن تكون content إحدى القيم التالية فقط:
textRun

object (TextRun)

عنصر فقرة لسلسلة نصية

autoText

object (AutoText)

عنصر فقرة نص تلقائي

pageBreak

object (PageBreak)

عنصر فقرة فاصل الصفحات

columnBreak

object (ColumnBreak)

عنصر فقرة فاصل الأعمدة

footnoteReference

object (FootnoteReference)

عنصر فقرة مرجعية للحاشية السفلية

horizontalRule

object (HorizontalRule)

عنصر فقرة قاعدة أفقية

equation

object (Equation)

تمثّل هذه السمة عنصر فقرة معادلة.

inlineObjectElement

object (InlineObjectElement)

عنصر فقرة كائن مضمّن

person

object (Person)

عنصر فقرة يرتبط بشخص أو عنوان بريد إلكتروني

TextRun

تمثّل ParagraphElement سلسلة من النصوص التي لها النمط نفسه.

تمثيل JSON
{
  "content": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
الحقول
content

string

تمثّل هذه السمة نص عملية التشغيل.

يتم استبدال أي عناصر غير نصية في عملية التشغيل بالحرف U+E907 من Unicode.

suggestedInsertionIds[]

string

معرّفات الإدراج المقترَحة. قد يتضمّن TextRun معرّفات إدراج متعدّدة إذا كان تغييرًا مقترحًا متداخلاً. إذا كانت فارغة، فهذا يعني أنّها ليست موضع إعلان مقترَحًا.

suggestedDeletionIds[]

string

معرّفات الحذف المقترَحة. إذا كان الحقل فارغًا، يعني ذلك أنّه لا توجد عمليات حذف مقترَحة لهذا المحتوى.

textStyle

object (TextStyle)

نمط النص في هذا المقطع

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

يتغيّر نمط النص المقترَح إلى هذا النص، ويتم تحديد مفتاحه حسب رقم تعريف الاقتراح.

TextStyle

تمثّل هذه السمة التنسيق الذي يمكن تطبيقه على النص.

يتم تمثيل أنماط النص الموروثة كحقول غير مضبوطة في هذه الرسالة. يعتمد العنصر الرئيسي لنمط النص على مكان تحديد نمط النص:

  • يرث TextStyle للنص في Paragraph من named style type المقابل للفقرة.
  • يرث TextStyle في named style من النمط المسمّى normal text.
  • يرث TextStyle للنمط المسمّى normal text من نمط النص التلقائي في محرّر "مستندات Google".
  • قد يرث TextStyle في عنصر Paragraph مضمّن في جدول نمط النص من نمط الجدول.

إذا لم يكن نمط النص موروثًا من عنصر رئيسي، ستؤدي إزالة ضبط الحقول إلى إعادة النمط إلى قيمة تطابق الإعدادات التلقائية في "محرّر مستندات Google".

تمثيل JSON
{
  "bold": boolean,
  "italic": boolean,
  "underline": boolean,
  "strikethrough": boolean,
  "smallCaps": boolean,
  "backgroundColor": {
    object (OptionalColor)
  },
  "foregroundColor": {
    object (OptionalColor)
  },
  "fontSize": {
    object (Dimension)
  },
  "weightedFontFamily": {
    object (WeightedFontFamily)
  },
  "baselineOffset": enum (BaselineOffset),
  "link": {
    object (Link)
  }
}
الحقول
bold

boolean

تحدّد هذه السمة ما إذا كان النص معروضًا بخط غامق أم لا.

italic

boolean

تحديد ما إذا كان النص مائلاً أم لا

underline

boolean

تحديد ما إذا كان النص تحته خط أم لا

strikethrough

boolean

تحديد ما إذا كان النص مشطوبًا أم لا

smallCaps

boolean

تحدّد هذه السمة ما إذا كان النص مكتوبًا بأحرف كبيرة صغيرة أم لا.

backgroundColor

object (OptionalColor)

لون خلفية النص في حال ضبطه، يكون اللون إما لونًا بنموذج أحمر أخضر أزرق أو شفافًا، وذلك حسب الحقل color.

foregroundColor

object (OptionalColor)

لون المقدمة للنص في حال ضبطه، يكون اللون إما لونًا بنموذج أحمر أخضر أزرق أو شفافًا، وذلك حسب الحقل color.

fontSize

object (Dimension)

حجم خط النص

weightedFontFamily

object (WeightedFontFamily)

مجموعة الخطوط ووزن النص المعروض

إذا كان طلب التعديل يحدّد قيمًا لكل من weightedFontFamily وbold، يتم تطبيق weightedFontFamily أولاً، ثم bold.

إذا لم يتم ضبط weightedFontFamily#weight، سيتم ضبطه تلقائيًا على 400.

في حال ضبط weightedFontFamily، يجب أيضًا ضبط weightedFontFamily#fontFamily بقيمة غير فارغة. وفي حال عدم توفّرها، سيتم عرض رسالة الخطأ 400 Bad Request.

baselineOffset

enum (BaselineOffset)

الإزاحة العمودية للنص من موضعه العادي

يتم تلقائيًا عرض النص الذي يتضمّن إزاحات خط الأساس SUPERSCRIPT أو SUBSCRIPT بحجم خط أصغر، ويتم احتسابه استنادًا إلى الحقل fontSize. لا تؤثر التغييرات في هذا الحقل في fontSize.

OptionalColor

لون يمكن أن يكون إما معتمًا بالكامل أو شفافًا بالكامل.

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

object (Color)

في حال ضبط هذه السمة، سيتم استخدامها كلون غير شفاف. إذا لم يتم ضبطها، يمثّل ذلك لونًا شفافًا.

اللون

لون خالص

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

object (RgbColor)

قيمة اللون في نموذج الأحمر والأخضر والأزرق

RgbColor

لون RGB

تمثيل JSON
{
  "red": number,
  "green": number,
  "blue": number
}
الحقول
red

number

تمثّل هذه السمة مكوّن اللون الأحمر، وتتراوح قيمته بين 0.0 و1.0.

green

number

تمثّل هذه السمة المكوّن الأخضر من اللون، وتتراوح قيمتها بين 0.0 و1.0.

blue

number

تمثّل هذه السمة مكوّن اللون الأزرق، وتتراوح قيمتها بين 0.0 و1.0.

السمة

مقدار في اتجاه واحد بالوحدات المحدّدة

تمثيل JSON
{
  "magnitude": number,
  "unit": enum (Unit)
}
الحقول
magnitude

number

المقدار

unit

enum (Unit)

تمثّل هذه السمة وحدات المقدار.

وحدة

وحدات القياس.

عمليات التعداد
UNIT_UNSPECIFIED الوحدات غير معروفة.
PT نقطة، وهي جزء من 72 جزءًا من البوصة

WeightedFontFamily

تمثّل هذه السمة مجموعة خطوط ووزن النص.

تمثيل JSON
{
  "fontFamily": string,
  "weight": integer
}
الحقول
fontFamily

string

مجموعة خطوط النص

يمكن أن تكون مجموعة الخطوط أي خط من قائمة "الخط" في "مستندات Google" أو من Google Fonts. إذا كان اسم الخط غير معروف، يتم عرض النص بالخط Arial.

weight

integer

وزن الخط يمكن أن يحتوي هذا الحقل على أي قيمة من مضاعفات 100 بين 100 و900، بما في ذلك الرقمان. يتوافق هذا النطاق مع القيم الرقمية الموضّحة في مواصفات CSS 2.1، الفقرة 15.6، مع عدم السماح بالقيم غير الرقمية.

القيمة التلقائية هي 400 ("عادي").

تشكّل كثافة الخط أحد مكونات كثافة الخط المعروضة. يحدّد مزيج من weight وقيمة bold التي تم حلّها لنمط النص الوزن المعروض، بعد احتساب الوراثة:

  • إذا كان النص غامقًا وكان الوزن أقل من 400، يكون الوزن المعروض 400.
  • إذا كان النص غامقًا وكان الوزن أكبر من أو يساوي 400 ولكن أقل من 700، يكون الوزن المعروض 700.
  • إذا كان الوزن أكبر من أو يساوي 700، يكون الوزن المعروض مساويًا للوزن.
  • إذا لم يكن النص غامقًا، تكون الكثافة المعروضة مساوية للكثافة.

BaselineOffset

الطرق التي يمكن من خلالها إزاحة النص عموديًا عن موضعه العادي

عمليات التعداد
BASELINE_OFFSET_UNSPECIFIED يتم اكتساب إزاحة خط الأساس للنص من العنصر الرئيسي.
NONE لا يتم إزاحة النص عموديًا.
SUPERSCRIPT يتم إزاحة النص عموديًا إلى الأعلى (نص مرتفع).
SUBSCRIPT يتم إزاحة النص عموديًا إلى الأسفل (نص سفلي).

SuggestedTextStyle

تغيير مقترَح على TextStyle

تمثيل JSON
{
  "textStyle": {
    object (TextStyle)
  },
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
الحقول
textStyle

object (TextStyle)

TextStyle لا يتضمّن سوى التغييرات التي تم إجراؤها في هذا الاقتراح. يمكن استخدام هذا الحقل مع textStyleSuggestionState لمعرفة الحقول التي تم تغييرها وقيمها الجديدة.

textStyleSuggestionState

object (TextStyleSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في TextStyle الأساسي.

TextStyleSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في TextStyle الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

تمثيل JSON
{
  "boldSuggested": boolean,
  "italicSuggested": boolean,
  "underlineSuggested": boolean,
  "strikethroughSuggested": boolean,
  "smallCapsSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "foregroundColorSuggested": boolean,
  "fontSizeSuggested": boolean,
  "weightedFontFamilySuggested": boolean,
  "baselineOffsetSuggested": boolean,
  "linkSuggested": boolean
}
الحقول
boldSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على bold.

italicSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على italic.

underlineSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على underline.

strikethroughSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على strikethrough.

smallCapsSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على smallCaps.

backgroundColorSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على backgroundColor.

foregroundColorSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على foregroundColor.

fontSizeSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على fontSize.

weightedFontFamilySuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على weightedFontFamily.

baselineOffsetSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على baselineOffset.

AutoText

ParagraphElement يمثّل موضعًا في النص يتم استبداله ديناميكيًا بمحتوى يمكن أن يتغير بمرور الوقت، مثل رقم الصفحة.

تمثيل JSON
{
  "type": enum (Type),
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
الحقول
type

enum (Type)

نوع هذا النص التلقائي.

suggestedInsertionIds[]

string

معرّفات الإدراج المقترَحة. قد يتضمّن AutoText معرّفات إدراج متعدّدة إذا كان تغييرًا مقترحًا متداخلاً. إذا كانت فارغة، فهذا يعني أنّها ليست موضع إعلان مقترَحًا.

suggestedDeletionIds[]

string

معرّفات الحذف المقترَحة. إذا كان الحقل فارغًا، يعني ذلك أنّه لا توجد عمليات حذف مقترَحة لهذا المحتوى.

textStyle

object (TextStyle)

نمط النص في هذا النص التلقائي

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

يتغيّر نمط النص المقترَح إلى هذا النص التلقائي، ويتم تحديد مفتاحه حسب معرّف الاقتراح.

النوع

أنواع النصوص التلقائية

عمليات التعداد
TYPE_UNSPECIFIED نوع نص تلقائي غير محدَّد
PAGE_NUMBER اكتب نصًا تلقائيًا يمثّل رقم الصفحة الحالية.
PAGE_COUNT اكتب نصًا تلقائيًا يمثّل العدد الإجمالي للصفحات في المستند.

PageBreak

ParagraphElement: تمثّل فاصل صفحة. يؤدي فاصل الصفحات إلى بدء النص اللاحق في أعلى الصفحة التالية.

تمثيل JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
الحقول
suggestedInsertionIds[]

string

معرّفات الإدراج المقترَحة. قد يتضمّن PageBreak معرّفات إدراج متعدّدة إذا كان تغييرًا مقترحًا متداخلاً. إذا كانت فارغة، فهذا يعني أنّها ليست موضع إعلان مقترَحًا.

suggestedDeletionIds[]

string

معرّفات الحذف المقترَحة. إذا كان الحقل فارغًا، يعني ذلك أنّه لا توجد عمليات حذف مقترَحة لهذا المحتوى.

textStyle

object (TextStyle)

نمط النص الخاص بـ PageBreak هذا.

على غرار المحتوى النصي، مثل سلاسل النصوص ومراجع الحواشي السفلية، يمكن أن يؤثر نمط النص لفاصل الصفحات في تصميم المحتوى بالإضافة إلى نمط النص المُدرَج بجانبه.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

يتغيّر نمط النص المقترَح إلى PageBreak هذا، ويتم تحديد مفتاحه حسب رقم تعريف الاقتراح.

ColumnBreak

ParagraphElement تمثّل فاصل أعمدة. يؤدي فاصل الأعمدة إلى بدء النص اللاحق في أعلى العمود التالي.

تمثيل JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
الحقول
suggestedInsertionIds[]

string

معرّفات الإدراج المقترَحة. قد يتضمّن ColumnBreak معرّفات إدراج متعدّدة إذا كان تغييرًا مقترحًا متداخلاً. إذا كانت فارغة، فهذا يعني أنّها ليست موضع إعلان مقترَحًا.

suggestedDeletionIds[]

string

معرّفات الحذف المقترَحة. إذا كان الحقل فارغًا، يعني ذلك أنّه لا توجد عمليات حذف مقترَحة لهذا المحتوى.

textStyle

object (TextStyle)

نمط النص الخاص بـ ColumnBreak هذا

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

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

يتغيّر نمط النص المقترَح إلى ColumnBreak هذا، ويتم تحديد مفتاحه حسب معرّف الاقتراح.

FootnoteReference

ParagraphElement يمثّل مرجع حاشية سفلية. مرجع الحاشية السفلية هو المحتوى المضمّن الذي يتم عرضه برقم ويُستخدم لتحديد الحاشية السفلية.

تمثيل JSON
{
  "footnoteId": string,
  "footnoteNumber": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
الحقول
footnoteId

string

معرّف footnote الذي يحتوي على محتوى مرجع الحاشية السفلية هذا.

footnoteNumber

string

تمثّل هذه السمة رقم الحاشية السفلية المعروض.

suggestedInsertionIds[]

string

معرّفات الإدراج المقترَحة. قد يتضمّن FootnoteReference معرّفات إدراج متعدّدة إذا كان تغييرًا مقترحًا متداخلاً. إذا كانت فارغة، فهذا يعني أنّها ليست موضع إعلان مقترَحًا.

suggestedDeletionIds[]

string

معرّفات الحذف المقترَحة. إذا كان الحقل فارغًا، يعني ذلك أنّه لا توجد عمليات حذف مقترَحة لهذا المحتوى.

textStyle

object (TextStyle)

تمثّل هذه السمة نمط النص الخاص بـ FootnoteReference.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

يتغيّر نمط النص المقترَح إلى FootnoteReference هذا، ويتم تحديد مفتاحه حسب رقم تعريف الاقتراح.

HorizontalRule

ParagraphElement تمثّل خطًا أفقيًا.

تمثيل JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
الحقول
suggestedInsertionIds[]

string

معرّفات الإدراج المقترَحة. قد يتضمّن HorizontalRule أرقام تعريف إدراج متعدّدة إذا كان تغييرًا مقترحًا مدمجًا. إذا كانت فارغة، فهذا يعني أنّها ليست موضع إعلان مقترَحًا.

suggestedDeletionIds[]

string

معرّفات الحذف المقترَحة. إذا كان الحقل فارغًا، يعني ذلك أنّه لا توجد عمليات حذف مقترَحة لهذا المحتوى.

textStyle

object (TextStyle)

نمط النص الخاص بهذا العنصر HorizontalRule.

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

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

يتغيّر نمط النص المقترَح إلى HorizontalRule هذا، ويتم تحديد مفتاحه حسب معرّف الاقتراح.

معادلة

ParagraphElement يمثّل معادلة.

تمثيل JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
الحقول
suggestedInsertionIds[]

string

معرّفات الإدراج المقترَحة. قد يتضمّن Equation معرّفات إدراج متعدّدة إذا كان تغييرًا مقترحًا متداخلاً. إذا كانت فارغة، فهذا يعني أنّها ليست موضع إعلان مقترَحًا.

suggestedDeletionIds[]

string

معرّفات الحذف المقترَحة. إذا كان الحقل فارغًا، يعني ذلك أنّه لا توجد عمليات حذف مقترَحة لهذا المحتوى.

InlineObjectElement

ParagraphElement يحتوي على InlineObject

تمثيل JSON
{
  "inlineObjectId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
الحقول
inlineObjectId

string

تمثّل هذه السمة معرّف InlineObject الذي يحتوي عليه هذا العنصر.

suggestedInsertionIds[]

string

معرّفات الإدراج المقترَحة. قد يتضمّن InlineObjectElement معرّفات إدراج متعدّدة إذا كان تغييرًا مقترحًا متداخلاً. إذا كانت فارغة، فهذا يعني أنّها ليست موضع إعلان مقترَحًا.

suggestedDeletionIds[]

string

معرّفات الحذف المقترَحة. إذا كان الحقل فارغًا، يعني ذلك أنّه لا توجد عمليات حذف مقترَحة لهذا المحتوى.

textStyle

object (TextStyle)

نمط النص الخاص بهذا العنصر InlineObjectElement.

على غرار المحتوى النصي، مثل سلاسل النصوص ومراجع الحواشي السفلية، يمكن أن يؤثر نمط النص الخاص بعنصر مضمّن على تخطيط المحتوى بالإضافة إلى نمط النص المُدرَج بجانبه.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

يتغيّر نمط النص المقترَح إلى InlineObject هذا، ويتم تحديد مفتاحه حسب معرّف الاقتراح.

شخص

تمثّل هذه السمة شخصًا أو عنوان بريد إلكتروني تم ذكرهما في مستند. تتصرّف الإشارات كعنصر واحد غير قابل للتغيير يحتوي على اسم الشخص أو عنوان بريده الإلكتروني.

تمثيل JSON
{
  "personId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "personProperties": {
    object (PersonProperties)
  }
}
الحقول
personId

string

النتائج فقط. المعرّف الفريد لهذا الرابط.

suggestedInsertionIds[]

string

أرقام تعريف الاقتراحات التي تُدرج رابط المستخدم هذا في المستند قد يتضمّن Person أرقام تعريف إدراج متعدّدة إذا كان تغييرًا مقترحًا متداخلاً (اقتراحًا ضمن اقتراح قدّمه مستخدم آخر، مثلاً). إذا كان هذا الحقل فارغًا، يعني ذلك أنّ رابط المستخدم هذا ليس إدراجًا مقترحًا.

suggestedDeletionIds[]

string

معرّفات الاقتراحات التي تزيل رابط المستخدم هذا من المستند قد يكون لدى Person معرّفات حذف متعددة، مثلاً إذا اقترح عدة مستخدمين حذفه. إذا كان هذا الحقل فارغًا، لن يتم اقتراح حذف رابط هذا الشخص.

textStyle

object (TextStyle)

نمط النص في Person

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

يتغيّر نمط النص المقترَح إلى Person، ويتم تحديد مفتاحه حسب رقم تعريف الاقتراح.

personProperties

object (PersonProperties)

النتائج فقط. تمثّل هذه السمة Person خصائص Person. هذا الحقل متوفّر دائمًا.

PersonProperties

السمات الخاصة بـ Person مرتبط

تمثيل JSON
{
  "name": string,
  "email": string
}
الحقول
name

string

اسم الشخص إذا كان معروضًا في نص الرابط بدلاً من عنوان البريد الإلكتروني الخاص به

email

string

عنوان البريد الإلكتروني المرتبط بـ "Person". هذا الحقل متوفّر دائمًا.

RichLinkProperties

السمات الخاصة بـ RichLink

تمثيل JSON
{
  "title": string,
  "uri": string,
  "mimeType": string
}
الحقول
title

string

النتائج فقط. عنوان RichLink كما يظهر في الرابط. يتطابق هذا العنوان مع عنوان المرجع المرتبط به في وقت الإدراج أو آخر تعديل للرابط. هذا الحقل متوفّر دائمًا.

uri

string

النتائج فقط. تمثّل هذه السمة معرّف الموارد المنتظم (URI) الخاص بالسمة RichLink. وهو متوفّر دائمًا.

mimeType

string

النتائج فقط. نوع MIME الخاص بـ RichLink، إذا كان متوفّرًا (على سبيل المثال، عندما يكون ملفًا في Drive)

ParagraphStyle

الأنماط التي تنطبق على فقرة كاملة

يتم تمثيل أنماط الفقرات الموروثة كحقول غير مضبوطة في هذه الرسالة. يعتمد العنصر الرئيسي لنمط الفقرة على مكان تحديد نمط الفقرة:

  • يرث Paragraph ParagraphStyle من named style type المقابل للفقرة.
  • يرث ParagraphStyle في named style من النمط المسمّى normal text.
  • يرث ParagraphStyle للنمط المسمّى normal text من نمط الفقرة التلقائي في محرّر "مستندات Google".
  • قد يرث ParagraphStyle في عنصر Paragraph مضمّن في جدول نمط الفقرة من نمط الجدول.

إذا لم يكن نمط الفقرة موروثًا من عنصر رئيسي، ستؤدي إزالة ضبط الحقول إلى إعادة النمط إلى قيمة تتطابق مع الإعدادات التلقائية في "محرّر مستندات Google".

تمثيل JSON
{
  "headingId": string,
  "namedStyleType": enum (NamedStyleType),
  "alignment": enum (Alignment),
  "lineSpacing": number,
  "direction": enum (ContentDirection),
  "spacingMode": enum (SpacingMode),
  "spaceAbove": {
    object (Dimension)
  },
  "spaceBelow": {
    object (Dimension)
  },
  "borderBetween": {
    object (ParagraphBorder)
  },
  "borderTop": {
    object (ParagraphBorder)
  },
  "borderBottom": {
    object (ParagraphBorder)
  },
  "borderLeft": {
    object (ParagraphBorder)
  },
  "borderRight": {
    object (ParagraphBorder)
  },
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "indentEnd": {
    object (Dimension)
  },
  "tabStops": [
    {
      object (TabStop)
    }
  ],
  "keepLinesTogether": boolean,
  "keepWithNext": boolean,
  "avoidWidowAndOrphan": boolean,
  "shading": {
    object (Shading)
  },
  "pageBreakBefore": boolean
}
الحقول
headingId

string

معرّف العنوان الخاص بالفقرة إذا كانت فارغة، فهذا يعني أنّ هذه الفقرة ليست عنوانًا.

هذه السمة للقراءة فقط.

namedStyleType

enum (NamedStyleType)

تمثّل هذه السمة نوع النمط المسمّى للفقرة.

بما أنّ تعديل نوع النمط المسمّى يؤثّر في الخصائص الأخرى ضمن ParagraphStyle، يتم تطبيق نوع النمط المسمّى قبل تعديل الخصائص الأخرى.

alignment

enum (Alignment)

تمثّل هذه السمة محاذاة النص لهذه الفقرة.

lineSpacing

number

تمثّل هذه السمة مقدار المسافة بين الأسطر كنسبة مئوية من المسافة العادية، حيث يتم تمثيل المسافة العادية بالقيمة 100.0. في حال عدم ضبطها، يتم اكتساب القيمة من العنصر الرئيسي.

direction

enum (ContentDirection)

تمثّل هذه السمة اتجاه نص الفقرة. في حال عدم ضبطها، تكون القيمة التلقائية LEFT_TO_RIGHT لأنّه لا يتم اكتساب اتجاه الفقرة.

spacingMode

enum (SpacingMode)

وضع التباعد للفقرة

spaceAbove

object (Dimension)

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

spaceBelow

object (Dimension)

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

borderBetween

object (ParagraphBorder)

تمثّل هذه السمة الحدود بين هذه الفقرة والفقرات التالية والسابقة. في حال عدم ضبطها، يتم اكتساب القيمة من العنصر الرئيسي.

يتم عرض الحدّ البيني عندما يكون للفقرة المجاورة خصائص الحدّ والمسافة البادئة نفسها.

لا يمكن تعديل حدود الفقرة جزئيًا. عند تغيير حدود فقرة، يجب تحديد الحدود الجديدة بالكامل.

borderTop

object (ParagraphBorder)

الحدّ في أعلى هذه الفقرة في حال عدم ضبطها، يتم اكتساب القيمة من العنصر الرئيسي.

يتم عرض الحدّ العلوي عندما يكون للفقرة أعلاه خصائص مختلفة للحدّ والمسافة البادئة.

لا يمكن تعديل حدود الفقرة جزئيًا. عند تغيير حدود فقرة، يجب تحديد الحدود الجديدة بالكامل.

borderBottom

object (ParagraphBorder)

الحدّ في أسفل هذه الفقرة في حال عدم ضبطها، يتم اكتساب القيمة من العنصر الرئيسي.

يتم عرض الحد السفلي عندما يكون للفقرة أدناه خصائص مختلفة للحد والمسافة البادئة.

لا يمكن تعديل حدود الفقرة جزئيًا. عند تغيير حدود فقرة، يجب تحديد الحدود الجديدة بالكامل.

borderLeft

object (ParagraphBorder)

الحدّ الأيسر لهذه الفقرة في حال عدم ضبطها، يتم اكتساب القيمة من العنصر الرئيسي.

لا يمكن تعديل حدود الفقرة جزئيًا. عند تغيير حدود فقرة، يجب تحديد الحدود الجديدة بالكامل.

borderRight

object (ParagraphBorder)

الحدّ الأيسر لهذه الفقرة في حال عدم ضبطها، يتم اكتساب القيمة من العنصر الرئيسي.

لا يمكن تعديل حدود الفقرة جزئيًا. عند تغيير حدود فقرة، يجب تحديد الحدود الجديدة بالكامل.

indentFirstLine

object (Dimension)

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

indentStart

object (Dimension)

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

indentEnd

object (Dimension)

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

tabStops[]

object (TabStop)

تمثّل هذه السمة قائمة بمواضع التوقف في علامات التبويب لهذه الفقرة. لا يتمّ توارث قائمة مواضع التوقف في علامات التبويب.

هذه السمة للقراءة فقط.

keepLinesTogether

boolean

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

keepWithNext

boolean

تحدّد هذه السمة ما إذا كان يجب عرض جزء على الأقل من هذه الفقرة في الصفحة أو العمود نفسهما مع الفقرة التالية، إذا أمكن ذلك. في حال عدم ضبطها، يتم اكتساب القيمة من العنصر الرئيسي.

avoidWidowAndOrphan

boolean

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

shading

object (Shading)

تمثّل هذه السمة تظليل الفقرة. في حال عدم ضبطها، يتم اكتساب القيمة من العنصر الرئيسي.

pageBreakBefore

boolean

تحديد ما إذا كان يجب أن تبدأ الفقرة الحالية دائمًا في بداية الصفحة في حال عدم ضبطها، يتم اكتساب القيمة من العنصر الرئيسي.

قد تؤدي محاولة تعديل pageBreakBefore للفقرات في مناطق غير متوافقة، بما في ذلك Table وHeader وFooter وFootnote، إلى حالة مستند غير صالحة تعرض الخطأ 400 Bad Request.

NamedStyleType

أنواع الأنماط المسماة

عمليات التعداد
NAMED_STYLE_TYPE_UNSPECIFIED لم يتم تحديد نوع النمط المسمّى.
NORMAL_TEXT نص عادي
TITLE العنوان
SUBTITLE العنوان الفرعي
HEADING_1 العنوان 1.
HEADING_2 العنوان 2.
HEADING_3 العنوان 3.
HEADING_4 عنوان 4
HEADING_5 العنوان 5.
HEADING_6 العنوان 6.

محاذاة

أنواع محاذاة النص للفقرة

عمليات التعداد
ALIGNMENT_UNSPECIFIED يتم اكتساب محاذاة الفقرة من العنصر الرئيسي.
START تتم محاذاة الفقرة مع بداية السطر. تتم محاذاته إلى اليمين إذا كان النص مكتوبًا بلغة تُقرأ من اليسار إلى اليمين، وإلى اليسار في الحالات الأخرى.
CENTER تكون الفقرة في وسط الصفحة.
END تتم محاذاة الفقرة مع نهاية السطر. تتم محاذاته إلى اليمين إذا كان النص مكتوبًا من اليسار إلى اليمين، وإلى اليسار في الحالات الأخرى.
JUSTIFIED الفقرة مضبوطة.

ContentDirection

يمكن أن يتدفق محتوى الاتجاهات فيه.

عمليات التعداد
CONTENT_DIRECTION_UNSPECIFIED لم يتم تحديد اتجاه المحتوى.
LEFT_TO_RIGHT يتم عرض المحتوى من اليسار إلى اليمين.
RIGHT_TO_LEFT يظهر المحتوى من اليمين إلى اليسار.

SpacingMode

الأوضاع المختلفة للمسافة بين الفقرات

عمليات التعداد
SPACING_MODE_UNSPECIFIED يتم اكتساب وضع التباعد من العنصر الرئيسي.
NEVER_COLLAPSE يتم دائمًا عرض تباعد الفقرات.
COLLAPSE_LISTS يتم تخطّي تباعد الفقرات بين عناصر القائمة.

ParagraphBorder

إطار حول فقرة

تمثيل JSON
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "padding": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
الحقول
color

object (OptionalColor)

لون الحدود

width

object (Dimension)

تمثّل هذه السمة عرض الحدود.

padding

object (Dimension)

المساحة المتروكة للحد

dashStyle

enum (DashStyle)

نمط الشرطة للحد

DashStyle

أنواع الشرطات التي يمكن عرض الأشكال الهندسية الخطية بها. تستند هذه القيم إلى النوع البسيط "ST_PresetLineDashVal" الموضّح في القسم 20.1.10.49 من "تنسيقات ملفات Office Open XML - الأساسيات ومرجع لغة الترميز"، الجزء 1 من الإصدار الخامس من ECMA-376.

عمليات التعداد
DASH_STYLE_UNSPECIFIED نمط الشرطة غير محدَّد.
SOLID خط متصل تتوافق مع قيمة ECMA-376 ST_PresetLineDashVal "solid". هذا هو نمط الشرطة التلقائي.
DOT خط متقطّع تتوافق مع قيمة ECMA-376 ST_PresetLineDashVal "نقطة".
DASH خط متقطّع تتوافق مع قيمة ECMA-376 ST_PresetLineDashVal "dash".

TabStop

موضع توقّف علامة الجدولة داخل فقرة

تمثيل JSON
{
  "offset": {
    object (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}
الحقول
offset

object (Dimension)

الإزاحة بين موضع التوقف هذا والهامش الأيمن

alignment

enum (TabStopAlignment)

محاذاة علامة التبويب هذه في حال عدم ضبطها، تكون القيمة التلقائية START.

TabStopAlignment

محاذاة علامة الجدولة

عمليات التعداد
TAB_STOP_ALIGNMENT_UNSPECIFIED لم يتم تحديد محاذاة علامة التبويب.
START تتم محاذاة موضع التوقف عن طريق الضغط على المفتاح Tab مع بداية السطر. هذا هو الخيار التلقائي.
CENTER تتم محاذاة علامة التبويب إلى وسط السطر.
END تتم محاذاة موضع التوقف عند علامة الجدولة مع نهاية السطر.

التظليل

تظليل الفقرة

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

object (OptionalColor)

لون خلفية تظليل هذه الفقرة.

SuggestedParagraphStyle

تغيير مقترَح على ParagraphStyle

تمثيل JSON
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
الحقول
paragraphStyle

object (ParagraphStyle)

ParagraphStyle لا يتضمّن سوى التغييرات التي تم إجراؤها في هذا الاقتراح. يمكن استخدام هذا الحقل مع paragraphStyleSuggestionState لمعرفة الحقول التي تم تغييرها وقيمها الجديدة.

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في ParagraphStyle الأساسي.

ParagraphStyleSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في ParagraphStyle الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

تمثيل JSON
{
  "headingIdSuggested": boolean,
  "namedStyleTypeSuggested": boolean,
  "alignmentSuggested": boolean,
  "lineSpacingSuggested": boolean,
  "directionSuggested": boolean,
  "spacingModeSuggested": boolean,
  "spaceAboveSuggested": boolean,
  "spaceBelowSuggested": boolean,
  "borderBetweenSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "indentEndSuggested": boolean,
  "keepLinesTogetherSuggested": boolean,
  "keepWithNextSuggested": boolean,
  "avoidWidowAndOrphanSuggested": boolean,
  "shadingSuggestionState": {
    object (ShadingSuggestionState)
  },
  "pageBreakBeforeSuggested": boolean
}
الحقول
headingIdSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على headingId.

namedStyleTypeSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على namedStyleType.

alignmentSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على alignment.

lineSpacingSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على lineSpacing.

directionSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على direction.

spacingModeSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على spacingMode.

spaceAboveSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على spaceAbove.

spaceBelowSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على spaceBelow.

borderBetweenSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على borderBetween.

borderTopSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على borderTop.

borderBottomSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على borderBottom.

borderLeftSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على borderLeft.

borderRightSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على borderRight.

indentFirstLineSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على indentFirstLine.

indentStartSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على indentStart.

indentEndSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على indentEnd.

keepLinesTogetherSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على keepLinesTogether.

keepWithNextSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على keepWithNext.

avoidWidowAndOrphanSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على avoidWidowAndOrphan.

shadingSuggestionState

object (ShadingSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن shading

pageBreakBeforeSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على pageBreakBefore.

ShadingSuggestionState

قناع يشير إلى الحقول في Shading الأساسي التي تم تغييرها في هذا التغيير المقترَح. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

تمثيل JSON
{
  "backgroundColorSuggested": boolean
}
الحقول
backgroundColorSuggested

boolean

تشير إلى ما إذا كان هناك تغيير مقترَح على Shading.

تعداد نقطي

تصف هذه السمة النقطة في الفقرة.

تمثيل JSON
{
  "listId": string,
  "nestingLevel": integer,
  "textStyle": {
    object (TextStyle)
  }
}
الحقول
listId

string

تمثّل هذه السمة رقم تعريف القائمة التي تنتمي إليها هذه الفقرة.

nestingLevel

integer

مستوى تداخل هذه الفقرة في القائمة

textStyle

object (TextStyle)

نمط النص الخاص بالفقرة الذي تم تطبيقه على هذه النقطة.

SuggestedBullet

تغيير مقترَح على Bullet

تمثيل JSON
{
  "bullet": {
    object (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}
الحقول
bullet

object (Bullet)

Bullet لا يتضمّن سوى التغييرات التي تم إجراؤها في هذا الاقتراح. يمكن استخدام هذا الحقل مع bulletSuggestionState لمعرفة الحقول التي تم تغييرها وقيمها الجديدة.

bulletSuggestionState

object (BulletSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في Bullet الأساسي.

BulletSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في Bullet الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

تمثيل JSON
{
  "listIdSuggested": boolean,
  "nestingLevelSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
الحقول
listIdSuggested

boolean

تشير إلى ما إذا كان هناك تغيير مقترَح على listId.

nestingLevelSuggested

boolean

تشير إلى ما إذا كان هناك تغيير مقترَح على nestingLevel.

textStyleSuggestionState

object (TextStyleSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن text style

ObjectReferences

مجموعة من أرقام تعريف العناصر

تمثيل JSON
{
  "objectIds": [
    string
  ]
}
الحقول
objectIds[]

string

معرّفات العناصر

SectionBreak

StructuralElement يمثّل فاصل أقسام. القسم هو مجموعة من المحتوى الذي يتضمّن SectionStyle نفسه. يمثّل فاصل الأقسام بداية قسم جديد، وينطبق نمط القسم على القسم الذي يلي فاصل الأقسام.

يبدأ نص المستند دائمًا بفاصل أقسام.

تمثيل JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "sectionStyle": {
    object (SectionStyle)
  }
}
الحقول
suggestedInsertionIds[]

string

معرّفات الإدراج المقترَحة. قد يتضمّن SectionBreak معرّفات إدراج متعدّدة إذا كان تغييرًا مقترحًا متداخلاً. إذا كانت فارغة، فهذا يعني أنّها ليست موضع إعلان مقترَحًا.

suggestedDeletionIds[]

string

معرّفات الحذف المقترَحة. إذا كان الحقل فارغًا، يعني ذلك أنّه لا توجد عمليات حذف مقترَحة لهذا المحتوى.

sectionStyle

object (SectionStyle)

تنسيق القسم بعد فاصل الأقسام هذا

SectionStyle

تمثّل هذه السمة النمط الذي ينطبق على أحد الأقسام.

تمثيل JSON
{
  "columnProperties": [
    {
      object (SectionColumnProperties)
    }
  ],
  "columnSeparatorStyle": enum (ColumnSeparatorStyle),
  "contentDirection": enum (ContentDirection),
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "sectionType": enum (SectionType),
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "flipPageOrientation": boolean
}
الحقول
columnProperties[]

object (SectionColumnProperties)

خصائص أعمدة القسم

إذا كان القسم فارغًا، سيحتوي على عمود واحد بالخصائص التلقائية في "محرّر مستندات Google". يمكن تعديل القسم بحيث لا يحتوي على أكثر من 3 أعمدة.

عند تعديل هذه السمة، يجب ضبط قيمة محددة. سيؤدي عدم ضبط هذه السمة إلى ظهور رسالة الخطأ "400: طلب غير صالح".

columnSeparatorStyle

enum (ColumnSeparatorStyle)

نمط فواصل الأعمدة

يمكن ضبط هذا النمط حتى عندما يكون هناك عمود واحد في القسم.

عند تعديل هذه السمة، يجب ضبط قيمة محددة. سيؤدي عدم ضبط هذه السمة إلى ظهور رسالة الخطأ 400 Bad Request.

contentDirection

enum (ContentDirection)

اتجاه المحتوى في هذا القسم. في حال عدم ضبطها، تكون القيمة التلقائية LEFT_TO_RIGHT.

عند تعديل هذه السمة، يجب ضبط قيمة محددة. سيؤدي عدم ضبط هذه السمة إلى ظهور رسالة الخطأ 400 Bad Request.

marginTop

object (Dimension)

هامش الصفحة العلوي للقسم إذا لم يتم ضبطها، تكون القيمة التلقائية marginTop من DocumentStyle.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

عند تعديل هذه السمة، يجب ضبط قيمة محددة. سيؤدي عدم ضبط هذه السمة إلى ظهور رسالة الخطأ 400 Bad Request.

marginBottom

object (Dimension)

الهامش السفلي للصفحة في القسم إذا لم يتم ضبطها، تكون القيمة التلقائية marginBottom من DocumentStyle.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

عند تعديل هذه السمة، يجب ضبط قيمة محددة. سيؤدي عدم ضبط هذه السمة إلى ظهور رسالة الخطأ 400 Bad Request.

marginRight

object (Dimension)

هامش الصفحة الأيمن للقسم إذا لم يتم ضبطها، تكون القيمة التلقائية marginRight من DocumentStyle. يؤدي تعديل الهامش الأيمن إلى تغيير حجم الأعمدة في هذا القسم. بما أنّ الهامش يؤثر في عرض العمود، يتم تطبيقه قبل خصائص العمود.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

عند تعديل هذه السمة، يجب ضبط قيمة محددة. سيؤدي عدم ضبط هذه السمة إلى ظهور رسالة الخطأ 400 Bad Request.

marginLeft

object (Dimension)

هامش الصفحة الأيسر للقسم إذا لم يتم ضبطها، تكون القيمة التلقائية marginLeft من DocumentStyle. يؤدي تعديل الهامش الأيسر إلى تغيير حجم الأعمدة في هذا القسم. بما أنّ الهامش يؤثر في عرض العمود، يتم تطبيقه قبل خصائص العمود.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

عند تعديل هذه السمة، يجب ضبط قيمة محددة. سيؤدي عدم ضبط هذه السمة إلى ظهور رسالة الخطأ 400 Bad Request.

marginHeader

object (Dimension)

هامش رأس القسم إذا لم يتم ضبطها، تكون القيمة التلقائية marginHeader من DocumentStyle. في حال تعديله، يتم ضبط useCustomHeaderFooterMargins على "صحيح" في DocumentStyle. تشير قيمة useCustomHeaderFooterMargins في DocumentStyle إلى ما إذا كان سيتم احترام هامش الرأس لهذا القسم.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

عند تعديل هذه السمة، يجب ضبط قيمة محددة. سيؤدي عدم ضبط هذه السمة إلى ظهور رسالة الخطأ 400 Bad Request.

sectionType

enum (SectionType)

النتائج فقط. تمثّل هذه السمة نوع القسم.

defaultHeaderId

string

معرّف العنوان التلقائي. في حال عدم ضبط هذه السمة، يتم اكتساب القيمة من SectionBreak's SectionStyle السابقة. إذا لم يتم ضبط القيمة في SectionBreak الأول، سيتم استخلاصها من defaultHeaderId في DocumentStyle.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

هذه السمة للقراءة فقط.

firstPageHeaderId

string

رقم تعريف العنوان المستخدَم للصفحة الأولى فقط من القسم إذا كانت قيمة useFirstPageHeaderFooter هي "صحيح"، يتم استخدام هذه القيمة للعنوان في الصفحة الأولى من القسم. إذا كانت القيمة false، يستخدم الرأس في الصفحة الأولى من القسم defaultHeaderId. في حال عدم ضبط هذه السمة، يتم اكتساب القيمة من SectionBreak's SectionStyle السابقة. إذا لم يتم ضبط القيمة في SectionBreak الأول، سيتم استخلاصها من firstPageHeaderId في DocumentStyle.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

هذه السمة للقراءة فقط.

evenPageHeaderId

string

معرّف العنوان المستخدَم للصفحات الزوجية فقط إذا كانت قيمة useEvenPageHeaderFooter في DocumentStyle هي "صحيح"، يتم استخدام هذه القيمة للعناوين في الصفحات الزوجية في القسم. إذا كانت القيمة خطأ، تستخدم العناوين في الصفحات الزوجية defaultHeaderId. في حال عدم ضبط هذه السمة، يتم اكتساب القيمة من SectionBreak's SectionStyle السابقة. إذا لم يتم ضبط القيمة في SectionBreak الأول، سيتم استخلاصها من evenPageHeaderId في DocumentStyle.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

هذه السمة للقراءة فقط.

pageNumberStart

integer

رقم الصفحة الذي يجب بدء احتساب عدد صفحات هذا القسم منه. في حال عدم ضبط هذه السمة، يستمر ترقيم الصفحات من القسم السابق. إذا لم يتم ضبط القيمة في SectionBreak الأول، يُرجى الرجوع إلى pageNumberStart في DocumentStyle.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

عند تعديل هذه السمة، يجب ضبط قيمة محددة. سيؤدي عدم ضبط هذه السمة إلى ظهور رسالة الخطأ 400 Bad Request.

flipPageOrientation

boolean

اختيارية: تشير إلى ما إذا كان سيتم عكس أبعاد pageSize في DocumentStyle لهذا القسم، ما يتيح تغيير اتجاه الصفحة بين الوضعين العمودي والأفقي. في حال عدم ضبطها، يتم استخلاص القيمة من flipPageOrientation في DocumentStyle.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

عند تعديل هذه السمة، يجب ضبط قيمة محددة. سيؤدي عدم ضبط هذه السمة إلى ظهور رسالة الخطأ 400 Bad Request.

SectionColumnProperties

السمات التي تنطبق على عمود أحد الأقسام

تمثيل JSON
{
  "width": {
    object (Dimension)
  },
  "paddingEnd": {
    object (Dimension)
  }
}
الحقول
width

object (Dimension)

النتائج فقط. عرض العمود

paddingEnd

object (Dimension)

المسافة المتروكة في نهاية العمود

ColumnSeparatorStyle

نمط فواصل الأعمدة بين الأعمدة

عمليات التعداد
COLUMN_SEPARATOR_STYLE_UNSPECIFIED نمط فاصل أعمدة غير محدَّد.
NONE لا تتضمّن خطوطًا فاصلة بين الأعمدة.
BETWEEN_EACH_COLUMN تعرض هذه السمة خطًا فاصلاً بين كل عمود.

SectionType

تمثّل هذه السمة موضع بداية القسم الحالي بالنسبة إلى القسم السابق.

عمليات التعداد
SECTION_TYPE_UNSPECIFIED لم يتم تحديد نوع القسم.
CONTINUOUS يبدأ القسم مباشرةً بعد الفقرة الأخيرة من القسم السابق.
NEXT_PAGE يبدأ القسم في الصفحة التالية.

جدول

StructuralElement يمثّل جدولاً.

تمثيل JSON
{
  "rows": integer,
  "columns": integer,
  "tableRows": [
    {
      object (TableRow)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableStyle": {
    object (TableStyle)
  }
}
الحقول
rows

integer

عدد الصفوف في الجدول

columns

integer

عدد الأعمدة في الجدول

من الممكن أن يكون الجدول غير مستطيل، لذا قد يحتوي بعض الصفوف على عدد مختلف من الخلايا.

tableRows[]

object (TableRow)

محتوى كل صف ونمطه

suggestedInsertionIds[]

string

معرّفات الإدراج المقترَحة. قد يتضمّن Table معرّفات إدراج متعدّدة إذا كان تغييرًا مقترحًا متداخلاً. إذا كانت فارغة، فهذا يعني أنّها ليست موضع إعلان مقترَحًا.

suggestedDeletionIds[]

string

معرّفات الحذف المقترَحة. إذا كان الحقل فارغًا، يعني ذلك أنّه لا توجد عمليات حذف مقترَحة لهذا المحتوى.

tableStyle

object (TableStyle)

تمثّل هذه السمة نمط الجدول.

TableRow

محتوى وأسلوب صف في Table

تمثيل JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "tableCells": [
    {
      object (TableCell)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "suggestedTableRowStyleChanges": {
    string: {
      object (SuggestedTableRowStyle)
    },
    ...
  }
}
الحقول
startIndex

integer

فهرس البدء المستند إلى الصفر لهذا الصف، بوحدات رموز UTF-16

endIndex

integer

الفهرس النهائي المستند إلى الصفر لهذا الصف، باستثناء، في وحدات رمز UTF-16.

tableCells[]

object (TableCell)

محتوى كل خلية في هذا الصف وأسلوبها

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

suggestedInsertionIds[]

string

معرّفات الإدراج المقترَحة. قد يتضمّن TableRow معرّفات إدراج متعدّدة إذا كان تغييرًا مقترحًا متداخلاً. إذا كانت فارغة، فهذا يعني أنّها ليست موضع إعلان مقترَحًا.

suggestedDeletionIds[]

string

معرّفات الحذف المقترَحة. إذا كان الحقل فارغًا، يعني ذلك أنّه لا توجد عمليات حذف مقترَحة لهذا المحتوى.

tableRowStyle

object (TableRowStyle)

نمط صف الجدول

suggestedTableRowStyleChanges

map (key: string, value: object (SuggestedTableRowStyle))

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

TableCell

محتوى الخلية ونمطها في Table

تمثيل JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "suggestedTableCellStyleChanges": {
    string: {
      object (SuggestedTableCellStyle)
    },
    ...
  }
}
الحقول
startIndex

integer

فهرس البدء المستند إلى الصفر لهذه الخلية، بوحدات رموز UTF-16

endIndex

integer

فهرس نهاية هذه الخلية المستند إلى الصفر، باستثناء، في وحدات رمز UTF-16.

content[]

object (StructuralElement)

محتوى الخلية

tableCellStyle

object (TableCellStyle)

نمط الخلية.

suggestedInsertionIds[]

string

معرّفات الإدراج المقترَحة. قد يتضمّن TableCell معرّفات إدراج متعدّدة إذا كان تغييرًا مقترحًا متداخلاً. إذا كانت فارغة، فهذا يعني أنّها ليست موضع إعلان مقترَحًا.

suggestedDeletionIds[]

string

معرّفات الحذف المقترَحة. إذا كان الحقل فارغًا، يعني ذلك أنّه لا توجد عمليات حذف مقترَحة لهذا المحتوى.

suggestedTableCellStyleChanges

map (key: string, value: object (SuggestedTableCellStyle))

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

TableCellStyle

نمط TableCell

يتم تمثيل أنماط خلايا الجدول الموروثة كحقول غير مضبوطة في هذه الرسالة. يمكن أن يرث نمط خلية الجدول من نمط الجدول.

تمثيل JSON
{
  "rowSpan": integer,
  "columnSpan": integer,
  "backgroundColor": {
    object (OptionalColor)
  },
  "borderLeft": {
    object (TableCellBorder)
  },
  "borderRight": {
    object (TableCellBorder)
  },
  "borderTop": {
    object (TableCellBorder)
  },
  "borderBottom": {
    object (TableCellBorder)
  },
  "paddingLeft": {
    object (Dimension)
  },
  "paddingRight": {
    object (Dimension)
  },
  "paddingTop": {
    object (Dimension)
  },
  "paddingBottom": {
    object (Dimension)
  },
  "contentAlignment": enum (ContentAlignment)
}
الحقول
rowSpan

integer

عدد الصفوف التي تمتد عليها الخلية

هذه السمة للقراءة فقط.

columnSpan

integer

تمثّل هذه السمة عدد الأعمدة التي تمتد عليها الخلية.

هذه السمة للقراءة فقط.

backgroundColor

object (OptionalColor)

لون خلفية الخلية

borderLeft

object (TableCellBorder)

الحد الأيسر للخلية

borderRight

object (TableCellBorder)

الحد الأيمن للخلية

borderTop

object (TableCellBorder)

الحد العلوي للخلية

borderBottom

object (TableCellBorder)

الحد السفلي للخلية

paddingLeft

object (Dimension)

المساحة المتروكة على يمين الخلية

paddingRight

object (Dimension)

المساحة المتروكة على يمين الخلية

paddingTop

object (Dimension)

المساحة المتروكة في أعلى الخلية

paddingBottom

object (Dimension)

المساحة المتروكة في أسفل الخلية

contentAlignment

enum (ContentAlignment)

محاذاة المحتوى في خلية الجدول يتطابق المحاذاة التلقائية مع محاذاة خلايا الجدول التي تم إنشاؤها حديثًا في محرّر "مستندات Google".

TableCellBorder

تمثّل هذه السمة حدّ خلية جدول.

لا يمكن أن تكون حدود خلايا الجدول شفافة. لإخفاء حدّ خلية جدول، اجعل عرضه 0.

تمثيل JSON
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
الحقول
color

object (OptionalColor)

لون الحدود

لا يمكن أن يكون هذا اللون شفافًا.

width

object (Dimension)

تمثّل هذه السمة عرض الحدود.

dashStyle

enum (DashStyle)

نمط الشرطة للحد

ContentAlignment

أنواع محاذاة المحتوى

مستمدّ من مجموعة فرعية من قيم النوع البسيط "ST_TextAnchoringType" في القسم 20.1.10.60 من "تنسيقات ملفات Office Open XML - الأساسيات ومرجع لغة الترميز"، الجزء 1 من ECMA-376 الإصدار الخامس.

عمليات التعداد
CONTENT_ALIGNMENT_UNSPECIFIED محاذاة محتوى غير محدّدة يتم اكتساب محاذاة المحتوى من العنصر الرئيسي إذا كان متوفّرًا.
CONTENT_ALIGNMENT_UNSUPPORTED محاذاة محتوى غير متوافقة
TOP محاذاة تحاذي المحتوى مع أعلى حاوية المحتوى يتوافق مع ECMA-376 ST_TextAnchoringType "t".
MIDDLE محاذاة تعمل على محاذاة المحتوى إلى منتصف حاوية المحتوى يتوافق مع ECMA-376 ST_TextAnchoringType "ctr".
BOTTOM محاذاة تعمل على محاذاة المحتوى مع أسفل حاوية المحتوى يتوافق مع ECMA-376 ST_TextAnchoringType "b".

SuggestedTableCellStyle

تغيير مقترَح على TableCellStyle

تمثيل JSON
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "tableCellStyleSuggestionState": {
    object (TableCellStyleSuggestionState)
  }
}
الحقول
tableCellStyle

object (TableCellStyle)

TableCellStyle لا يتضمّن سوى التغييرات التي تم إجراؤها في هذا الاقتراح. يمكن استخدام هذا الحقل مع tableCellStyleSuggestionState لمعرفة الحقول التي تم تغييرها وقيمها الجديدة.

tableCellStyleSuggestionState

object (TableCellStyleSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في TableCellStyle الأساسي.

TableCellStyleSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في TableCellStyle الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

تمثيل JSON
{
  "rowSpanSuggested": boolean,
  "columnSpanSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "paddingLeftSuggested": boolean,
  "paddingRightSuggested": boolean,
  "paddingTopSuggested": boolean,
  "paddingBottomSuggested": boolean,
  "contentAlignmentSuggested": boolean
}
الحقول
rowSpanSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على rowSpan.

columnSpanSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على columnSpan.

backgroundColorSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على backgroundColor.

borderLeftSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على borderLeft.

borderRightSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على borderRight.

borderTopSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على borderTop.

borderBottomSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على borderBottom.

paddingLeftSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على paddingLeft.

paddingRightSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على paddingRight.

paddingTopSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على paddingTop.

paddingBottomSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على paddingBottom.

contentAlignmentSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على contentAlignment.

TableRowStyle

الأنماط التي تنطبق على صف جدول

تمثيل JSON
{
  "minRowHeight": {
    object (Dimension)
  },
  "tableHeader": boolean,
  "preventOverflow": boolean
}
الحقول
minRowHeight

object (Dimension)

تمثّل هذه السمة الحد الأدنى لارتفاع الصف. سيتم عرض الصف في محرّر "مستندات Google" بارتفاع يساوي هذه القيمة أو أكبر منها لعرض كل المحتوى في خلايا الصف.

tableHeader

boolean

تُستخدَم لتحديد ما إذا كان الصف يمثّل عنوان جدول.

preventOverflow

boolean

تحديد ما إذا كان الصف لا يمكن أن يتجاوز حدود الصفحة أو العمود

SuggestedTableRowStyle

تغيير مقترَح على TableRowStyle

تمثيل JSON
{
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}
الحقول
tableRowStyle

object (TableRowStyle)

TableRowStyle لا يتضمّن سوى التغييرات التي تم إجراؤها في هذا الاقتراح. يمكن استخدام هذا الحقل مع tableRowStyleSuggestionState لمعرفة الحقول التي تم تغييرها وقيمها الجديدة.

tableRowStyleSuggestionState

object (TableRowStyleSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في TableRowStyle الأساسي.

TableRowStyleSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في TableRowStyle الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

تمثيل JSON
{
  "minRowHeightSuggested": boolean
}
الحقول
minRowHeightSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على minRowHeight.

TableStyle

الأنماط التي تنطبق على جدول

تمثيل JSON
{
  "tableColumnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
الحقول
tableColumnProperties[]

object (TableColumnProperties)

خصائص كل عمود

يُرجى العِلم أنّه في "مستندات Google"، تحتوي الجداول على صفوف وتحتوي الصفوف على خلايا، على غرار HTML. وبالتالي، يمكن العثور على خصائص الصف في tableRowStyle الخاص بالصف.

TableColumnProperties

خصائص عمود في جدول

تمثيل JSON
{
  "widthType": enum (WidthType),
  "width": {
    object (Dimension)
  }
}
الحقول
widthType

enum (WidthType)

نوع عرض العمود.

width

object (Dimension)

عرض العمود تحديد متى تكون قيمة widthType للعمود هي FIXED_WIDTH

WidthType

تمثّل هذه السمة نوع عرض العمود.

عمليات التعداد
WIDTH_TYPE_UNSPECIFIED لم يتم تحديد نوع عرض العمود.
EVENLY_DISTRIBUTED

يتم توزيع عرض العمود بالتساوي بين الأعمدة الأخرى الموزّعة بالتساوي.

يتم تحديد عرض العمود تلقائيًا وسيكون له جزء متساوٍ من العرض المتبقي للجدول بعد احتساب جميع الأعمدة ذات العروض المحددة.

FIXED_WIDTH عرض عمود ثابت تحتوي السمة [width][google.apps.docs.v1.TableColumnProperties.width على عرض العمود.

TableOfContents

StructuralElement يمثّل جدول محتويات.

تمثيل JSON
{
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
الحقول
content[]

object (StructuralElement)

محتوى جدول المحتويات

suggestedInsertionIds[]

string

معرّفات الإدراج المقترَحة. قد يتضمّن TableOfContents أرقام تعريف إدراج متعدّدة إذا كان تغييرًا مقترحًا مدمجًا. إذا كانت فارغة، فهذا يعني أنّها ليست موضع إعلان مقترَحًا.

suggestedDeletionIds[]

string

معرّفات الحذف المقترَحة. إذا كان الحقل فارغًا، يعني ذلك أنّه لا توجد عمليات حذف مقترَحة لهذا المحتوى.

حاشية سفلية

حاشية سفلية في المستند

تمثيل JSON
{
  "footnoteId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
الحقول
footnoteId

string

معرّف الحاشية السفلية.

content[]

object (StructuralElement)

محتوى الحاشية السفلية

تبدأ فهارس محتوى الحاشية السفلية من الرقم صفر.

DocumentStyle

نمط المستند

تمثيل JSON
{
  "background": {
    object (Background)
  },
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "useEvenPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "pageSize": {
    object (Size)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "useCustomHeaderFooterMargins": boolean,
  "flipPageOrientation": boolean,
  "documentFormat": {
    object (DocumentFormat)
  }
}
الحقول
background

object (Background)

خلفية المستند يجب ألا يكون لون خلفية المستندات شفافًا.

defaultHeaderId

string

معرّف العنوان التلقائي. في حال عدم ضبط هذه السياسة، لن يكون هناك عنوان تلقائي.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

هذه السمة للقراءة فقط.

evenPageHeaderId

string

معرّف العنوان المستخدَم للصفحات الزوجية فقط تحدّد قيمة useEvenPageHeaderFooter ما إذا كان سيتم استخدام defaultHeaderId أو هذه القيمة للرأس في الصفحات الزوجية. في حال عدم ضبط هذا الخيار، لن يكون هناك رأس للصفحات الزوجية.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

هذه السمة للقراءة فقط.

firstPageHeaderId

string

رقم تعريف العنوان المستخدَم للصفحة الأولى فقط في حال عدم ضبط هذا الخيار، لن يكون هناك عنوان فريد للصفحة الأولى. تحدّد قيمة useFirstPageHeaderFooter ما إذا كان سيتم استخدام defaultHeaderId أو هذه القيمة للعنوان في الصفحة الأولى. في حال عدم ضبط هذه السياسة، لن يكون هناك رأس للصفحة الأولى.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

هذه السمة للقراءة فقط.

pageNumberStart

integer

رقم الصفحة الذي يجب بدء احتساب عدد الصفحات منه.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

marginTop

object (Dimension)

الهامش العلوي للصفحة

يؤدي تعديل هامش الصفحة العلوي في نمط المستند إلى محو هامش الصفحة العلوي في جميع أنماط الأقسام.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

marginBottom

object (Dimension)

الهامش السفلي للصفحة

يؤدي تعديل هامش الصفحة السفلي في نمط المستند إلى محو هامش الصفحة السفلي في جميع أنماط الأقسام.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

marginRight

object (Dimension)

هامش الصفحة الأيمن

يؤدي تعديل هامش الصفحة الأيمن في نمط المستند إلى محو هامش الصفحة الأيمن في جميع أنماط الأقسام. وقد يؤدي أيضًا إلى تغيير حجم الأعمدة في جميع الأقسام.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

marginLeft

object (Dimension)

هامش الصفحة الأيسر

يؤدي تعديل هامش الصفحة الأيمن في نمط المستند إلى محو هامش الصفحة الأيمن في جميع أنماط الأقسام. وقد يؤدي أيضًا إلى تغيير حجم الأعمدة في جميع الأقسام.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

pageSize

object (Size)

تمثّل هذه السمة حجم الصفحة في المستند.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

marginHeader

object (Dimension)

مقدار المساحة بين أعلى الصفحة ومحتوى الرأس

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

flipPageOrientation

boolean

اختيارية: تحدّد ما إذا كان سيتم عكس أبعاد pageSize، ما يتيح تغيير اتجاه الصفحة بين الوضعين العمودي والأفقي.

إذا كانت قيمة [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] هي PAGELESS، لن يتم عرض هذه السمة.

documentFormat

object (DocumentFormat)

تحدّد إعدادات التنسيق على مستوى المستند، مثل وضع المستند (صفحات أو بلا صفحات).

الخلفية

تمثّل خلفية المستند.

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

object (OptionalColor)

لون الخلفية

الحجم

العرض والارتفاع

تمثيل JSON
{
  "height": {
    object (Dimension)
  },
  "width": {
    object (Dimension)
  }
}
الحقول
height

object (Dimension)

تمثّل هذه السمة ارتفاع العنصر.

width

object (Dimension)

تمثّل هذه السمة عرض العنصر.

DocumentFormat

تمثّل إعدادات التنسيق على مستوى المستند.

تمثيل JSON
{
  "documentMode": enum (DocumentMode)
}
الحقول
documentMode

enum (DocumentMode)

تُستخدَم لتحديد ما إذا كان المستند سيُقسَّم إلى صفحات أو لا.

DocumentMode

تُستخدَم لتحديد ما إذا كان المستند سيُقسَّم إلى صفحات أو لا.

عمليات التعداد
DOCUMENT_MODE_UNSPECIFIED لم يتم تحديد وضع المستند.
PAGES يحتوي المستند على صفحات.
PAGELESS المستند بلا صفحات.

SuggestedDocumentStyle

تغيير مقترَح على DocumentStyle

تمثيل JSON
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "documentStyleSuggestionState": {
    object (DocumentStyleSuggestionState)
  }
}
الحقول
documentStyle

object (DocumentStyle)

DocumentStyle لا يتضمّن سوى التغييرات التي تم إجراؤها في هذا الاقتراح. يمكن استخدام هذا الحقل مع documentStyleSuggestionState لمعرفة الحقول التي تم تغييرها وقيمها الجديدة.

documentStyleSuggestionState

object (DocumentStyleSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في DocumentStyle الأساسي.

DocumentStyleSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في DocumentStyle الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

تمثيل JSON
{
  "backgroundSuggestionState": {
    object (BackgroundSuggestionState)
  },
  "defaultHeaderIdSuggested": boolean,
  "defaultFooterIdSuggested": boolean,
  "evenPageHeaderIdSuggested": boolean,
  "evenPageFooterIdSuggested": boolean,
  "firstPageHeaderIdSuggested": boolean,
  "firstPageFooterIdSuggested": boolean,
  "useFirstPageHeaderFooterSuggested": boolean,
  "useEvenPageHeaderFooterSuggested": boolean,
  "pageNumberStartSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginLeftSuggested": boolean,
  "pageSizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginHeaderSuggested": boolean,
  "marginFooterSuggested": boolean,
  "useCustomHeaderFooterMarginsSuggested": boolean,
  "flipPageOrientationSuggested": boolean
}
الحقول
backgroundSuggestionState

object (BackgroundSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن background

defaultHeaderIdSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على defaultHeaderId.

evenPageHeaderIdSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على evenPageHeaderId.

firstPageHeaderIdSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على firstPageHeaderId.

pageNumberStartSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على pageNumberStart.

marginTopSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على marginTop.

marginBottomSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على marginBottom.

marginRightSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على marginRight.

marginLeftSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على marginLeft.

pageSizeSuggestionState

object (SizeSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن [size] [google.apps.docs.v1.DocumentStyle.size].

marginHeaderSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على marginHeader.

flipPageOrientationSuggested

boolean

اختيارية: توضّح ما إذا كان هناك تغيير مقترَح على flipPageOrientation.

BackgroundSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في Background الأساسي. بالنسبة إلى أي حقل تم ضبطه على "صحيح"، يحتوي Backgound على قيمة مقترَحة جديدة.

تمثيل JSON
{
  "backgroundColorSuggested": boolean
}
الحقول
backgroundColorSuggested

boolean

تشير إلى ما إذا تم تعديل لون الخلفية الحالي في هذا الاقتراح.

SizeSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في Size الأساسي. بالنسبة إلى أي حقل تم ضبطه على "صحيح"، يحتوي Size على قيمة مقترَحة جديدة.

تمثيل JSON
{
  "heightSuggested": boolean,
  "widthSuggested": boolean
}
الحقول
heightSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على height.

widthSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على width.

NamedStyles

الأنماط المُسمّاة يمكن أن تكتسب الفقرات في المستند TextStyle وParagraphStyle من هذه الأنماط المسماة.

تمثيل JSON
{
  "styles": [
    {
      object (NamedStyle)
    }
  ]
}
الحقول
styles[]

object (NamedStyle)

الأنماط المُسمّاة

هناك إدخال لكل named style types محتمل.

NamedStyle

نمط مُسمّى يمكن أن ترث الفقرات في المستند TextStyle وParagraphStyle من هذا النمط المسمّى عندما يكون لها نوع النمط المسمّى نفسه.

تمثيل JSON
{
  "namedStyleType": enum (NamedStyleType),
  "textStyle": {
    object (TextStyle)
  },
  "paragraphStyle": {
    object (ParagraphStyle)
  }
}
الحقول
namedStyleType

enum (NamedStyleType)

يشير ذلك إلى نوع هذا النمط المسمّى.

textStyle

object (TextStyle)

نمط النص لهذا النمط المُسمّى.

paragraphStyle

object (ParagraphStyle)

نمط الفقرة لهذا النمط المُسمّى.

SuggestedNamedStyles

تغيير مقترَح على NamedStyles

تمثيل JSON
{
  "namedStyles": {
    object (NamedStyles)
  },
  "namedStylesSuggestionState": {
    object (NamedStylesSuggestionState)
  }
}
الحقول
namedStyles

object (NamedStyles)

NamedStyles لا يتضمّن سوى التغييرات التي تم إجراؤها في هذا الاقتراح. يمكن استخدام هذا الحقل مع namedStylesSuggestionState لمعرفة الحقول التي تم تغييرها وقيمها الجديدة.

namedStylesSuggestionState

object (NamedStylesSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في NamedStyles الأساسي.

NamedStylesSuggestionState

تعرض هذه السمة حالة اقتراح رسالة NamedStyles.

تمثيل JSON
{
  "stylesSuggestionStates": [
    {
      object (NamedStyleSuggestionState)
    }
  ]
}
الحقول
stylesSuggestionStates[]

object (NamedStyleSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من NamedStyle المقابل في styles.

يتطابق ترتيب حالات اقتراحات الأنماط المسماة هذه مع ترتيب النمط المسمى المقابل ضمن named styles الاقتراح.

NamedStyleSuggestionState

حالة اقتراح لرسالة NamedStyle

تمثيل JSON
{
  "namedStyleType": enum (NamedStyleType),
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
الحقول
namedStyleType

enum (NamedStyleType)

تمثّل هذه السمة نوع النمط المُسمّى الذي تتوافق معه حالة الاقتراح هذه.

يتم توفير هذا الحقل لتسهيل مطابقة NamedStyleSuggestionState مع NamedStyle المقابل.

textStyleSuggestionState

object (TextStyleSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن text style

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن paragraph style

قائمة

تمثّل القائمة سمات القائمة لمجموعة من الفقرات التي تنتمي جميعها إلى القائمة نفسها. تحتوي الفقرة التي تشكّل جزءًا من قائمة على مرجع إلى رقم تعريف القائمة في bullet.

تمثيل JSON
{
  "listProperties": {
    object (ListProperties)
  },
  "suggestedListPropertiesChanges": {
    string: {
      object (SuggestedListProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
الحقول
listProperties

object (ListProperties)

خصائص القائمة

suggestedListPropertiesChanges

map (key: string, value: object (SuggestedListProperties))

التغييرات المقترَحة على خصائص القائمة، ويتم تحديدها بمفتاح معرّف الاقتراح.

suggestedInsertionId

string

المعرّف المقترَح للإدراج إذا كانت فارغة، فهذا يعني أنّها ليست موضع إعلان مقترَحًا.

suggestedDeletionIds[]

string

معرّفات الحذف المقترَحة. إذا كانت فارغة، يعني ذلك أنّه لا توجد عمليات حذف مقترَحة لهذه القائمة.

ListProperties

خصائص list التي تصف شكل وتصميم الرموز النقطية التابعة للفقرات المرتبطة بقائمة

تمثيل JSON
{
  "nestingLevels": [
    {
      object (NestingLevel)
    }
  ]
}
الحقول
nestingLevels[]

object (NestingLevel)

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

تحتوي القائمة على 9 مستويات دمج على الأكثر، حيث يتوافق مستوى الدمج 0 مع المستوى الأعلى ومستوى الدمج 8 مع المستوى الأكثر دمجًا. يتم عرض مستويات التداخل بترتيب تصاعدي، ويتم عرض المستوى الأقل تداخلاً أولاً.

NestingLevel

يحتوي على خصائص تصف شكل نقطة تعداد في قائمة على مستوى معيّن من التداخل.

تمثيل JSON
{
  "bulletAlignment": enum (BulletAlignment),
  "glyphFormat": string,
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "textStyle": {
    object (TextStyle)
  },
  "startNumber": integer,

  // Union field glyph_kind can be only one of the following:
  "glyphType": enum (GlyphType),
  "glyphSymbol": string
  // End of list of possible types for union field glyph_kind.
}
الحقول
bulletAlignment

enum (BulletAlignment)

محاذاة النقطة ضمن المساحة المخصّصة لعرضها

glyphFormat

string

سلسلة التنسيق المستخدَمة للتعداد النقطي في مستوى التداخل هذا

يحتوي تنسيق الرمز الرسومي على عنصر نائب واحد أو أكثر، ويتم استبدال هذه العناصر بالقيم المناسبة استنادًا إلى glyphType أو glyphSymbol. تتّبع العناصر النائبة النمط %[nestingLevel]. بالإضافة إلى ذلك، يمكن أن تتضمّن العناصر النائبة بادئات ولاحقات. وبالتالي، يتبع تنسيق الرمز النمطي <prefix>%[nestingLevel]<suffix>. يُرجى العِلم أنّ البادئة واللاحقة اختياريتان ويمكن أن تكونا سلاسل عشوائية.

على سبيل المثال، يشير تنسيق الرمز %0. إلى أنّ الرمز المعروض سيستبدل العنصر النائب بالرمز المقابل لمستوى التداخل 0 متبوعًا بنقطة كلاحقة. وبالتالي، ستؤدي قائمة بنوع حرف رسومي UPPER_ALPHA وتنسيق حرف رسومي %0. في مستوى التداخل 0 إلى قائمة تتضمّن أحرفًا رسومية معروضة.

A.

B.

C.

يمكن أن يحتوي تنسيق الرمز الرسومي على عناصر نائبة لمستوى التداخل الحالي بالإضافة إلى عناصر نائبة لمستويات التداخل الرئيسية. على سبيل المثال، يمكن أن تتضمّن القائمة تنسيق حرف رسومي %0. في مستوى الدمج 0 وتنسيق حرف رسومي %0.%1. في مستوى الدمج 1. بافتراض أنّ كلا مستويَي التداخل يحتويان على أنواع رموز DECIMAL، سيؤدي ذلك إلى إنشاء قائمة تتضمّن رموزًا معروضة

1.

2.

2.1.

2.2.

3.

بالنسبة إلى مستويات التداخل المرتبة، تعتمد السلسلة التي تحل محل العنصر النائب في تنسيق الرمز الرسومي لفقرة معيّنة على ترتيب الفقرة ضمن القائمة.

indentFirstLine

object (Dimension)

مقدار المسافة البادئة للسطر الأول من الفقرات في مستوى التداخل هذا

indentStart

object (Dimension)

مقدار المسافة البادئة للفقرات في هذا المستوى من التداخل. يتم تطبيقه على الجانب الذي يتوافق مع بداية النص، استنادًا إلى اتجاه محتوى الفقرة.

textStyle

object (TextStyle)

تمثّل هذه السمة نمط النص الخاص بالرموز النقطية في مستوى الدمج هذا.

startNumber

integer

عدد عنصر القائمة الأول في مستوى الدمج هذا

يتم التعامل مع القيمة 0 على أنّها القيمة 1 في القوائم التي تستخدم الأحرف والقوائم التي تستخدم الأرقام الرومانية. بالنسبة إلى القيمتين 0 و1، ستبدأ القوائم التي تتضمّن أحرفًا وأرقامًا رومانية بالرقم a وi على التوالي.

يتم تجاهل هذه القيمة لمستويات التداخل التي تحتوي على رموز غير مرتبة.

حقل الدمج glyph_kind نوع الرمز الرسومي المستخدَم في التعداد النقطي. تحدّد هذه السمة رمز النقطة الذي يحلّ محل العناصر النائبة في glyph_format. يمكن أن تكون glyph_kind إحدى القيم التالية فقط:
glyphType

enum (GlyphType)

نوع الرمز الرسومي المستخدَم في التعداد النقطي عند ترتيب الفقرات في مستوى التداخل هذا

يحدّد نوع الرمز الرسومي نوع الرمز الرسومي المستخدَم لاستبدال العناصر النائبة ضمن glyphFormat عند ترتيب الفقرات في مستوى التداخل هذا. على سبيل المثال، إذا كان مستوى التداخل 0، وكان glyphFormat هو %0. وكان نوع الحرف الرسومي DECIMAL، سيحل الحرف الرسومي المعروض محل العنصر النائب %0 في تنسيق الحرف الرسومي برقم يتوافق مع ترتيب عنصر القائمة ضمن القائمة.

glyphSymbol

string

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

يحلّ رمز الحرف الرسومي محل العناصر النائبة ضمن glyphFormat. على سبيل المثال، إذا كان glyphSymbol هو الدائرة المصمتة التي تتوافق مع نقطة الرمز Unicode U+25cf، وكان glyphFormat هو %0، سيكون الرمز الرسومي المعروض هو الدائرة المصمتة.

BulletAlignment

أنواع المحاذاة لنقطة تعداد

عمليات التعداد
BULLET_ALIGNMENT_UNSPECIFIED لم يتم تحديد محاذاة النقطة.
START تتم محاذاة النقطة مع بداية المساحة المخصّصة لعرضها. تتم محاذاته إلى اليمين إذا كان النص مكتوبًا بلغة تُقرأ من اليسار إلى اليمين، وإلى اليسار في الحالات الأخرى.
CENTER تتم محاذاة الرمز النقطي إلى وسط المساحة المخصّصة لعرضه.
END تتم محاذاة النقطة إلى نهاية المساحة المخصّصة لعرضها. تتم محاذاته إلى اليمين إذا كان النص مكتوبًا من اليسار إلى اليمين، وإلى اليسار في الحالات الأخرى.

GlyphType

أنواع الرموز الرسومية التي تستخدمها النقاط عند ترتيب الفقرات في مستوى التداخل هذا

عمليات التعداد
GLYPH_TYPE_UNSPECIFIED نوع الرمز الرسومي غير محدّد أو غير متوافق.
NONE سلسلة فارغة
DECIMAL رقم، مثل 1 أو 2 أو 3
ZERO_DECIMAL رقم يتم فيه إضافة صفر قبل الأرقام المكوّنة من رقم واحد، مثل 01 أو 02 أو 03 لا تتم إضافة صفر قبل الأرقام التي تتضمّن أكثر من رقم واحد.
UPPER_ALPHA حرف كبير، مثل A أو B أو C
ALPHA حرف صغير، مثل a أو b أو c
UPPER_ROMAN رقم روماني بأحرف كبيرة، مثل I أو II أو III
ROMAN رقم روماني صغير، مثل i أو ii أو iii

SuggestedListProperties

تغيير مقترَح على ListProperties

تمثيل JSON
{
  "listProperties": {
    object (ListProperties)
  },
  "listPropertiesSuggestionState": {
    object (ListPropertiesSuggestionState)
  }
}
الحقول
listProperties

object (ListProperties)

ListProperties لا يتضمّن سوى التغييرات التي تم إجراؤها في هذا الاقتراح. يمكن استخدام هذا الحقل مع listPropertiesSuggestionState لمعرفة الحقول التي تم تغييرها وقيمها الجديدة.

listPropertiesSuggestionState

object (ListPropertiesSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في ListProperties الأساسي.

ListPropertiesSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في ListProperties الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

تمثيل JSON
{
  "nestingLevelsSuggestionStates": [
    {
      object (NestingLevelSuggestionState)
    }
  ]
}
الحقول
nestingLevelsSuggestionStates[]

object (NestingLevelSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من NestingLevel المقابل في nestingLevels.

يتم عرض حالات اقتراحات مستوى التداخل بترتيب تصاعدي لمستوى التداخل، ويتم عرض أقل مستوى تداخلاً أولاً.

NestingLevelSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في NestingLevel الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

تمثيل JSON
{
  "bulletAlignmentSuggested": boolean,
  "glyphTypeSuggested": boolean,
  "glyphFormatSuggested": boolean,
  "glyphSymbolSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "startNumberSuggested": boolean
}
الحقول
bulletAlignmentSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على bulletAlignment.

glyphTypeSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على glyphType.

glyphFormatSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على glyphFormat.

glyphSymbolSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على glyphSymbol.

indentFirstLineSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على indentFirstLine.

indentStartSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على indentStart.

textStyleSuggestionState

object (TextStyleSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن text style

startNumberSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على startNumber.

NamedRanges

مجموعة من كل NamedRange في المستند التي تشترك في اسم معيّن

تمثيل JSON
{
  "name": string,
  "namedRanges": [
    {
      object (NamedRange)
    }
  ]
}
الحقول
name

string

تمثّل هذه السمة الاسم الذي تشترك فيه جميع named ranges.

namedRanges[]

object (NamedRange)

NamedRange التي تتشارك الاسم نفسه

NamedRange

مجموعة من Ranges لها معرّف النطاق المُعنوَن نفسه.

تسمح النطاقات المسماة للمطوّرين بربط أجزاء من المستند بتصنيف عشوائي يحدّده المستخدم حتى يمكن قراءة محتواه أو تعديله آليًا في وقت لاحق. يمكن أن يحتوي المستند على نطاقات مُسمّاة متعددة تحمل الاسم نفسه، ولكن لكل نطاق مُسمّى رقم تعريف فريد.

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

النطاقات المُعنوَنة ليست خاصة. يمكن لجميع التطبيقات والمتعاونين الذين لديهم إذن الوصول إلى المستند الاطّلاع على النطاقات المسماة.

تمثيل JSON
{
  "namedRangeId": string,
  "name": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
الحقول
namedRangeId

string

معرّف النطاق المُعنوَن.

name

string

تمثّل هذه السمة اسم النطاق المُعنوَن.

ranges[]

object (Range)

النطاقات التي تنتمي إلى هذا النطاق المُعنوَن

النطاق

تحدّد هذه السمة نطاقًا متجاورًا من النص.

تمثيل JSON
{
  "segmentId": string,
  "startIndex": integer,
  "endIndex": integer,
  "tabId": string
}
الحقول
segmentId

string

تمثّل هذه السمة معرّف الرأس أو التذييل أو الحاشية السفلية التي يتضمّنها هذا النطاق. يشير رقم تعريف القسم الفارغ إلى نص المستند.

startIndex

integer

فهرس البدء المستند إلى الصفر لهذا النطاق، بوحدات رموز UTF-16

في جميع الاستخدامات الحالية، يجب توفير فهرس بدء. هذا الحقل هو Int32Value لاستيعاب حالات الاستخدام المستقبلية ذات النطاقات المفتوحة.

endIndex

integer

فهرس النهاية المستند إلى الصفر لهذا النطاق، باستثناء النهاية، بوحدات رموز UTF-16

في جميع الاستخدامات الحالية، يجب توفير فهرس نهائي. هذا الحقل هو Int32Value لاستيعاب حالات الاستخدام المستقبلية ذات النطاقات المفتوحة.

tabId

string

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

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

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

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

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

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

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

InlineObject

عنصر يظهر مضمّنًا مع النص يحتوي InlineObject على EmbeddedObject مثل صورة.

تمثيل JSON
{
  "objectId": string,
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "suggestedInlineObjectPropertiesChanges": {
    string: {
      object (SuggestedInlineObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
الحقول
objectId

string

معرّف هذا العنصر المضمّن. يمكن استخدامها لتعديل سمات أحد العناصر.

inlineObjectProperties

object (InlineObjectProperties)

تمثّل هذه السمة خصائص هذا العنصر المضمّن.

suggestedInlineObjectPropertiesChanges

map (key: string, value: object (SuggestedInlineObjectProperties))

التغييرات المقترَحة على خصائص الكائن المضمّن، ويتم تحديد مفاتيحها حسب رقم تعريف الاقتراح.

suggestedInsertionId

string

المعرّف المقترَح للإدراج إذا كانت فارغة، فهذا يعني أنّها ليست موضع إعلان مقترَحًا.

suggestedDeletionIds[]

string

معرّفات الحذف المقترَحة. إذا كان الحقل فارغًا، يعني ذلك أنّه لا توجد عمليات حذف مقترَحة لهذا المحتوى.

InlineObjectProperties

خصائص InlineObject

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

object (EmbeddedObject)

الكائن المضمّن لهذا الكائن المضمّن.

EmbeddedObject

تمثّل هذه السمة عنصرًا مضمّنًا في المستند.

تمثيل JSON
{
  "title": string,
  "description": string,
  "embeddedObjectBorder": {
    object (EmbeddedObjectBorder)
  },
  "size": {
    object (Size)
  },
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "linkedContentReference": {
    object (LinkedContentReference)
  },

  // Union field properties can be only one of the following:
  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
  // End of list of possible types for union field properties.
}
الحقول
title

string

تمثّل هذه السمة عنوان العنصر المضمّن. يتم دمج title وdescription معًا لعرض النص البديل.

description

string

وصف العنصر المضمّن يتم دمج title وdescription معًا لعرض النص البديل.

embeddedObjectBorder

object (EmbeddedObjectBorder)

حدّ الكائن المضمّن

size

object (Size)

حجم الصورة المرئي بعد الاقتصاص

marginTop

object (Dimension)

الهامش العلوي للكائن المضمّن

marginBottom

object (Dimension)

تمثّل هذه السمة الهامش السفلي للكائن المضمّن.

marginRight

object (Dimension)

الهامش الأيمن للكائن المضمّن

marginLeft

object (Dimension)

الهامش الأيسر للكائن المضمّن

linkedContentReference

object (LinkedContentReference)

تمثّل هذه السمة مرجعًا إلى المحتوى الخارجي المرتبط بالمصدر. على سبيل المثال، يحتوي على مرجع إلى الرسم البياني المصدر في "جداول بيانات Google" عندما يكون العنصر المضمّن عبارة عن رسم بياني مرتبط.

إذا لم يتم ضبط هذه السمة، لن يتم ربط الكائن المضمّن.

حقل الدمج properties السمات الخاصة بكل نوع من أنواع الكائنات المضمّنة يمكن أن تكون properties إحدى القيم التالية فقط:
embeddedDrawingProperties

object (EmbeddedDrawingProperties)

خصائص الرسم المضمّن

imageProperties

object (ImageProperties)

تمثّل هذه السمة خصائص الصورة.

EmbeddedDrawingProperties

لا يتضمّن هذا النوع أي حقول.

خصائص الرسم المضمّن والمستخدَمة للتمييز بين أنواع الكائنات الرسم المضمّن هو رسم يتم إنشاؤه وتعديله داخل مستند. يُرجى العِلم أنّه لا يمكن تقديم تفاصيل موسّعة.

ImageProperties

تمثّل هذه السمة خصائص الصورة.

تمثيل JSON
{
  "contentUri": string,
  "sourceUri": string,
  "brightness": number,
  "contrast": number,
  "transparency": number,
  "cropProperties": {
    object (CropProperties)
  },
  "angle": number
}
الحقول
contentUri

string

معرّف URI للصورة بمدة صلاحية تلقائية تبلغ 30 دقيقة يتم وضع علامة على معرّف الموارد المنتظم هذا باستخدام حساب مقدّم الطلب. يمكن لأي شخص لديه معرّف URI الوصول إلى الصورة كما لو كان هو صاحب الطلب الأصلي. قد تفقد إمكانية الوصول إلى الصورة إذا تم تغيير إعدادات مشاركة المستند.

sourceUri

string

معرّف الموارد المنتظم المصدر هو المعرّف المستخدَم لإدراج الصورة. يمكن أن يكون معرّف الموارد المنتظم (URI) للمستند المصدر فارغًا.

brightness

number

تأثير سطوع الصورة يجب أن تكون القيمة في الفاصل الزمني [-1.0, 1.0]، حيث يعني 0 عدم حدوث أي تأثير.

contrast

number

تأثير التباين في الصورة يجب أن تكون القيمة في الفاصل الزمني [-1.0, 1.0]، حيث يعني 0 عدم حدوث أي تأثير.

transparency

number

تأثير الشفافية للصورة يجب أن تكون القيمة في الفاصل الزمني [0.0, 1.0]، حيث يعني 0 عدم التأثير ويعني 1 الشفافية.

cropProperties

object (CropProperties)

خصائص اقتصاص الصورة

angle

number

زاوية التدوير في اتجاه عقارب الساعة للصورة، بوحدة الراديان

CropProperties

خصائص اقتصاص الصورة

يتم تمثيل مستطيل الاقتصاص باستخدام إزاحات كسرية من الحواف الأربع للمحتوى الأصلي.

  • إذا كان الإزاحة في الفترة (0, 1)، يتم وضع الحافة المقابلة لمستطيل الاقتصاص داخل المستطيل المحيط الأصلي للصورة.
  • إذا كانت قيمة الإزاحة سالبة أو أكبر من 1، يتم وضع الحافة المقابلة لمستطيل الاقتصاص خارج المستطيل المحيط الأصلي للصورة.
  • إذا كانت جميع الإزاحات وزوايا الدوران تساوي 0، لن يتم اقتصاص الصورة.
تمثيل JSON
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
الحقول
offsetLeft

number

يحدّد الإزاحة مقدار المسافة إلى الداخل بين الحافة اليسرى لمستطيل الاقتصاص والحافة اليسرى للمحتوى الأصلي كجزء من عرض المحتوى الأصلي.

offsetRight

number

يحدّد الإزاحة مقدار المسافة بين الحافة اليمنى لمستطيل الاقتصاص والحافة اليمنى للمحتوى الأصلي كجزء من عرض المحتوى الأصلي.

offsetTop

number

تحدّد الإزاحة المسافة الداخلية بين الحافة العلوية لمستطيل الاقتصاص والحافة العلوية للمحتوى الأصلي كجزء من ارتفاع المحتوى الأصلي.

offsetBottom

number

يحدّد الإزاحة المسافة الداخلية للحافة السفلية لمستطيل الاقتصاص من الحافة السفلية للمحتوى الأصلي كجزء من ارتفاع المحتوى الأصلي.

angle

number

زاوية التدوير في اتجاه عقارب الساعة لمستطيل الاقتصاص حول مركزه، بوحدات الراديان يتم تطبيق التدوير بعد الإزاحات.

EmbeddedObjectBorder

إطار حول EmbeddedObject

تمثيل JSON
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle),
  "propertyState": enum (PropertyState)
}
الحقول
color

object (OptionalColor)

لون الحدود

width

object (Dimension)

تمثّل هذه السمة عرض الحدود.

dashStyle

enum (DashStyle)

نمط الشرطة للحد

propertyState

enum (PropertyState)

حالة سمة الحدود

PropertyState

تمثّل هذه السمة الحالات المحتملة لمكان مخصّص للاستئجار.

عمليات التعداد
RENDERED إذا كانت حالة إحدى السمات هي RENDERED، يعني ذلك أنّ العنصر يتضمّن السمة المقابلة عند عرضه في المستند. هذه هي القيمة الافتراضية.
NOT_RENDERED إذا كانت حالة إحدى السمات هي NOT_RENDERED، يعني ذلك أنّ العنصر لا يتضمّن السمة المقابلة عند عرضه في المستند.

LinkedContentReference

تمثّل هذه السمة مرجعًا إلى المحتوى الخارجي المرتبط بالمصدر.

تمثيل JSON
{

  // Union field reference can be only one of the following:
  "sheetsChartReference": {
    object (SheetsChartReference)
  }
  // End of list of possible types for union field reference.
}
الحقول
حقل الدمج reference المرجع الخاص بنوع المحتوى المرتبط يمكن أن تكون reference إحدى القيم التالية فقط:
sheetsChartReference

object (SheetsChartReference)

مرجع إلى الرسم البياني المرتبط

SheetsChartReference

إشارة إلى رسم بياني مرتبط مضمّن من "جداول بيانات Google"

تمثيل JSON
{
  "spreadsheetId": string,
  "chartId": integer
}
الحقول
spreadsheetId

string

رقم تعريف جدول بيانات Google الذي يحتوي على الرسم البياني المصدر

chartId

integer

معرّف الرسم البياني المحدّد في جدول بيانات Google الذي تم تضمينه

SuggestedInlineObjectProperties

تغيير مقترَح على InlineObjectProperties

تمثيل JSON
{
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "inlineObjectPropertiesSuggestionState": {
    object (InlineObjectPropertiesSuggestionState)
  }
}
الحقول
inlineObjectProperties

object (InlineObjectProperties)

InlineObjectProperties لا يتضمّن سوى التغييرات التي تم إجراؤها في هذا الاقتراح. يمكن استخدام هذا الحقل مع inlineObjectPropertiesSuggestionState لمعرفة الحقول التي تم تغييرها وقيمها الجديدة.

inlineObjectPropertiesSuggestionState

object (InlineObjectPropertiesSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في InlineObjectProperties الأساسي.

InlineObjectPropertiesSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في InlineObjectProperties الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

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

object (EmbeddedObjectSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن embeddedObject

EmbeddedObjectSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في EmbeddedObject الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

تمثيل JSON
{
  "embeddedDrawingPropertiesSuggestionState": {
    object (EmbeddedDrawingPropertiesSuggestionState)
  },
  "imagePropertiesSuggestionState": {
    object (ImagePropertiesSuggestionState)
  },
  "titleSuggested": boolean,
  "descriptionSuggested": boolean,
  "embeddedObjectBorderSuggestionState": {
    object (EmbeddedObjectBorderSuggestionState)
  },
  "sizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginLeftSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "linkedContentReferenceSuggestionState": {
    object (LinkedContentReferenceSuggestionState)
  }
}
الحقول
embeddedDrawingPropertiesSuggestionState

object (EmbeddedDrawingPropertiesSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن embeddedDrawingProperties

imagePropertiesSuggestionState

object (ImagePropertiesSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن imageProperties

titleSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على title.

descriptionSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على description.

embeddedObjectBorderSuggestionState

object (EmbeddedObjectBorderSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن embeddedObjectBorder

sizeSuggestionState

object (SizeSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن size

marginLeftSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على marginLeft.

marginRightSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على marginRight.

marginTopSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على marginTop.

marginBottomSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على marginBottom.

linkedContentReferenceSuggestionState

object (LinkedContentReferenceSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن linkedContentReference

EmbeddedDrawingPropertiesSuggestionState

لا يتضمّن هذا النوع أي حقول.

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في EmbeddedDrawingProperties الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

ImagePropertiesSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في ImageProperties الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

تمثيل JSON
{
  "contentUriSuggested": boolean,
  "sourceUriSuggested": boolean,
  "brightnessSuggested": boolean,
  "contrastSuggested": boolean,
  "transparencySuggested": boolean,
  "cropPropertiesSuggestionState": {
    object (CropPropertiesSuggestionState)
  },
  "angleSuggested": boolean
}
الحقول
contentUriSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على contentUri.

sourceUriSuggested

boolean

تشير إلى ما إذا كان هناك تغيير مقترَح على [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri].

brightnessSuggested

boolean

تشير إلى ما إذا كان هناك تغيير مقترَح على [السطوع] [google.apps.docs.v1.EmbeddedObject.brightness].

contrastSuggested

boolean

تشير إلى ما إذا كان هناك تغيير مقترَح على [التباين] [google.apps.docs.v1.EmbeddedObject.contrast].

transparencySuggested

boolean

تشير إلى ما إذا كان هناك تغيير مقترَح على [الشفافية] [google.apps.docs.v1.EmbeddedObject.transparency].

cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن cropProperties

angleSuggested

boolean

تشير إلى ما إذا كان هناك تغيير مقترَح على [الزاوية] [google.apps.docs.v1.EmbeddedObject.angle].

CropPropertiesSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في CropProperties الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

تمثيل JSON
{
  "offsetLeftSuggested": boolean,
  "offsetRightSuggested": boolean,
  "offsetTopSuggested": boolean,
  "offsetBottomSuggested": boolean,
  "angleSuggested": boolean
}
الحقول
offsetLeftSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على offsetLeft.

offsetRightSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على offsetRight.

offsetTopSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على offsetTop.

offsetBottomSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على offsetBottom.

angleSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على angle.

EmbeddedObjectBorderSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في EmbeddedObjectBorder الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

تمثيل JSON
{
  "colorSuggested": boolean,
  "widthSuggested": boolean,
  "dashStyleSuggested": boolean,
  "propertyStateSuggested": boolean
}
الحقول
colorSuggested

boolean

تشير إلى ما إذا كان هناك تغيير مقترَح على [color] [google.apps.docs.v1.EmbeddedBorderObject.color].

widthSuggested

boolean

تشير إلى ما إذا كان هناك تغيير مقترَح على [العرض] [google.apps.docs.v1.EmbeddedBorderObject.width].

dashStyleSuggested

boolean

تشير إلى ما إذا كان هناك تغيير مقترَح على [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style].

propertyStateSuggested

boolean

تشير إلى ما إذا كان هناك تغيير مقترَح على [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state].

LinkedContentReferenceSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في LinkedContentReference الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

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

object (SheetsChartReferenceSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن sheetsChartReference

SheetsChartReferenceSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في SheetsChartReference الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

تمثيل JSON
{
  "spreadsheetIdSuggested": boolean,
  "chartIdSuggested": boolean
}
الحقول
spreadsheetIdSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على spreadsheetId.

chartIdSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على chartId.

PositionedObject

عنصر مرتبط بعنصر Paragraph وموضّع بالنسبة إلى بداية الفقرة. يحتوي PositionedObject على EmbeddedObject مثل صورة.

تمثيل JSON
{
  "objectId": string,
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "suggestedPositionedObjectPropertiesChanges": {
    string: {
      object (SuggestedPositionedObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
الحقول
objectId

string

معرّف هذا العنصر الموضّع.

positionedObjectProperties

object (PositionedObjectProperties)

خصائص هذا العنصر الموضّع

suggestedPositionedObjectPropertiesChanges

map (key: string, value: object (SuggestedPositionedObjectProperties))

التغييرات المقترَحة على خصائص الكائن الموضّع، ويتم تحديدها باستخدام معرّف الاقتراح.

suggestedInsertionId

string

المعرّف المقترَح للإدراج إذا كانت فارغة، فهذا يعني أنّها ليست موضع إعلان مقترَحًا.

suggestedDeletionIds[]

string

معرّفات الحذف المقترَحة. إذا كان الحقل فارغًا، يعني ذلك أنّه لا توجد عمليات حذف مقترَحة لهذا المحتوى.

PositionedObjectProperties

خصائص PositionedObject

تمثيل JSON
{
  "positioning": {
    object (PositionedObjectPositioning)
  },
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
الحقول
positioning

object (PositionedObjectPositioning)

تحديد موضع هذا العنصر الذي تم تحديد موضعه بالنسبة إلى سطر جديد من Paragraph الذي يشير إلى هذا العنصر الذي تم تحديد موضعه

embeddedObject

object (EmbeddedObject)

العنصر المضمّن لهذا العنصر الموضّع.

PositionedObjectPositioning

موضع PositionedObject يتم تحديد موضع العنصر المحدّد بالنسبة إلى بداية Paragraph الذي يرتبط به.

تمثيل JSON
{
  "layout": enum (PositionedObjectLayout),
  "leftOffset": {
    object (Dimension)
  },
  "topOffset": {
    object (Dimension)
  }
}
الحقول
layout

enum (PositionedObjectLayout)

تنسيق هذا العنصر الموضّع.

leftOffset

object (Dimension)

إزاحة الحافة اليسرى للعنصر الذي تمّ تحديد موضعه بالنسبة إلى بداية Paragraph الذي تمّ ربطه به يمكن أن يعتمد موضع الكائن الدقيق على المحتوى الآخر في المستند وتنسيق المستند.

topOffset

object (Dimension)

إزاحة الحافة العلوية للعنصر الذي تمّ تحديد موضعه بالنسبة إلى بداية Paragraph الذي تمّ ربطه به يمكن أن يعتمد موضع الكائن الدقيق على المحتوى الآخر في المستند وتنسيق المستند.

PositionedObjectLayout

التنسيقات المحتملة لـ [PositionedObject][google.aps.docs.v1.PositionedObject].

عمليات التعداد
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED لم يتم تحديد التنسيق.
WRAP_TEXT يلتف النص حول العنصر الذي تمّت محاذاته.
BREAK_LEFT يقسّم النص بحيث يكون العنصر الذي تمّت محاذاته على اليسار والنص على اليمين.
BREAK_RIGHT يقسّم النص بحيث يكون العنصر الذي تمّت محاذاته على اليمين والنص على اليسار.
BREAK_LEFT_RIGHT يقسم النص بحيث لا يظهر أي نص على يمين العنصر الموضّع أو يساره.
IN_FRONT_OF_TEXT يكون العنصر الذي تم ضبط موضعه أمام النص.
BEHIND_TEXT يكون الكائن الذي تم ضبط موضعه خلف النص.

SuggestedPositionedObjectProperties

تغيير مقترَح على PositionedObjectProperties

تمثيل JSON
{
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "positionedObjectPropertiesSuggestionState": {
    object (PositionedObjectPropertiesSuggestionState)
  }
}
الحقول
positionedObjectProperties

object (PositionedObjectProperties)

PositionedObjectProperties لا يتضمّن سوى التغييرات التي تم إجراؤها في هذا الاقتراح. يمكن استخدام هذا الحقل مع positionedObjectPropertiesSuggestionState لمعرفة الحقول التي تم تغييرها وقيمها الجديدة.

positionedObjectPropertiesSuggestionState

object (PositionedObjectPropertiesSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في PositionedObjectProperties الأساسي.

PositionedObjectPropertiesSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في PositionedObjectProperties الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

تمثيل JSON
{
  "positioningSuggestionState": {
    object (PositionedObjectPositioningSuggestionState)
  },
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
الحقول
positioningSuggestionState

object (PositionedObjectPositioningSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن positioning

embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح ضمن embeddedObject

PositionedObjectPositioningSuggestionState

قناع يشير إلى الحقول التي تم تغييرها في هذا الاقتراح من الحقول المتوفّرة في PositionedObjectPositioning الأساسي. لكل حقل تم ضبطه على "صحيح"، هناك قيمة مقترَحة جديدة.

تمثيل JSON
{
  "layoutSuggested": boolean,
  "leftOffsetSuggested": boolean,
  "topOffsetSuggested": boolean
}
الحقول
layoutSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على layout.

leftOffsetSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على leftOffset.

topOffsetSuggested

boolean

توضّح ما إذا كان هناك تغيير مقترَح على topOffset.

SuggestionsViewMode

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

عمليات التعداد
DEFAULT_FOR_CURRENT_ACCESS يعتمد SuggestionsViewMode المُطبَّق على المستند الذي تم عرضه على مستوى وصول المستخدم الحالي. إذا كان لدى المستخدم إذن بالاطّلاع فقط، يتم تطبيق PREVIEW_WITHOUT_SUGGESTIONS. في الحالات الأخرى، يتم تطبيق التصنيف SUGGESTIONS_INLINE. هذا هو وضع العرض التلقائي للاقتراحات.
SUGGESTIONS_INLINE

يحتوي المستند الذي تم إرجاعه على اقتراحات مضمّنة. سيتم التمييز بين التغييرات المقترَحة والمحتوى الأساسي داخل المستند.

ستعرض الطلبات باسترداد مستند باستخدام هذا الوضع الخطأ 403 إذا لم يكن لدى المستخدم إذن بعرض التغييرات المقترَحة.

PREVIEW_SUGGESTIONS_ACCEPTED

المستند الذي يتم عرضه هو معاينة تم فيها قبول جميع التغييرات المقترَحة.

ستعرض الطلبات باسترداد مستند باستخدام هذا الوضع الخطأ 403 إذا لم يكن لدى المستخدم إذن بعرض التغييرات المقترَحة.

PREVIEW_WITHOUT_SUGGESTIONS المستند الذي يتم إرجاعه هو معاينة تم فيها رفض جميع التغييرات المقترَحة إذا كان هناك أي اقتراحات في المستند.

الطُرق

batchUpdate

تطبيق تحديث واحد أو أكثر على المستند

create

ينشئ مستندًا فارغًا باستخدام العنوان المقدَّم في الطلب.

get

تعرض هذه الطريقة أحدث إصدار من المستند المحدّد.