Method: documents.create

یک سند خالی با استفاده از عنوان داده شده در درخواست ایجاد می‌کند. سایر فیلدهای درخواست، از جمله هرگونه محتوای ارائه شده، نادیده گرفته می‌شوند.

سند ایجاد شده را برمی‌گرداند.

درخواست HTTP

POST https://docs.googleapis.com/v1/documents

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "commentsViewMode": enum (CommentsViewMode),
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "suggestions": [
    {
      object (SuggestionThread)
    }
  ],
  "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

فقط خروجی. شناسه‌ی ویرایش سند. می‌تواند در درخواست‌های به‌روزرسانی برای مشخص کردن اینکه به‌روزرسانی‌ها روی کدام ویرایش سند اعمال شوند و اگر سند از آن ویرایش ویرایش شده باشد، درخواست چگونه باید رفتار کند، استفاده شود. فقط در صورتی پر می‌شود که کاربر دسترسی ویرایش به سند را داشته باشد.

شناسه‌ی بازبینی یک عدد ترتیبی نیست، بلکه یک رشته‌ی مبهم است. قالب شناسه‌ی بازبینی ممکن است با گذشت زمان تغییر کند. یک شناسه‌ی بازبینیِ برگردانده شده فقط تا ۲۴ ساعت پس از برگردانده شدن معتبر است و نمی‌توان آن را بین کاربران به اشتراک گذاشت. اگر شناسه‌ی بازبینی بین فراخوانی‌ها بدون تغییر باشد، سند تغییر نکرده است. برعکس، یک شناسه‌ی تغییر یافته (برای همان سند و کاربر) معمولاً به این معنی است که سند به‌روزرسانی شده است. با این حال، یک شناسه‌ی تغییر یافته همچنین می‌تواند به دلیل عوامل داخلی مانند تغییرات قالب شناسه باشد.

suggestionsViewMode

enum ( SuggestionsViewMode )

فقط خروجی. حالت نمایش پیشنهادات روی سند اعمال می‌شود.

توجه: هنگام ویرایش یک سند، تغییرات باید بر اساس سندی با SUGGESTIONS_INLINE باشد.

commentsViewMode

enum ( CommentsViewMode )

فقط خروجی. حالت نمایش نظرات به سند اعمال می‌شود.

comments[]

object ( CommentThread )

فقط خروجی. نظرات مرتبط با سند. فقط در صورتی پر می‌شود که پارامتر commentsViewMode طوری تنظیم شده باشد که نیاز به نظرات داشته باشد (مانند COMMENTS_VIEW_MODE_INCLUDED ).

suggestions[]

object ( SuggestionThread )

فقط خروجی. پیشنهادات مرتبط با سند. فقط در صورتی پر می‌شود که پارامتر commentsViewMode طوری تنظیم شده باشد که به نظرات نیاز داشته باشد (مانند COMMENTS_VIEW_MODE_INCLUDED ).

body

object ( Body )

فقط خروجی. بدنه اصلی سند.

فیلد قدیمی: در عوض، از Document.tabs.documentTab.body استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی درباره اولین تب در سند است.

headers

map (key: string, value: object ( Header ))

فقط خروجی. سرصفحه‌های موجود در سند، که با شناسه سرصفحه مشخص شده‌اند.

فیلد قدیمی: در عوض، از Document.tabs.documentTab.headers استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی درباره اولین تب در سند است.

footers

map (key: string, value: object ( Footer ))

فقط خروجی. پاورقی‌های موجود در سند، که با شناسه پاورقی مشخص شده‌اند.

فیلد قدیمی: در عوض، از Document.tabs.documentTab.footers استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی درباره اولین تب در سند است.

footnotes

map (key: string, value: object ( Footnote ))

فقط خروجی. پاورقی‌های موجود در سند، که با شناسه پاورقی مشخص شده‌اند.

فیلد قدیمی: در عوض، از Document.tabs.documentTab.footnotes استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی در مورد اولین تب در سند است.

documentStyle

object ( DocumentStyle )

فقط خروجی. سبک سند.

فیلد قدیمی: در عوض، از Document.tabs.documentTab.documentStyle استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی در مورد اولین تب در سند است.

suggestedDocumentStyleChanges

map (key: string, value: object ( SuggestedDocumentStyle ))

فقط خروجی. تغییرات پیشنهادی در سبک سند، که با شناسه پیشنهاد مشخص شده‌اند.

فیلد قدیمی: در عوض، از Document.tabs.documentTab.suggestedDocumentStyleChanges استفاده کنید، که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی در مورد اولین تب در سند است.

namedStyles

object ( NamedStyles )

فقط خروجی. سبک‌های نامگذاری شده‌ی سند.

فیلد قدیمی: در عوض، از Document.tabs.documentTab.namedStyles استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی درباره اولین تب در سند است.

suggestedNamedStylesChanges

map (key: string, value: object ( SuggestedNamedStyles ))

فقط خروجی. تغییرات پیشنهادی در سبک‌های نامگذاری شده سند، که با شناسه پیشنهاد مشخص شده‌اند.

فیلد قدیمی: در عوض، از Document.tabs.documentTab.suggestedNamedStylesChanges استفاده کنید، که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی در مورد اولین تب در سند است.

lists

map (key: string, value: object ( List ))

فقط خروجی. لیست‌های موجود در سند، که با شناسه لیست کلیدگذاری شده‌اند.

فیلد قدیمی: در عوض، از Document.tabs.documentTab.lists استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی درباره اولین تب در سند است.

namedRanges

map (key: string, value: object ( NamedRanges ))

فقط خروجی. محدوده‌های نامگذاری شده در سند، که با نام کلیدگذاری شده‌اند.

فیلد قدیمی: در عوض، از Document.tabs.documentTab.namedRanges استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی درباره اولین تب در سند است.

inlineObjects

map (key: string, value: object ( InlineObject ))

فقط خروجی. اشیاء درون‌خطی در سند، که با شناسه شیء کلیدگذاری شده‌اند.

فیلد قدیمی: در عوض، از Document.tabs.documentTab.inlineObjects استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی در مورد اولین تب در سند است.

positionedObjects

map (key: string, value: object ( PositionedObject ))

فقط خروجی. اشیاء موقعیت‌یابی‌شده در سند، که با شناسه شیء کلیدگذاری شده‌اند.

فیلد قدیمی: در عوض، از Document.tabs.documentTab.positionedObjects استفاده کنید که محتوای واقعی سند را از همه تب‌ها نمایش می‌دهد، زمانی که پارامتر includeTabsContent روی true تنظیم شده باشد. اگر false یا unset باشد، این فیلد حاوی اطلاعاتی در مورد اولین تب در سند است.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل یک نمونه تازه ایجاد شده از Document است.

دامنه‌های مجوز

به یکی از حوزه‌های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.