Client
class Client (View source)
The Google API Client https://github.com/google/google-api-php-client
Constants
| LIBVER |
|
| USER_AGENT_SUFFIX |
|
| OAUTH2_REVOKE_URI |
|
| OAUTH2_TOKEN_URI |
|
| OAUTH2_AUTH_URL |
|
| API_BASE_PATH |
|
Properties
| protected array | $requestedScopes |
Methods
Construct the Google Client.
Get a string containing the version of the library.
Attempt to exchange a code for an valid authentication token.
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.
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.
No description
No description
Returns if the access_token is expired.
Set the OAuth 2.0 Client ID.
No description
Set the OAuth 2.0 Client Secret.
No description
Set the OAuth 2.0 Redirect URI.
No description
Set OAuth 2.0 "state" parameter to achieve per-request customization.
No description
No description
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.
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.
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().
This functions adds a scope to be requested as part of the OAuth2.0 flow.
Returns the list of scopes requested by the client
No description
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
No description
No description
Set the auth config from new or deprecated JSON config.
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
No description
create a default google auth object
Set the Cache object
No description
No description
Set the Logger object
No description
No description
No description
Set the Http Client object
No description
Set the API format version.
No description
No description
Details
__construct(array $config = array())
Construct the Google Client.
string
getLibraryVersion()
Get a string containing the version of the library.
array
authenticate($code)
deprecated
deprecated
For backwards compatibility alias for fetchAccessTokenWithAuthCode
array
fetchAccessTokenWithAuthCode($code)
Attempt to exchange a code for an valid authentication token.
Helper wrapped around the OAuth 2.0 implementation.
array
refreshTokenWithAssertion()
deprecated
deprecated
For backwards compatibility alias for fetchAccessTokenWithAssertion
array
fetchAccessTokenWithAssertion(ClientInterface $authHttp = null)
Fetches a fresh access token with a given assertion token.
array
refreshToken(string $refreshToken)
For backwards compatibility alias for fetchAccessTokenWithRefreshToken
array
fetchAccessTokenWithRefreshToken(string $refreshToken = null)
Fetches a fresh OAuth 2.0 access token with the given refresh token.
string
createAuthUrl(string|array $scope = null)
Create a URL to obtain user authorization.
The authorization endpoint allows the user to first authenticate, and then grant/deny the access request.
ClientInterface
authorize(ClientInterface $http = null)
Adds auth listeners to the HTTP client based on the credentials set in the Google API Client object
useApplicationDefaultCredentials(bool $useAppCreds = true)
Set the configuration to use application default credentials for authentication
isUsingApplicationDefaultCredentials()
To prevent useApplicationDefaultCredentials from inappropriately being called in a conditional
setAccessToken(string|array $token)
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.)
getAccessToken()
No description
string|null
getRefreshToken()
No description
bool
isAccessTokenExpired()
Returns if the access_token is expired.
getAuth()
deprecated
deprecated
No description
setAuth($auth)
deprecated
deprecated
No description
setClientId(string $clientId)
Set the OAuth 2.0 Client ID.
getClientId()
No description
setClientSecret(string $clientSecret)
Set the OAuth 2.0 Client Secret.
getClientSecret()
No description
setRedirectUri(string $redirectUri)
Set the OAuth 2.0 Redirect URI.
getRedirectUri()
No description
setState(string $state)
Set OAuth 2.0 "state" parameter to achieve per-request customization.
setAccessType(string $accessType)
No description
setApprovalPrompt(string $approvalPrompt)
No description
setLoginHint(string $loginHint)
Set the login hint, email address or sub id.
setApplicationName(string $applicationName)
Set the application name, this is included in the User-Agent HTTP header.
setRequestVisibleActions(array $requestVisibleActions)
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:
setDeveloperKey(string $developerKey)
Set the developer key to use, these are obtained through the API Console.
setHostedDomain($hd)
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.
setPrompt($prompt)
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.
setOpenidRealm($realm)
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.
setIncludeGrantedScopes($include)
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.
setTokenCallback(callable $tokenCallback)
sets function to be called when an access token is fetched
bool
revokeToken(string|array|null $token = null)
Revoke an OAuth2 access token or refresh token. This method will revoke the current access token, if a token isn't provided.
array|false
verifyIdToken(string|null $idToken = null)
Verify an id_token. This method will verify the current id_token, if one isn't provided.
setScopes($scope_or_scopes)
Set the scopes to be requested. Must be called before createAuthUrl().
Will remove any previously configured scopes.
addScope($scope_or_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.
array
getScopes()
Returns the list of scopes requested by the client
string|null
prepareScopes()
No description
object
execute(RequestInterface $request, string $expectedClass = null)
Helper method to execute deferred HTTP requests.
setUseBatch(bool $useBatch)
Declare whether batch calls should be used. This may increase throughput by making multiple requests in one connection.
isAppEngine()
Are we running in Google AppEngine? return bool
setConfig($name, $value)
No description
getConfig($name, $default = null)
No description
setAuthConfigFile(string $file)
deprecated
deprecated
For backwards compatibility alias for setAuthConfig
setAuthConfig(string|array $config)
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.
setSubject(string $subject)
Use when the service account has been delegated domain wide access.
setDefer(bool $defer)
Declare whether making API calls should make the call immediately, or return a request which can be called with ->execute();
bool
shouldDefer()
Whether or not to return raw requests
OAuth2
getOAuth2Service()
No description
protected
createOAuth2Service()
create a default google auth object
setCache(CacheItemPoolInterface $cache)
Set the Cache object
CacheItemPoolInterface
getCache()
No description
setCacheConfig(array $cacheConfig)
No description
setLogger(LoggerInterface $logger)
Set the Logger object
LoggerInterface
getLogger()
No description
protected
createDefaultLogger()
No description
protected
createDefaultCache()
No description
setHttpClient(ClientInterface $http)
Set the Http Client object
ClientInterface
getHttpClient()
No description
setApiFormatV2(bool $value)
Set the API format version.
true will use V2, which may return more useful error messages.
protected
createDefaultHttpClient()
No description
protected
getAuthHandler()
No description