יצירת מסמך ריק לפי הכותרת שמופיעה בבקשה. המערכת מתעלמת משדות אחרים בבקשה, כולל תוכן שסופק.
מחזירה את המסמך שנוצר.
בקשת 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
מידע נוסף זמין במדריך להרשאות.