Developer Knowledge API

Developer Knowledge API は、Google の公開デベロッパー ドキュメントへのプログラムによるアクセスを提供します。これにより、このナレッジベースを独自のアプリケーションやワークフローに統合できます。

概要

Developer Knowledge API は、Google のデベロッパー向けドキュメントへの機械可読アクセス用の正規ソースとなるように設計されています。ドキュメントの検索と取得、クエリへの回答を行う関数が用意されています。

• SearchDocumentChunks を使用して、クエリに基づいて関連するページの URI とコンテンツ スニペットを見つけます。
• GetDocument または BatchGetDocuments を使用して、検索結果のコンテンツ全体を取得します。
• AnswerQuery を使用して、ドキュメント コーパスから抽出されたクエリに対する回答を生成します。

Developer Knowledge API は、非構造化 Markdown コンテンツとしてドキュメント ページの検索と取得をサポートしています。検索可能なコンテンツのコーパスは、コーパス リファレンスに記載されています。

デベロッパー知識の活用方法

ワークフローに応じて、次のサーフェスから Developer Knowledge にアクセスできます。

• REST API と RPC API: HTTP エンドポイントまたは gRPC エンドポイントを直接呼び出します。メソッドの仕様については、REST リファレンスと RPC リファレンスを参照してください。
• クライアント ライブラリ: Python、Node.js、TypeScript、Go、Java、PHP、Ruby の公式クライアント ライブラリを使用して、Developer Knowledge API をアプリケーションに統合します。
• Google Cloud CLI（gcloud）: ターミナルから gcloud developer-knowledge コマンドを実行して、ドキュメント チャンクの検索、Markdown コンテンツの取得、回答の生成を行います。
• Developer Knowledge MCP サーバー: Model Context Protocol（MCP）ツール（search_documents、get_documents、answer_query）を使用して、AI コーディング アシスタントまたはエージェントを Google のドキュメントに接続します。MCP リファレンスを参照してください。

ヒント: AI コーディング アシスタントを使用している場合は、npx skills add google/skills --skill retrieving-developer-knowledge を実行して retrieving-developer-knowledge エージェント スキルをインストールします。このスキルにより、アシスタントには、どの Developer Knowledge MCP サーバーツールを選択するか、エラーを処理する方法、MCP サーバーが利用できない場合に curl で REST API を呼び出す方法に関する組み込みの指示が与えられます。詳細については、Developer Knowledge エージェント スキルを使用するをご覧ください。

API と MCP サーバーのどちらかを選択する

Developer Knowledge API と Developer Knowledge MCP サーバーは、さまざまな統合ニーズに対応するように設計されています。

• 次の場合に Developer Knowledge API、クライアント ライブラリ、または gcloud CLI を使用します。
  • プロジェクトで AI エージェントが使用されていない。
  • エージェントのカスタムツールまたはツールセットを定義する場合。
  • 結果をモデルに渡す前に処理または結合する（たとえば、完全なコンテンツを取得する前にドキュメントのバイト長を確認する）。
  • 検索結果をフィルタ（data_source や update_time など）するか、フィールド マスクを適用する必要があります。
• Developer Knowledge MCP サーバーとエージェント スキルは、次の場合に使用します。
  • カスタムのツール定義と説明を記述せずに、AI コーディング アシスタントまたはエージェントを接続したい。
  • Developer Knowledge MCP サーバーに新機能が追加されたときに自動更新を希望している。
  • 検索結果にカスタム メタデータ フィルタリングは必要ありません。

API を有効にする

Developer Knowledge API を使用するには、まず Google Cloud プロジェクトで API を有効にする必要があります。

ヒント: Google Cloud プロジェクトがない場合は、Google Cloud または Firebase の手順に沿って作成します。

1. Google API ライブラリで Developer Knowledge API ページを開きます。
2. API を使用するプロジェクトが正しく選択されていることを確認します。
3. [有効にする] をクリックします。API を有効にして使用するために、特定の IAM ロールは必要ありません。

認証

Developer Knowledge API へのリクエストは、次のいずれかの方法で認証できます。

• API キー: key クエリ パラメータまたは X-Goog-Api-Key ヘッダーを使用して、直接の REST リクエストまたは Developer Knowledge MCP サーバーを認証します。
• アプリケーションのデフォルト認証情報（ADC）、OAuth 2.0、またはサービス アカウント: 公式のクライアント ライブラリまたは本番環境のワークフローを使用する場合にリクエストを認証します。認証情報の設定の詳細については、アプリケーションのデフォルト認証情報のドキュメントをご覧ください。
• ユーザー認証情報（gcloud CLI）: gcloud auth login を使用して Google Cloud アカウントにログインし、CLI リクエストを認証します。設定手順については、gcloud CLI クイックスタートをご覧ください。

含まれるドキュメント

API で検索されるドキュメントについては、コーパス リファレンスをご覧ください。

Developer Knowledge API は、最新の Google デベロッパー ドキュメントへのアクセスを提供することを目的としています。Google の目標は、公開後 48 時間以内にコンテンツのインデックスを再作成し、新しいドキュメントや更新されたドキュメントを 2 営業日以内に利用できるようにすることです。

既知の制限事項

• マークダウンの品質: マークダウンはソース HTML から生成されます。不一致や形式の問題が発生する可能性があります。
• コンテンツの範囲: コーパス リファレンスの公開ページのみが含まれます。GitHub、OSS サイト、ブログ、YouTube などの他のソースのコンテンツは含まれません。