クイックスタート: Developer Knowledge API を使ってみる

このガイドでは、Developer Knowledge API の使用を開始する方法について説明します。このチュートリアルでは、Developer Knowledge API を有効にして API キーを取得し、最初の API 呼び出しを行ってデベロッパー ドキュメントを検索して取得する方法について説明します。

始める前に

API を有効にする

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

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 キーを取得したら、API の使用を開始できます。次の例は、「BigQuery」に関連するドキュメント チャンクを検索する方法を示しています。

  1. Developer Knowledge API キーを環境変数に保存します。

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    YOUR_API_KEY は、生成した API キーに置き換えます。

  2. curl を使用して searchDocumentChunks エンドポイントを呼び出します。

    curl "https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

このコマンドは、クエリに一致するドキュメント チャンクのリストを返します。これには、コンテンツのスニペットと各ドキュメントの parent が含まれます。

ドキュメントを取得する

searchDocumentChunks からのレスポンスには、ドキュメント チャンクのリストが含まれます。各ドキュメント チャンクには parent フィールドがあり、これを使用して GetDocument でドキュメントのコンテンツ全体を取得できます。

searchDocumentChunks 呼び出しから返されたドキュメント チャンクの 1 つの parent（documents/developers.google.com/... など）をコピーして環境変数に保存し、curl を使用して GetDocument エンドポイントを呼び出します。

export DOC_NAME="DOCUMENT_NAME"

curl "https://developerknowledge.googleapis.com/v1alpha/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

これにより、指定されたドキュメントの完全な Markdown コンテンツが返されます。

次のステップ