Docs For Class AdWordAdService

AdWordAdService

Description

AdWords Lib Ad Class

Use this class to work with Google AdWords Ad Service AdService provides operations for accessing, creating and modifying Ads in an AdGroup. Each Ad object is the visual representation of an ad. Each ad group has one or more ads, where an ad can be of many different formats (such as text ad or an image ad). An ad can be in following serving statuses: enabled, disabled, or paused. Only enabled ads will be served; a disabled or paused ad will not be served.

copyright: Mirchev Ideas Ltd. © 2003, 2004, 2005, 2006, 2007
link: http://www.google.com/apis/adwords/developer/AdService.html For more information about AdService see in Google AdWords Developer's Guide

Located in /services/AdWordAdService.inc

AdWordService
   |
   --AdWordAdService

Method Summary

AdWordAdService AdWordAdService (string $soapToolkit)

object|false addAds ( $ads, [string $clientEmail = ''], array $newAds)

object|false checkAds (array $ads, [object AdWordLanguageTarget $languageTarget = ''], [object AdWordGeoTarget $geoTarget = ''], [string $clientEmail = ''])

object|false findBusinesses (string $name, string $address, string $countryCode, [string $clientEmail = ''])

object|false getActiveAds (array $adGroupIds, [string $clientEmail = ''])

object|false getAd (int $adGroupId, int $adId, [string $clientEmail = ''])

object|false getAdStats (int $adGroupId, int $adIds, int $startDay, int $endDay, [string $clientEmail = ''])

object|false getAllAds (array $adGroupIds, [string $clientEmail = ''])

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

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

bool updateAds (array $ads, [string $clientEmail = ''])

Methods

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

Example:

 <?php
 $adService = new AdWordAdService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 ?>

Please use defined constants for supported by AdWords Lib toolkit names

see: AdWordsConsts.inc

AdWordAdService AdWordAdService (string $soapToolkit)

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

Make a batch of new Ads.

The adGroupId field of the Ad indicates which AdGroup to add the Ad to. The adGroupId field is required, and the indicated AdGroup must exist already. The Ad's id and disapproved fields are set by the AdService -- if you fill them in they will be ignored. By default, Ads are enabled and will be served as soon as they are created. You can set the status field on the ad to either paused or disabled to prevent the ad from being active.

Example:

 <?php
 $adService = new AdWordAdService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$newAds is an array of objects of class AdWordAd or any of its descendants
 $response = $adService->addAds($newAds);
 if ($response === false) { // if an error appears
         $errr = $adService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordAd
 ?>

return: object of class AdWordCriterion or false on error
see: AdWordAd
link: http://www.google.com/apis/adwords/developer/AdService.html#addAds For more information about addAds see in Google AdWords Developer's Guide

object|false addAds ( $ads, [string $clientEmail = ''], array $newAds)

array $newAds: array of objects of class AdWordAd
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account
$ads

Check a batch of Ads for policy errors.

The number of Ads in the batch is limited to the maximum number of Ads per adgroup.

Example:

 <?php
 $adService = new AdWordAdService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$ads is an array of objects of class AdWordAd
 //$languageTarget is an object of class AdWordLanguageTarget
 //$geoTarget is an object of class AdWordGeoTarget
 $response = $adService->checkAds($ads, $languageTarget, $geoTarget);
 if ($response === false) { // if an error appears
         $errr = $adService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class ApiError which hold a list of policy errors
 ?>

return: object of class AdWordApiError or false on error
see: AdWordAd
link: http://www.google.com/apis/adwords/developer/AdService.html#checkAds For more information about checkAds see in Google AdWords Developer's Guide

object|false checkAds (array $ads, [object AdWordLanguageTarget $languageTarget = ''], [object AdWordGeoTarget $geoTarget = ''], [string $clientEmail = ''])

array $ads: array of objects of class AdWordAd
object AdWordLanguageTarget $languageTarget: object of class AdWordLanguageTarget
object AdWordGeoTarget $geoTarget: object of class AdWordGeoTarget
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Searches for businesses with similar attributes.

This call is similar to querying Google Local Search. All parameters are required.

Example:

 <?php
 $adService = new AdWordAdService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $adService->findBusinesses($name, $address, $countryCode);
 if ($response === false) { // if an error appears
         $errr = $adService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordBusiness
 ?>

return: object of class AdWordBusiness or false on error
see: AdWordBusiness
link: http://www.google.com/apis/adwords/developer/AdService.html#findBusinesses For more information about findBusinesses see in Google AdWords Developer's Guide

object|false findBusinesses (string $name, string $address, string $countryCode, [string $clientEmail = ''])

string $name: Name of the business. Must not be null.
string $address: Location of the business. Format is free form. Examples: "Mountain View, CA" or "1600 Amphitheatre Pkwy, Mountain View, CA". Must not be null.
string $countryCode: Two letter country code of the business address. Must not be null.
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Return all active Ads associated with the list of AdGroup ids specified.

Example:

 <?php
 $adService = new AdWordAdService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $adService->getActiveAds($adGroupIds);
 if ($response === false) { // if an error appears
         $errr = $adService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordAd
 ?>

return: object of class AdWordAd or false on error
see: AdWordAd
link: http://www.google.com/apis/adwords/developer/AdService.html#getActiveAds For more information about getActiveAds see in Google AdWords Developer's Guide

object|false getActiveAds (array $adGroupIds, [string $clientEmail = ''])

array $adGroupIds: An array of AdGroup Ids that own the Ads
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Return information about one Ad.

Example:

 <?php
 $adService = new AdWordAdService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $adService->getAd($adGroupId, $adId);
 if ($response === false) { // if an error appears
         $errr = $adService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordAd
 ?>

return: object of class AdWordAd or false on error
see: AdWordAd
link: http://www.google.com/apis/adwords/developer/AdService.html#getAd For more information about getAd see in Google AdWords Developer's Guide

object|false getAd (int $adGroupId, int $adId, [string $clientEmail = ''])

int $adGroupId: The ID of the AdGroup owning the Ad
int $adId: The ID of the Ad
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Get statistics for a list of ads in an ad group.

The time granularity is one day.

Example:

 <?php
 $adService = new AdWordAdService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $adService->getAdStats($adGroupId, $adIds, $startDay, $endDay, true);
 if ($response === false) { // if an error appears
         $errr = $adService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordStatsRecord
 ?>

return: object of class AdWordStatsRecord or false on error
see: AdWordStatsRecord
link: http://www.google.com/apis/adwords/developer/AdService.html#getAdStats For more information about getAdStats see in Google AdWords Developer's Guide

object|false getAdStats (int $adGroupId, int $adIds, int $startDay, int $endDay, [string $clientEmail = ''])

int $adGroupId: The ID of the AdGroup owning the Ad
int $adIds: The ads to query
int $startDay: The starting day of the period for which statistics are to be collected (xsd:date)
int $endDay: The ending day of the period for which statistics are to be collected, inclusive (xsd:date)
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Return all Ads (enabled, disabled, or paused) associated with the list of AdGroup ids specified.

Example:

 <?php
 $adService = new AdWordAdService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $adService->getAllAds($adGroupIds);
 if ($response === false) { // if an error appears
         $errr = $adService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordAd
 ?>

return: object of class AdWordAd or false on error
see: AdWordAd
link: http://www.google.com/apis/adwords/developer/AdService.html#getAllAds For more information about getAllAds see in Google AdWords Developer's Guide

object|false getAllAds (array $adGroupIds, [string $clientEmail = ''])

array $adGroupIds: An array of AdGroup Ids that own the Ads
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Returns the list of businesses registered to the user in the Local Business Center.

The user is determined by the clientEmail header if it is specified. Otherwise, the email header is used instead.

Example:

 <?php
 $adService = new AdWordAdService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $adService->getMyBusinesses();
 if ($response === false) { // if an error appears
         $errr = $adService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordBusiness
 ?>

return: object of class AdWordBusiness or false on error
see: AdWordBusiness
link: http://www.google.com/apis/adwords/developer/AdService.html#getMyBusinesses For more information about getMyBusinesses see in Google AdWords Developer's Guide

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

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

Returns a list of all videos stored under the users account.

The user is determined by the clientEmail if specified. Otherwise, the email header is used.

Example:

 <?php
 $adService = new AdWordAdService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $adService->getMyVideos();
 if ($response === false) { // if an error appears
         $errr = $adService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordVideo
 ?>

return: object of class AdWordVideo or false on error
see: AdWordVideo
link: http://www.google.com/apis/adwords/developer/AdService.html#getMyVideos For more information about getMyVideos see in Google AdWords Developer's Guide

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

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

Update a batch of ads.

Use the id field of the ad to indicate which ad to update. Currently only the status field is updateable, all other fields will be ignored.

Example:

 <?php
 $criterionService = new AdWordAdService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $criterionService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$ad1, $ad2 is an object of class AdWordAd or any of its descendants
 $ads = array($ad1, $ad2);
 $response = $criterionService->updateAds($ads);
 if ($response === false) { // if an error appears
         $errr = $classKW->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response == true
 ?>

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

bool updateAds (array $ads, [string $clientEmail = ''])

array $ads: array of objects of class AdWordAd
string $clientEmail: provide the clientEmail when you want to edit 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()

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