Docs For Class AdWordTrafficEstimatorService

Description

AdWords Lib Traffic Estimator Service Class

Provides keyword traffic estimates for new or existing keywords, ad groups, and campaigns

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

Located in /services/AdWordTrafficEstimatorService.inc

AdWordService
   |
   --AdWordTrafficEstimatorService

Method Summary

AdWordTrafficEstimatorService AdWordTrafficEstimatorService (string $soapToolkit)

array|false checkKeywordTraffic (array $keywordTrafficRequests, [string $clientEmail = ''])

array|false estimateAdGroupList (array $adGroupRequests, [string $clientEmail = ''])

array|false estimateCampaignList (array $campaignRequests, [string $clientEmail = ''])

array|false estimateKeywordList (array $keywordRequests, [string $clientEmail = ''])

Methods

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

Example:

 <?php
 $trafService = new AdWordTrafficEstimatorService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 ?>

Please use defined constants for supported by AdWords Lib toolkit names

see: AdWordsConsts.inc

AdWordTrafficEstimatorService AdWordTrafficEstimatorService (string $soapToolkit)

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

Check a batch of keywords to see whether they will get any traffic.

If a keyword is not expected to get any traffic, you more than likely don't want to bother adding it. Also, if a keyword is not expected to get any traffic, it is probably not worth calling estimateKeywordList on it.

Example:

 <?php
 $trafService = new AdWordTrafficEstimatorService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $trafService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$keywordTrafficRequests is array of objects of class AdWordKeywordTrafficRequest
 $response = $trafService->checkKeywordTraffic($keywordTrafficRequests);
 if ($response === false) { // if an error appears
         $errr = $classKW->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordKeywordTraffic
 ?>

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

array|false checkKeywordTraffic (array $keywordTrafficRequests, [string $clientEmail = ''])

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

Returns traffic estimates for the requested set of new or existing ad groups.

All of the ad groups must be new or all of the ad groups must be from the same campaign. New ad groups are estimated as if they were part of a new campaign with global targeting

Example:

 <?php
 $trafService = new AdWordTrafficEstimatorService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $trafService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$adgroupReq1, $adgroupReq2 are objects of class AdWordAdGroupRequest
 $adGroupRequests = array($adgroupReq1, $adgroupReq2);
 $response = $trafService->estimateAdGroupList($adGroupRequests);
 if ($response === false) { // if an error appears
         $errr = $classKW->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordAdGroupEstimate
 ?>

return: array of objects of class AdWordAdGroupEstimate or false on error
see: AdWordAdGroupRequest
see: AdWordAdGroupEstimate
link: http://www.google.com/apis/adwords/developer/TrafficEstimatorService.html#estimateAdGroupList For more information about estimateAdGroupList see in Google AdWords Developer's Guide

array|false estimateAdGroupList (array $adGroupRequests, [string $clientEmail = ''])

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

Returns traffic estimates for the requested set of new and/or existing campaigns

Example:

 <?php
 $trafService = new AdWordTrafficEstimatorService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $trafService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$campReq1, $campReq2 are objects of class AdWordCampaignRequest
 $campaignRequests = array($campReq1, $campReq2);
 $response = $trafService->estimateCampaignList($campaignRequests);
 if ($response === false) { // if an error appears
         $errr = $classKW->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordCampaignEstimate
 ?>

return: array of objects of class AdWordCampaignEstimate or false on error
see: AdWordCampaignRequest
see: AdWordCampaignEstimate
link: http://www.google.com/apis/adwords/developer/TrafficEstimatorService.html#estimateCampaignList For more information about estimateCampaignList see in Google AdWords Developer's Guide

array|false estimateCampaignList (array $campaignRequests, [string $clientEmail = ''])

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

Returns traffic estimates for the requested set of new keywords.

All of the keywords must be new. New keywords are estimated as if they were part of a single new ad group in a single new campaign with global targeting.

Example:

 <?php
 $trafService = new AdWordTrafficEstimatorService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $trafService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$keywReq1, $keywReq2 are objects of class AdWordKeywordRequest
 $keywordRequests = array($keywReq1, $keywReq2);
 $response = $trafService->estimateKeywordList($keywordRequests);
 if ($response === false) { // if an error appears
         $errr = $classKW->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordKeywordEstimate
 ?>

return: array of objects of class AdWordKeywordEstimate or false on error
see: AdWordKeywordRequest
see: AdWordKeywordEstimate
link: http://www.google.com/apis/adwords/developer/TrafficEstimatorService.html#estimateKeywordList For more information about estimateKeywordList see in Google AdWords Developer's Guide

array|false estimateKeywordList (array $keywordRequests, [string $clientEmail = ''])

array $keywordRequests: array of objects of class AdWordKeywordRequest
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()