GetOAuthAccessToken
さまざまなGoogle サービスで認証で使用されるOAuth アクセストークンを取得します。
NOTE:このストアドプロシージャを実行したのち、OAuthRefreshToken が結果セットの一部として返されなかった場合、Prompt 値をCONSENT に変更してプロシージャを再度実行します。これにより、アプリは強制的に再認証を行い、新しいトークン情報を送信します。
Input
Name | Type | Required | Description |
AuthMode | String | True | 使用する認証モードのタイプ。
使用できる値は次のとおりです。APP, WEB デフォルト値はWEBです。 |
Verifier | String | False | アプリに接続許可が与えられた後にGoogle から返される検証コード。WEB AuthMode のみ。 |
Scope | String | False | Google API へのアクセス権の範囲。デフォルトでは、このデータプロバイダーで使われるすべてのAPI へのアクセスが指定されます。 |
CallbackURL | String | False | このフィールドは、応答の送信先を指定します。このパラメータの値は、HTTP スキームまたはHTTPS スキーム、大文字小文字の区別、末尾のフォワードスラッシュ(/)などが、APIs Console に登録された値の1つに正確に一致しなければなりません。 |
Prompt | String | True | このフィールドは、ユーザーに提示するプロンプトを示します。次の値を指定できます:NONE、CONSENT、SELECT ACCOUNT。デフォルトはSELECT_ACCOUNT で、ユーザーは接続するアカウントを選択するよう求められます。CONSENT に設定されている場合は、特定のスコープのセットについてアプリケーションに以前に同意している場合でも、ユーザーには毎回同意ページが表示されます。最後に、NONE に設定されている場合、認証または同意画面はユーザーに表示されません。
デフォルト値はSELECT_ACCOUNTです。 |
AccessType | String | True | このフィールドは、ユーザーがブラウザを使用中でないときに、アプリケーションがGoogle API にアクセスする必要があるかどうかを示します。このパラメータのデフォルトはOFFLINE です。ユーザーがブラウザを使用中でないときに、アプリケーションがアクセストークンをリフレッシュする必要がある場合は、OFFLINE を使用します。これにより、アプリケーションは、ユーザーの認可コードを初めて交換するときにリフレッシュトークンを取得します。
使用できる値は次のとおりです。ONLINE, OFFLINE デフォルト値はOFFLINEです。 |
State | String | False | 応答を受け取ったときにアプリケーションで使用する何らかの状態を示します。アプリケーションは、送信した値と同じ値を受け取ります。つまり、このパラメータは、Google 認可サーバーまで往復して返されます。用途には、ユーザーをサイト内の正しいリソースにリダイレクトする、ノンスを使用する、クロスサイトリクエストフォージェリを防止するなどがあります。 |
Result Set Columns
Name | Type | Description |
OAuthAccessToken | String | Google から返される認証トークン。これは、引き続きこの特定のサービスの他の操作を呼び出すために使用できます。 |
OAuthRefreshToken | String | 新しいアクセストークンを取得するために使用されるトークン。 |
ExpiresIn | String | アクセストークンの残りの有効期間。 |