Method: documents.create

יוצר מסמך ריק עם הכותרת שצוינה בבקשה. המערכת מתעלמת משדות אחרים בבקשה, כולל תוכן שסופק.

הפונקציה מחזירה את המסמך שנוצר.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-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

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