Docs For Class awAccountService

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: For more information about AccountService see in Google AdWords Developer's Guide
license: http://www.phpadwordsapi.com/license_agreement.html

Located in /services/AccountService.php

awService
   |
   --awAccountService

Method Summary

awAccountService awAccountService ([boolean $useSandbox = false])

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

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

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

array getMccAlerts ([string $clientEmail = ''])

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

Methods

awAccountService Constructor

Example:

 <?php
 $accountService = new awAccountService();
 ?>

awAccountService awAccountService ([boolean $useSandbox = false])

boolean $useSandbox: should we use the sandbox

Return the AdWords account specified by the client account header.

Example:

 <?php
 $accountService = new awAccountService();
 $accountService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $accountService->getAccountInfo();
 ?>

return: awV13AccountInfo the account info in awV13AccountInfo object, or false on error
link: 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 client account information for managed clients of 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 awAccountService();
 $accountService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $accountService->getClientAccountInfos();
 //$response is an array of objects of class <a href="../PHP_AdWords_API_Lib/awV13ClientAccountInfo.html">awV13ClientAccountInfo</a>
 ?>

return: array of objects of class awV13ClientAccountInfo or false on error
link: For more information about getClientAccountInfos see in Google AdWords Developer's Guide

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

$clientEmail

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 awAccountService();
 $accountService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $accountService->getClientAccounts();
 //$response is an array of strings
 ?>

return: array of strings or false on error
link: For more information about getClientAccounts see in Google AdWords Developer's Guide

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

$clientEmail

etrieves the MCC alerts associated with any of the accounts beneath the current account.

Example:

 <?php
 $accountService = new awAccountService();
 $accountService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $accountService->getMccAlerts();
 ?>

return: of objects of class awV13MccAlert or false on error
link: For more information about getMccAlerts see in Google AdWords Developer's Guide

array getMccAlerts ([string $clientEmail = ''])

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

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

Example:

 <?php
 $accountService = new awAccountService();
 $accountService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 
 $account = new awV13AccountInfo;
 $account->set('descriptiveName', 'Renamed Account');
 $account->set('languagePreference', 'en');
 
 $response = $accountService->updateAccountInfo($account);
 ?>

return: true on success, or false on error
link: For more information about updateAccountInfo see in Google AdWords Developer's Guide

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

object awV13AccountInfo $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 awService

awService::__construct()
awService::callService()
awService::checkArray()
awService::checkArrayOf()
awService::checkObjectOf()
awService::getAccount()
awService::getClientCustomerId()
awService::getClientEmail()
awService::getResponseHeaders()
awService::getToolkit()
awService::setAccount()
awService::setClientCustomerId()
awService::setClientEmail()
awService::setTokens()
awService::setUserAgent()
awService::_getServiceHeadersV2009()
awService::_returnResponseAsArrayOf()
awService::_returnResponseAsObjectOf()