با استفاده از عنوان داده شده در درخواست، یک سند خالی ایجاد می کند. سایر قسمت های درخواست، از جمله هر محتوای ارائه شده، نادیده گرفته می شوند.
سند ایجاد شده را برمی گرداند.
درخواست HTTP
POST https://docs.googleapis.com/v1/documents
URL از دستور GRPC Transcoding استفاده می کند.
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "documentId": string, "title": string, "body": { object ( |
زمینه های | |
---|---|
documentId | فقط خروجی شناسه سند. |
title | عنوان سند. |
body | فقط خروجی بدنه اصلی سند. |
headers | فقط خروجی سرصفحه های موجود در سند، با شناسه سرصفحه کلید شده اند. |
footers | فقط خروجی پاورقی های موجود در سند، با شناسه پاورقی کلید زده می شوند. |
footnotes | فقط خروجی پاورقی های موجود در سند، با شناسه پاورقی کلید زده شده اند. |
documentStyle | فقط خروجی سبک سند. |
suggestedDocumentStyleChanges | فقط خروجی تغییرات پیشنهادی در سبک سند، با شناسه پیشنهاد کلید زده شده است. |
namedStyles | فقط خروجی سبک های نامگذاری شده سند. |
suggestedNamedStylesChanges | فقط خروجی تغییرات پیشنهادی در سبک های نامگذاری شده سند، با شناسه پیشنهاد کلید زده شده است. |
lists | فقط خروجی فهرستهای موجود در سند، با شناسه فهرست کلید زده میشوند. |
namedRanges | فقط خروجی محدوده های نامگذاری شده در سند، با نام کلید شده است. |
revisionId | فقط خروجی شناسه ویرایش سند. میتواند در درخواستهای بهروزرسانی استفاده شود تا مشخص شود که در کدام یک از نسخههای یک سند، بهروزرسانیها اعمال شود و اگر سند از آن تجدیدنظر ویرایش شده است، چگونه باید رفتار کند. فقط در صورتی پر می شود که کاربر دسترسی ویرایش به سند داشته باشد. شناسه تجدیدنظر یک عدد متوالی نیست بلکه یک رشته مات است. قالب شناسه بازبینی ممکن است در طول زمان تغییر کند. شناسه بازگردانی شده فقط تا 24 ساعت پس از بازگرداندن آن تضمین شده است که اعتبار دارد و نمیتوان آن را بین کاربران به اشتراک گذاشت. اگر شناسه بازبینی بین تماس ها تغییر نکرده باشد، سند تغییر نکرده است. برعکس، شناسه تغییر یافته (برای همان سند و کاربر) معمولاً به این معنی است که سند به روز شده است. با این حال، تغییر شناسه می تواند به دلیل عوامل داخلی مانند تغییر فرمت شناسه نیز باشد. |
suggestionsViewMode | فقط خروجی حالت نمایش پیشنهادات روی سند اعمال شد. توجه: هنگام ویرایش یک سند، تغییرات باید بر اساس سندی با |
inlineObjects | فقط خروجی اشیاء درون خطی در سند، با شناسه شی کلید زده می شوند. |
positionedObjects | فقط خروجی اشیاء قرار داده شده در سند، با شناسه شی کلید زده می شوند. |
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک نمونه جدید از Document
است.
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/documents
-
https://www.googleapis.com/auth/drive
-
https://www.googleapis.com/auth/drive.file
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.