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 (أو أي حقل فرعي).

في حال ضبط commentsViewMode على COMMENTS_VIEW_MODE_INCLUDED، عليك أيضًا ضبط suggestionsViewMode على SUGGESTIONS_INLINE بشكلٍ صريح.

إذا ضبطت commentsViewMode على COMMENTS_VIEW_MODE_INCLUDED أو COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS، قد لا تتمكّن من ضبط suggestionsViewMode على PREVIEW_WITHOUT_SUGGESTIONS أو PREVIEW_SUGGESTIONS_ACCEPTED.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نصها على مثال 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

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