FireDAC Components for Google Analytics

Build 20.0.7587

GetOAuthAccessToken

Obtains the OAuth access token to be used for authentication with various Google services.

Input

Name Type Required Description
AuthMode String True The type of authentication mode to use.

The allowed values are APP, WEB.

The default value is WEB.

Verifier String False The verifier code returned by Google after permission for the app to connect has been granted. WEB AuthMode only.
Scope String True The scope of access to Google APIs. By default, access to all APIs used by this data provider will be specified.

The default value is https://www.googleapis.com/auth/analytics.readonly.

CallbackURL String False This field determines where the response is sent. The value of this parameter must exactly match one of the values registered in the APIs Console, including the HTTP or HTTPS schemes, capitalization, and trailing forward slash ('/').
Prompt String True This field indicates the prompt to present the user. The default is CONSENT, so a given user will see a consent page every time, even if they have previously given consent to the application for a given set of scopes. If it is set to SELECT_ACCOUNT, the user will be prompted to select the account to connect to. Lastly, if it is set to NONE, no authentication or consent screens will be displayed to the user.

The allowed values are NONE, CONSENT, SELECT_ACCOUNT.

The default value is CONSENT.

AccessType String True This field indicates if your application needs to access a Google API when the user is not present at the browser. This parameter defaults to OFFLINE. If your application needs to refresh access tokens when the user is not present at the browser, then use OFFLINE. This will result in your application obtaining a refresh token the first time your application exchanges an authorization code for a user.

The allowed values are ONLINE, OFFLINE.

The default value is OFFLINE.

State String False This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Google authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.

Result Set Columns

Name Type Description
OAuthAccessToken String The authentication token returned from Google. This can be used in subsequent calls to other operations for this particular service.
OAuthRefreshToken String A token that may be used to obtain a new access token.
ExpiresIn String The remaining lifetime on the access token.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587