このページでは、BigQuery API の Cloud クライアント ライブラリの使用方法を示します。以前の Google API クライアント ライブラリを含む、Cloud APIs のクライアント ライブラリの詳細については、クライアント ライブラリの説明をご覧ください。
クライアント ライブラリのインストール
C#
詳細については、C# 開発環境の設定をご覧ください。
Install-Package Google.Cloud.BigQuery.V2 -Pre
Go
詳細については、Go 開発環境の設定をご覧ください。
go get cloud.google.com/go/bigquery
Java
詳細については、Java 開発環境の設定をご覧ください。
Maven を使用している場合は、次のものを pom.xml
ファイルに追加します。BOM の詳細については、Google Cloud Platform ライブラリ BOM をご覧ください。
Gradle を使用している場合は、次のものを依存関係に追加します。
sbt を使用している場合は、次のものを依存関係に追加します。
Visual Studio Code、IntelliJ または Eclipse を使用している場合は、次の IDE プラグインでプロジェクトにクライアント ライブラリを追加できます。
プラグインでは、サービス アカウントのキー管理などの追加機能も提供されます。詳細は各プラグインのドキュメントをご覧ください。
Node.js
詳細については、Node.js 開発環境の設定をご覧ください。
npm install --save @google-cloud/bigquery
PHP
詳細については、Google Cloud での PHP の使用をご覧ください。
composer require google/cloud-bigquery
Python
詳細については、Python 開発環境の設定をご覧ください。
pip install --upgrade google-cloud-bigquery
Ruby
詳細については、Ruby 開発環境の設定をご覧ください。
gem install google-cloud-bigquery
認証の設定
クライアント ライブラリを実行するには、まず認証を設定する必要があります。これを行う 1 つの方法は、次のようにサービス アカウントを作成して環境変数を設定することです。その他の認証方法については、サービス アカウントとして認証するをご覧ください。
Console
サービス アカウントを作成します。
-
Cloud Console で [サービス アカウントの作成] ページに移動します。
[サービス アカウントの作成] に移動 - プロジェクトを選択します。
-
[サービス アカウント名] フィールドに名前を入力します。Cloud Console は、この名前に基づいて [サービス アカウント ID] フィールドに入力します。
[サービス アカウントの説明] フィールドに説明を入力します。例:
Service account for quickstart
- [作成して続行] をクリックします。
-
プロジェクトへのアクセス権限を付与するには、サービス アカウントに次のロールを付与します。[プロジェクト] > [オーナー]
[ロールを選択] リストでロールを選択します。
ロールを追加するには、[
別のロールを追加] をクリックして各ロールを追加します。 - [続行] をクリックします。
-
[完了] をクリックして、サービス アカウントの作成を完了します。
ブラウザ ウィンドウは閉じないでください。次のステップでこれを使用します。
サービス アカウント キーを作成します。
- Cloud Console で、作成したサービス アカウントのメールアドレスをクリックします。
- [キー] をクリックします。
- [鍵を追加]、[新しい鍵を作成] の順にクリックします。
- [作成] をクリックします。JSON キーファイルがパソコンにダウンロードされます。
- [閉じる] をクリックします。
gcloud
認証を設定します。
-
サービス アカウントを作成します。NAME をサービス アカウントの名前に置き換えます。
gcloud iam service-accounts create NAME
-
サービス アカウントにロールを付与します。次の IAM ロールごとに次のコマンドを 1 回実行します。
roles/owner
gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:NAME@PROJECT_ID.iam.gserviceaccount.com" --role=ROLE
次のように置き換えます。
- NAME: サービス アカウントの名前
- PROJECT_ID: サービス アカウントを作成したプロジェクト ID
- ROLE: 付与するロール
-
鍵ファイルを生成します。
gcloud iam service-accounts keys create FILE_NAME.json --iam-account=NAME@PROJECT_ID.iam.gserviceaccount.com
次のように置き換えます。
- FILE_NAME: 鍵ファイルの名前
- NAME: サービス アカウントの名前
- PROJECT_ID: サービス アカウントを作成したプロジェクト ID
環境変数 GOOGLE_APPLICATION_CREDENTIALS
を設定して、アプリケーション コードに認証情報を指定します。この変数は、現在のシェル セッションにのみ適用されます。この変数を新しいシェル セッションに適用する場合は、シェル起動ファイル(~/.bashrc
ファイルや ~/.profile
ファイルなど)で変数を設定します。
Linux または macOS
export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH
"
KEY_PATH
をサービス アカウント キーが含まれる JSON ファイルのパスに置き換えます。
例:
export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"
Windows
PowerShell の場合:
$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH
"
KEY_PATH
をサービス アカウント キーが含まれる JSON ファイルのパスに置き換えます。
例:
$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"
コマンド プロンプトの場合:
set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH
KEY_PATH
をサービス アカウント キーが含まれる JSON ファイルのパスに置き換えます。
クライアント ライブラリの使用
次の例は、クライアントを初期化し、BigQuery API 一般公開データセットに対してクエリを実行する方法を示しています。
C#
このサンプルを試す前に、BigQuery API クイックスタート: クライアント ライブラリの使用にある C# の設定手順を行ってください。詳細については、BigQuery API C# API のリファレンス ドキュメントをご覧ください。
Go
このサンプルを試す前に、BigQuery API クイックスタート: クライアント ライブラリの使用にある Go の設定手順を行ってください。詳細については、BigQuery API Go API のリファレンス ドキュメントをご覧ください。
Java
このサンプルを試す前に、BigQuery API クイックスタート: クライアント ライブラリの使用にある Java の設定手順を行ってください。詳細については、BigQuery API Java API のリファレンス ドキュメントをご覧ください。
Node.js
このサンプルを試す前に、BigQuery API クイックスタート: クライアント ライブラリの使用にある Node.js の設定手順を行ってください。詳細については、BigQuery API Node.js API のリファレンス ドキュメントをご覧ください。
PHP
このサンプルを試す前に、BigQuery API クイックスタート: クライアント ライブラリの使用にある PHP の設定手順を行ってください。詳細については、BigQuery API PHP API のリファレンス ドキュメントをご覧ください。
Python
このサンプルを試す前に、BigQuery API クイックスタート: クライアント ライブラリの使用にある Python の設定手順を行ってください。詳細については、BigQuery API Python API のリファレンス ドキュメントをご覧ください。
Ruby
このサンプルを試す前に、BigQuery API クイックスタート: クライアント ライブラリの使用にある Ruby の設定手順を行ってください。詳細については、BigQuery API Ruby API のリファレンス ドキュメントをご覧ください。
参考情報
C#
Go
Java
Node.js
PHP
Python
Ruby
サードパーティの BigQuery API クライアント ライブラリ
上記の表の Google がサポートするライブラリに加えて、サードパーティが提供する一連のライブラリも使用できます。
言語 | ライブラリ |
---|---|
Python | pandas-gbq(移行ガイド) |
R | bigrquery、BigQueryR |
Scala | spark-bigquery-connector |
次のステップ
使ってみる
Google Cloud を初めて使用される方は、アカウントを作成して、実際のシナリオでの BigQuery のパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。
BigQuery の無料トライアル