Docs For Class AdWordAdGroupService

AdWordAdGroupService

Description

AdWords Lib AdGroup Class

Use this class to work with Google AdWords AdGroup Service. AdGroupService provides operations for accessing, modifying, and creating AdGroups

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

Located in /services/AdWordAdGroupService.inc

AdWordService
   |
   --AdWordAdGroupService

Method Summary

AdWordAdGroupService AdWordAdGroupService (string $soapToolkit)

object|false addAdGroup (int $campaignID, object AdWordAdGroup $newAdGroup, [string $clientEmail = ''])

array|false addAdGroupList (int $campaignID, array $newAdGroups, [string $clientEmail = ''])

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

array|false getAdGroupList (array $adgroupIDs, [string $clientEmail = ''])

array|false getAdGroupStats (int $campaignId, array $adGroupIds, string $start, string $end, [string $clientEmail = ''])

array|false getAllAdGroups (int $campaignID, [string $clientEmail = ''])

array|false getAllChangedAdGroups (int $campaignID, string $since, [string $clientEmail = ''])

bool updateAdGroup (object AdWordAdGroup $adGroup, [string $clientEmail = ''])

bool updateAdGroupList (array $adGroups, [string $clientEmail = ''])

Methods

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

Example:

 <?php
 $adgroupService = new AdWordAdGroupService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 ?>

Please use defined constants for supported by AdWords Lib toolkit names

see: AdWordsConsts.inc

AdWordAdGroupService AdWordAdGroupService (string $soapToolkit)

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

Adds a new AdGroup to a Campaign.

Example:

 <?php
 $adgroupService = new AdWordAdGroupService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adgroupService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$campaignID - ID of the Campaign to which new AdGroup will be added
 //$newAdGroup is an object of class AdWordAdGroup
 $response = $adgroupService->addAdGroup($campaignID, $newAdGroup);
 if ($response === false) { // if an error appears
         $errr = $classKW->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an object of class AdWordAdGroup which holds the new
 //created AdGroup
 ?>

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

object|false addAdGroup (int $campaignID, object AdWordAdGroup $newAdGroup, [string $clientEmail = ''])

int $campaignID: ID of the Campaign to which new AdGroup will be added
object AdWordAdGroup $newAdGroup: an object of class AdWordAdGroup
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Adds new AdGroups to a Campaign.

Example:

 <?php
 $adgroupService = new AdWordAdGroupService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adgroupService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$campaignID - ID of the Campaign to which new AdGroups will be added
 //$adgroup1, $adgroup2 are objects of class AdWordAdGroup
 $newAdGroups = array($adgroup1, $adgroup2);
 $response = $adgroupService->addAdGroupList($campaignID, $newAdGroups);
 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 AdWordAdGroup which
 //holds the new created AdGroups
 ?>

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

array|false addAdGroupList (int $campaignID, array $newAdGroups, [string $clientEmail = ''])

int $campaignID: ID of the Campaign to which new AdGroups will be added
array $newAdGroups: array of objects of class AdWordAdGroup
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Returns all information about the specified AdGroup

Example:

 <?php
 $adgroupService = new AdWordAdGroupService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adgroupService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$adgroupId - AdGroup's ID
 $response = $adgroupService->getAdGroup($adgroupId);
 if ($response === false) { // if an error appears
         $errr = $classKW->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an object of class AdWordAdGroup
 ?>

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

object|false getAdGroup (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

Returns a list of AdGroups

Example:

 <?php
 $adgroupService = new AdWordAdGroupService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adgroupService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$adgroupId1, $adgroupId2 - AdGroups' IDs
 $adgroupIDs = array($adgroupId1, $adgroupId2);
 $response = $adgroupService->getAdGroupList($adgroupIDs);
 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 AdWordAdGroup
 ?>

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

array|false getAdGroupList (array $adgroupIDs, [string $clientEmail = ''])

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

Gets statistics for a list of ad groups in a Campaign for a period of time

Example:

 <?php
 $adgroupService = new AdWordAdGroupService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adgroupService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$campaignID - ID of the Campaign
 //$adgroup1, $adgroup2 are objects of class AdWordAdGroup
 $adGroupIds = array($adgroup1, $adgroup2);
 $start = '2005-01-01T00:00:00Z';
 $end = '2005-02-01T00:00:00Z';
 $response = $adgroupService->getAdGroupStats($campaignID, $adGroupIds, $start, $end);
 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 AdWordStatsRecord
 ?>

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

array|false getAdGroupStats (int $campaignId, array $adGroupIds, string $start, string $end, [string $clientEmail = ''])

int $campaignId: ID of the Campaign
array $adGroupIds: array of AdGroups' 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

Returns all AdGroups from a Campaign. If there are no AdGroups in this Campaign, an empty array will be returned

Example:

 <?php
 $adgroupService = new AdWordAdGroupService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adgroupService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$campaignID - ID of the Campaign
 $response = $adgroupService->getAllAdGroups($campaignID);
 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 AdWordAdGroup
 ?>

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

array|false getAllAdGroups (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

Removed from AdWords API.

Returns all changed AdGroups from a Campaign. If there are no AdGroups in this Campaign, an empty array will be returned

Example:

 <?php
 $adgroupService = new AdWordAdGroupService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adgroupService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$campaignID - ID of the Campaign
 $since = '2005-01-01T00:00:00Z';
 $response = $adgroupService->getAllChangedAdGroups($campaignID, $since);
 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 AdWordAdGroup
 ?>

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

array|false getAllChangedAdGroups (int $campaignID, string $since, [string $clientEmail = ''])

int $campaignID: ID of the Campaign
string $since: beginning of the period
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Updates the fields of an existing AdGroup

Example:

 <?php
 $adgroupService = new AdWordAdGroupService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adgroupService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$adgroup is an object of class AdWordAdGroup
 $response = $adgroupService->updateAdGroup($adgroup);
 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: AdWordAdGroup
link: http://www.google.com/apis/adwords/developer/AdGroupService.html#updateAdGroup For more information about updateAdGroup see in Google AdWords Developer's Guide

bool updateAdGroup (object AdWordAdGroup $adGroup, [string $clientEmail = ''])

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

Updates the fields of multiple existing AdGroups

Example:

 <?php
 $adgroupService = new AdWordAdGroupService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $adgroupService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$adgroup1, $adgroup2 are objects of class AdWordAdGroup
 $adGroups = array($adgroup1, $adgroup2);
 $response = $adgroupService->updateAdGroupList($adGroups);
 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: AdWordAdGroup
link: http://www.google.com/apis/adwords/developer/AdGroupService.html#updateAdGroupList For more information about updateAdGroupList see in Google AdWords Developer's Guide

bool updateAdGroupList (array $adGroups, [string $clientEmail = ''])

array $adGroups: array of objects of class AdWordAdGroup
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:12 +0300 by phpDocumentor 1.3.2