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

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