Google::Ads::Common::AuthTokenHandler
Google::Ads::Common::AuthTokenHandler implements most of the methods required to request AuthTokens using the ClientLogin protocol, see https://developers.google.com/accounts/docs/AuthForInstalledApps for more information about the protocol.
Each of these attributes can be set via the constructor as a hash. Alternatively, there is a get_ and set_ method associated with each attribute for retrieving or setting them dynamically.
The email of the account to authorization against.
The password to use for authorization.
Endpoint of the authorization server.
Auth token either manually set or generated.
time in which the token was issued if it was requested by this class.
Initializes the handler with properties such as the email and password to use for generating AuthTokens.
A required api_client with a reference to the API client object handling the requests against the API.
A hash reference with the following keys: { # The service name to access. service => "adwords", # The email address of a Google Account. email => "user@domain.com", # The password for the Google Account. password => "password", }
True, if a valid AuthToken is available or can be generated to use within API requests.
Forces refreshing the auth token using the credentials set in the handler.
Calls the authorization server to generate a new AuthToken. Sets the generated AuthToken in the auth_token property as well as the issued_in property. A captcha token and code can be passed to this method to handle captcha challenges
An optional captcha token, obtained from a captcha challenge error. See Google::Ads::Common::CaptchaRequiredError.
An optional captcha code, obtained from the user by looking at the captcha image.
Returns an error of type Google::Ads::Common::CaptchaRequiredError or Google::Ads::Common::AuthError if an error occurred while generating the token.
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.0
Unless 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.
David Torres <david.t at google.com>
$Rev: $ $LastChangedBy: $ $Id: $
1 POD Error
The following errors were encountered while parsing the POD:
You forgot a '=back' before '=head2'
To install Google::Ads::AdWords::Client, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Google::Ads::AdWords::Client
CPAN shell
perl -MCPAN -e shell install Google::Ads::AdWords::Client
For more information on module installation, please visit the detailed CPAN module installation guide.