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 ),
"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 باشد. |
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
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-02-27 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-02-27 بهوقت ساعت هماهنگ جهانی."],[[["Creates a new Google Docs document with the specified title, leaving all other content blank."],["Uses a POST request to `https://docs.googleapis.com/v1/documents` with the document title in the request body."],["Returns the newly created document object in the response."],["Requires authorization with specific Google Docs or Drive scopes."]]],[]]