Class AdWordCampaignService

Description
Description | Methods (details)

AdWords Lib Campaign Service Class

Use this class to work with Google AdWords Campaign Service. CampaignService provides operations for accessing, modifying, and creating AdWords Campaigns

Located in /services/AdWordCampaignService.inc 

AdWordService
   |
   --AdWordCampaignService
Method Summary
Description | Methods (details)
AdWordCampaignService AdWordCampaignService (string $soapToolkit)
object|false addCampaign (object AdWordCampaign $campaign, [string $clientEmail = ''])
array|false addCampaignList (array $campaigns, [string $clientEmail = ''])
array|false getAllAdWordsCampaigns ([string $clientEmail = ''])
object|false getCampaign (int $campaignId, [string $clientEmail = ''])
array|false getCampaignList (array $campaignIds, [string $clientEmail = ''])
array|false getCampaignStats (array $campaignIds, string $start, string $end, [string $clientEmail = ''])
string|false getOptimizeAdServing (int $campaignId, [string $clientEmail = ''])
string|false setOptimizeAdServing (int $campaignId, bool $enable, [string $clientEmail = ''])
bool updateCampaign (object AdWordCampaign $campaign, [string $clientEmail = ''])
bool updateCampaignList (array $campaigns, [string $clientEmail = ''])
Methods
Description | Methods (details)

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

Example: 

  1.  <?php
    2. 

  2.  $campaignService = new AdWordCampaignService(ADWORD_SOAP_TOOLKIT_NUSOAP);
    3. 

  3.  ?>
    4.
Please use defined constants for supported by AdWords Lib toolkit names

AdWordCampaignService AdWordCampaignService (string $soapToolkit)
  • string $soapToolkit: name of a supported by AdWords Lib SOAP Toolkit

Adds a new Campaign

Example: 

  1.  <?php
    2. 

  2.  $campaignService = new AdWordCampaignService(ADWORD_SOAP_TOOLKIT_NUSOAP);
    3. 

  3.  $campaignService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
    4. 

  4.  //$newCampaign is an object of class AdWordCampaign
    5. 

  5.  $response = $campaignService->addCampaign($newCampaign);
    6. 

  6.  if ($response === false) { // if an error appears
    7. 

  7.          $errr = $classKW->getLastError(); //get error object
    8. 

  8.          echo $errr->toString(); //output error
    9. 

  9.          exit();
    10. 

  10.  }
    11. 

  11.  //$response is an object of class AdWordCampaign which holds the new
    12. 

  12.  //created Campaign
    13. 

  13.  ?>
    14.

object|false addCampaign (object AdWordCampaign $campaign, [string $clientEmail = ''])
  • object AdWordCampaign $campaign: the new campaign info
  • string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Adds new Campaigns

Example: 

  1.  <?php
    2. 

  2.  $campaignService = new AdWordCampaignService(ADWORD_SOAP_TOOLKIT_NUSOAP);
    3. 

  3.  $campaignService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
    4. 

  4.  //$campaign1, $campaign2 are objects of class AdWordCampaign
    5. 

  5.  $campaigns = array($campaign1, $campaign2);
    6. 

  6.  $response = $campaignService->addCampaignList($campaigns);
    7. 

  7.  if ($response === false) { // if an error appears
    8. 

  8.          $errr = $classKW->getLastError(); //get error object
    9. 

  9.          echo $errr->toString(); //output error
    10. 

  10.          exit();
    11. 

  11.  }
    12. 

  12.  //$response is an array of objects of class AdWordCampaign which
    13. 

  13.  //holds the new created Campaigns
    14. 

  14.  ?>
    15.

array|false addCampaignList (array $campaigns, [string $clientEmail = ''])
  • array $campaigns: array of objects of class AdWordCampaign
  • string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Returns all Campaigns. If there are no Campaigns, an empty array will be returned

Example: 

  1.  <?php
    2. 

  2.  $campaignService = new AdWordCampaignService(ADWORD_SOAP_TOOLKIT_NUSOAP);
    3. 

  3.  $campaignService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
    4. 

  4.  $response = $adgroupService->getAllAdWordsCampaigns();
    5. 

  5.  if ($response === false) { // if an error appears
    6. 

  6.          $errr = $classKW->getLastError(); //get error object
    7. 

  7.          echo $errr->toString(); //output error
    8. 

  8.          exit();
    9. 

  9.  }
    10. 

  10.  //$response is an array of objects of class AdWordCampaign
    11. 

  11.  ?>
    12.

array|false getAllAdWordsCampaigns ([string $clientEmail = ''])
  • 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 Campaign

Example: 

  1.  <?php
    2. 

  2.  $campaignService = new AdWordCampaignService(ADWORD_SOAP_TOOLKIT_NUSOAP);
    3. 

  3.  $campaignService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
    4. 

  4.  //$campaignId - Campaign's ID
    5. 

  5.  $response = $campaignService->getCampaign($campaignId);
    6. 

  6.  if ($response === false) { // if an error appears
    7. 

  7.          $errr = $classKW->getLastError(); //get error object
    8. 

  8.          echo $errr->toString(); //output error
    9. 

  9.          exit();
    10. 

  10.  }
    11. 

  11.  //$response is an object of class AdWordCampaign
    12. 

  12.  ?>
    13.

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

Returns a list of Campaigns

Example: 

  1.  <?php
    2. 

  2.  $campaignService = new AdWordCampaignService(ADWORD_SOAP_TOOLKIT_NUSOAP);
    3. 

  3.  $campaignService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
    4. 

  4.  //$campaignId1, $campaignId2 - Campaigns' IDs
    5. 

  5.  $campaignIds = array($campaignId1, $campaignId2);
    6. 

  6.  $response = $campaignService->getCampaignList($campaignIds);
    7. 

  7.  if ($response === false) { // if an error appears
    8. 

  8.          $errr = $classKW->getLastError(); //get error object
    9. 

  9.          echo $errr->toString(); //output error
    10. 

  10.          exit();
    11. 

  11.  }
    12. 

  12.  //$response is an array of objects of class AdWordCampaign
    13. 

  13.  ?>
    14.

array|false getCampaignList (array $campaignIds, [string $clientEmail = ''])
  • array $campaignIds: array of Campaigns' 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 ad Campaigns for a period of time

Example: 

  1.  <?php
    2. 

  2.  $campaignService = new AdWordCampaignService(ADWORD_SOAP_TOOLKIT_NUSOAP);
    3. 

  3.  $campaignService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
    4. 

  4.  //$campaignId1, $campaignId2 - Campaigns' IDs
    5. 

  5.  $campaignIds = array($campaignId1, $campaignId2);
    6. 

  6.  $start = '2005-01-01T00:00:00Z';
    7. 

  7.  $end = '2005-02-01T00:00:00Z';
    8. 

  8.  $response = $campaignService->getCampaignStats($campaignIds, $start, $end);
    9. 

  9.  if ($response === false) { // if an error appears
    10. 

  10.          $errr = $classKW->getLastError(); //get error object
    11. 

  11.          echo $errr->toString(); //output error
    12. 

  12.          exit();
    13. 

  13.  }
    14. 

  14.  //$response is an array of objects of class AdWordStatsRecord
    15. 

  15.  ?>
    16.

array|false getCampaignStats (array $campaignIds, string $start, string $end, [string $clientEmail = ''])
  • array $campaignIds: array of Campaigns' 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

Retrieves the 'optimized ad serving' setting for this campaign

Example: 

  1.  <?php
    2. 

  2.  $campaignService = new AdWordCampaignService(ADWORD_SOAP_TOOLKIT_NUSOAP);
    3. 

  3.  $campaignService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
    4. 

  4.  //$campaignId - Campaign's ID
    5. 

  5.  $response = $campaignService->getOptimizeAdServing($campaignId);
    6. 

  6.  if ($response === false) { // if an error appears
    7. 

  7.          $errr = $classKW->getLastError(); //get error object
    8. 

  8.          echo $errr->toString(); //output error
    9. 

  9.          exit();
    10. 

  10.  }
    11. 

  11.  //$response is string - 'true' or 'false'
    12. 

  12.  ?>
    13.

string|false getOptimizeAdServing (int $campaignId, [string $clientEmail = ''])
  • int $campaignId: Campaign ID
  • string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Modifies the 'optimized ad serving' setting for this campaign

Example: 

  1.  <?php
    2. 

  2.  $campaignService = new AdWordCampaignService(ADWORD_SOAP_TOOLKIT_NUSOAP);
    3. 

  3.  $campaignService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
    4. 

  4.  //$campaignId - Campaign's ID
    5. 

  5.  $response = $campaignService->setOptimizeAdServing($campaignId, true);
    6. 

  6.  if ($response === false) { // if an error appears
    7. 

  7.          $errr = $classKW->getLastError(); //get error object
    8. 

  8.          echo $errr->toString(); //output error
    9. 

  9.          exit();
    10. 

  10.  }
    11. 

  11.  //$response = true
    12. 

  12.  ?>
    13.

string|false setOptimizeAdServing (int $campaignId, bool $enable, [string $clientEmail = ''])
  • int $campaignId: Campaign ID
  • bool $enable: if the optimized ad serving should be enabled
  • string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Updates the settings for an existing campaign

Example: 

  1.  <?php
    2. 

  2.  $campaignService = new AdWordCampaignService(ADWORD_SOAP_TOOLKIT_NUSOAP);
    3. 

  3.  $campaignService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
    4. 

  4.  //$campaign is an object of class AdWordCampaign
    5. 

  5.  $response = $campaignService->updateCampaign($campaign);
    6. 

  6.  if ($response === false) { // if an error appears
    7. 

  7.          $errr = $classKW->getLastError(); //get error object
    8. 

  8.          echo $errr->toString(); //output error
    9. 

  9.          exit();
    10. 

  10.  }
    11. 

  11.  //$response == true
    12. 

  12.  ?>
    13.

bool updateCampaign (object AdWordCampaign $campaign, [string $clientEmail = ''])
  • object AdWordCampaign $campaign: object of class AdWordCampaign
  • string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Updates the settings for a list of existing campaigns.

Example: 

  1.  <?php
    2. 

  2.  $campaignService = new AdWordCampaignService(ADWORD_SOAP_TOOLKIT_NUSOAP);
    3. 

  3.  $campaignService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
    4. 

  4.  //$campaign1, $campaign1 are objects of class AdWordCampaign
    5. 

  5.  $campaigns = array($campaign1, $campaign1);
    6. 

  6.  $response = $campaignService->updateCampaignList($campaigns);
    7. 

  7.  if ($response === false) { // if an error appears
    8. 

  8.          $errr = $classKW->getLastError(); //get error object
    9. 

  9.          echo $errr->toString(); //output error
    10. 

  10.          exit();
    11. 

  11.  }
    12. 

  12.  //$response == true
    13. 

  13.  ?>
    14.

bool updateCampaignList (array $campaigns, [string $clientEmail = ''])
  • array $campaigns: array of objects of class AdWordCampaign
  • 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:15 +0300 by phpDocumentor 1.3.2