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),
  "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 أو تركها بدون ضبط، سيحتوي هذا الحقل على معلومات حول علامة التبويب الأولى في المستند.

نص الاستجابة

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

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

يتطلب أحد نطاقات OAuth التالية:

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

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