このガイドでは、Developer Knowledge API の主な機能（ドキュメントの検索、単一ドキュメントの取得、複数のドキュメントの一括取得）の使用例を示します。
始める前に、API を有効にして Developer Knowledge API キーを生成し、キーを環境変数に保存していることを確認してください。
export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"
SearchDocumentChunks でドキュメントを検索する
documents.searchDocumentChunks メソッドを使用して、クエリ文字列に一致するドキュメント チャンクを見つけます。結果には、ドキュメントのコンテンツのチャンクと、ドキュメントのコンテンツ全体を取得するために使用できる parent 参照が含まれます。
次の例では、「BigQuery」に一致するドキュメントを検索します。
curl "https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"
pageSize などのパラメータを使用して検索結果を絞り込み、1 ページあたりの結果の数を制限したり、pageToken を使用して後続のページを取得したりできます。
GetDocument を使用してドキュメントを取得する
documents.get メソッドを使用して、SearchDocumentChunks 呼び出しで返された DocumentChunk.parent を使用して、単一のドキュメントのコンテンツ全体を取得します。
次の例では、documents/DOCUMENT_ID という名前のドキュメントを取得します。
curl "https://developerknowledge.googleapis.com/v1alpha/documents:get?name=documents/DOCUMENT_ID&key=$DEVELOPERKNOWLEDGE_API_KEY"
レスポンスは、content フィールドを含む完全な Document リソースです。
BatchGetDocuments を使用して複数のドキュメントを取得する
documents.batchGet メソッドを使用すると、1 回の API 呼び出しで最大 100 件のドキュメントを名前で取得できます。これは、複数の GetDocument リクエストを行うよりも効率的です。
次の例では、名前で 2 つのドキュメントを取得します。
curl "https://developerknowledge.googleapis.com/v1alpha/documents:batchGet?names=documents/DOCUMENT_ID_1&names=documents/DOCUMENT_ID_2&key=$DEVELOPERKNOWLEDGE_API_KEY"
レスポンスには、リクエストされた Document リソースのリストが含まれます。