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

מידע נוסף זמין במדריך להרשאות.