יצירת מסמך ריק באמצעות הכותרת שצוינה בבקשה. המערכת מתעלמת משדות אחרים בבקשה, כולל תוכן שסופק.
הפונקציה מחזירה את המסמך שנוצר.
בקשת HTTP
POST https://docs.googleapis.com/v1/documents
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג ב-JSON |
---|
{ "documentId": string, "title": string, "tabs": [ { object ( |
שדות | |
---|---|
document |
פלט בלבד. המזהה של המסמך. |
title |
כותרת המסמך. |
tabs[] |
כרטיסיות שנכללות במסמך. כרטיסיות יכולות להכיל כרטיסיות צאצא, כרטיסייה שמוטמעת בכרטיסייה אחרת. הכרטיסיות הצאצאיות מיוצגות בשדה |
revision |
פלט בלבד. מזהה הגרסה של המסמך. אפשר להשתמש בו בבקשות לעדכון כדי לציין על איזו גרסה של מסמך להחיל את העדכונים ואיך הבקשה צריכה לפעול אם המסמך עבר עריכה מאז הגרסה הזו. השדה מאוכלס רק אם למשתמש יש גישת עריכה למסמך. מזהה הגרסה הוא לא מספר רציף אלא מחרוזת אטומה. הפורמט של מזהה הגרסה עשוי להשתנות עם הזמן. מזהה הגרסה המוחזרת תקף רק למשך 24 שעות לאחר ההחזרה, ואי אפשר לשתף אותו בין משתמשים. אם מזהה הגרסה לא משתנה בין הקריאות, סימן שהמסמך לא השתנה. לעומת זאת, מזהה שהשתנה (באותו מסמך ובאותו משתמש) בדרך כלל מציין שהמסמך עודכן. עם זאת, שינוי במזהה יכול לנבוע גם מגורמים פנימיים, כמו שינויים בפורמט המזהה. |
suggestions |
פלט בלבד. מצב תצוגת ההצעות שהוחל על המסמך. הערה: כשעורכים מסמך, השינויים חייבים להתבסס על מסמך עם |
body |
פלט בלבד. גוף המסמך הראשי. שדה מדור קודם: במקום זאת, משתמשים ב- |
headers |
פלט בלבד. הכותרות במסמך, לפי מפתח של מזהה כותרת. שדה מדור קודם: במקום זאת, משתמשים ב- |
footers |
פלט בלבד. כותרות התחתונות במסמך, לפי מפתח של מזהה כותרת תחתונה. שדה מדור קודם: במקום זאת, משתמשים ב- |
footnotes |
פלט בלבד. הערות השוליים במסמך, לפי מפתח של מזהה הערת שוליים. שדה מדור קודם: במקום זאת, משתמשים ב- |
document |
פלט בלבד. סגנון המסמך. שדה מדור קודם: במקום זאת, משתמשים ב- |
suggested |
פלט בלבד. השינויים המוצעים בסגנון של המסמך, לפי מזהה ההצעה. שדה מדור קודם: במקום זאת, משתמשים ב- |
named |
פלט בלבד. הסגנונות של המסמך שצוינו בשם. שדה מדור קודם: במקום זאת, משתמשים ב- |
suggested |
פלט בלבד. השינויים המוצעים בסגנונות השם של המסמך, לפי מזהה ההצעה. שדה מדור קודם: במקום זאת, משתמשים ב- |
lists |
פלט בלבד. הרשימות במסמך, לפי מפתח של מזהה רשימה. שדה מדור קודם: במקום זאת, משתמשים ב- |
named |
פלט בלבד. טווחי התאים בעלי השם במסמך, לפי מפתחות שמבוססים על השם. שדה מדור קודם: במקום זאת, משתמשים ב- |
inline |
פלט בלבד. האובייקטים שמוצגים בשורה במסמך, לפי מפתח של מזהה אובייקט. שדה מדור קודם: במקום זאת, משתמשים ב- |
positioned |
פלט בלבד. האובייקטים הממוקמים במסמך, לפי מפתח של מזהה אובייקט. שדה מדור קודם: במקום זאת, משתמשים ב- |
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של Document
.
היקפי הרשאה
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/documents
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
מידע נוסף זמין במדריך ההרשאות.