Method: documents.get

完全な Markdown コンテンツを含む単一のドキュメントを取得します。

HTTP リクエスト

GET https://developerknowledge.googleapis.com/v1alpha/{name=documents/**}

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

パスパラメータ

パラメータ
name

string

必須。取得するドキュメントの名前を指定します。形式: documents/{uri_without_scheme} 例: documents/docs.cloud.google.com/storage/docs/creating-buckets

名前は 500 文字以内で指定してください。500 文字を超える値は INVALID_ARGUMENT エラーになります。

クエリ パラメータ

パラメータ
view

enum (DocumentView)

省略可。ドキュメントの DocumentView を指定します。指定しない場合、DeveloperKnowledge.GetDocument はデフォルトで DOCUMENT_VIEW_CONTENT になります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には Document のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

詳細については、OAuth 2.0 Overview をご覧ください。