このメソッドまたは別の認証メソッドは、ee.initialize() の前に呼び出す必要があります。
ユーザーがクライアント ID で識別されるアプリへのアクセスを以前に許可していない場合、デフォルトでは、必要な権限を付与するようユーザーに求めるダイアログ ウィンドウが表示されます。ただし、このポップアップはブラウザによってブロックされる可能性があります。これを回避するには、opt_onImmediateFailed コールバックを指定し、その中でページ内ログイン ボタンをレンダリングしてから、このボタンのクリック イベント ハンドラから ee.data.authenticateViaPopup() を呼び出します。これにより、ポップアップがユーザー アクションの直接的な結果となるため、ブラウザによるポップアップのブロックが停止します。
認証トークンは、可能な場合は自動的に更新されます。すべての非同期呼び出しは適切な認証情報とともに送信されると想定して問題ありません。ただし、同期呼び出しの場合は、ee.data.getAuthToken() で認証トークンを確認し、認証トークンがない場合は ee.data.refreshAuthToken() を手動で呼び出す必要があります。トークン更新オペレーションは非同期であり、同期呼び出しの前にオンデマンドでバックグラウンドで実行することはできません。
用途 | 戻り値 |
---|---|
ee.data.authenticateViaOauth(clientId, success, error, extraScopes, onImmediateFailed, suppressDefaultScopes) |
引数 | タイプ | 詳細 |
---|---|---|
clientId | 文字列 | アプリケーションの OAuth クライアント ID。認証された呼び出しを無効にする場合は null。これは Google Developers Console で取得できます。プロジェクトには、スクリプトが実行されているドメインに対応する JavaScript オリジンが必要です。 |
success | 関数 | 認証が成功した場合に呼び出す関数。 |
error | 関数(省略可) | 認証に失敗した場合に呼び出す関数。エラー メッセージが渡されます。即時(バックグラウンド)モードでの認証が失敗し、opt_onImmediateFailed が指定されている場合は、opt_error の代わりにその関数が呼び出されます。 |
extraScopes | List<String>(省略可) | リクエストする追加の OAuth スコープ。 |
onImmediateFailed | 関数(省略可) | バックグラウンドでの自動認証が失敗した場合に呼び出す関数。デフォルトは ee.data.authenticateViaPopup() で、渡されたコールバックにバインドされます。 |
suppressDefaultScopes | ブール値、省略可 | true の場合、opt_extraScopes で指定されたスコープのみがリクエストされます。opt_extraScopes で明示的に指定されていない限り、デフォルトのスコープはリクエストされません。 |