サービス アカウント

サービス アカウントは、エンドユーザーではなく、アプリケーションに関連付けられたアカウントです。アプリを開発する場合や REST API を使用する場合は、サービス アカウントを使用して Earth Engine の認証を行う必要があります。サービス アカウントによる認証の詳細

サービス アカウントを作成する

まず、Google Cloud プロジェクトを作成します(まだ作成していない場合)。

Cloud プロジェクトのサービス アカウントを管理するには、Cloud コンソール メニュー()に移動し、[IAM と管理] > [サービス アカウント] を選択します。(プロンプトが表示されたら、プロジェクトを選択します)。

新しいサービス アカウントを作成するには、[+ サービス アカウントを作成] リンクをクリックします。

App Engine プロジェクトを作成した場合は、そのプロジェクトのデフォルトのサービス アカウント(App Engine のデフォルトのサービス アカウント)がすでに存在している可能性があります。App Engine プロジェクトを設定する場合は、サービス アカウントの [ロール] で [プロジェクト] > [編集者] を選択します。

Earth Engine を使用するようにサービス アカウントを構成する

すべてのサービス アカウントは Cloud プロジェクト内で作成されます。このプロジェクトは、App Engine アプリまたは Cloud VM に使用されるプロジェクトと同じでもかまいません。クラウド プロジェクトが登録されていて Earth Engine にアクセスできること、プロジェクトで Earth Engine API が有効になっていることを確認します。適切な権限を持つプロジェクト内のすべてのサービス アカウントが Earth Engine にアクセスできます。

アプリケーションのデフォルト認証情報を使用して Earth Engine に対する認証を行う

アプリケーションのデフォルト認証情報(ADC)は、秘密鍵を手動で管理することなく、無人環境(Cloud Run や Compute Engine など)で認証を行うための推奨される方法です。Cloud プロジェクト ID を渡してライブラリを初期化します(my-project はプロジェクト ID に置き換えます)。

import google.auth
import ee

credentials, project_id = google.auth.default()
ee.Initialize(credentials, project='my-project')

秘密鍵で認証する

アプリケーションでサービス アカウントの秘密鍵を使用して認証する必要がある場合(ADC を使用できる本番環境では推奨されません):

  1. サービス アカウントの秘密鍵を作成します。
    • Cloud Console の [サービス アカウント] ページに移動します。
    • アカウントのメニュー()をクリックし、[鍵を作成] > [JSON] をクリックします。
    • JSON キーファイルをダウンロードします。
  2. 鍵ファイルは安全に保管してください。キーファイルは、プログラムがサービス アカウントに代わって Google API にアクセスできるようにする特別なファイルです。秘密鍵を公開場所に保存しないでください。秘密鍵を紛失した場合は、サービス アカウントへのアクセスを取り消し、Cloud コンソールを使用して新しいサービス アカウントを作成できます。詳細については、サービス アカウント キーの作成と削除をご覧ください。
  3. .private-key.json ファイルを配置した場所から、次の Python コードをテストします(my-project は Google Cloud プロジェクト ID に置き換えます)。
    import ee
    service_account = 'my-service-account@...gserviceaccount.com'
    credentials = ee.ServiceAccountCredentials(service_account, '.private-key.json')
    ee.Initialize(credentials, project='my-project')

エラーなしで初期化できれば、サービス アカウントを使用する準備は完了です。

Compute Engine でデフォルトのサービス アカウントを使用する

デフォルトのサービス アカウントを使用している場合は、まず Compute Engine サービス アカウントの VM のアクセス スコープを「すべての Cloud API に完全アクセス権を許可」に変更する必要があります。(Dataflow または App Engine でデフォルトのサービス アカウントを使用している場合、この手順は必要ありません)。

デフォルトのサービス アカウントを使用して Earth Engine に対する認証を行うには、次のコードを使用します(my-project は Google Cloud プロジェクト ID に置き換えます)。

from google.auth import compute_engine
import ee
credentials = compute_engine.Credentials(scopes=['https://www.googleapis.com/auth/earthengine'])
ee.Initialize(credentials, project='my-project')

REST API アクセスを設定する

サービス アカウントが REST API を使用して計算を行う場合は、プロジェクト レベルの権限(具体的には Earth Engine リソース閲覧者のロール)を付与する必要があります。プロジェクトの構成によっては、サービス アカウントに Service Usage コンシューマーのロールを付与する必要がある場合もあります。Earth Engine の使用に必要なプロジェクト権限の詳細については、アクセス制御のページをご覧ください。

トラブルシューティング

エラー: invalid_grant

OAuth2 はクロックのずれに非常に敏感です。すべてが正しく設定されていることが確実な場合は、パソコンの時計がネットワーク時刻と同期されているかどうかを確認します。

エラー: Cloud Storage へのエクスポート時に「指定されたスコープが承認されていません」

Cloud Run タスクで実行中にこのエラーが表示された場合は、認証情報の作成時(google.auth.default(scopes=...) など)に scopes 引数を設定しないでください。スコープを指定すると、この環境のデフォルトの権限が妨げられる可能性があります。