Method: documents.get

指定されたドキュメントの最新バージョンを取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
documentId

string

取得するドキュメントの ID。

クエリ パラメータ

パラメータ
suggestionsViewMode

enum (SuggestionsViewMode)

ドキュメントに適用する提案ビューモード。これにより、すべての提案がインラインで表示されたドキュメントを確認できます。指定しない場合は、DEFAULT_FOR_CURRENT_ACCESS が使用されます。

includeTabsContent

boolean

Document の body や documentStyle などのテキスト コンテンツ フィールドではなく、Document.tabs フィールドに入力するかどうか。

  • true の場合: ドキュメントのコンテンツが Document のテキスト コンテンツ フィールドではなく、Document.tabs フィールドに入力されます。

  • false の場合: ドキュメントの最初のタブの内容が、Document.tabs を除く Document のコンテンツ フィールドに入力されます。ドキュメントにタブが 1 つしかない場合、そのタブを使用してドキュメントのコンテンツが入力されます。Document.tabs は空になります。

Document.tabs フィールド(またはサブフィールド)を参照するフィールド マスクを使用すると、API はリクエストを 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

詳しくは、承認ガイドをご覧ください。