Method: documents.create

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

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

בקשת HTTP

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

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

גוף הבקשה

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

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

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