Method: documents.get

آخرین نسخه از سند مشخص شده را دریافت می‌کند.

درخواست HTTP

GET https://docs.googleapis.com/v1/documents/{documentId}

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

پارامترهای مسیر

پارامترها
documentId

string

شناسه سندی که قرار است بازیابی شود.

پارامترهای پرس و جو

پارامترها
suggestionsViewMode

enum ( SuggestionsViewMode )

حالت نمایش پیشنهادات برای اعمال به سند. این حالت امکان مشاهده سند را با تمام پیشنهادات درون خطی، پذیرفته شده یا رد شده فراهم می‌کند. اگر موردی مشخص نشده باشد، DEFAULT_FOR_CURRENT_ACCESS استفاده می‌شود.

includeTabsContent

boolean

آیا فیلد Document.tabs به جای فیلدهای محتوای متن مانند body و documentStyle در Document پر شود یا خیر.

  • وقتی true : محتوای سند به جای فیلدهای محتوای متن در Document در فیلد Document.tabs قرار می‌گیرد.

  • وقتی false : محتوای اولین تب سند، فیلدهای محتوا در Document را به جز Document.tabs پر می‌کند. اگر سندی فقط یک تب داشته باشد، از آن تب برای پر کردن محتوای سند استفاده می‌شود. Document.tabs خالی خواهد بود.

اگر از یک ماسک فیلد استفاده کنید که به فیلد Document.tabs (یا هر زیرفیلد دیگری) ارجاع می‌دهد، API به طور ضمنی با درخواست طوری رفتار می‌کند که انگار includeTabsContent روی true تنظیم کرده‌اید.

commentsViewMode

enum ( CommentsViewMode )

حالت نمایش نظرات برای اعمال به سند. این حالت امکان مشاهده سند را با نظرات حذف شده یا اضافه شده فراهم می‌کند. اگر نظری مشخص نشده باشد، COMMENTS_VIEW_MODE_OMITTED استفاده می‌شود.

اگر commentsViewMode روی هر مقداری تنظیم کنید، باید includeTabsContent نیز روی true تنظیم کنید یا از یک ماسک فیلد استفاده کنید که به فیلد Document.tabs (یا هر زیرفیلدی) ارجاع دهد.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

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

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

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

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

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