Docs For Class AdWordService

AdWordService

Description

AdWords Lib AdWordService

Base class for all AdWords Services Classes.

Direct descendents

Class	Description
AdWordAccountService	AdWords Lib Account Service Class
AdWordAdGroupService	AdWords Lib AdGroup Class
AdWordCampaignService	AdWords Lib Campaign Service Class
AdWordCriterionService	AdWords Lib Criterion Class
AdWordInfoService	AdWords Lib Info Service Class
AdWordAdService	AdWords Lib Ad Class
AdWordReportService	AdWords Lib Report Service Class
AdWordTrafficEstimatorService	AdWords Lib Traffic Estimator Service Class
AdWordKeywordToolService	AdWords Lib KeywordToolService Class
AdWordSiteSuggestionService	AdWords Lib Site Suggestion Service Class

Method Summary

AdWordService AdWordService (string $soapToolkit, string $url)

mixed callService (string $command, string $paramsxml, [string $clientEmail = ''], [boolean $expectsArray = false])

array getAccount ()

string getClientCustomerId ()

string getClientEmail ()

object|null getLastError ()

array getResponseHeaders ()

void setAccount (string $accountEmail, string $accountPass, string $accountUserAgent, string $accountDeveloperToken, string $accountApplicationToken)

void setClientCustomerId (string $clientCustomerId)

void setClientEmail (string $clientEmail)

Methods

AdWordService Constructor. It takes two parameters - name of a supported by AdWords Lib SOAP toolkit and a service URL

Example:

 <?php
 $obj = new AdWordService(ADWORD_SOAP_TOOLKIT_NUSOAP, ADWORD_KEYWORD_SERVICE_URL);
 ?>

Please use defined constants for supported by AdWords Lib toolkit names and service URLs

see: AdWordsConsts.inc
see: ServicesURL.inc

AdWordService AdWordService (string $soapToolkit, string $url)

string $soapToolkit: name of a supported by AdWords Lib SOAP Toolkit
string $url: the URL for this service

Call a Google AdWords service

Example:

 <?php
 $obj = new AdWordService(ADWORD_SOAP_TOOLKIT_NUSOAP, ADWORD_KEYWORD_SERVICE_URL);
 $obj->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $result = $obj->callService($command, $paramsxml);
 // $result holds response string from Google AdWords service or false on error
 ?>

return: response string from Google AdWords service or false on error
see: AdWordError

mixed callService (string $command, string $paramsxml, [string $clientEmail = ''], [boolean $expectsArray = false])

string $command: Google AdWords service command
string $paramsxml: Google AdWords service command parameters in XML format
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account
boolean $expectsArray: if true the return should be array of objects

Returns an array with Google AdWords account that was set by AdWordService::setAccount() function

Example:

 <?php
 $obj = new AdWordService(ADWORD_SOAP_TOOLKIT_NUSOAP, ADWORD_KEYWORD_SERVICE_URL);
 $account = $obj->getAccount(); // $account is an empty array
 $obj->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 ...
 $account = $obj->getAccount();
 //$account is an array with the account values set by AdWordService::setAccount() function
 ?>

return: array with the account values set by AdWordService::setAccount() function or an empty array if no account was set
link: http://www.google.com/apis/adwords/developer/adwords_api_intro.html#adwords_api_intro_headers For more information about accounts see in Google AdWords Developer's Guide

array getAccount ()

Returns clientCustomerId that was set by AdWordService::setClientCustomerId() function

If no clientCustomerId was set, returns an empty string.

Example:

 <?php
 $obj = new AdWordService(ADWORD_SOAP_TOOLKIT_NUSOAP, ADWORD_KEYWORD_SERVICE_URL);
 $obj->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $string = $obj->getClientCustomerId(); // $string == ''
 $obj->setClientCustomerId($clientCustomerId);
 ...
 $string = $obj->getClientCustomerId(); // $string == $clientCustomerId
 ?>

return: clientCustomerId that was set by AdWordService::setClientCustomerId() function or empty string
see: AdWordService::setClientCustomerId()
link: http://www.google.com/apis/adwords/developer/adwords_api_intro.html#adwords_api_intro_headers For more information about accounts see in Google AdWords Developer's Guide

string getClientCustomerId ()

Returns clientEmail that was set by AdWordService::setClientEmail() function

If no clientEmail was set, returns an empty string.

Example:

 <?php
 $obj = new AdWordService(ADWORD_SOAP_TOOLKIT_NUSOAP, ADWORD_KEYWORD_SERVICE_URL);
 $obj->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $string = $obj->getClientEmail(); // $string == ''
 $obj->setClientEmail($clientEmail);
 ...
 $string = $obj->getClientEmail(); // $string == $clientEmail
 ?>

return: clientEmail that was set by AdWordService::setClientEmail() function or empty string
see: AdWordService::setClientEmail()
link: http://www.google.com/apis/adwords/developer/adwords_api_intro.html#adwords_api_intro_headers For more information about accounts see in Google AdWords Developer's Guide

string getClientEmail ()

Returns last error. If there is no error returns NULL

Example:

 <?php
 $obj = new AdWordService(ADWORD_SOAP_TOOLKIT_NUSOAP, ADWORD_KEYWORD_SERVICE_URL);
 $obj->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $error = $obj->getLastError(); // $error is NULL
 ...
 $result = $obj->callService($command, $sameWrongParam);
 if ($result === false)
         $error = $obj->getLastError(); // $error is an object of class AdWordError
 ?>

return: object of class AdWordError or NULL if there is no error returns NULL
see: AdWordError

object|null getLastError ()

Returns an array with AdWords response headers from the last operation.

The headers include requestId, responseTime, operations and units. Units contains the amount of quota used.

Example:

 <?php
 $keywordService = new AdWordKeywordService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $keywordService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 
 # $newKeyword is an object of class AdWordKeyword
 $response = $keywordService->addKeyword($newKeyword);
 if ($response === false) { // if an error appears
         $errr = $classKW->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 
 # print the response headers
 $responseHeaders = $keywordService->getResponseHeaders();
 echo 'Request ID: ' . $responseHeaders['requestId'] . '<br>';
 echo 'Response Time: ' . $responseHeaders['responseTime'] . '<br>';
 echo 'Operations: ' . $responseHeaders['operations'] . '<br>';
 echo 'Units: ' . $responseHeaders['units'] . '<br>';
 ?>

return: the headers

array getResponseHeaders ()

Sets a google AdWords account to work with

Example:

 <?php
 $obj = new AdWordService(ADWORD_SOAP_TOOLKIT_NUSOAP, ADWORD_KEYWORD_SERVICE_URL);
 $obj->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 ?>

link: http://www.google.com/apis/adwords/developer/adwords_api_intro.html#adwords_api_intro_headers For more information about accounts see in Google AdWords Developer's Guide

void setAccount (string $accountEmail, string $accountPass, string $accountUserAgent, string $accountDeveloperToken, string $accountApplicationToken)

string $accountEmail: email address for the AdWords account being accessed.
string $accountPass: password for the AdWords account being accessed.
string $accountUserAgent: an arbitrary string that identifies the customer sending the request.
string $accountDeveloperToken: a unique string that identifies you as an authorized developer for the AdWords API. An example developer token string is ABcdeFGH93KL-NOPQ_STUv.
string $accountApplicationToken: a string that identifies an application as one authorized to call the AdWords API web services. If your application calls another application, use the application token for the one that actually sends the request.

Sets clientCustomerId to be used for a service

Provide the clientCustomerId when you want to edit a client's account rather than your own account. The client's customerId set by this function must be managed by account set by AdWordService::setAccount() function

Example:

 <?php
 $obj = new AdWordService(ADWORD_SOAP_TOOLKIT_NUSOAP, ADWORD_KEYWORD_SERVICE_URL);
 $obj->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 // you can set a client's customerId and work with their account
 $obj->setClientCustomerId($clientCustomerId);
 $result = $obj->callService($command, $paramsxml);
 //you can still use same object to manage another client account
 $result = $obj->callService($command, $paramsxml, $otherClientEmail);
 ?>

void setClientCustomerId (string $clientCustomerId)

string $clientCustomerId: a client's customer id which account you want to edit

Sets clientEmail to be used for a service

Provide the clientEmail when you want to edit a client's account rather than your own account. The client's email set by this function must be managed by account set by AdWordService::setAccount() function

Example:

 <?php
 $obj = new AdWordService(ADWORD_SOAP_TOOLKIT_NUSOAP, ADWORD_KEYWORD_SERVICE_URL);
 $obj->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 // you can call a service command for a client
 $result = $obj->callService($command, $paramsxml, $clientEmail);
 // or you can set a client's email and work with their account
 $obj->setClientEmail($clientEmail);
 $result = $obj->callService($command, $paramsxml);
 //you can still use same object to manage another client account
 $result = $obj->callService($command, $paramsxml, $otherClientEmail);
 ?>

void setClientEmail (string $clientEmail)

string $clientEmail: a client's email which account you want to edit

Documentation generated on Mon, 10 Sep 2007 15:07:27 +0300 by phpDocumentor 1.3.2