Method: documents.create

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

تعرض هذه الطريقة المستند الذي تم إنشاؤه.

طلب HTTP

POST https://docs.googleapis.com/v1/documents

يستخدِم عنوان URL بنية تحويل الترميز إلى gRPC.

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "commentsViewMode": enum (CommentsViewMode),
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "suggestions": [
    {
      object (SuggestionThread)
    }
  ],
  "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.
commentsViewMode

enum (CommentsViewMode)

النتائج فقط. تمثّل هذه السمة وضع عرض التعليقات المطبَّق على المستند.
comments[]

object (CommentThread)

النتائج فقط. التعليقات المرتبطة بالمستند يتم ملء هذا الحقل فقط إذا تم ضبط المَعلمة commentsViewMode على طلب التعليقات (مثل COMMENTS_VIEW_MODE_INCLUDED).
suggestions[]

object (SuggestionThread)

النتائج فقط. الاقتراحات المرتبطة بالمستند يتم ملء هذا الحقل فقط إذا تم ضبط المَعلمة commentsViewMode على طلب التعليقات (مثل COMMENTS_VIEW_MODE_INCLUDED).
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 أو لم يتم ضبطها، يحتوي هذا الحقل على معلومات حول علامة التبويب الأولى في المستند.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نصها على مثال تم إنشاؤه حديثًا Document.

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.