Google APIlity Library Documentation

Google APIlity Library Reference

The APIlity PHP Library provides an object-oriented way to easily access and manage the Google AdWords API from within PHP.
This comes along with an abstraction from the SOAP and WSDL details.

This reference documents all functions offered by the library. The functions are categorized into several sections with different senses.
Please note: each section has its own color represented by a colored bar at the right side and the particular link color. Thus orientation is very easy.

Quicknavigator

APIlity structure

Click the images to resize the class organigram and/or the object hierarchy:

APIlity class organigram   |   APIlity object hierarchy

Campaign.php

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

Object Operations

getActiveAdGroups
getAdScheduling
getAllAdGroups
getBelongsToClientEmail
getBudgetAmount
getBudgetOptimizerSettings
getBudgetPeriod
getCampaignData
getCampaignNegativeKeywordCriteria
getCampaignNegativeWebsiteCriteria
getCampaignStats
getEndDate
getEstimate
getGeoTargets
getId
getIsEnabledOptimizedAdServing
getLanguages
getName
getNetworkTargeting
getRecommendedBudget
getStartDate
getStatus
setAdScheduling
setBudgetAmount
setBudgetOptimizerSettings
setBudgetPeriod
setCampaignNegativeKeywordCriteria
setCampaignNegativeWebsiteCriteria
setConversionOptimizerSettings
setEndDate
setGeoTargets
setIsEnabledOptimizedAdServing
setLanguages
setName
setNetworkTargeting
setStatus
toXml

Class Operations

addCampaign
addCampaignList
addCampaignsOneByOne
createCampaignObject
getActiveCampaigns
getAllCampaigns
getCampaignList
removeCampaign
APIlity uses these native API Campaign functions.
These function are defined in the Campaign Service WSDL.

Object Operations

Class Operations

addCampaign(
  $name,
  $status,
  $startDate,
  $endDate,
  $budgetAmount,
  $budgetPeriod,
  $networkTargeting,
  $languages,
  $geoTargets,
  $adScheduling,
  $budgetOptimizerSettings
)
Adds a Campaign to the current customer's account.
Parameters:
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}

Response:
Campaign campaignObject

Sample:
$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()
    )
  )
); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

addCampaignList($campaigns)
Adds a list of Campaigns to the current customer's account. Please note: this will fail completely even if just one Campaign fails, but the function causes no SOAP overhead.
Parameters:
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'}
  )
)

Response:
[Campaign] campaignObjects

Sample:
$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)); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

addCampaignsOneByOne($campaigns)
Adds a list of Campaigns to the current customer's account. Please note: this will not fail completely if just one Campaign fails, but the function causes a lot of SOAP overhead.
Parameters:
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'}
  )
)

Response:
[Campaign] campaignObjects

Sample:
$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)); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

AdGroup.php

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

Object Operations

getActiveAds
getAdGroupData
getAdGroupStats
getAllAds
getAllCriteria
getBelongsToCampaignId
getEstimate
getId
getKeywordContentMaxCpc
getKeywordMaxCpc
getMaxCpa
getName
getProxyKeywordMaxCpc
getSiteMaxCpc
getSiteMaxCpm
getStatus
setKeywordContentMaxCpc
setKeywordMaxCpc
setMaxCpa
setName
setSiteMaxCpc
setSiteMaxCpm
setStatus
toXml

Class Operations

addAdGroup
addAdGroupList
addAdGroupsOneByOne
createAdGroupObject
getActiveAdGroups
getAdGroupList
getAllAdGroups
removeAdGroup
APIlity uses these native API AdGroup functions.
These function are defined in the AdGroup Service WSDL.

Object Operations

Class Operations

Criterion.php

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

Object Operations

getBelongsToAdGroupId
getCriterionData // KeywordCriterion object
getCriterionData // WebsiteCriterion object
getCriterionStats
getCriterionType
getDestinationUrl
getEstimate
getFirstPageCpc
getId
getIsNegative
getIsPaused
getLanguage
getMaxCpc // KeywordCriterion
getMaxCpc // WebsiteCriterion
getMaxCpm
getProxyMaxCpc
getQualityScore
getStatus
getText
getType
getUrl
setDestinationUrl
setIsNegative
setIsPaused
setLanguage
setMaxCpc
setMaxCpm
setText
setType
setUrl
toXml

Class Operations

addKeywordCriteriaOneByOne
addKeywordCriterion
addKeywordCriterionList
addWebsiteCriteriaOneByOne
addWebsiteCriterion
addWebsiteCriterionList
checkCriterionList
createCriterionObject
getAllCriteria
getCriterionList
getCriterionListStats
removeCriterion
removeCriterionList
updateCriterionList
APIlity uses these native API Criterion functions.
These function are defined in the Criterion Service WSDL.

Object Operations

Class Operations

checkCriterionList($criteria, $languages, $geoTargets)
Checks a list of Criteria for policy errors.
Parameters:
[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'
)

Response:
[ApiError] criteriaCheck

Sample:
$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
  
)
); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

Ad.php

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

Object Operations

getAdData // CommerceAd objects
getAdData // ImageAd object
getAdData // LocalBusinessAd objects
getAdData // MobileAd object
getAdData // TextAd object
getAdData // VideoAd objects
getAdStats
getAdType
getAddress
getBelongsToAdGroupId
getBusinessImage
getBusinessKey
getBusinessName
getCity
getCountryCode
getCustomIcon
getCustomIconId
getDescription
getDescription1
getDescription2
getDestinationUrl
getDisplayUrl
getFullBusinessName
getHeadline
getId
getImage
getIsDisapproved
getLatitude
getLongitude
getMarkupLanguages
getMobileCarriers
getName
getPhoneNumber
getPostPriceAnnotation
getPostalCode
getPrePriceAnnotation
getPriceString
getProductImage
getRegion
getStatus
getStockIcon
getTargetRadiusInKm
getVideo
setDescription1
setDescription2
setDestinationUrl
setDisplayUrl
setHeadline
setStatus
toXml

Class Operations

addCommerceAd
addCommerceAdList
addCommerceAdsOneByOne
addImageAd
addImageAdList
addImageAdsOneByOne
addLocalBusinessAd
addLocalBusinessAdList
addLocalBusinessAdsOneByOne
addMobileAd
addMobileAdList
addMobileAdsOneByOne
addMobileImageAd
addMobileImageAdList
addMobileImageAdsOneByOne
addTextAd
addTextAdList
addTextAdsOneByOne
addVideoAd
checkAdList
createAdObject
findBusinesses
getActiveAds
getAllAds
getMyBusinesses
getMyVideos
removeAd
APIlity uses these native API Ad functions.
These function are defined in the Ad Service WSDL.

Object Operations

Class Operations

addCommerceAdList($ads) 
Adds a list of Commerce Ads to the given AdGroup. This will fail completely even if just one Ad fails, but the function causes no SOAP overhead.
Parameters:
ads = array(
  array(
    'belongsToAdGroupId',
    'description1',
    'description2',
    'headline',
    'prePriceAnnotation',
    'postPriceAnnotation',
    'priceString',
    'productImageLocation',
    'status',
    'displayUrl',
    'destinationUrl'
  )
)

Response:
[Ad] adObjects

Sample:
$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)); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

addCommerceAdsOneByOne($ads) 
Adds a list of Commerce Ads to the given AdGroup. This will not fail completely if just one Ad fails, but the function causes a lot of SOAP overhead.
Parameters:
ads = array(
  array(
    'belongsToAdGroupId',
    'description1',
    'description2',
    'headline',
    'prePriceAnnotation',
    'postPriceAnnotation',
    'priceString',
    'productImageLocation',
    'status',
    'displayUrl',
    'destinationUrl'
  )
)

Response:
[Ad] adObjects

Sample:
$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)); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

addLocalBusinessAd(
  $belongsToAdGroupId,
  $address,
  $businessImageLocation,
  $businessKey,
  $businessName,
  $city,
  $countryCode,
  $customIconLocation,
  $customIconId,
  $description1,
  $description2,
  $phoneNumber,
  $postalCode,
  $region,
  $stockIcon,
  $targetRadiusInKm,
  $status,
  $displayUrl,
  $destinationUrl,
  $exemptionRequest = false
)      
Adds a Local Business Ad to the given AdGroup.
Parameters:
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.

Response:
Ad adObject

Sample:
$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/'
); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

addLocalBusinessAdList($ads) 
Adds a list of Local Business Ads to the given AdGroup. This will fail completely even if just one Ad fails, but the function causes no SOAP overhead.
Parameters:
ads = array(
  array(
    'belongsToAdGroupId',
    'address',
    'businessImageLocation',
    'businessKey',
    'businessName',
    'city',
    'countryCode',
    'customIconLocation',
    'customIconId',
    'description1',
    'description2',
    'phoneNumber',
    'postalCode',
    'region',
    'stockIcon',
    'targetRadiusInKm',
    'status',
    'displayUrl',
    'destinationUrl',
    {'exemptionRequest'}
  )
)

Response:
[Ad] adObjects

Sample:
$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)); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

addLocalBusinessAdsOneByOne($ads) 
Adds a list of Local Business Ads to the given AdGroup. This will not fail completely if just one Ad fails, but the function causes a lot of SOAP overhead.
Parameters:
ads = array(
  array(
    'belongsToAdGroupId',
    'address',
    'businessImageLocation',
    'businessKey',
    'businessName',
    'city',
    'countryCode',
    'customIconLocation',
    'customIconId',
    'description1',
    'description2',
    'phoneNumber',
    'postalCode',
    'region',
    'stockIcon',
    'targetRadiusInKm',
    'status',
    'displayUrl',
    'destinationUrl',
    {'exemptionRequest'}
  )
)

Response:
[Ad] adObjects

Sample:
$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)); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

addMobileAdList($ads) 
Adds a list of Mobile Ads to the given AdGroup. This will fail completely even if just one Ad fails, but the function causes no SOAP overhead.
Parameters:
ads = array(
  array(
    'belongsToAdGroupId',
    'businessName',
    'countryCode',
    'description',
    'headline',
    'markupLanguages',
    'mobileCarriers',
    'phoneNumber',
    'status',
    'displayUrl',
    'destinationUrl',
    '{exemptionRequest}' // Required on policy violation.
  )
)

Response:
[Ad] adObjects

Sample:
$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)); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

addMobileAdsOneByOne($ads) 
Adds a list of Mobile Ads to the given AdGroup. This will not fail completely if just one Ad fails, but the function causes a lot of SOAP overhead.
Parameters:
ads = array(
  array(
    'belongsToAdGroupId',
    'businessName',
    'countryCode',
    'description',
    'headline',
    'markupLanguages',
    'mobileCarriers',
    'phoneNumber',
    'status',
    'displayUrl',
    'destinationUrl',
    '{exemptionRequest}' // Required on policy violation.
  )
)

Response:
[Ad] adObjects

Sample:
$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)); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

checkAdList($adObjects, $languages, $geoTargets)
Checks a batch of Ads for policy errors. The number of Ads in the batch is limited to the maximum number of Ads per adgroup.
Parameters:
[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' =>
)

Response:
[ApiError] adsCheck

Sample:
$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)); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

Report.php

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

Operations

deleteReport
downloadTsvReport
downloadXmlReport
getAccountStructureTsvReport
getAccountStructureXmlReport
getAccountTsvReport
getAccountXmlReport
getAdGroupTsvReport
getAdGroupXmlReport
getAllJobs
getCampaignTsvReport
getCampaignXmlReport
getContentPlacementTsvReport
getContentPlacementXmlReport
getCreativeTsvReport
getCreativeXmlReport
getGeographicTsvReport
getGeographicXmlReport
getKeywordTsvReport
getKeywordXmlReport
getReachAndFrequqencyTsvReport
getReachAndFrequqencyXmlReport
getSearchQueryTsvReport
getSearchQueryXmlReport
getUrlTsvReport
getUrlXmlReport
APIlity uses these native API Report functions.
These function are defined in the Report Service WSDL.

getAccountStructureTsvReport(
  $name, 
  $startDay,
  $endDay,
  $selectedColumns,
  $aggregationTypes,
  $campaigns,
  $campaignStatuses,
  $adGroups,
  $adGroupStatuses,
  $keywords,
  $keywordStatuses,
  $adWordsType,
  $keywordType,
  $isCrossClient,
  $clientEmails,
  $includeZeroImpression,
  $sleepTime,
  $validateFirst,
  $onlyReturnDownloadUrl
)
An Account Structure report lets you view attribute data from your account. This report type provides a convenient way for you retrieve all data unrelated to performance in one report.
Parameters:
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 onlyReturnDownloadUrl

Response:
String reportTsv

Sample:
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
); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

getAccountStructureXmlReport(
  $name, 
  $startDay,
  $endDay,
  $selectedColumns,
  $aggregationTypes,
  $campaigns,
  $campaignStatuses,
  $adGroups,
  $adGroupStatuses,
  $keywords,
  $keywordStatuses,
  $adWordsType,
  $keywordType,
  $isCrossClient,
  $clientEmails,
  $includeZeroImpression,
  $sleepTime,
  $validateFirst,
  $onlyReturnDownloadUrl
)
An Account Structure report lets you view attribute data from your account. This report type provides a convenient way for you retrieve all data unrelated to performance in one report.
Parameters:
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 onlyReturnDownloadUrl

Response:
String reportXml

Sample:
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
); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

getCreativeTsvReport(
  $name,
  $startDay,
  $endDay,
  $selectedColumns,
  $aggregationTypes,
  $campaigns,
  $campaignStatuses,
  $adGroups,
  $adGroupStatuses,
  $keywords,
  $keywordStatuses,
  $adWordsType,
  $keywordType,
  $isCrossClient,
  $clientEmails,
  $includeZeroImpression,
  $sleepTime,
  $validateFirst,
  $onlyReturnDownloadUrl
)
Gets an Ad performance report. An Ad performance report lets you view statistics on how specific types of ad variations are performing. This report lets you see performance statistics on text ads, image ads and, where available, mobile ads and local business ads.
Parameters:
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 onlyReturnDownloadUrl

Response:
String reportTsv

Sample:
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
); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

getCreativeXmlReport(
  $name,
  $startDay,
  $endDay,
  $selectedColumns,
  $aggregationTypes,
  $campaigns,
  $campaignStatuses,
  $adGroups,
  $adGroupStatuses,
  $keywords,
  $keywordStatuses,
  $adWordsType,
  $keywordType,
  $isCrossClient,
  $clientEmails,
  $includeZeroImpression,
  $sleepTime,
  $validateFirst,
  $onlyReturnDownloadUrl
)
Gets an Ad performance report. An Ad performance report lets you view statistics on how specific types of ad variations are performing. This report lets you see performance statistics on text ads, image ads and, where available, mobile ads and local business ads.
Parameters:
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 onlyReturnDownloadUrl

Response:
String reportXml

Sample:
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
); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

getReachAndFrequqencyTsvReport(
  $name,
  $startDay,
  $endDay,
  $selectedColumns,
  $aggregationTypes,
  $campaigns,
  $campaignStatuses,
  $adGroups,
  $adGroupStatuses,
  $keywords,
  $keywordStatuses,
  $adWordsType,
  $keywordType,
  $isCrossClient,
  $clientEmails,
  $includeZeroImpression,
  $sleepTime,
  $validateFirst,
  $onlyReturnDownloadUrl
)
Gets a Reach and Frequency performance report. A Reach and Frequency performance report shows how many people saw your ads and how many times they saw them over a certain period of time. This report data is available at the site, ad group, and campaign levels for CPM site-targeted campaigns only.
Parameters:
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 onlyReturnDownloadUrl

Response:
String reportTsv

Sample:
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
); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

getReachAndFrequqencyXmlReport(
  $name,
  $startDay,
  $endDay,
  $selectedColumns,
  $aggregationTypes,
  $campaigns,
  $campaignStatuses,
  $adGroups,
  $adGroupStatuses,
  $keywords,
  $keywordStatuses,
  $adWordsType,
  $keywordType,
  $isCrossClient,
  $clientEmails,
  $includeZeroImpression,
  $sleepTime,
  $validateFirst
  $onlyReturnDownloadUrl
)
Gets a Reach and Frequency performance report. A Reach and Frequency performance report shows how many people saw your ads and how many times they saw them over a certain period of time. This report data is available at the site, ad group, and campaign levels for CPM site-targeted campaigns only.
Parameters:
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 onlyReturnDownloadUrl

Response:
String reportXml

Sample:
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
); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

getSearchQueryTsvReport(
  $name,
  $startDay,
  $endDay,
  $selectedColumns,
  $aggregationTypes,
  $campaigns,
  $campaignStatuses,
  $adGroups,
  $adGroupStatuses,
  $keywords,
  $keywordStatuses,
  $adWordsType,
  $keywordType,
  $isCrossClient,
  $clientEmails,
  $includeZeroImpression,
  $sleepTime,
  $validateFirst,
  $onlyReturnDownloadUrl
)
Gets a Search Query Performance report. A Search Query Performance report shows performance data for the search queries that triggered the ads which appeared after receiving clicks. This report is only available for the search network.
Parameters:
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 onlyReturnDownloadUrl

Response:
String reportTsv

Sample:
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
); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

getSearchQueryXmlReport(
  $name,
  $startDay,
  $endDay,
  $selectedColumns,
  $aggregationTypes,
  $campaigns,
  $campaignStatuses,
  $adGroups,
  $adGroupStatuses,
  $keywords,
  $keywordStatuses,
  $adWordsType,
  $keywordType,
  $isCrossClient,
  $clientEmails,
  $includeZeroImpression,
  $sleepTime,
  $validateFirst,
  $onlyReturnDownloadUrl
)
Gets a Search Query Performance report. A Search Query Performance report shows performance data for the search queries that triggered the ads which appeared after receiving clicks. This report is only available for the search network.
Parameters:
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 onlyReturnDownloadUrl

Response:
String reportXml

Sample:
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
); 

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

KeywordTool.php

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

Operations

getKeywordVariations
getKeywordsFromSite
APIlity uses these native API KeywordTool functions.
These function are defined in the KeywordTool Service WSDL.

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

Operations

getSitesByCategoryName
getSitesByDemographics
getSitesByTopics
getSitesByUrls
APIlity uses these native API SiteSuggestion functions.
These function are defined in the SiteSuggestion Service WSDL.

TrafficEstimate.php

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

Operations

checkKeywordListTraffic
getAdGroupEstimate
getCampaignEstimate
getCustomizedKeywordListEstimate
getKeywordEstimate
getNewKeywordEstimate
getNewKeywordListEstimate
APIlity uses these native API TrafficEstimator functions.
These function are defined in the TrafficEstimator Service WSDL.

Account.php

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

Operations










APIlity uses these native API Account functions.
These function are defined in the Account Service WSDL.

Info.php

Quicknavigatior Back To Top APIlity Home   APIlity Forum
» Campaign  |  » AdGroup  |  » Criterion  |  » Ad  |  » Report  |  » KeywordTool  |  » SiteSuggestion  |  » TrafficEstimate  |  »  |  » Info

Operations

getMethodCost
getOperationCount
getOperationsQuotaThisMonth
getUnitCount
getUnitCountForClients
getUnitCountForMethod
getUsageQuotaThisMonth
APIlity uses these native API Info functions.
These function are defined in the Info Service WSDL.