Docs For Class AdWordAccountService

Description

AdWords Lib Account Service Class

Use this class to work with Google AdWords Account Service. AccountService provides operations for accessing, modifying, and creating Accounts

copyright: Mirchev Ideas Ltd. © 2005
link: http://www.google.com/apis/adwords/developer/AccountService.html For more information about AccountService see in Google AdWords Developer's Guide
license: http://www.phpadwordsapi.com/license_agreement.html

Located in /services/AdWordAccountService.inc

AdWordService
   |
   --AdWordAccountService

Method Summary

AdWordAccountService AdWordAccountService (string $soapToolkit)

object|false getAccountInfo ([string $clientEmail = ''])

array|false getClientAccounts ([ $clientEmail = ''])

bool setLoginInfo (string $login, string $newPassword, [string $clientEmail = ''])

bool updateAccountInfo (object AdWordAccountInfo $accountInfo, [string $clientEmail = ''])

Methods

AdWordAccountService Constructor. It takes one parameter - name of a supported by AdWords Lib SOAP toolkit

Example:

 <?php
 $accountService = new AdWordAccountService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 ?>

Please use defined constants for supported by AdWords Lib toolkit names

see: AdWordsConsts.inc

AdWordAccountService AdWordAccountService (string $soapToolkit)

string $soapToolkit: name of a supported by AdWords Lib SOAP Toolkit

Return the AdWords account specified by the client account header.

Example:

 <?php
 $accountService = new AdWordAccountService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $accountService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $accountService->getAccountInfo();
 if ($response === false) { // if an error appears
         $errr = $classKW->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 ?>

return: AdWordAccountInfo the account info in AdWordAccountInfo object, or false on error
link: http://www.google.com/apis/adwords/developer/AccountService.html#getAccountInfo For more information about getAccountInfo see in Google AdWords Developer's Guide

object|false getAccountInfo ([string $clientEmail = ''])

string $clientEmail: provide the clientEmail when you want to use a client's account rather than your own account

Gets the primary email address for each account managed by the effective user.

If the effective user user has no client accounts, an empty array is returned. The effective user is: * the user specified in the clientEmail header of the request if that header is provided * the user specified in the email header if the clientEmail header is not provided For more information about the clientEmail header, see the section Request Headers in the Introduction. In other words, you can use the getClientAccounts request to find the primary email addresses for your own clients, or for your client's clients. If an account has more than one email associated with it, getClientAccounts gets only the primary email for the account.

Example:

 <?php
 $accountService = new AdWordAccountService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $accountService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $accountService->getClientAccounts();
 if ($response === false) { // if an error appears
         $errr = $accountService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of strings
 ?>

return: array of strings or false on error
link: http://www.google.com/apis/adwords/developer/AccountService.html#getClientAccounts For more information about getClientAccounts see in Google AdWords Developer's Guide

array|false getClientAccounts ([ $clientEmail = ''])

$clientEmail

Set the login information for the current user.

Example:

 <?php
 $accountService = new AdWordAccountService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $accountService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 
 $response = $accountService->setLoginInfo('newemail@google.com', 'password');
 if ($response === false) { // if an error appears
         $errr = $classKW->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 ?>

return: true on success, or false on error
link: http://www.google.com/apis/adwords/developer/AccountService.html#setLoginInfo For more information about setLoginInfo see in Google AdWords Developer's Guide

bool setLoginInfo (string $login, string $newPassword, [string $clientEmail = ''])

string $login: the login email of the account
string $newPassword: the password for the account
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Updates the database to reflect the changes in the account object.

Example:

 <?php
 $accountService = new AdWordAccountService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $accountService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 
 $account = new AdWordAccountInfo;
 $account->set('descriptiveName', 'Renamed Account');
 $account->set('languagePreference', 'en');
 
 $response = $accountService->updateAccountInfo($account);
 if ($response === false) { // if an error appears
         $errr = $classKW->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 ?>

return: true on success, or false on error
link: http://www.google.com/apis/adwords/developer/AccountService.html#updateAccountInfo For more information about updateAccountInfo see in Google AdWords Developer's Guide

bool updateAccountInfo (object AdWordAccountInfo $accountInfo, [string $clientEmail = ''])

object AdWordAccountInfo $accountInfo: the account info object to be updated
string $clientEmail: provide the clientEmail when you want to use a client's account rather than your own account

Inherited Methods

Inherited From AdWordService

AdWordService::AdWordService()
AdWordService::callService()
AdWordService::getAccount()
AdWordService::getClientCustomerId()
AdWordService::getClientEmail()
AdWordService::getLastError()
AdWordService::getResponseHeaders()
AdWordService::setAccount()
AdWordService::setClientCustomerId()
AdWordService::setClientEmail()