Developer Knowledge API

Developer Knowledge API を使用すると、Google の公開デベロッパー ドキュメントにプログラムでアクセスできるため、このナレッジベースを独自のアプリケーションやワークフローに統合できます。

概要

Developer Knowledge API は、Google のデベロッパー ドキュメントに機械可読形式でアクセスするための正規のソースとなるように設計されています。主な機能は次の 2 つです。

すぐに始めるには、クイックスタート ガイドに沿って操作してください。

検索可能なコンテンツのコーパスは、コーパス リファレンスに記載されています。

プレビューに関する注意: このプレビュー リリースでは、ドキュメント ページを検索して 構造化されていない Markdown コンテンツとして取得できます。

API を有効にする

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

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

認証

Developer Knowledge API を使用するには、Developer Knowledge API キーが必要です。作成するには:

  1. API を有効にしたプロジェクトの Google Cloud コンソールで、 [認証情報] ページに移動します。
  2. [認証情報を作成] をクリックし、メニューから [API キー] を選択します。[API キーを作成しました] ダイアログに、新しく作成されたキーの文字列が表示されます。
  3. [API キーを編集] をクリックします。
  4. [名前] フィールドに、キーの名前を入力します。
  5. [API の制限] で [キーを制限] を選択します。
  6. [API を選択] リストで [Developer Knowledge API] を有効にして、[OK] をクリックします。
    • 注: Developer Knowledge API を有効にしたばかりの場合、[API を選択] リストに表示されるまでに遅延が発生する可能性があります。
  7. [保存] をクリックします。

この Developer Knowledge API キーをリクエストに含めます。たとえば、REST 呼び出しでは、key クエリ パラメータを使用して含める必要があります。例については、 クイックスタート ガイドをご覧ください。

含まれるドキュメント

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

既知の制限事項