Client

Construct the Google Client.

Get a string containing the version of the library.

For backwards compatibility alias for fetchAccessTokenWithAuthCode

Attempt to exchange a code for an valid authentication token.

Helper wrapped around the OAuth 2.0 implementation.

For backwards compatibility alias for fetchAccessTokenWithAssertion

Fetches a fresh access token with a given assertion token.

For backwards compatibility alias for fetchAccessTokenWithRefreshToken

Fetches a fresh OAuth 2.0 access token with the given refresh token.

Create a URL to obtain user authorization.

The authorization endpoint allows the user to first authenticate, and then grant/deny the access request.

Adds auth listeners to the HTTP client based on the credentials set in the Google API Client object

Set the configuration to use application default credentials for authentication

To prevent useApplicationDefaultCredentials from inappropriately being called in a conditional

Set the access token used for requests.

Note that at the time requests are sent, tokens are cached. A token will be cached for each combination of service and authentication scopes. If a cache pool is not provided, creating a new instance of the client will allow modification of access tokens. If a persistent cache pool is provided, in order to change the access token, you must clear the cached token by calling $client->getCache()->clear(). (Use caution in this case, as calling clear() will remove all cache items, including any items not related to Google API PHP Client.)

Returns if the access_token is expired.

Set the OAuth 2.0 Client ID.

Set the OAuth 2.0 Client Secret.

Set the OAuth 2.0 Redirect URI.

Set OAuth 2.0 "state" parameter to achieve per-request customization.

Set the login hint, email address or sub id.

Set the application name, this is included in the User-Agent HTTP header.

If 'plus.login' is included in the list of requested scopes, you can use this method to define types of app activities that your app will write.

You can find a list of available types here:

Set the developer key to use, these are obtained through the API Console.

Set the hd (hosted domain) parameter streamlines the login process for Google Apps hosted accounts. By including the domain of the user, you restrict sign-in to accounts at that domain.

Set the prompt hint. Valid values are none, consent and select_account.

If no value is specified and the user has not previously authorized access, then the user is shown a consent screen.

openid.realm is a parameter from the OpenID 2.0 protocol, not from OAuth 2.0. It is used in OpenID 2.0 requests to signify the URL-space for which an authentication request is valid.

If this is provided with the value true, and the authorization request is granted, the authorization will include any previous authorizations granted to this user/application combination for other scopes.

sets function to be called when an access token is fetched

Revoke an OAuth2 access token or refresh token. This method will revoke the current access token, if a token isn't provided.

Verify an id_token. This method will verify the current id_token, if one isn't provided.

Set the scopes to be requested. Must be called before createAuthUrl().

Will remove any previously configured scopes.

This functions adds a scope to be requested as part of the OAuth2.0 flow.

Will append any scopes not previously requested to the scope parameter. A single string will be treated as a scope to request. An array of strings will each be appended.

Returns the list of scopes requested by the client

Helper method to execute deferred HTTP requests.

Declare whether batch calls should be used. This may increase throughput by making multiple requests in one connection.

Are we running in Google AppEngine? return bool

For backwards compatibility alias for setAuthConfig

Set the auth config from new or deprecated JSON config.

This structure should match the file downloaded from the "Download JSON" button on in the Google Developer Console.

Use when the service account has been delegated domain wide access.

Declare whether making API calls should make the call immediately, or return a request which can be called with ->execute();

Whether or not to return raw requests

create a default google auth object

Set the Cache object

Set the Logger object

Set the Http Client object

Set the API format version.

true will use V2, which may return more useful error messages.