Docs For Class AdWordCriterionService

AdWordCriterionService

Description

AdWords Lib Criterion Class

Use this class to work with Google AdWords Criterion Service CriterionService provides operations for accessing, modifying, and creating Criteria (Keywords and Websites) in an AdGroup.

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

Located in /services/AdWordCriterionService.inc

AdWordService
   |
   --AdWordCriterionService

Method Summary

AdWordCriterionService AdWordCriterionService (string $soapToolkit)

object|false addCriteria (array $newCriteria, [string $clientEmail = ''])

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

array|false getAllCriteria (int $adGroupId, [string $clientEmail = ''])

array|false getCampaignNegativeCriteria (int $campaignId, [string $clientEmail = ''])

array|false getCriteria (int $adGroupId, array $criterionIds, [string $clientEmail = ''])

array|false getCriterionStats (int $adGroupId, array $criterionIds, string $start, string $end, [string $clientEmail = ''])

bool removeCriteria (int $adGroupId, array $criterionIds, [string $clientEmail = ''])

bool setCampaignNegativeCriteria (array $campaignId, array $criteria, [string $clientEmail = ''])

bool updateCriteria (array $criteria, [string $clientEmail = ''])

Methods

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

Example:

 <?php
 $criterionService = new AdWordCriterionService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 ?>

Please use defined constants for supported by AdWords Lib toolkit names

see: AdWordsConsts.inc

AdWordCriterionService AdWordCriterionService (string $soapToolkit)

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

Adds a new Criteria to an AdGroup.

Example:

 <?php
 $criterionService = new AdWordCriterionService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $criterionService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$newCriteria is an array of objects of class AdWordCriterion
 $response = $criterionService->addCriteria($newCriteria);
 if ($response === false) { // if an error appears
         $errr = $criterionService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordCriterion which hold the new created criteria
 ?>

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

object|false addCriteria (array $newCriteria, [string $clientEmail = ''])

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

Check a batch of criteria for policy errors.

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

Example:

 <?php
 $criterionService = new AdWordCriterionService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $criterionService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$criteria is an array of objects of class AdWordCriterion
 //$languageTarget is an object of class AdWordLanguageTarget
 //$geoTarget is an object of class AdWordGeoTarget
 $response = $criterionService->checkCriteria($criteria, $languageTarget, $geoTarget);
 if ($response === false) { // if an error appears
         $errr = $criterionService->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: AdWordCriterion
link: http://www.google.com/apis/adwords/developer/CriterionService.html#checkCriteria For more information about checkCriteria see in Google AdWords Developer's Guide

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

array $criteria: array of objects of class AdWordCriterion
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

Return a list of criteria associated with this AdGroup.

Example:

 <?php
 $criterionService = new AdWordCriterionService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $criterionService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$adGroupId - ID of the adGroup
 $response = $criterionService->getAllCriteria($adGroupId);
 if ($response === false) { // if an error appears
         $errr = $criterionService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordCriterion
 ?>

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

array|false getAllCriteria (int $adGroupId, [string $clientEmail = ''])

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

Gets a list of the negative criteria associated with a campaign.

Negative criteria determine where the ads in the campaign will not be displayed. Negative website criteria indicate websites where the ads will not appear. Negative keyword criteria indicate keywords that cause the ads to be excluded from display.

Example:

 <?php
 $criterionService = new AdWordCriterionService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $criterionService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$campaignId - ID of the campaign
 $response = $criterionService->getCampaignNegativeCriteria($campaignId);
 if ($response === false) { // if an error appears
         $errr = $criterionService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordCriterion
 ?>

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

array|false getCampaignNegativeCriteria (int $campaignId, [string $clientEmail = ''])

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

Return a list of criteria with the specified IDs associated with this AdGroup.

This function will only return criteria associated with one AdGroup at a time. Invalid IDs are ignored.

Example:

 <?php
 $criterionService = new AdWordCriterionService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $criterionService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$adGroupId - ID of the adGroup
 //$criterionId1, $criterionId2 - Criterion IDs
 $criterionIds = array($criterionId1, $criterionId2);
 $response = $criterionService->getCriteria($adGroupId, $criterionIds);
 if ($response === false) { // if an error appears
         $errr = $criterionService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordCriterion
 ?>

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

array|false getCriteria (int $adGroupId, array $criterionIds, [string $clientEmail = ''])

int $adGroupId: ID of the adGroup
array $criterionIds: array of Criterion IDs
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 criteria in an ad group.

See StatsRecord for details about the statistics returned. The time granularity is one day. We use data types that include timezone information so that the dates can be properly normalized. (Note that statistics are not included for negative criteria.)

Example:

 <?php
 $criterionService = new AdWordCriterionService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $criterionService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$adGroupId - ID of the adGroup
 //$criterionId1, $criterionId2 - Criterion IDs
 $criterionIds = array($criterionId1, $criterionId2);
 $start = '2005-01-01T00:00:00Z';
 $end = '2005-02-01T00:00:00Z';
 $response = $criterionService->getCriterionStats($adGroupId, $criterionIds, $start, $end);
 if ($response === false) { // if an error appears
         $errr = $criterionService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordStatsRecord
 ?>

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

array|false getCriterionStats (int $adGroupId, array $criterionIds, string $start, string $end, [string $clientEmail = ''])

int $adGroupId: ID of the adGroup
array $criterionIds: array of Criteria IDs
string $start: beginning of the period
string $end: end of of the period
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Remove a list of Criteria from an AdGroup.

Note that there is no 'undo' for this operation.

Example:

 <?php
 $criterionService = new AdWordCriterionService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $criterionService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$adGroupId - ID of the adGroup
 //$criterionId1, $criterionId2 - Criterion IDs
 $criterionIds = array($criterionId1, $criterionId2);
 $response = $criterionService->removeCriteria($adGroupId, $criterionIds);
 if ($response === false) { // if an error appears
         $errr = $criterionService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response == true
 ?>

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

bool removeCriteria (int $adGroupId, array $criterionIds, [string $clientEmail = ''])

int $adGroupId: ID of the adGroup
array $criterionIds: Criterion IDs
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Removes all existing negative criteria from a campain and sets new negative criteria for the specified campaign.

Calling this method with a null or empty list clears the negative criteria for the campaign. If your campaign already has some negative criteria and you want to add more, first call getCampaignNegativeCriteria, then add the new negative criteria to the results and send the complete set of negative criteria to setCampaignNegativeCriteria.

Example:

 <?php
 $criterionService = new AdWordCriterionService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $criterionService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$criteria is an array of objects of class AdWordCriterion
 $response = $criterionService->setCampaignNegativeCriteria($campaignId, $criteria);
 if ($response === false) { // if an error appears
         $errr = $criterionService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is true on success, false on failure
 ?>

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

bool setCampaignNegativeCriteria (array $campaignId, array $criteria, [string $clientEmail = ''])

array $campaignId: the campaign id
array $criteria: array of objects of class AdWordCriterion
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Update all mutable fields associated with these Criteria.

Only the maxCpc, maxCpm, negative, and destinationUrl fields are mutable.

Example:

 <?php
 $criterionService = new AdWordCriterionService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $criterionService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$criterion1, $criterion2 is an object of class AdWordCriterion
 $criteria = array($criterion1, $criterion2);
 $response = $criterionService->updateKeywordList($criteria);
 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: AdWordCriterion
link: http://www.google.com/apis/adwords/developer/CriterionService.html#updateCriteria For more information about updateCriteria see in Google AdWords Developer's Guide

bool updateCriteria (array $criteria, [string $clientEmail = ''])

array $criteria: array of objects of class AdWordCriterion
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:17 +0300 by phpDocumentor 1.3.2