Method: documents.get

يحصل هذا الطلب على أحدث إصدار من المستند المحدّد.

طلب HTTP

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

يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.

مَعلمات المسار

المعلمات
documentId

string

رقم تعريف المستند المطلوب استرداده

معلمات طلب البحث

المعلمات
suggestionsViewMode

enum (SuggestionsViewMode)

وضع عرض الاقتراحات الذي سيتم تطبيقه على المستند يتيح ذلك عرض المستند مع جميع الاقتراحات المضمّنة أو المقبولة أو المرفوضة. إذا لم يتم تحديد وضع عرض، سيتم استخدام DEFAULT_FOR_CURRENT_ACCESS.

includeTabsContent

boolean

ما إذا كان سيتم ملء حقل Document.tabs بدلاً من حقول المحتوى النصي، مثل body وdocumentStyle في Document

  • عند ضبط القيمة على true: يتم ملء محتوى المستند في حقل Document.tabs بدلاً من حقول المحتوى النصي في Document.

  • عند ضبط القيمة على false: يتم ملء حقول المحتوى في Document بمحتوى علامة التبويب الأولى في المستند، باستثناء Document.tabs. إذا كان المستند يحتوي على علامة تبويب واحدة فقط، يتم استخدام علامة التبويب هذه لملء محتوى المستند. Document.tabs سيكون فارغًا.

إذا كنت تستخدم قناع حقول يشير إلى حقل Document.tabs (أو أي حقل فرعي)، ستتعامل واجهة برمجة التطبيقات ضمنيًا مع الطلب كما لو أنّك ضبطت 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

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.