NAME
Google::Ads::Common::OAuthHandlerInterface
DESCRIPTION
Abstract interface and a specialization of the Google::Ads::Common::AuthHandlerInterface for dealing with OAuth requests.
Meant be implemented by concrete OAuth handlers to define the necessary subroutines to fully implement OAuth access to Google APIs.
METHODS
get_authorization_url
Meant to be implemented by a concrete class, which should issue a request token and return a valid URL for the user to authorize the token. The implementor must save the request token in the token attribute for later use by the upgrade_token method. A callback URL can be passed to re-direct the user after the token is authorized.
Parameters
A required callback URL to which the user will be redirected after authorizing access. A special "oob" out-of-band value is allow to just print the verifier in screen.
Returns
The URL for the user to authorize access to his account. The user first must login in the account that want to grant access to.
issue_access_token
Method to upgrade/obtain an authorized access token.
Parameters
The verifier code returned to your callback page or printed out if using 'oob' special callback URL.
LICENSE AND COPYRIGHT
Copyright 2012 Google Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
AUTHOR
David Torres <david.t at google.com>
REPOSITORY INFORMATION
$Rev: $
$LastChangedBy: $
$Id: $