Developer Knowledge API クライアント ライブラリ

このページでは、Developer Knowledge API の Cloud クライアント ライブラリの使用を開始する方法を説明します。クライアント ライブラリは、未加工の HTTP リクエストを構築する代わりに、慣用的な型、組み込みの認証、自動ページネーション、再試行処理を提供し、記述する必要があるコードの量を削減します。

Google APIs のクライアント ライブラリの詳細については、クライアント ライブラリの説明をご覧ください。

クライアント ライブラリをインストールする

プログラミング言語を選択して、公式の Developer Knowledge API クライアント ライブラリをインストールします。

Go

モジュールを Go プロジェクトに追加します。

go get cloud.google.com/go/developerknowledge/apiv1

詳細については、Go 開発環境の設定をご覧ください。

Java

Maven を使用する場合は、pom.xml ファイルに次の依存関係を追加します。

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-developer-knowledge</artifactId>
  <version>0.6.0</version>
</dependency>

Gradle を使用している場合は、次の依存関係を build.gradle ファイルに追加します。

implementation 'com.google.cloud:google-cloud-developer-knowledge:0.6.0'

詳細については、Java 開発環境の設定をご覧ください。

Node.js と TypeScript

npm を使用してパッケージをインストールします。

npm install @google/developer-knowledge

詳細については、Node.js 開発環境の設定をご覧ください。

PHP

Composer を使用してパッケージをインストールします。

composer require google/developer-knowledge

詳細については、Google Cloud での PHP の使用をご覧ください。

Python

pip を使用してパッケージをインストールします。

pip install --upgrade google-developer-knowledge

詳細については、Python 開発環境の設定をご覧ください。

Ruby

gem をインストールします。

gem install google-developers-developer_knowledge

詳細については、Ruby 開発環境の設定をご覧ください。

認証を設定する

API リクエストを行う前に、Google Cloud プロジェクトで Developer Knowledge API を有効にしていることを確認してください。

Developer Knowledge API の呼び出しを認証するために、クライアント ライブラリではアプリケーションのデフォルト認証情報（ADC）がサポートされています。ライブラリは、定義された一連の場所で認証情報を探し、その認証情報を使用して API へのリクエストを認証します。ADC を使用すると、アプリケーション コードを変更することなく、ローカルでの開発や本番環境など、さまざまな環境のアプリケーションで認証情報を使用できるようになります。

本番環境では、ADC の設定方法はサービスとコンテキストによって異なります。

  • Google Cloud 環境: アプリケーションが Cloud Run、Google Kubernetes Engine、Compute Engine、Cloud Run functions で実行されている場合、ADC はコンピューティング リソースに接続されているサービス アカウントを自動的に使用します。
  • 外部環境またはオンプレミス環境: Workload Identity 連携を使用するか、GOOGLE_APPLICATION_CREDENTIALS 環境変数を認証情報構成ファイルのパスに設定します。

本番環境の認証情報オプションの詳細については、アプリケーションのデフォルト認証情報を設定するをご覧ください。

ローカル開発環境では、Google アカウントに関連付けられている認証情報を使用して ADC を設定できます。

  1. gcloud CLI をインストールして初期化します。

  2. Google アカウントのローカル認証情報を作成します。

    gcloud auth application-default login

    ログイン画面が表示されます。ログインすると、ADC で使用されるローカル認証情報ファイルに認証情報が保存されます。

参考情報

言語タブを選択すると、各クライアント ライブラリの API リファレンス ドキュメント、コードサンプル、ベスト プラクティス、問題トラッカー、ソースコード リポジトリへのリンクが表示されます。

Go

次のリストは、Go のクライアント ライブラリに関連するその他のリソースへのリンクを示します。

Java

次のリストは、Java のクライアント ライブラリに関連するその他のリソースへのリンクを示します。

Node.js と TypeScript

次のリストは、Node.js と TypeScript のクライアント ライブラリに関連するその他のリソースへのリンクを示します。

PHP

次のリストは、PHP のクライアント ライブラリに関連するその他のリソースへのリンクを示します。

Python

次のリストは、Python のクライアント ライブラリに関連するその他のリソースへのリンクを示します。

Ruby

次のリストは、Ruby のクライアント ライブラリに関連するその他のリソースへのリンクを示します。

次のステップ