Google APIlity Library Documentation

getAdScheduling()

Returns the Campaign's ad schedule.
Parameters:

None

Response:

adScheduling = array(
  'status',
  'intervals' = array(
    array(
      'day',
      'startHour',
      'startMinute',
      'endHour',
      'endMinute',
      'multiplier'
    )
  )
)

Sample:


$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getAdScheduling());

getAllAdGroups()

Returns all AdGroups of a given Campaign.
Parameters:

None

Response:

[AdGroup] allAdGroupObjects

Sample:


$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getAllAdGroups());

getBelongsToClientEmail()

Returns the client email this Campaign belongs to.
Parameters:

None

Response:

String email

Sample:


$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getBelongsToClientEmail();

getBudgetAmount()

Returns the Campaign's budget amount.
Parameters:

None

Response:

Integer budgetAmount

Sample:


$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getBudgetAmount();

getBudgetOptimizerSettings()

Returns the Campaign's budget optimizer settings.
Parameters:

None

Response:

budgetOptimizerSettings = array(
  'bidCeiling',
  'enabled',
  'takeOnOptimizedBids'
)

Sample:


$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getBudgetOptimizerSettings());

getBudgetPeriod()

Returns the Campaign's budget period.
Parameters:

None

Response:

String budgetPeriod

Sample:


$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getBudgetPeriod();

getCampaignData()

Returns all the Campaign's attributes in one go.
Parameters:

None

Response:

campaignData = array(
  'name',
  'id',
  'belongsToClientEmail',
  'status',
  'startDate',
  'endDate',
  'budgetAmount',
  'budgetPeriod',
  'networkTargeting',
  'languages',
  'geoTargets',
  'isEnabledSeparateContentBids',
  'isEnabledOptimizedAdServing'
)

Sample:


$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getCampaignData());

getCampaignNegativeKeywordCriteria()

Returns the Campaign's Negative Keyword Criteria.
Parameters:

None

Response:

campaignNegativeKeywords = array(
  array(
    'text',
    'type'
  )
)

Sample:


$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getCampaignNegativeKeywordCriteria());

getCampaignNegativeWebsiteCriteria()

Returns the Campaign's Negative Website Criteria.
Parameters:

None

Response:

campaignNegativeWebsites = array(
  array(
    'url',
  )
)

Sample:


$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getCampaignNegativeWebsiteCriteria());

getCampaignStats($startDate, $endDate)

Returns the statistical data for a Campaign during the given period of time.
Parameters:

String startDate
String endDate

Response:

campaignStats = array(
  'averagePosition',
  'clicks',
  'conversionRate',
  'conversions',
  'cost',
  'id',
  'impressions',
  'name'
)

Sample:


$yesterday = gmdate(
  "Y-m-d",
  mktime(
    date("H"),
    date("i"),
    date("s"),
    date("m"),
    date("d") - 1,
    date("Y")
  )
);
$dayBeforeYesterday = gmdate(
  "Y-m-d",
  mktime(
    date("H"),
    date("i"),
    date("s"),
    date("m"),
    date("d") - 2,
    date("Y")
  )
);
$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getCampaignStats($dayBeforeYesterday, $yesterday));

getEndDate()

Returns the Campaign's end date.
Parameters:

None

Response:

String endDate

Sample:


$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getEndDate();

getEstimate()

Returns a performance estimate for the Campaign.
Parameters:

None

Response:

campaignEstimate = array(
  array(
    array(
      'text',
      'lowerAveragePosition',
      'upperAveragePosition',
      'lowerCostPerClick',
      'upperCostPerClick',
      'lowerClicksPerDay',
      'upperClicksPerDay'
    ),
    'adGroupName',
    'adGroupId'
  ),
  'campaignName',
  'campaignId'
)

Sample:


$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getEstimate());

getGeoTargets()

Returns the Campaign's geo targetings.
Parameters:

None

Response:

[String] geoTargets

Sample:


$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getGeoTargets());

getId()

Returns the Campaign's ID.
Parameters:

None

Response:

Integer id  // for MySQL use BigInt

Sample:


$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getId();

getIsEnabledOptimizedAdServing()

Returns if the advertisment serving of the Campaign is being optimized.
Parameters:

None

Response:

Boolean isEnabledOptimizedAdServing

Sample:


$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getIsEnabledOptimizedAdServing();

getIsEnabledSeparateContentBids()

Returns if the separate content bids feature is enabled.
Parameters:

None

Response:

Boolean isEnabledSeparateContentBids

Sample:


$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getIsEnabledSeparateContentBids();

getLanguages()

Returns the Campaign's language targeting.
Parameters:

None

Response:

[String] languages

Sample:


$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getLanguages());

getName()

Returns the Campaign's name.
Parameters:

None

Response:

String name

Sample:


$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getName();

getNetworkTargeting()

Returns the Campaign's network targeting.
Parameters:

None

Response:

[String] networkTargeting

Sample:


$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getNetworkTargeting());

getStartDate()

Returns the Campaign's start date.
Parameters:

None

Response:

String startDate

Sample:


$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getStartDate();

getStatus()

Returns the Campaign's status.
Parameters:

None

Response:

String status

Sample:


$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getStatus();

setAdScheduling($newAdScheduling)

Sets the Campaign's new ad schedule.
Parameters:

newAdScheduling = array(
  'status',
  'intervals' = array(
    array(
      'day',
      'startHour',
      'startMinute',
      'endHour',
      'endMinute',
      'multiplier',
    )
  )
)

None

Sample:


$interval1 = array();
  $interval1['multiplier'] = 1.5;
  $interval1['day'] = "Saturday";
  $interval1['startHour'] = 13;
  $interval1['startMinute'] = 0;
  $interval1['endHour'] = 15;
  $interval1['endMinute'] = 15;
$interval2 = array();
  $interval2['multiplier'] = 0.7;
  $interval2['day'] = "Sunday";
  $interval2['startHour'] = 9;
  $interval2['startMinute'] = 30;
  $interval2['endHour'] = 10;
  $interval2['endMinute'] = 45;
$adScheduling = array(
  'status' => "Enabled",
  'intervals' => array(
    $interval1,
    $interval2
  )
);
$campaignObject = createCampaignObject(123456789);
$campaignObject->setAdScheduling($adScheduling);

setBudgetAmount($newBudgetAmount)

Sets a new Campaign budget amount.
Parameters:

Integer newBudgetAmount

Response:

None

Sample:


$campaignObject = createCampaignObject(123456789);
$campaignObject->setBudgetAmount(1000);

setBudgetOptimizerSettings($newBudgetOptimizerSettings)

Sets the Campaign's budget optimizer settings.
Parameters:

newBudgetOptimizerSettings = array(
  'bidCeiling',
  'enabled',
  'takeOnOptimizedBids'
)

Response:

None

Sample:


$campaignObject = createCampaignObject(123456789);
$budgetOptimizerSettings = array(
  'bidCeiling' => 42,
  'enabled' => true,
  'takeOnOptimizedBids' => true
);
$campaignObject->setBudgetOptimizerSettings($budgetOptimizerSettings);

setBudgetPeriod($newBudgetPeriod)

Sets a new Campaign budget period.
Parameters:

String newBudgetPeriod

Response:

None

Sample:


$campaignObject = createCampaignObject(123456789);
$campaignObject->setBudgetPeriod('Daily');

setCampaignNegativeKeywordCriteria($newCampaignNegativeKeywords)

Sets new Campaign Negative Keyword Criteria. Already existing Campaign Negative Keyword Criteria will be overwritten. However, already existing Campaign Negative Website Criteria will be kept.
Parameters:

newCampaignNegativeKeywords = array(
  array(
    'text',
    'type'
  )
)

Response:

None

Sample:


$campaignObject = createCampaignObject(123456789);
$negativeCriterion1 = array('text' => "none", 'type' => "Broad");
$negativeCriterion2 = array('text' => "of these", 'type' => "Phrase");
$campaignObject->setCampaignNegativeKeywordCriteria(
  array($negativeCriterion1, $negativeCriterion2)
);

setCampaignNegativeWebsiteCriteria($newCampaignNegativeWebsites)

Sets new Campaign Negative Website Criteria. Already existing Campaign Negative Website Criteria will be overwritten. However, already existing Campaign Negative Keyword Criteria will be kept.
Parameters:

newCampaignNegativeWebsites = array(
  array(
    'url'
  )
)

Response:

None

Sample:


$campaignObject = createCampaignObject(123456789);
$negativeCriterion1 = array('url' => "spiegel.de");
$negativeCriterion2 = array('url' => "aol.com");
$campaignObject->setCampaignNegativeWebsiteCriteria(
  array($negativeCriterion1, $negativeCriterion2)
);

setConversionOptimizerSettings($conversionOptimizerSettings)

Sets the Campaign's conversion optimizer settings.
Parameters:

newConversionOptimizerSettings = array(
  'enabled',
  'maxCpaBidForAllAdGroups'
)

Response:

None

Sample:


$campaignObject = createCampaignObject(123456789);
$conversionOptimizerSettings = array(
  'enabled' => true,
  'maxCpaBidForAllAdGroups' => 10
);
$campaignObject->setConversionOptimizerSettings($conversionOptimizerSettings);

setEndDate($newEndDate)

Sets a new Campaign end date.
Parameters:

String newEndDate

Response:

None

Sample:


$campaignObject = createCampaignObject(123456789);
$campaignObject->setEndDate("2011-12-17");

setGeoTargets($newGeoTargets)

Sets new Campaign geo targets.
Parameters:

newGeoTargets = array(
  'countryTargets' => array(
    'countries' => array()
  ),
  'regionTargets' => array(
    'regions' => array()
  ),
  'metroTargets' => array(
    'metros' => array()
  ),
  'cityTargets' => array(
    'cities' => array()
  ),
  'proximityTargets' => array(
    'circles' => array(
      'latitudeMicroDegrees',
      'longitudeMicroDegrees',
      'radiusMeters'
    )
  ),
  'targetAll'
)

Response:

None

Sample:


$campaignObject = createCampaignObject(123456789);
$newGeoTargets = array(
  'countryTargets' => array(
    'countries' => array()
  ),
  'regionTargets' => array(
    'regions' => array()
  ),
  'metroTargets' => array(
    'metros' => array()
  ),
  'cityTargets' => array(
    'cities' => array(
      "Reutlingen, BW DE",
 &n

Object Operations getAdScheduling getAllAdGroups getBelongsToClientEmail getBudgetAmount getBudgetOptimizerSettings getBudgetPeriod getCampaignData getCampaignNegativeKeywordCriteria getCampaignNegativeWebsiteCriteria getCampaignStats getEndDate getEstimate getGeoTargets getId getIsEnabledOptimizedAdServing getIsEnabledSeparateContentBids getLanguages getName getNetworkTargeting getStartDate getStatus setAdScheduling setBudgetAmount setBudgetOptimizerSettings setBudgetPeriod setCampaignNegativeKeywordCriteria setCampaignNegativeWebsiteCriteria setConversionOptimizerSettings setEndDate setGeoTargets setIsEnabledOptimizedAdServing setIsEnabledSeparateContentBids setLanguages setName setNetworkTargeting setStatus toXml	Class Operations addCampaign addCampaignList addCampaignsOneByOne createCampaignObject getAllCampaigns getCampaignList removeCampaign
APIlity uses these native API Campaign functions.
These function are defined in the Campaign Service WSDL.

Google APIlity Library Documentation

Google APIlity Library Reference

Quicknavigator

Campaign.php

Object Operations

Class Operations

Object Operations