יצירת מסמך ריק לפי הכותרת שמופיעה בבקשה. המערכת מתעלמת משדות אחרים בבקשה, כולל תוכן שסופק.
הפונקציה מחזירה את המסמך שנוצר.
בקשת HTTP
POST https://docs.googleapis.com/v1/documents
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג ב-JSON |
---|
{ "documentId": string, "title": string, "tabs": [ { object ( |
שדות | |
---|---|
documentId |
פלט בלבד. המזהה של המסמך. |
title |
כותרת המסמך. |
tabs[] |
כרטיסיות שהן חלק ממסמך. כרטיסיות יכולות להכיל כרטיסיות צאצא, כרטיסייה שבתוך כרטיסייה אחרת. הכרטיסיות הצאצאיות מיוצגות בשדה |
revisionId |
פלט בלבד. מזהה הגרסה של המסמך. אפשר להשתמש בו בבקשות לעדכון כדי לציין על איזו גרסה של מסמך להחיל את העדכונים ואיך הבקשה צריכה לפעול אם המסמך עבר עריכה מאז הגרסה הזו. השדה הזה מאוכלס רק אם למשתמש יש גישת עריכה למסמך. מזהה הגרסה הוא לא מספר רציף, אלא מחרוזת אטומה. הפורמט של מזהה הגרסה הקודמת עשוי להשתנות עם הזמן. מובטח שמזהה הגרסה שהוחזר יהיה תקף רק ל-24 שעות לאחר החזרתו, ולא ניתן לשתף אותו עם משתמשים. אם מזהה הגרסה לא משתנה בין הקריאות, סימן שהמסמך לא השתנה. לעומת זאת, מזהה שהשתנה (באותו מסמך ובאותו משתמש) בדרך כלל מציין שהמסמך עודכן. עם זאת, שינוי המזהה יכול גם לנבוע מגורמים פנימיים, כמו שינויים בפורמט של המזהה. |
suggestionsViewMode |
פלט בלבד. מצב תצוגת ההצעות שהוחל על המסמך. הערה: כשעורכים מסמך, השינויים חייבים להתבסס על מסמך עם |
body |
פלט בלבד. התוכן הראשי של המסמך. השדה 'מדור קודם': במקום זאת, צריך להשתמש ב- |
headers |
פלט בלבד. הכותרות במסמך, לפי מפתח של מזהה כותרת. השדה 'מדור קודם': במקום זאת, צריך להשתמש ב- |
footers |
פלט בלבד. כותרות התחתונות במסמך, לפי מפתח של מזהה כותרת תחתונה. שדה מדור קודם: במקום זאת, משתמשים ב- |
footnotes |
פלט בלבד. הערות השוליים במסמך, כשהן מקובצות לפי מזהה של הערת שוליים. השדה 'מדור קודם': במקום זאת, צריך להשתמש ב- |
documentStyle |
פלט בלבד. סגנון המסמך. שדה מדור קודם: במקום זאת, משתמשים ב- |
suggestedDocumentStyleChanges |
פלט בלבד. השינויים המוצעים בסגנון של המסמך, לפי מזהה ההצעה. השדה 'מדור קודם': במקום זאת, צריך להשתמש ב- |
namedStyles |
פלט בלבד. סגנונות המסמך בעלי השם. השדה 'דור קודם': במקום זאת, צריך להשתמש ב- |
suggestedNamedStylesChanges |
פלט בלבד. ההצעות לשינויים לסגנונות של המסמך שקיבלו שם, עם מזהה ההצעה. השדה 'דור קודם': במקום זאת, צריך להשתמש ב- |
lists |
פלט בלבד. הרשימות במסמך, לפי מפתח של מזהה רשימה. שדה מדור קודם: במקום זאת, משתמשים ב- |
namedRanges |
פלט בלבד. טווחי השמות במסמך, עם קידוד לפי שם. שדה מדור קודם: במקום זאת, משתמשים ב- |
inlineObjects |
פלט בלבד. האובייקטים המוטבעים במסמך, עם קידוד לפי מזהה אובייקט. השדה 'מדור קודם': במקום זאת, צריך להשתמש ב- |
positionedObjects |
פלט בלבד. האובייקטים הממוקמים במסמך, עם קידוד לפי מזהה אובייקט. השדה 'מדור קודם': במקום זאת, צריך להשתמש ב- |
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של Document
.
היקפי ההרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/documents
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
מידע נוסף זמין במדריך ההרשאות.