Quicknavigator
-
» Campaign » AdGroup » Criterion » Ad » Report » KeywordTool » SiteSuggestion » TrafficEstimate » Account » Info
Click the images to resize the class organigram and/or the object hierarchy:
|
Quicknavigator
|
APIlity structure
Click the images to resize the class organigram and/or the object hierarchy:
|
getActiveAdGroups()None[AdGroup] activeAdGroupObjects
$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getActiveAdGroups());
getAdScheduling()NoneadScheduling = array(
'status',
'intervals' = array(
array(
'day',
'startHour',
'startMinute',
'endHour',
'endMinute',
'multiplier'
)
)
)
$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getAdScheduling());
getAllAdGroups()None[AdGroup] allAdGroupObjects
$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getAllAdGroups());
getBelongsToClientEmail()NoneString email
$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getBelongsToClientEmail();
getBudgetAmount()NoneInteger budgetAmount
$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getBudgetAmount();
getBudgetOptimizerSettings()NonebudgetOptimizerSettings = array(
'bidCeiling',
'enabled',
'takeOnOptimizedBids'
)
$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getBudgetOptimizerSettings());
getBudgetPeriod()NoneString budgetPeriod
$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getBudgetPeriod();
getCampaignData()NonecampaignData = array(
'name',
'id',
'belongsToClientEmail',
'status',
'startDate',
'endDate',
'budgetAmount',
'budgetPeriod',
'networkTargeting',
'languages',
'geoTargets',
'isEnabledOptimizedAdServing'
)
$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getCampaignData());
getCampaignNegativeKeywordCriteria()NonecampaignNegativeKeywords = array(
array(
'text',
'type'
)
)
$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getCampaignNegativeKeywordCriteria());
getCampaignNegativeWebsiteCriteria()NonecampaignNegativeWebsites = array(
array(
'url',
)
)
$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getCampaignNegativeWebsiteCriteria());
getCampaignStats($startDate, $endDate)String startDate
String endDatecampaignStats = array(
'averagePosition',
'clicks',
'conversionRate',
'conversions',
'cost',
'id',
'impressions',
'name'
)
$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()NoneString endDate
$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getEndDate();
getEstimate()NonecampaignEstimate = array(
array(
array(
'text',
'lowerAveragePosition',
'upperAveragePosition',
'lowerCostPerClick',
'upperCostPerClick',
'lowerClicksPerDay',
'upperClicksPerDay'
),
'adGroupName',
'adGroupId'
),
'campaignName',
'campaignId'
)
$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getEstimate());
getGeoTargets()None[String] geoTargets
$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getGeoTargets());
getId()NoneInteger id // for MySQL use BigInt
$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getId();
getIsEnabledOptimizedAdServing()NoneBoolean isEnabledOptimizedAdServing
$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getIsEnabledOptimizedAdServing();
getLanguages()None[String] languages
$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getLanguages());
getName()NoneString name
$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getName();
getNetworkTargeting()None[String] networkTargeting
$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getNetworkTargeting());
getRecommendedBudget()NoneBudget recommendedBudget
$campaignObject = createCampaignObject(123456789);
print_r($campaignObject->getRecommendedBudget());
getStartDate()NoneString startDate
$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getStartDate();
getStatus()NoneString status
$campaignObject = createCampaignObject(123456789);
echo $campaignObject->getStatus();
setAdScheduling($newAdScheduling)newAdScheduling = array(
'status',
'intervals' = array(
array(
'day',
'startHour',
'startMinute',
'endHour',
'endMinute',
'multiplier',
)
)
)
$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)Integer newBudgetAmountNone
$campaignObject = createCampaignObject(123456789);
$campaignObject->setBudgetAmount(1000);
setBudgetOptimizerSettings($newBudgetOptimizerSettings)newBudgetOptimizerSettings = array(
'bidCeiling',
'enabled',
'takeOnOptimizedBids'
)None
$campaignObject = createCampaignObject(123456789);
$budgetOptimizerSettings = array(
'bidCeiling' => 42,
'enabled' => true,
'takeOnOptimizedBids' => true
);
$campaignObject->setBudgetOptimizerSettings($budgetOptimizerSettings);
setBudgetPeriod($newBudgetPeriod)String newBudgetPeriodNone
$campaignObject = createCampaignObject(123456789);
$campaignObject->setBudgetPeriod('Daily');
setCampaignNegativeKeywordCriteria($newCampaignNegativeKeywords)newCampaignNegativeKeywords = array(
array(
'text',
'type'
)
)None
$campaignObject = createCampaignObject(123456789);
$negativeCriterion1 = array('text' => "none", 'type' => "Broad");
$negativeCriterion2 = array('text' => "of these", 'type' => "Phrase");
$campaignObject->setCampaignNegativeKeywordCriteria(
array($negativeCriterion1, $negativeCriterion2)
);
setCampaignNegativeWebsiteCriteria($newCampaignNegativeWebsites)newCampaignNegativeWebsites = array(
array(
'url'
)
)None
$campaignObject = createCampaignObject(123456789);
$negativeCriterion1 = array('url' => "spiegel.de");
$negativeCriterion2 = array('url' => "aol.com");
$campaignObject->setCampaignNegativeWebsiteCriteria(
array($negativeCriterion1, $negativeCriterion2)
);
setConversionOptimizerSettings($conversionOptimizerSettings)newConversionOptimizerSettings = array(
'enabled',
'maxCpaBidForAllAdGroups'
)None
$campaignObject = createCampaignObject(123456789);
$conversionOptimizerSettings = array(
'enabled' => true,
'maxCpaBidForAllAdGroups' => 10
);
$campaignObject->setConversionOptimizerSettings($conversionOptimizerSettings);
setEndDate($newEndDate)String newEndDateNone
$campaignObject = createCampaignObject(123456789);
$campaignObject->setEndDate("2011-12-17");
setGeoTargets($newGeoTargets)newGeoTargets = array(
'countryTargets' => array(
'countries' => array(),
'excludedCountries' => array()
),
'regionTargets' => array(
'regions' => array(),
'excludedRegions' => array()
),
'metroTargets' => array(
'metros' => array(),
'excludedMetros' => array()
),
'cityTargets' => array(
'cities' => array(),
'excludedCities' => array()
),
'proximityTargets' => array(
'circles' => array(
'latitudeMicroDegrees',
'longitudeMicroDegrees',
'radiusMeters'
)
),
'targetAll'
)None
$campaignObject = createCampaignObject(123456789);
$newGeoTargets = array(
'countryTargets' => array(
'countries' => array()
),
'regionTargets' => array(
'regions' => array()
),
'metroTargets' => array(
'metros' => array()
),
'cityTargets' => array(
'cities' => array(
"Reutlingen, BW DE",
"Karlsruhe, BW DE"
),
'excludedCities' => array(
"Hamburg, HH DE"
)
),
'proximityTargets' => array(
'circles' => array()
)
);
$campaignObject->setGeoTargets($newGeoTargets);
setIsEnabledOptimizedAdServing($newFlag)Boolean newFlagNone
$campaignObject = createCampaignObject(123456789);
$campaignObject->setIsEnabledOptimizedAdServing(true);
setLanguages($newLanguages)[String] newLanguages // Pass array("all") to select all languagesNone
$campaignObject = createCampaignObject(123456789);
$campaignObject->setLanguages(array("fr", "de"));
setName($newName)String newNameNone
$campaignObject = createCampaignObject(123456789);
$campaignObject->setName("The new name");
setNetworkTargeting($networkTargeting)[String] networkTargeting // Valid values: GoogleSearch, SearchNetwork, ContentNetworkNone
$campaignObject = createCampaignObject(123456789);
$campaignObject->setNetworkTargeting(array("GoogleSearch", "SearchNetwork"));
setStatus($newStatus)String newStatus // Pass "Active" or "Paused"None
$campaignObject = createCampaignObject(123456789);
$campaignObject->setStatus("Active");
toXml()NoneString campaignXml // Contains the Campaign in XML format
$campaignObject = createCampaignObject(123456789);
echo htmlspecialchars($campaignObject->toXml());
addCampaign(
$name,
$status,
$startDate,
$endDate,
$budgetAmount,
$budgetPeriod,
$networkTargeting,
$languages,
$geoTargets,
$adScheduling,
$budgetOptimizerSettings
)String name
String status
String startDate // Pass "" in order to start the Campaign directly after creation
String endDate // Pass "" in order to get a Campaign that never ends
Integer budgetAmount
String budgetPeriod
[String] networkTargeting
[String] languages // Pass array("all") to select all languages
newGeoTargets = array(
'countryTargets' => array(
'countries' => array(),
'excludedCountries' => array(),
),
'regionTargets' => array(
'regions' => array(),
'excludedRegions' => array()
),
'metroTargets' => array(
'metros' => array(),
'excludedMetros' => array()
),
'cityTargets' => array(
'cities' => array(),
'excludedCities' => array(),
),
'proximityTargets' => array(
'circles' => array(
'latitudeMicroDegrees',
'longitudeMicroDegrees',
'radiusMeters'
)
),
'targetAll'
)
{AdScheduling adScheduling}
{BudgetOptimizerSettings budgetOptimizerSettings}Campaign campaignObject
$campaignObject = addCampaign(
"Test",
"Active",
"2007-01-01",
"2011-01-01",
50,
'Daily',
array("GoogleSearch", "ContentNetwork"),
array("fr", "de"),
array(
'countryTargets' => array(
'countries' => array()
),
'regionTargets' => array(
'regions' => array()
),
'metroTargets' => array(
'metros' => array()
),
'cityTargets' => array(
'cities' => array("Grenoble, V FR")
),
'proximityTargets' => array(
'circles' => array()
)
)
);
addCampaignList($campaigns)campaigns = array(
array(
'name',
'status',
'startDate', // Pass "" in order to start the Campaign directly after creation
'endDate', // Pass "" in order to get a Campaign that never ends
'budgetAmount',
'budgetPeriod',
'networkTargeting',
'languages', // Pass array("all") to select all languages
'geoTargets' = array(
'countryTargets' => array(
'countries' => array(),
'excludedCountries' => array()
),
'regionTargets' => array(
'regions' => array(),
'excludedRegions' => array()
),
'metroTargets' => array(
'metros' => array(),
'excludedMetros' => array()
),
'cityTargets' => array(
'cities' => array(),
'excludedCities' => array()
),
'proximityTargets' => array(
'circles' => array(
'latitudeMicroDegrees',
'longitudeMicroDegrees',
'radiusMeters'
)
),
'targetAll'
)
{'adScheduling'}
{'budgetOptimizerSettings'}
)
)[Campaign] campaignObjects
$campaign1 = array(
'name' => "Test1",
'status' => "Active",
'startDate' => "2007-01-01",
'endDate' => "2011-01-01",
'budgetAmount' => 50,
'budgetPeriod' => 'Daily',
'networkTargeting' => array("GoogleSearch", "ContentNetwork"),
'languages' => array("de", "en"),
'geoTargets' => array(
'countryTargets' => array(
'countries' => array()
),
'regionTargets' => array(
'regions' => array()
),
'metroTargets' => array(
'metros' => array()
),
'cityTargets' => array(
'cities' => array(
"Grenoble, V FR"
)
),
'proximityTargets' => array(
'circles' => array()
)
)
);
$campaign2 = array(
'name' => "Test2",
'status' => "Active",
'startDate' => "2007-01-01",
'endDate' => "2011-01-01",
'budgetAmount' => 50,
'budgetPeriod' => 'Daily',
'networkTargeting' => array("GoogleSearch", "ContentNetwork"),
'languages' => array("de"),
'geoTargets' => array(
'countryTargets' => array(
'countries' => array()
),
'regionTargets' => array(
'regions' => array()
),
'metroTargets' => array(
'metros' => array()
),
'cityTargets' => array(
'cities' => array(
"Grenoble, V FR"
)
),
'proximityTargets' => array(
'circles' => array()
)
)
);
$campaignObjects = addCampaignList(array($campaign1, $campaign2));
addCampaignsOneByOne($campaigns)campaigns = array(
array(
'name',
'status',
'startDate', // Pass "" in order to start the Campaign directly after creation
'endDate', // Pass "" in order to get a Campaign that never ends
'budgetAmount',
'budgetPeriod',
'networkTargeting',
'languages', // Pass array("all") to select all languages
'geoTargets' = array(
'countryTargets' => array(
'countries' => array(),
'excludedCountries' => array()
),
'regionTargets' => array(
'regions' => array(),
'excludedRegions' => array()
),
'metroTargets' => array(
'metros' => array(),
'excludedMetros' => array()
),
'cityTargets' => array(
'cities' => array(),
'excludedCities' => array()
),
'proximityTargets' => array(
'circles' => array(
'latitudeMicroDegrees',
'longitudeMicroDegrees',
'radiusMeters'
)
),
'targetAll',
)
{'adScheduling'}
{'budgetOptimizerSettings'}
)
)[Campaign] campaignObjects
$campaign1 = array(
'name' => "Test1",
'status' => "Active",
'startDate' => "2007-01-01",
'endDate' => "2011-01-01",
'budgetAmount' => 50,
'budgetPeriod' => 'Daily',
'networkTargeting' => array("GoogleSearch", "ContentNetwork"),
'languages' => array("de", "en"),
'geoTargets' => array(
'countryTargets' => array(
'countries' => array()
),
'regionTargets' => array(
'regions' => array()
),
'metroTargets' => array(
'metros' => array()
),
'cityTargets' => array(
'cities' => array(
"Grenoble, V FR"
)
),
'proximityTargets' => array(
'circles' => array()
)
)
);
$campaign2 = array(
'name' => "Test2",
'status' => "Active",
'startDate' => "2007-01-01",
'endDate' => "2011-01-01",
'budgetAmount' => 50,
'budgetPeriod' => 'Daily',
'networkTargeting' => array("GoogleSearch", "ContentNetwork"),
'languages' => array("de"),
'geoTargets' => array(
'countryTargets' => array(
'countries' => array()
),
'regionTargets' => array(
'regions' => array()
),
'metroTargets' => array(
'metros' => array()
),
'cityTargets' => array(
'cities' => array(
"Grenoble, V FR"
)
),
'proximityTargets' => array(
'circles' => array()
)
)
);
$campaignObjects = addCampaignsOneByOne(array($campaign1, $campaign2));
createCampaignObject($givenCampaignId)Integer givenCampaignIdCampaign campaignObject
$campaignObject = createCampaignObject(123456789);
getActiveCampaigns()None[Campaign] activeCampaignObjects
$activeCampaigns = getActiveCampaigns();
getAllCampaigns()None[Campaign] allCampaignObjects
$allCampaigns = getAllCampaigns();
getCampaignList($givenCampaignIds)[Integer] givenCampaignIds[Campaign] campaignObjects
$campaignIds = array(123456789, 987654321, 567891234);
$campaignObjects = getCampaignList($campaignIds);
removeCampaign($campaignObject)Campaign campaignObjectNone
$campaignObject = createCampaignObject(123456789);
removeCampaign($campaignObject);
Object OperationsgetActiveAdsgetAdGroupData getAdGroupStats getAllAds getAllCriteria getBelongsToCampaignId getEstimate getId getKeywordContentMaxCpc getKeywordMaxCpc getMaxCpa getName getProxyKeywordMaxCpc getSiteMaxCpc getSiteMaxCpm getStatus setKeywordContentMaxCpc setKeywordMaxCpc setMaxCpa setName setSiteMaxCpc setSiteMaxCpm setStatus toXml |
Class OperationsaddAdGroupaddAdGroupList addAdGroupsOneByOne createAdGroupObject getActiveAdGroups getAdGroupList getAllAdGroups removeAdGroup |
| APIlity uses these native API AdGroup functions. | |
| These function are defined in the AdGroup Service WSDL. | |
getActiveAds()None[Ad] activeAdObjects
$adGroupObject = createAdGroupObject($givenAdGroupId);
print_r($adGroupObject->getActiveAds());
getAdGroupData()NoneadGroupData = array(
'name',
'id',
'belongsToCampaignId',
'keywordMaxCpc',
'siteMaxCpm',
'siteMaxCpc',
'maxCpa',
'keywordContentMaxCpc',
'status'
)
$adGroupObject = createAdGroupObject($givenAdGroupId);
print_r($adGroupObject->getAdGroupData());
getAdGroupStats($startDate, $endDate)String startDate
String endDateadGroupStats = array(
'averagePosition',
'clicks',
'conversionRate',
'conversions',
'cost',
'id',
'impressions',
'name'
)
$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")
)
);
$adGroupObject = createAdGroupObject($givenAdGroupId);
print_r($adGroupObject->getAdGroupStats($dayBeforeYesterday, $yesterday));
getAllAds()None[Ad] allAdObjects
$adGroupObject = createAdGroupObject($givenAdGroupId);
print_r($adGroupObject->getAllAds());
getAllCriteria()None[Criteria] allCriterionObjects
$adGroupObject = createAdGroupObject($givenAdGroupId);
print_r($adGroupObject->getAllCriteria());
getBelongsToCampaignId()NoneInteger belongsToAdGroupId // for MySQL use BigInt
$adGroupObject = createAdGroupObject($givenAdGroupId);
echo $adGroupObject->getBelongsToAdGroupId();
getEstimate()NoneadGroupEstimate = array(
array(
'text',
'lowerAveragePosition',
'upperAveragePosition',
'lowerCostPerClick',
'upperCostPerClick',
'lowerClicksPerDay',
'upperClicksPerDay'
),
'adGroupName',
'adGroupId'
)
$adGroupObject = createAdGroupObject($givenAdGroupId);
print_r($adGroupObject->getEstimate());
getId()NoneInteger id // for MySQL use BigInt
$adGroupObject = createAdGroupObject($givenAdGroupId);
echo $adGroupObject->getId();
getKeywordContentMaxCpc()NoneInteger keywordContentMaxCpc
$adGroupObject = createAdGroupObject($givenAdGroupId);
echo $adGroupObject->getKeywordContentMaxCpc();
getKeywordMaxCpc()NoneInteger keywordMaxCpc
$adGroupObject = createAdGroupObject($givenAdGroupId);
echo $adGroupObject->getKeywordMaxCpc();
getMaxCpa()NoneInteger maxCpa
$adGroupObject = createAdGroupObject($givenAdGroupId);
echo $adGroupObject->getMaxCpa();
getName()NoneString name
$adGroupObject = createAdGroupObject($givenAdGroupId);
echo $adGroupObject->getName();
getProxyKeywordMaxCpc()NoneInteger proxyKeywordMaxCpc
$adGroupObject = createAdGroupObject($givenAdGroupId);
echo $adGroupObject->getProxyKeywordMaxCpc();
getSiteMaxCpc()NoneInteger siteMaxCpc
$adGroupObject = createAdGroupObject($givenAdGroupId);
echo $adGroupObject->getSiteMaxCpc();
getSiteMaxCpm()NoneInteger siteMaxCpm
$adGroupObject = createAdGroupObject($givenAdGroupId);
echo $adGroupObject->getSiteMaxCpm();
getStatus()NoneString status // Enabled, Paused, Deleted
$adGroupObject = createAdGroupObject($givenAdGroupId);
echo $adGroupObject->getStatus();
setKeywordContentMaxCpc($newKeywordContentMaxCpc)Integer newKeywordContentMaxCpcNone
$adGroupObject = createAdGroupObject($givenAdGroupId);
$adGroupObject->setKeywordContentMaxCpc(0.65);
setKeywordMaxCpc($newKeywordMaxCpc)Integer newKeywordMaxCpcNone
$adGroupObject = createAdGroupObject($givenAdGroupId);
$adGroupObject->setKeywordMaxCpc(0.65);
setMaxCpa($newMaxCpa)Integer newMaxCpaNone
$adGroupObject = createAdGroupObject($givenAdGroupId);
$adGroupObject->setMaxCpa(10);
setName($newName)String newNameNone
$adGroupObject = createAdGroupObject($givenAdGroupId);
$adGroupObject->setName("The new name");
setSiteMaxCpc($newSiteMaxCpc)Integer newSiteMaxCpcNone
$adGroupObject = createAdGroupObject($givenAdGroupId);
$adGroupObject->setSiteMaxCpc(10);
setSiteMaxCpm($newMaxCpm)Integer newSiteMaxCpmNone
$adGroupObject = createAdGroupObject($givenAdGroupId);
$adGroupObject->setSiteMaxCpm(0.65);
setStatus($newStatus)String newStatus // Pass "Enabled" or "Paused"None
$adGroupObject = createAdGroupObject($givenAdGroupId);
$adGroupObject->setStatus("Paused");
toXml()NoneString adGroupXml // Contains the AdGroup in XML format
$adGroupObject = createAdGroupObject(123456789);
echo htmlspecialchars($adGroupObject->toXml());
addAdGroup($name, $campaignId, $status, $keywordMaxCpc)String name
Integer belongsToCampaignId
String status
Integer keywordMaxCpc
{Integer siteMaxCpm}
{Integer siteMaxCpc}
{Integer maxCpa}
{Integer keywordContentMaxCpc}AdGroup adGroupObject
$adGroupObject = addAdGroup("Test", 123456789, "Enabled", 0.65);
addAdGroupList($adGroups)adGroups = array(
array(
'name',
'belongsToCampaignId',
'status',
'keywordMaxCpc',
{'siteMaxCpm'},
{'Integer siteMaxCpc'},
{'Integer maxCpa'},
{'keywordContentMaxCpc'}
)
)[AdGroup] adGroupObjects
$adGroup1 = array(
'name' => "Test1",
'belongsToCampaignId' => 123456789,
'status' => "Enabled",
'keywordMaxCpc' => 0.10
);
$adGroup2 = array(
'name' => "Test2",
'belongsToCampaignId' => 123456789,
'status' => "Enabled",
'keywordMaxCpc' => 0.10
);
$adGroupObjects = addAdGroupList(array($adGroup1, $adGroup2));
addAdGroupsOneByOne($adGroups)adGroups = array(
array(
'name',
'belongsToCampaignId',
'status',
'keywordMaxCpc',
{'siteMaxCpm'},
{'Integer siteMaxCpc'},
{'Integer maxCpa'},
{'keywordContentMaxCpc'}
)
)[AdGroup] adGroupObjects
$adGroup1 = array(
'name' => "Test1",
'belongsToCampaignId' => 123456789,
'status' => "Enabled",
'keywordMaxCpc' => 0.10
);
$adGroup2 = array(
'name' => "Test2",
'belongsToCampaignId' => 123456789,
'status' => "Enabled",
'keywordMaxCpc' => 0.10
);
$adGroupObjects = addAdGroupList(array($adGroup1, $adGroup2));
createAdGroupObject($givenAdGroupId)Integer givenAdGroupIdAdGroup adGroupObject
$adGroupObject = createAdGroupObject(123456789);
getActiveAdGroups($campaignId)Integer campaignId[AdGroup] activeAdGroupObjects
$activeAdGroups = getActiveAdGroups(123456789);
getAdGroupList($adGroupIds)[Integer] adGroupIds[AdGroup] adGroupObjects
$adGroupIds = array(123456789, 987654321, 123459876);
$adGroupObjects = getAdGroupList($adGroupIds);
getAllAdGroups($campaignId)Integer campaignId[AdGroup] allAdGroupObjects
$allAdGroups = getAllAdGroups(123456789);
removeAdGroup($adGroupObject)AdGroup adGroupObjectNone
$adGroupObject = createAdGroupObject(123456789);
removeAdGroup($adGroupObject);
getBelongsToAdGroupId()NoneInteger belongsToAdGroupId // for MySQL use BigInt
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getBelongsToAdGroupId();
getCriterionData() // KeywordCriterion objectNonecriterionData = array(
'text',
'id',
'belongsToAdGroupId',
'type',
'criterionType',
'isNegative',
'isPaused',
'maxCpc',
'firstPageCpc',
'qualityScore',
'status',
'language',
'destinationUrl'
)
$criterionObject = createCriterionObject(123456789, 987654321);
print_r($criterionObject->getCriterionData());
getCriterionData() // WebsiteCriterion objectNone$criterionData = array(
'id',
'url',
'belongsToAdGroupId',
'criterionType',
'isNegative',
'maxCpm',
'maxCpc',
'status',
'language',
'destinationUrl'
);
$criterionObject = createCriterionObject(123456789, 987654321);
print_r($criterionObject->getCriterionData());
getCriterionStats($startDate, $endDate)String startDate
String endDatecriterionStats = array(
'averagePosition',
'clicks',
'conversionRate',
'conversions',
'cost',
'id',
'impressions',
'text'
)
$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")
)
);
$criterionObject = createCriterionObject(123456789, 987654321);
print_r($criterionObject->getCriterionStats($dayBeforeYesterday, $yesterday));
getCriterionType()NoneString criterionType
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getCriterionType();
getDestinationUrl()NoneString destinationUrl
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getDestinationUrl();
getEstimate()NonekeywordEstimate = array(
'text',
'lowerAveragePosition',
'upperAveragePosition',
'lowerCostPerClick',
'upperCostPerClick',
'lowerClicksPerDay',
'upperClicksPerDay'
)
$criterionObject = createCriterionObject(123456789, 987654321);
print_r($criterionObject->getEstimate());
getFirstPageCpc()NoneInteger firstPageCpc
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getFirstPageCpc();
getId()NoneInteger id // for MySQL use BigInt
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getId();
getIsNegative()NoneBoolean isNegative
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getIsNegative();
getIsPaused()NoneBoolean isPaused
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getIsPaused();
getLanguage()NoneString language
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getLanguage();
getMaxCpc() // KeywordCriterionNoneInteger maxCpc
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getMaxCpc();
getMaxCpc() // WebsiteCriterionNoneInteger maxCpc
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getMaxCpc();
getMaxCpm()NoneInteger maxCpm
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getMaxCpm();
getProxyMaxCpc()NoneInteger proxyMaxCpc
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getKeywordMaxCpc();
getQualityScore()NoneInteger qualityScore
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getQualityScore();
getStatus()NoneString status
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getStatus;
getText()NoneString criterionText
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getText();
getType()NoneString type
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getType();
getUrl()NoneString url
$criterionObject = createCriterionObject(123456789, 987654321);
echo $criterionObject->getUrl();
setDestinationUrl($newDestinationUrl)String newDestinationUrlNone
$criterionObject = createCriterionObject(123456789, 987654321);
$criterionObject->setDestinationUrl("http://groups.google.com/group/adwords-api-php");
setIsNegative($newFlag)Boolean newFlagNone
$criterionObject = createCriterionObject(123456789, 987654321);
$criterionObject->setIsNegative(true);
setIsPaused($newFlag)Boolean newFlagNone
$criterionObject = createCriterionObject(123456789, 987654321);
$criterionObject->setIsPaused(true);
setLanguage($newLanguage)String newLanguageNone
$criterionObject = createCriterionObject(123456789, 987654321);
$criterionObject->setLanguage("fr");
setMaxCpc($newMaxCpc)Integer newMaxCpcNone
$criterionObject = createCriterionObject(123456789, 987654321);
$criterionObject->setMaxCpc(0.65);
setMaxCpm($newMaxCpm)Integer newMaxCpmNone
$criterionObject = createCriterionObject(123456789, 987654321);
$criterionObject->setMaxCpm(0.65);
setText($newText)String newTextNone
$criterionObject = createCriterionObject(123456789, 987654321);
$criterionObject->setText("The new text");
setType($newType)String newTypeNone
$criterionObject = createCriterionObject(123456789, 987654321);
$criterionObject->setType("Exact");
setUrl($newUrl)String newUrlNone
$criterionObject = createCriterionObject(123456789, 987654321);
$criterionObject->setUrl("groups.google.com");
toXml()NoneString criterionXml // Contains the Criterion in XML format
$criterionObject = createCriterionObject(123456789, 987654321);
echo htmlspecialchars($criterionObject->toXml());
addKeywordCriteriaOneByOne($keywordCriteria)$keywordCriteria = array(
array(
'text',
'belongsToAdGroupId',
'type',
'isNegative',
'maxCpc',
'language',
'destinationUrl',
{'exemptionRequest'}
)
)[KeywordCriterion] criterionObjects
$criterion1 = array(
'text' => "test1",
'belongsToAdGroupId' => 123456789,
'type' => "Broad",
'isNegative' => false,
'maxCpc' => 1.0,
'language' => "de",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$criterion2 = array(
'text' => "test2",
'belongsToAdGroupId' => 123456789,
'type' => "Exact",
'isNegative' => false,
'maxCpc' => 1.0,
'language' => "de",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$criterionObjects = addKeywordCriteriaOnebyOne(array($criterion1, $criterion2));
addKeywordCriterion(
$text,
$belongsToAdGroupId,
$type,
$isNegative,
$maxCpc,
$language,
$destinationUrl
)function addKeywordCriterion(
$text,
$belongsToAdGroupId,
$type,
$isNegative,
$maxCpc,
$language,
$destinationUrl,
$exemptionRequest
)
// Use the above function to upload KeywordCriteria that do not meet the Google Editorial Guidelines.String text
Integer belongsToAdGroupId
String type
Boolean isNegative
Integer maxCpc
String language
String destinationUrl // Pass "" if default AdGroup destination URL should be used
{String exemptionRequest} // Required on policy violation.KeywordCriterion criterionObject
$criterionObject = addKeywordCriterion(
"test",
123456789,
"Exact",
false,
0.65,
"fr",
"http://groups.google.com/group/adwords-api-php"
);
addKeywordCriterionList($keywordCriteria)keywordCriteria = array(
array(
'text',
'belongsToAdGroupId',
'type',
'isNegative',
'maxCpc',
'language',
'destinationUrl',
{'exemptionRequest'}
)
)[KeywordCriterion] criterionObjects
$criterion1 = array(
'text' => "test1",
'belongsToAdGroupId' => 123456789,
'type' => "Broad",
'isNegative' => false,
'maxCpc' => 1.0,
'language' => "de",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$criterion2 = array(
'text' => "test2",
'belongsToAdGroupId' => 123456789,
'type' => "Exact",
'isNegative' => false,
'maxCpc' => 1.0,
'language' => "de",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$criterionObjects = addKeywordCriterionList(array($criterion1, $criterion2));
addWebsiteCriteriaOneByOne($keywords)websiteCriteria = array(
array(
'url',
'belongsToAdGroupId',
'isNegative',
'maxCpm',
'maxCpc',
'destinationUrl'
)
)[WebsiteCriterion] criterionObjects
$criterion1 = array(
'url' => "google.com",
'belongsToAdGroupId' => 123456789,
'isNegative' => false,
'maxCpm' => 0.6,
'maxCpc' => 0,
'destinationUrl' => "http://www.google.com"
);
$criterion2 = array(
'url' => "adwords.com",
'belongsToAdGroupId' => 123456789,
'isNegative' => false,
'maxCpm' => 0.7,
'maxCpc' => 0,
'destinationUrl' => "http://www.adwords.com"
);
$criterionObjects = addWebsiteCriteriaOneByOne(array($criterion1, $criterion2));
addWebsiteCriterion(
$url,
$belongsToAdGroupId,
$isNegative,
$maxCpm,
$maxCpc,
$destinationUrl
)String url
Integer belongsToAdGroupId
Boolean isNegative
Integer maxCpm
Integer maxCpc
String destinationUrlWebsiteCriterion criterionObject
$criterionObject = addWebsiteCriterion(
"google.com",
123456789,
false,
0.6,
0,
"http://www.google.com"
);
addWebsiteCriterionList($websiteCriteria)websiteCriteria = array(
array(
'url',
'belongsToAdGroupId',
'isNegative',
'maxCpm',
'maxCpc',
'destinationUrl'
)
)[WebsiteCriterion] criterionObjects
$criterion1 = array(
'url' => "google.com",
'belongsToAdGroupId' => 123456789,
'isNegative' => false,
'maxCpm' => 0.6,
'maxCpc' => 0,
'destinationUrl' => "http://www.google.com"
);
$criterion2 = array(
'url' => "adwords.com",
'belongsToAdGroupId' => 123456789,
'isNegative' => false,
'maxCpm' => 0.7,
'maxCpc' => 0,
'destinationUrl' => "http://www.adwords.com"
);
$criterionObjects = addWebsiteCriterionList(array($criterion1, $criterion2));
checkCriterionList($criteria, $languages, $geoTargets)[Criterion] criteria
[String] languages
geoTargets = 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'
)[ApiError] criteriaCheck
$criterion1 = array(
'text' => "test1",
'type' => "Broad",
'isNegative' => false,
'maxCpc' => 1.0,
'language' => "de",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$criterion2 = array(
'text' => "test2",
'type' => "Exact",
'isNegative' => false,
'maxCpc' => 1.0,
'language' => "de",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$geoTargets = array(
'countryTargets' => array(
'countries' => array()
),
'regionTargets' => array(
'regions' => array()
),
'metroTargets' => array(
'metros' => array()
),
'cityTargets' => array(
'cities' => array(
"Grenoble, V FR"
)
),
'proximityTargets' => array(
'circles' => array()
)
);
$languages = array('de', 'fr', 'en');
print_r(
checkCriterionList(
array($criterion1, $criterion2),
$languages,
$geoTargets
)
);
createCriterionObject($givenAdGroupId, $givenKeywordId)Integer givenAdGroupId
Integer givenKeywordIdCriterion keywordObject
$criterionObject = createCriterionObject(123456789, 987654321);
getAllCriteria($adGroupId)Integer adGroupId[Criterion] allCriterionObjects
$allCriteria = getAllCriteria(123456789);
getCriterionList($adGroupId, $criterionIds)Integer adGroupId
[Integer] criterionIds[Criterion] criterionObjects
$criterionIds = array(123456789, 987654321, 123459876);
$criterionObjects = getCriterionList(123456789, $criterionIds);
getCriterionListStats($adGroupId, $criterionIds, $startDate, $endDate)Integer adGroupId
[Integer] criterionIds
String startDate
String endDate[StatsObject] criterionStats
$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")
)
);
$criterionIds = array(123456789, 987654321, 123459876);
$criterionStats = getCriterionListStats(123456789, $criterionIds, $dayBeforeYesterday, $yesterday);
removeCriterion($criterionObject)Criterion criterionObjectNone
$criterionObject = createCriterionObject(123456789, 987654321);
removeCriterion($criterionObject);
removeCriterionList($criterionObjects)[Criterion] criterionObjectsNone
$criterionIds = array(123456789, 987654321, 123459876);
$criterionObjects = getCriterionList(123456789, $criterionIds);
removeCriterionList($criterionObjects);
updateCriterionList($criteria)[Criterion] criteriaNone
$criterion1 = array(
'text' => "test1",
'belongsToAdGroupId' => 123456789,
'type' => "Broad",
'isNegative' => false,
'maxCpc' => 1.0,
'language' => "de",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$criterion2 = array(
'text' => "test2",
'belongsToAdGroupId' => 123456789,
'type' => "Exact",
'isNegative' => false,
'maxCpc' => 1.0,
'language' => "de",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
updateCriterionList(array($criterion1, $criterion2));
getAdData() // CommerceAd objectsNoneadData = array(
'id',
'belongsToAdGroupId',
'description1',
'description2',
'headline',
'prePriceAnnotation',
'postPriceAnnotation',
'priceString',
'productImage',
'displayUrl',
'destinationUrl',
'status',
'isDisapproved'
);
$adObject = createAdObject(123456789, 987654321);
print_r($adObject->getAdData());
getAdData() // ImageAd objectNoneadData = array(
'id',
'belongsToAdGroupId',
'image',
'displayUrl',
'destinationUrl',
'status',
'isDisapproved'
);
$adObject = createAdObject(123456789, 987654321);
print_r($adObject->getAdData());
getAdData() // LocalBusinessAd objectsNoneadData = array(
'id',
'belongsToAdGroupId',
'address',
'businessImage',
'businessKey',
'businessName',
'fullBusinessName',
'city',
'countryCode',
'customIcon',
'customIconId',
'description1',
'description2',
'phoneNumber',
'postalCode',
'region',
'stockIcon',
'targetRadiusInKm',
'displayUrl',
'destinationUrl',
'status',
'isDisapproved',
'latitude',
'longitude'
);
$adObject = createAdObject(123456789, 987654321);
print_r($adObject->getAdData());
getAdData() // MobileAd objectNoneadData = array(
'id',
'belongsToAdGroupId',
'businessName',
'countryCode',
'description',
'headline',
'markupLanguages',
'mobileCarriers',
'phoneNumber',
'displayUrl',
'destinationUrl',
'status',
'isDisapproved'
);
$adObject = createAdObject(123456789, 987654321);
print_r($adObject->getAdData());
getAdData() // TextAd objectNoneadData = array(
'id',
'belongsToAdGroupId',
'headline',
'description1',
'description2',
'displayUrl',
'destinationUrl',
'status',
'isDisapproved'
);
$adObject = createAdObject(123456789, 987654321);
print_r($adObject->getAdData());
getAdData() // VideoAd objectsNoneadData = array(
'id',
'belongsToAdGroupId',
'video',
'image',
'name',
'displayUrl',
'destinationUrl',
'status',
'isDisapproved'
);
$adObject = createAdObject(123456789, 987654321);
print_r($adObject->getAdData());
getAdStats($startDate, $endDate)NoneadStats = array(
'averagePosition',
'clicks',
'conversionRate',
'conversions',
'cost',
'id',
'impressions',
'name'
)
$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")
)
);
$adObject = createAdObject(123456789, 987654321);
print_r($adObject->getAdStats($dayBeforeYesterday, $yesterday));
getAdType()NoneString adType
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getAdType();
getAddress()NoneString address
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getAddress();
getBelongsToAdGroupId()NoneInteger belongsToAdGroupId // for MySQL use BigInt
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getBelongsToAdGroupId();
getBusinessImage()NoneImage businessImage
$adObject = createAdObject(123456789, 987654321);
print_r($adObject->getBusinessImage());
getBusinessKey()NoneString businessKey
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getBusinessKey();
getBusinessName()NoneString businessName
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getBusinessName();
getCity()NoneString city
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getCity();
getCountryCode()NoneString countryCode
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getCountryCode();
getCustomIcon()NoneImage customIcon
$adObject = createAdObject(123456789, 987654321);
print_r($adObject->getCustomIcon());
getCustomIconId()NoneInteger customIconId
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getCustomIconId();
getDescription()NoneString description
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getDescription();
getDescription1()NoneString description1
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getDescription1();
getDescription2()NoneString description2
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getDescription2();
getDestinationUrl()NoneString destinationUrl
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getDestinationUrl();
getDisplayUrl()NoneString displayUrl
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getDisplayUrl();
getFullBusinessName()NoneString fullBusinessName
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getFullBusinessName();
getHeadline()NoneString headline
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getHeadline();
getId()NoneInteger id // for MySQL use BigInt
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getId();
getImage()NoneImage image
$adObject = createAdObject(123456789, 987654321);
print_r($adObject->getImage());
getIsDisapproved()NoneBoolean isDisapproved
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getIsDisapproved();
getLatitude()NoneString latitude
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getLatitude();
getLongitude()NoneString longitude
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getLongitude();
getMarkupLanguages()None[String] markupLanguages
$adObject = createAdObject(123456789, 987654321);
print_r($adObject->getMarkupLanguages());
getMobileCarriers()None[String] mobileCarriers
$adObject = createAdObject(123456789, 987654321);
print_r($adObject->getMobileCarriers());
getName()NoneString name
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getName();
getPhoneNumber()NoneString phoneNumber
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getPhoneNumber();
getPostPriceAnnotation()NoneString postPriceAnnotation
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getPostPriceAnnotation();
getPostalCode()NoneString postalCode
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getPostalCode();
getPrePriceAnnotation()NoneString prePriceAnnotation
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getPrePriceAnnotation();
getPriceString()NoneString priceString
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getPriceString();
getProductImage()NoneImage productImage
$adObject = createAdObject(123456789, 987654321);
print_r($adObject->getProductImage());
getRegion()NoneString region
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getRegion();
getStatus()NoneString status
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getStatus();
getStockIcon()NoneString stockIcon
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getStockIcon();
getTargetRadiusInKm()NoneString targetRadius
$adObject = createAdObject(123456789, 987654321);
echo $adObject->getTargetRadiusInKm();
getVideo()NoneVideo video
$adObject = createAdObject(123456789, 987654321);
print_r($adObject->getVideo());
setDescription1 ($newDescription1)String description1None
$adObject = createAdObject(123456789, 987654321);
$adObject->setDescription1 ("The new description1");
setDescription2 ($newDescription2)String description2None
$adObject = createAdObject(123456789, 987654321);
$adObject->setDescription2 ("The new description2");
setDestinationUrl ($newDestinationUrl)String destinationUrlNone
$adObject = createAdObject(123456789, 987654321);
$adObject->setDestinationUrl("http://groups.google.com/group/adwords-api-php");
setDisplayUrl ($newDisplayUrl)String displayUrlNone
$adObject = createAdObject(123456789, 987654321);
$adObject->setDisplayUrl ("http://groups.google.com/group/adwords-api-php");
setHeadline ($newHeadline)String headlineNone
$adObject = createAdObject(123456789, 987654321);
$adObject->setHeadline ("The new headline");
setStatus ($newStatus)String statusNone
$adObject = createAdObject(123456789, 987654321);
$adObject->setStatus ("Paused");
toXml()NoneString Xml // Contains the Ad in XML format
$adObject = createAdObject(123456789, 987654321);
echo htmlspecialchars($adObject->toXml());
addCommerceAd(
$belongsToAdGroupId,
$description1,
$description2,
$headline,
$postPriceAnnotation,
$prePriceAnnotation,
$priceString,
$productImageLocation,
$status,
$displayUrl,
$destinationUrl
) Integer belongsToAdGroupId
String description1
String description2
String headline
String prePriceAnnotation
String postPriceAnnotation
String priceString
String productImageLocation
String status
String displayUrl
String destinationUrlAd adObject
$commerceAd = addCommerceAd(
123456789,
"Description 1",
"Description 2",
"Headline",
"pre-price",
"post-price",
"price",
"TestSuite_CommerceAd.gif",
"Enabled",
"http://groups.google.com",
"http://groups.google.com/group/adwords-api-php"
);
addCommerceAdList($ads) ads = array(
array(
'belongsToAdGroupId',
'description1',
'description2',
'headline',
'prePriceAnnotation',
'postPriceAnnotation',
'priceString',
'productImageLocation',
'status',
'displayUrl',
'destinationUrl'
)
)[Ad] adObjects
$commerceAd1 = array(
'belongsToAdGroupId' => 123456789,
'description1' => "Description 1",
'description2' => "Description 2",
'headline' => "Headline1",
'prePriceAnnotation' => "pre-price",
'postPriceAnnotation' => "post-price",
'priceString' => "price",
'productImageLocation' => "TestSuite_CommerceAd.gif",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$commerceAd2 = array(
'belongsToAdGroupId' => 123456789,
'description1' => "Description 1",
'description2' => "Description 2",
'headline' => "Headline2",
'prePriceAnnotation' => "pre-price",
'postPriceAnnotation' => "post-price",
'priceString' => "price",
'productImageLocation' => "TestSuite_CommerceAd.gif",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$commerceAds = addCommerceAdList(array($commerceAd1, $commerceAd2));
addCommerceAdsOneByOne($ads) ads = array(
array(
'belongsToAdGroupId',
'description1',
'description2',
'headline',
'prePriceAnnotation',
'postPriceAnnotation',
'priceString',
'productImageLocation',
'status',
'displayUrl',
'destinationUrl'
)
)[Ad] adObjects
$commerceAd1 = array(
'belongsToAdGroupId' => 123456789,
'description1' => "Description 1",
'description2' => "Description 2",
'headline' => "Headline1",
'prePriceAnnotation' => "pre-price",
'postPriceAnnotation' => "post-price",
'priceString' => "price",
'productImageLocation' => "TestSuite_CommerceAd.gif",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$commerceAd2 = array(
'belongsToAdGroupId' => 123456789,
'description1' => "Description 1",
'description2' => "Description 2",
'headline' => "Headline2",
'prePriceAnnotation' => "pre-price",
'postPriceAnnotation' => "post-price",
'priceString' => "price",
'productImageLocation' => "TestSuite_CommerceAd.gif",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$commerceAds = addCommerceAdsOneByOne(array($commerceAd1, $commerceAd2));
addImageAd(
$belongsToAdGroupId,
$imageLocation,
$name,
$status,
$displayUrl,
$destinationUrl
) Integer belongsToAdGroupId
String imageLocation // Pass [image URL] XOR [path]+[fileName] RELATIVE to your web server's root folder (often called "htdocs")
String name
String status
String displayUrl
String destinationUrlAd adObject
$imageAd = addImageAd(
123456789,
"Creative-TestSuite_Banner.jpg",
"Test",
"Enabled",
"http://groups.google.com/group/adwords-api-php",
"http://groups.google.com/group/adwords-api-php"
);
addImageAdList($ads) ads = array(
array(
'belongsToAdGroupId',
'imageLocation',
'name',
'status',
'displayUrl',
'destinationUrl'
)
)[Ad] adObjects
$imageAd1 = array(
'belongsToAdGroupId' => 123456789,
'imageLocation' => "Creative-TestSuite_Banner.jpg",
'name' => "Test1",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$imageAd2 = array(
'belongsToAdGroupId' => 123456789,
'imageLocation' => "Creative-TestSuite_Banner.jpg",
'name' => "Test2",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$imageAds = addImageAdList(array($imageAd1, $imageAd2));
addImageAdsOneByOne($ads) ads = array(
array(
'belongsToAdGroupId',
'imageLocation',
'name',
'status',
'displayUrl',
'destinationUrl'
)
)[Ad] adObjects
$imageAd1 = array(
'belongsToAdGroupId' => 123456789,
'imageLocation' => "Creative-TestSuite_Banner.jpg",
'name' => "Test1",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$imageAd2 = array(
'belongsToAdGroupId' => 123456789,
'imageLocation' => "Creative-TestSuite_Banner.jpg",
'name' => "Test2",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$imageAds = addImageAdsOneByOne(array($imageAd1, $imageAd2));
addLocalBusinessAd(
$belongsToAdGroupId,
$address,
$businessImageLocation,
$businessKey,
$businessName,
$city,
$countryCode,
$customIconLocation,
$customIconId,
$description1,
$description2,
$phoneNumber,
$postalCode,
$region,
$stockIcon,
$targetRadiusInKm,
$status,
$displayUrl,
$destinationUrl,
$exemptionRequest = false
) Integer belongsToAdGroupId
String address
String businessImageLocation
String businessKey
String businessName
String city
String countryCode
{String customIconLocation} // XOR customIconId XOR stockIcon
{Integer customIconId} // XOR stockIcon XOR customIconLocation
String description1
String description2
String phoneNumber
String postalCode
String region
{String stockIcon} // XOR customIconId XOR customIconLocation
Integer targetRadiusInKm
String status
String displayUrl
String destinationUrl
{String exemptionRequest} // Required on policy violation.Ad adObject
$localBusinessAd = addLocalBusinessAd(
123456789,
'ABC Street 123',
'./TestSuite_LocalBusinessAd.gif',
'Some!Cryptic!Business!Key!Assigned!To!Your!Business',
'Your Business Name',
'Mountain View',
'US',
null,
null,
'Your Description 1',
'Your Description 2',
'123 456 789',
'12345',
'Bay Area',
'Standard_1',
16.09344,
'Enabled',
'www.google-apility.sourceforge.net',
'http://www.google-apility.sourceforge.net/'
);
addLocalBusinessAdList($ads) ads = array(
array(
'belongsToAdGroupId',
'address',
'businessImageLocation',
'businessKey',
'businessName',
'city',
'countryCode',
'customIconLocation',
'customIconId',
'description1',
'description2',
'phoneNumber',
'postalCode',
'region',
'stockIcon',
'targetRadiusInKm',
'status',
'displayUrl',
'destinationUrl',
{'exemptionRequest'}
)
)[Ad] adObjects
$ad1 = array(
'belongsToAdGroupId' => 123456789,
'address' => 'ABC Street 123',
'businessImageLocation' => './TestSuite_LocalBusinessAd1.gif',
'businessKey' => 'Some!Cryptic!Business!Key!Assigned!To!Your!Business 1',
'businessName' => 'Your Business Name 1',
'city' => 'Mountain View',
'countryCode' => 'US',
'customIconLocation' => null,
'customIconId' => null,
'description1' => 'Your Description 1',
'description2' => 'Your Description 2',
'phoneNumber' => '123 456 789',
'postalCode' => '12345',
'region' => 'Bay Area',
'stockIcon' => 'Standard_1',
'targetRadiusInKm' => 16.09344,
'status' => 'Enabled',
'displayUrl' => 'www.google-apility.sourceforge.net',
'destinationUrl' => 'http://www.google-apility.sourceforge.net/'
);
$ad2 = array(
'belongsToAdGroupId' => 123456789,
'address' => 'XYZ Street 321',
'businessImageLocation' => './TestSuite_LocalBusinessAd2.gif',
'businessKey' => 'Some!Cryptic!Business!Key!Assigned!To!Your!Business 2',
'businessName' => 'Your Business Name 2',
'city' => 'Mountain View',
'countryCode' => 'US',
'customIconLocation' => null,
'customIconId' => null,
'description1' => 'Your Description 1',
'description2' => 'Your Description 2',
'phoneNumber' => '987 654 321',
'postalCode' => '54321',
'region' => 'Bay Area',
'stockIcon' => 'Standard_2',
'targetRadiusInKm' => 16.09344,
'status' => 'Enabled',
'displayUrl' => 'www.google-apility.sourceforge.net',
'destinationUrl' => 'http://www.google-apility.sourceforge.net/'
);
$localBusinessAds = addLocalBusinessAdList(array($ad1, $ad2));
addLocalBusinessAdsOneByOne($ads) ads = array(
array(
'belongsToAdGroupId',
'address',
'businessImageLocation',
'businessKey',
'businessName',
'city',
'countryCode',
'customIconLocation',
'customIconId',
'description1',
'description2',
'phoneNumber',
'postalCode',
'region',
'stockIcon',
'targetRadiusInKm',
'status',
'displayUrl',
'destinationUrl',
{'exemptionRequest'}
)
)[Ad] adObjects
$ad1 = array(
'belongsToAdGroupId' => 123456789,
'address' => 'ABC Street 123',
'businessImageLocation' => './TestSuite_LocalBusinessAd1.gif',
'businessKey' => 'Some!Cryptic!Business!Key!Assigned!To!Your!Business 1',
'businessName' => 'Your Business Name 1',
'city' => 'Mountain View',
'countryCode' => 'US',
'customIconLocation' => null,
'customIconId' => null,
'description1' => 'Your Description 1',
'description2' => 'Your Description 2',
'phoneNumber' => '123 456 789',
'postalCode' => '12345',
'region' => 'Bay Area',
'stockIcon' => 'Standard_1',
'targetRadiusInKm' => 16.09344,
'status' => 'Enabled',
'displayUrl' => 'www.google-apility.sourceforge.net',
'destinationUrl' => 'http://www.google-apility.sourceforge.net/'
);
$ad2 = array(
'belongsToAdGroupId' => 123456789,
'address' => 'XYZ Street 321',
'businessImageLocation' => './TestSuite_LocalBusinessAd2.gif',
'businessKey' => 'Some!Cryptic!Business!Key!Assigned!To!Your!Business 2',
'businessName' => 'Your Business Name 2',
'city' => 'Mountain View',
'countryCode' => 'US',
'customIconLocation' => null,
'customIconId' => null,
'description1' => 'Your Description 1',
'description2' => 'Your Description 2',
'phoneNumber' => '987 654 321',
'postalCode' => '54321',
'region' => 'Bay Area',
'stockIcon' => 'Standard_2',
'targetRadiusInKm' => 16.09344,
'status' => 'Enabled',
'displayUrl' => 'www.google-apility.sourceforge.net',
'destinationUrl' => 'http://www.google-apility.sourceforge.net/'
);
$localBusinessAds = addLocalBusinessAdsOneByOne(array($ad1, $ad2));
addMobileAd(
$belongsToAdGroupId,
$businessName,
$countryCode,
$description,
$headline,
$markupLanguages,
$mobileCarriers,
$phoneNumber,
$status,
$displayUrl,
$destinationUrl,
$exemptionRequest = false
) Integer belongsToAdGroupId
String businessName
String countryCode
String description
String headline
[String] markupLanguages
[String] mobileCarriers
String phoneNumber
String status
String displayUrl
String destinationUrl
String {exemptionRequest} // Required on policy violation.Ad adObject
$mobileAd = addMobileAd(
123456789,
"Test Business Inc.",
"US",
"Test Business Description",
"Test Business Headline",
array("XHTML"),
array("Cingular@US"),
"800-123-4567",
"Enabled",
"http://groups.google.com/group/adwords-api-php",
"http://groups.google.com/group/adwords-api-php"
);
addMobileAdList($ads) ads = array(
array(
'belongsToAdGroupId',
'businessName',
'countryCode',
'description',
'headline',
'markupLanguages',
'mobileCarriers',
'phoneNumber',
'status',
'displayUrl',
'destinationUrl',
'{exemptionRequest}' // Required on policy violation.
)
)[Ad] adObjects
$ad1 = array(
'belongsToAdGroupId' => 123456789,
'businessName' => "Test Business 1 Inc.",
'countryCode' => "US",
'description' => "Test Business 1 Description",
'headline' => "Test Business 1 Headline",
'markupLanguages' => array("XHTML"),
'mobileCarriers' => array("Cingular@US"),
'phoneNumber' => "800-123-4567",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$ad2 = array(
'belongsToAdGroupId' => 123456789,
'businessName' => "Test Business 2 Inc.",
'countryCode' => "US",
'description' => "Test Business 2 Description",
'headline' => "Test Business 2 Headline",
'markupLanguages' => array("XHTML"),
'mobileCarriers' => array("Cingular@US"),
'phoneNumber' => "800-123-5678",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$mobileAds = addMobileAdList(array($ad1, $ad2));
addMobileAdsOneByOne($ads) ads = array(
array(
'belongsToAdGroupId',
'businessName',
'countryCode',
'description',
'headline',
'markupLanguages',
'mobileCarriers',
'phoneNumber',
'status',
'displayUrl',
'destinationUrl',
'{exemptionRequest}' // Required on policy violation.
)
)[Ad] adObjects
$ad1 = array(
'belongsToAdGroupId' => 123456789,
'businessName' => "Test Business 1 Inc.",
'countryCode' => "US",
'description' => "Test Business 1 Description",
'headline' => "Test Business 1 Headline",
'markupLanguages' => array("XHTML"),
'mobileCarriers' => array("Cingular@US"),
'phoneNumber' => "800-123-4567",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$ad2 = array(
'belongsToAdGroupId' => 123456789,
'businessName' => "Test Business 2 Inc.",
'countryCode' => "US",
'description' => "Test Business 2 Description",
'headline' => "Test Business 2 Headline",
'markupLanguages' => array("XHTML"),
'mobileCarriers' => array("Cingular@US"),
'phoneNumber' => "800-123-5678",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$mobileAds = addMobileAdsOneByOne(array($ad1, $ad2));
addMobileImageAd(
$belongsToAdGroupId,
$imageLocation,
$markupLanguages,
$mobileCarriers,
$status,
$displayUrl,
$destinationUrl,
$exemptionRequest = false
) Integer belongsToAdGroupId
String imageLocation
[String] markupLanguages
[String] mobileCarriers
String status
String displayUrl
String destinationUrl
String {exemptionRequest} // Required on policy violation.Ad adObject
$mobileImageAd = addMobileAd(
123456789,
"192x53.gif"
array("XHTML"),
array("Cingular@US"),
"Enabled",
"www.google.com",
"http://google.com/"
);
addMobileImageAdList($ads) ads = array(
array(
'belongsToAdGroupId',
'imageLocation'
'markupLanguages',
'mobileCarriers',
'status',
'displayUrl',
'destinationUrl',
'{exemptionRequest}' // Required on policy violation.
)
)[Ad] adObjects
$ad1 = array(
'belongsToAdGroupId' => 123456789,
'imageLocation' => "192x53_1.gif",
'markupLanguages' => array("XHTML"),
'mobileCarriers' => array("Cingular@US"),
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$ad2 = array(
'belongsToAdGroupId' => 123456789,
'imageLocation' => "192x53_1.gif",
'markupLanguages' => array("XHTML"),
'mobileCarriers' => array("Cingular@US"),
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$mobileAds = addMobileImageAdList(array($ad1, $ad2));
addMobileImageAdsOneByOne($ads) ads = array(
array(
'belongsToAdGroupId',
'imageLocation',
'markupLanguages',
'mobileCarriers',
'status',
'displayUrl',
'destinationUrl',
'{exemptionRequest}' // Required on policy violation.
)
)[Ad] adObjects
$ad1 = array(
'belongsToAdGroupId' => 123456789,
'imageLocation' => "192x53_1.gif",
'markupLanguages' => array("XHTML"),
'mobileCarriers' => array("Cingular@US"),
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$ad2 = array(
'belongsToAdGroupId' => 123456789,
'imageLocation' => "192x53_2.gif",
'markupLanguages' => array("XHTML"),
'mobileCarriers' => array("Cingular@US"),
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$mobileAds = addMobileImageAdsOneByOne(array($ad1, $ad2));
addTextAd(
$belongsToAdGroupId,
$headline,
$description1,
$description2,
$status,
$displayUrl,
$destinationUrl,
$exemptionRequest = false
)Integer belongsToAdGroupId
String headline
String description1
String description2
String status
String displayUrl
String destinationUrl
{exemptionRequest} // Required on policy violation.Ad adObject
$adObject = addTextAd(
123456789,
"The headline",
"The description1",
"The description2",
"Enabled",
"http://groups.google.com/group/adwords-api-php",
"http://groups.google.com/group/adwords-api-php"
);
addTextAdList($ads)ads = array(
array(
'belongsToAdGroupId',
'headline',
'description1',
'description2',
'status',
'displayUrl',
'destinationUrl',
{'exemptionRequest'}
)
)[Ad] adObjects
$ad1 = array(
'belongsToAdGroupId' => 123456789,
'headline' => "The first headline",
'description1' => "The first description1",
'description2' => "The first description2",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$ad2 = array(
'belongsToAdGroupId' => 123456789,
'headline' => "The second headline",
'description1' => "The second description1",
'description2' => "The second description2",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$adObjects = addTextAdList(array($ad1, $ad2));
addTextAdsOneByOne($ads) ads = array(
array(
'belongsToAdGroupId',
'headline',
'description1',
'description2',
'status',
'displayUrl',
'destinationUrl',
{'exemptionRequest'}
)
)[Ad] adObjects
$ad1 = array(
'belongsToAdGroupId' => 123456789,
'headline' => "The first headline",
'description1' => "The first description1",
'description2' => "The first description2",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$ad2 = array(
'belongsToAdGroupId' => 123456789,
'headline' => "The second headline",
'description1' => "The second description1",
'description2' => "The second description2",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$adObjects = addTextAdsOneByOne(array($ad1, $ad2));
addVideoAd(
$belongsToAdGroupId,
$imageLocation,
$name,
$video,
$displayUrl,
$destinationUrl,
$status,
$exemptionRequest = false,
)Integer belongsToAdGroupId
String imageLocation
String name
Video video
String displayUrl
String destinationUrl
String status
{exemptionRequest} // Required on policy violation.Ad adObject
$videos = getMyVideos();
$adObject = addVideoAd(
123456789,
"./image.jpg",
"The Name",
$video[0],
"http://groups.google.com/group/adwords-api-php",
"http://groups.google.com/group/adwords-api-php",
"Enabled"
);
checkAdList($adObjects, $languages, $geoTargets)[Ad] ads
[String] languages
geoTargets = 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' =>
)[ApiError] adsCheck
$ad1 = array(
'headline' => "The first headline",
'description1' => "The first description1",
'description2' => "The first description2",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$ad2 = array(
'headline' => "The second headline",
'description1' => "The second description1",
'description2' => "The second description2",
'status' => "Enabled",
'displayUrl' => "http://groups.google.com/group/adwords-api-php",
'destinationUrl' => "http://groups.google.com/group/adwords-api-php"
);
$adObjects = array($ad1, $ad2);
$geoTargets = array(
'countryTargets' => array(
'countries' => array()
),
'regionTargets' => array(
'regions' => array()
),
'metroTargets' => array(
'metros' => array()
),
'cityTargets' => array(
'cities' => array("Grenoble, V FR")
),
'proximityTargets' => array(
'circles' => array()
)
);
$languages = array('de', 'fr', 'en');
print_r(checkAdList($adObjects, $languages, $geoTargets));
createAdObject($givenAdGroupId, $givenAdId) Integer givenAdGroupId
Integer givenAdIdAd adObject
print_r(createAdObject(123456789, 987654321));
findBusinesses($name, $address, $countryCode) String name
String address
String countryCode[Business] businesses
print_r(findBusinesses('Farmacia', 'Barcelona', 'ES'));
getActiveAds($adGroupIds) [Integer] adGroupIds[Ad] adObjects
$allAds = getActiveAds(array(123456789));
getAllAds($adGroupIds) [Integer] adGroupIds[Ad] adObjects
$allAds = getAllAds(array(123456789));
getMyBusinesses() None[Business] myBusinesses
print_r(getMyBusinesses());
getMyVideos()None[Video] videos
$myVideos = getMyVideos();
removeAd($adObject)Ad adObjectnone
$adObject = createAdObject(123456789, 987654321);
$adObject->removeAd($adObject);
deleteReport($reportJobId)Integer reportJobIdNone
$allReportJobs = getAllJobs();
foreach($allReportJobs as $reportJob) {
deleteReport($reportJob['Id']);
}
downloadTsvReport($reportId)Integer reportIdString tsvReport // Contains the report in TSV file format
$tsvReport = downloadTsvReport(12345);
echo $tsvReport;
downloadXmlReport($reportId)Integer reportIdString xmlReport // Contains the report in XML file format
$xmlReport = downloadXmlReport(12345);
echo $xmlReport;
getAccountStructureTsvReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportTsv
echo getAccountStructureTsvReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('AdGroup', 'AdGroupId'),
array('AdGroup'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
false
);
getAccountStructureXmlReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportXml
echo getAccountStructureXmlReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('AdGroup', 'AdGroupId'),
array('AdGroup'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
false
);
getAccountTsvReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportTsv
echo getAccountTsvReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('CustomerName'),
array('Weekly'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
false
);
getAccountXmlReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportXml
echo getAccountXmlReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('CustomerName'),
array('Weekly'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
false
);
getAdGroupTsvReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportTsv
echo getAdGroupTsvReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('AdGroup', 'AdGroupId'),
array('Weekly'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
false
);
getAdGroupXmlReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportXml
echo getAdGroupXmlReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('AdGroup', 'AdGroupId'),
array('Weekly'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
false
);
getAllJobs()None[ReportJob] allReportJobs
print_r(getAllJobs());
getCampaignTsvReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportTsv
echo getCampaignTsvReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('Campaign', 'CampaignId'),
array('Weekly'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
false
);
getCampaignXmlReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportXml
echo getCampaignXmlReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('Campaign', 'CampaignId'),
array('Weekly'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
false
);
getContentPlacementTsvReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportTsv
echo getContentPlacementTsvReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('AdGroup', 'PlacementUrl'),
array('AdGroup', 'Url', 'Weekly'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
false
);
getContentPlacementXmlReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportXml
echo getContentPlacementXmlReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('AdGroup', 'PlacementUrl'),
array('AdGroup', 'Url', 'Weekly'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
false
);
getCreativeTsvReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportTsv
echo getCreativeTsvReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('CreativeId'),
array('Weekly'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
false
);
getCreativeXmlReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportXml
echo getCreativeXmlReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('CreativeId'),
array('Weekly'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
false
);
getGeographicTsvReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportTsv
echo getGeographicTsvReport(
'Report Name',
'2008-09-01',
'2008-12-01',
array('Country', 'Account'),
array('Account'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
true
);
getGeographicXmlReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportXml
echo getGeographicXmlReport(
'Report Name',
'2008-09-01',
'2008-12-01',
array('Country', 'Account'),
array('Account'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
true
);
getKeywordTsvReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportTsv
echo getKeywordTsvReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('Keyword', 'KeywordId'),
array('Weekly'),
array(),
array(),
array(),
array(),
array(),
array(),
'SearchOnly',
'Broad',
false,
array(),
false,
30,
false
);
getKeywordXmlReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportXml
echo getKeywordXmlReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('Keyword', 'KeywordId'),
array('Weekly'),
array(),
array(),
array(),
array(),
array(),
array(),
'SearchOnly',
'Broad',
false,
array(),
false,
30,
false
);
getReachAndFrequqencyTsvReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportTsv
echo getReachAndFrequencyTsvReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('Campaign'),
array('Weekly', 'Campaign'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
false
);
getReachAndFrequqencyXmlReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportXml
echo getReachAndFrequencyXmlReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('Campaign'),
array('Weekly', 'Campaign'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
false
);
getSearchQueryTsvReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportTsv
echo getSearchQueryTsvReport(
'Report Name',
'2008-09-01',
'2008-11-01',
array('Account', 'Query'),
array('Account', 'Daily'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
true
);
getSearchQueryXmlReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportXml
echo getSearchQueryXmlReport(
'Report Name',
'2008-09-01',
'2008-11-01',
array('Account', 'Query'),
array('Account', 'Daily'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
true
);
getUrlTsvReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportTsv
echo getUrlTsvReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('DestinationURL'),
array('Weekly'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
false
);
getUrlXmlReport(
$name,
$startDay,
$endDay,
$selectedColumns,
$aggregationTypes,
$campaigns,
$campaignStatuses,
$adGroups,
$adGroupStatuses,
$keywords,
$keywordStatuses,
$adWordsType,
$keywordType,
$isCrossClient,
$clientEmails,
$includeZeroImpression,
$sleepTime,
$validateFirst,
$onlyReturnDownloadUrl
)String name,
String startDay,
String endDay,
[String] selectedColumns,
[String] aggregationTypes,
[Integer] campaigns,
[String] campaignStatuses,
[Integer] adGroups,
[String] adGroupStatuses,
[String] keywords,
[String] keywordStatuses,
String adWordsType,
String keywordType,
Boolean isCrossClient,
[String] clientEmails,
Boolean includeZeroImpression,
Integer sleepTime,
Boolean validateFirst
Boolean onlyReturnDownloadUrlString reportXml
echo getUrlXmlReport(
'Report Name',
'2006-09-01',
'2007-09-01',
array('DestinationURL'),
array('Weekly'),
array(),
array(),
array(),
array(),
array(),
array(),
'',
'',
false,
array(),
false,
30,
false
);
OperationsgetKeywordVariationsgetKeywordsFromSite |
| APIlity uses these native API KeywordTool functions. |
| These function are defined in the KeywordTool Service WSDL. |
getKeywordVariations($seedKeywords, $useSynonyms, $languages, $countries)[SeedKeyword] seedKeywords
Boolean useSynonyms
[String] languages // Pass array("all") to select all languages
[String] countries // Pass array("all") for all countrieskeywordVariations = array(
'moreSpecific' =>
array(
'text',
'language',
'advertiserCompetitionScale',
'avgSearchVolume',
'lastMonthSearchVolume'
),
'additionalToConsider' =>
array(
'text',
'language',
'advertiserCompetitionScale',
'avgSearchVolume',
'lastMonthSearchVolume'
)
)
$seedKeyword1 = array(
'text' => "some text",
'type' => "Broad",
'isNegative' => false
);
$seedKeyword2 = array(
'text' => "other text",
'type' => "Phrase",
'isNegative' => true
);
$seedKeywords = array($seedKeyword1, $seedKeyword2);
print_r(getKeywordVariations($seedKeywords, true, array("all"), array("all")));
getKeywordsFromSite($url, $includeLinkedPages, $languages, $countries)String url
Boolean includeLinkedPages
[String] languages // Pass array("all") to select all languages
[String] countries // Pass array("all") for all countrieskeywordsFromSite = array(
'groups',
'keywords' =>
array(
'text',
'language',
'advertiserCompetitionScale',
'avgSearchVolume',
'lastMonthSearchVolume'
)
)
print_r(getKeywordsFromSite("spiegel.de", false, array("all"), array("all")));
OperationsgetSitesByCategoryNamegetSitesByDemographics getSitesByTopics getSitesByUrls |
| APIlity uses these native API SiteSuggestion functions. |
| These function are defined in the SiteSuggestion Service WSDL. |
getSitesByCategoryName($categoryName, $targeting)String categoryName
targeting = array(
'countries' => array(),
'languages' => array(),
'metros' => array(),
'regions' => array()
)SiteSuggestion siteSuggestion
$targeting = array(
'countries' => array('ES'),
'languages' => array('es'),
'metros' => array(),
'regions' => array()
);
print_r(getSitesByCategoryName("MP3 Players", $targeting));
getSitesByDemographics($demographics, $targeting)targeting = array(
'countries' => array(),
'languages' => array(),
'metros' => array(),
'regions' => array()
)
array(
'childrenTarget',
'ethnicityTarget',
'genderTarget',
'minAgeRange',
'maxAgeRange',
'minHouseholdIncomeRange',
'maxHouseholdIncomeRange'
);SiteSuggestion siteSuggestion
$targeting = array(
'countries' => array('ES'),
'languages' => array('es'),
'metros' => array(),
'regions' => array()
);
$demographics = array(
'childrenTarget' => 'HouseholdsWithChildrenOnly',
'ethnicityTarget' => 'NoPreference',
'genderTarget' => 'NoPreference',
'minAgeRange' => 'Range25To34',
'maxAgeRange' => 'Range25To34',
'minHouseholdIncomeRange' => 'Range75000To99999',
'maxHouseholdIncomeRange' => 'Range100000PLUS'
);
print_r(getSitesByDemographics($demographics, $targeting));
getSitesByTopics($topics, $targeting)targeting = array(
'countries' => array(),
'languages' => array(),
'metros' => array(),
'regions' => array()
)
[String] topicsSiteSuggestion siteSuggestion
$targeting = array(
'countries' => array('ES'),
'languages' => array('es'),
'metros' => array(),
'regions' => array()
);
$topics = array('search engines', 'web services');
print_r(getSitesByTopics($topics, $targeting));
getSitesByUrls($urls, $targeting)targeting = array(
'countries' => array(),
'languages' => array(),
'metros' => array(),
'regions' => array()
)
[String] urlsSiteSuggestion siteSuggestion
$targeting = array(
'countries' => array('ES'),
'languages' => array('es'),
'metros' => array(),
'regions' => array()
);
$urls = array('google.com', 'yahoo.com');
print_r(getSitesByUrls($urls, $targeting));
OperationscheckKeywordListTrafficgetAdGroupEstimate getCampaignEstimate getCustomizedKeywordListEstimate getKeywordEstimate getNewKeywordEstimate getNewKeywordListEstimate |
| APIlity uses these native API TrafficEstimator functions. |
| These function are defined in the TrafficEstimator Service WSDL. |
checkKeywordListTraffic($keywords)Keyword keywordObject // simplified Keyword object[KeywordTraffic]
$keyword1 = array('text' => "test1", 'type' => "Broad");
$keyword2 = array('text' => "test2", 'type' => "Broad");
print_r(checkKeywordListTraffic(array($keyword1, $keyword2)));
getAdGroupEstimate($adGroupObject)AdGroup adGroupObjectadGroupEstimate = array(
array(
'text',
'lowerAveragePosition',
'upperAveragePosition',
'lowerCostPerClick',
'upperCostPerClick',
'lowerClicksPerDay',
'upperClicksPerDay'
),
'adGroupName',
'adGroupId'
)
$adGroupObject = createAdGroupObject(123456789);
$adGroupEstimate = getAdGroupEstimate($adGroupObject);
getCampaignEstimate($campaignObject)Campaign campaignObjectcampaignEstimate = array(
array(
array(
'text',
'lowerAveragePosition',
'upperAveragePosition',
'lowerCostPerClick',
'upperCostPerClick',
'lowerClicksPerDay',
'upperClicksPerDay'
),
'adGroupName',
'adGroupId'
),
'campaignName',
'campaignId'
)
$campaignObject = createCampaignObject(123456789);
$campaignEstimate = getCampaignEstimate($campaignObject);
getCustomizedKeywordListEstimate(
$keywords,
$maxCpc,
$geoTargets,
$languages,
$networkTargeting
)[Keyword] keywordObjects
Integer maxCpc
[String] geoTargets
[String] languages
[String] networkTargeting
keywordEstimate = array(
'text',
'lowerAveragePosition',
'upperAveragePosition',
'lowerCostPerClick',
'upperCostPerClick',
'lowerClicksPerDay',
'upperClicksPerDay'
)
$keywordObjects = array(createKeywordObject(123456789, 987654321));
$maxCpc = 0.1;
$newGeoTargets = array(
'countryTargets' => array(
'countries' => array()
),
'regionTargets' => array(
'regions' => array()
),
'metroTargets' => array(
'metros' => array()
),
'cityTargets' => array(
'cities' => array(
"Reutlingen, BW DE",
"Karlsruhe, BW DE"
)
),
'proximityTargets' => array(
'circles' => array()
)
);
$languages = array('de');
$networkTargeting = array("GoogleSearch", "SearchNetwork");
$keywordEstimate = getCustomizedKeywordListEstimate(
$keywordObjects,
$maxCpc,
$newGeoTargets,
$languages,
$networkTargeting
);
getKeywordEstimate($keywordObject)Keyword keywordObjectkeywordEstimate = array(
'text',
'lowerAveragePosition',
'upperAveragePosition',
'lowerCostPerClick',
'upperCostPerClick',
'lowerClicksPerDay',
'upperClicksPerDay'
)
$keywordObject = createKeywordObject(123456789, 987654321);
$keywordEstimate = getKeywordEstimate($keywordObject);
getNewKeywordEstimate($text, $type, $maxCpc, $isNegative)String text
String type
Integer maxCpc
Boolean isNegativenewKeywordEstimate = array(
'text',
'lowerAveragePosition',
'upperAveragePosition',
'lowerCostPerClick',
'upperCostPerClick',
'lowerClicksPerDay',
'upperClicksPerDay'
)
$newKeywordEstimate = getNewKeywordEstimate("test", "Exact", 0.65, false);
getNewKeywordListEstimate($newKeywords)newKeywords = array(
array(
'text',
'type',
'maxCpc'
'isNegative'
)
)newKeywordListEstimates = array(
array(
'text',
'lowerAveragePosition',
'upperAveragePosition',
'lowerCostPerClick',
'upperCostPerClick',
'lowerClicksPerDay',
'upperClicksPerDay'
)
)
$keyword1 = array(
'text' => "test1",
'type' => "Broad",
'maxCpc' => 0.10,
'isNegative' => false
);
$keyword2 = array(
'text' => "test2",
'type' => "Broad",
'maxCpc' => 0.20,
'isNegative' => false
);
$newKeywordEstimates = getNewKeywordListEstimate(array($keyword1, $keyword2));
OperationscreateDefaultNetworkTargetingXmlcreateEmailPreferencesXml getAccountInfo getClientsClientAccountInfos getClientsClientAccounts getManagersClientAccountInfos getManagersClientAccounts getMccAlerts updateAccountInfo |
| APIlity uses these native API Account functions. |
| These function are defined in the Account Service WSDL. |
createDefaultNetworkTargetingXml($networkTargets)NetworkTargets networkTargetsString defaultNetworkTargetingXml // contains XML encoded Default Network Targets
$networkTargets = array('GoogleSearch', 'ContentNetwork');
$defaultNetworkTargetingXml = createDefaultNetworkTargetingXml($networkTargets);
createEmailPreferencesXml(
$marketResearchEnabled,
$newsletterEnabled,
$promotionsEnabled,
$accountPerformanceEnabled,
$disapprovedAdsEnabled
)Boolean marketResearchEnabled
Boolean newsletterEnabled
Boolean promotionsEnabled
Boolean accountPerformanceEnabled
Boolean disapprovedAdsEnabledString emailPreferencesXml // contains XML encoded Email Preferences
$emailPreferencesXml = createEmailPreferencesXml(true, false, true, true, true);
getAccountInfo()NoneaccountInfo =
array(
'currencyCode',
'customerId',
'defaultNetworkTargeting' => array(),
'descriptiveName',
'emailPromotionsPreferences' array(
'marketResearchEnabled',
'newsletterEnabled',
'promotionsEnabled',
),
'languagePreference',
'primaryAddress' => array(
'addressLine1',
'addressLine2',
'city',
'companyName',
'countryCode',
'emailAddress',
'faxNumber',
'name',
'phoneNumber',
'postalCode',
'state'
),
'primaryBusinessCategory',
'termsAndConditions',
'timeZoneEffectiveDate'
)
print_r(getAccountInfo());
getClientsClientAccountInfos()None[String] clientAccountInfos
print_r(getClientsClientAccountInfos());
getClientsClientAccounts()None[String] clientAccounts
print_r(getClientsClientAccounts());
getManagersClientAccountInfos()None[String] clientAccountInfos
print_r(getManagersClientAccountInfos());
getManagersClientAccounts()None[String] clientAccounts
print_r(getManagersClientAccounts());
getMccAlerts()None[MccAlert] mccAlerts
print_r(getMccAlerts());
updateAccountInfo(
$defaultNetworkTargeting,
$descriptiveName,
$emailPromotionsPreferences,
$languagePreference,
$primaryBusinessCategory
)String defaultAdsNetworkTargeting // hint: use the function createDefaultNetworkTargetingXml()
String descriptiveName
String emailPreferencesXml // hint: use the function createEmailPreferencesXml()
String languagePreference
String primaryBusinessCategoryNone
// use the helper functions to make sure the XML is valid
$defaultNetworkTargeting = array('GoogleSearch', 'SearchNetwork');
$defaultNetworkTargetingXml = createDefaultNetworkTargetingXml($defaultNetworkTargeting);
$emailPromotionsPreferences = createEmailPreferencesXml(true, true, false, true, true);
// finally update the account
updateAccountInfo($defaultNetworkTargetingXml, 'My favorite customer', $emailPromotionsPreferences, 'fr', 'Manufacturing');
OperationsgetMethodCostgetOperationCount getOperationsQuotaThisMonth getUnitCount getUnitCountForClients getUnitCountForMethod getUsageQuotaThisMonth |
| APIlity uses these native API Info functions. |
| These function are defined in the Info Service WSDL. |
getMethodCost($service, $method, $date)String service
String method
String dateInteger methodCost
$yesterday = gmdate(
"Y-m-d",
mktime(
date("H"),
date("i"),
date("s"),
date("m"),
date("d") - 1,
date("Y")
)
);
echo getMethodCost("AdService","updateAds", $yesterday);
getOperationCount($startDate, $endDate)String startDate
String endDateInteger operationCount
$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")
)
);
echo getOperationCount($dayBeforeYesterday, $yesterday);
getOperationsQuotaThisMonth()NoneInteger operationsQuotaThisMonth
echo getOperationsQuotaThisMonth();
getUnitCount($startDate, $endDate)String startDate
String endDateInteger operationCount
$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")
)
);
echo getUnitCount($dayBeforeYesterday, $yesterday);
getUnitCountForClients($startDate, $endDate, $clientEmails)String startDate
String endDate
[String] clientEmailsunitCountForClients = array(
array(
'clientEmail'
'quotaUnits'
)
)
print_r(
getUnitCountForClients(
'2005-01-01', '2006-08-01',
array(
'myCustomEmail@someWhere.tld',
'myOtherCustomEmail@anyWhere.tld'
)
)
);
getUnitCountForMethod($service, $method, $startDate, $endDate)String service
String method
String startDate
String endDateInteger unitCountForMethod
$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")
)
);
echo getUnitCountForMethod("AdService", "updateAds", $dayBeforeYesterday, $yesterday);
getUsageQuotaThisMonth()NoneInteger usageQuotaThisMonth
echo getUsageQuotaThisMonth();