Method: documents.create

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

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

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcode.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "documentId": string,
  "title": string,
  "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)
    },
    ...
  },
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
الحقول
documentId

string

الإخراج فقط. رقم تعريف المستند.
title

string

تمثّل هذه السمة عنوان المستند.
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))

الإخراج فقط. النطاقات المُعنوَنة في المستند، المرتبطة بالاسم.
revisionId

string

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

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

enum (SuggestionsViewMode)

الإخراج فقط. وضع عرض الاقتراحات المطبّق على المستند.

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

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

الإخراج فقط. تمثّل هذه السمة العناصر المضمَّنة في المستند المرتبطة برقم تعريف العنصر.
positionedObjects

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

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

نص الاستجابة

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

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

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

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

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