Docs For Class AdWordKeywordToolService

Description

AdWords Lib KeywordToolService Class

Use this class to work with Google AdWords KeywordTool Service KeywordToolService provides operations for getting new keywords based on seed keywords you provide or on the words found on a web site from a URL that you provide.

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

Located in /services/AdWordKeywordToolService.inc

AdWordService
   |
   --AdWordKeywordToolService

Method Summary

AdWordKeywordToolService AdWordKeywordToolService (string $soapToolkit)

object|false getKeywordsFromSite (string $url, bool $includeLinkedPages, object $languageTarget, object $geoTarget, [ $clientEmail = ''])

object|false getKeywordVariations (object $seedKeywords, bool $useSynonyms, object $languageTarget, object $geoTarget, [ $clientEmail = ''])

Methods

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

Example:

 <?php
 $keywordToolService = new AdWordKeywordToolService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 ?>

Please use defined constants for supported by AdWords Lib toolkit names

see: AdWordsConsts.inc

AdWordKeywordToolService AdWordKeywordToolService (string $soapToolkit)

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

Given a URL, returns keywords based on words found on that web page or site, which can be used as keyword criteria for a campaign.

The results are grouped by common keywords, with the groups ordered by decreasing relevance.

Example:

 <?php
 $keywordToolService = new AdWordKeywordToolService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $keywordToolService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $url = 'http://www.mirchevideas.com';
 $includeLinkedPages = true;
 $response = $infoService->getKeywordsFromSite($url, $includeLinkedPages, $languageTarget, $geoTarget);
 if ($response === false) { // if an error appears
         $errr = $keywordToolService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 ?>

return:
object of class SiteKeywordGroups or false on error
TODO: make a check - only countries are allowed in $geoTarget!
link: http://www.google.com/apis/adwords/developer/KeywordToolService.html#getKeywordsFromSite For more information about getKeywordsFromSite see in Google AdWords Developer's Guide

object|false getKeywordsFromSite (string $url, bool $includeLinkedPages, object $languageTarget, object $geoTarget, [ $clientEmail = ''])

string $url: the site's location
bool $includeLinkedPages: whether to follow links on the page at the given url
object $languageTarget: the intended target languages of the adgroup that will use the generated keywords
object $geoTarget: the intended target countries of the adgroup that will use the generated keywords
$clientEmail

Given a list of SeedKeywords, returns their variations in multiple lists within KeywordVariations.

Each list represents a different kind of variation.

Example:

 <?php
 $keywordToolService = new AdWordKeywordToolService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $keywordToolService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $seedKeywords = new AdWordSeedKeyword();
 $seedKeywords->addSeedKeyword('test keyword');
 $useSynonyms = true;
 $response = $infoService->getKeywordVariations($seedKeywords, $useSynonyms, $languageTarget, $geoTarget);
 if ($response === false) { // if an error appears
         $errr = $keywordToolService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 ?>

return:
object of class KeywordVariations or false on error
TODO: make a check - only countries are allowed in $geoTarget!
link: http://www.google.com/apis/adwords/developer/KeywordToolService.html#getKeywordVariations For more information about getKeywordVariations see in Google AdWords Developer's Guide

object|false getKeywordVariations (object $seedKeywords, bool $useSynonyms, object $languageTarget, object $geoTarget, [ $clientEmail = ''])

object $seedKeywords: the keywords to derive variations from
bool $useSynonyms: If true, will use synonyms of source keywords as sources
object $languageTarget: locale information for finding variations and popularity data
object $geoTarget: locale information for finding variations and popularity data
$clientEmail

Inherited Methods

Inherited From AdWordService

AdWordService::AdWordService()
AdWordService::callService()
AdWordService::getAccount()
AdWordService::getClientCustomerId()
AdWordService::getClientEmail()
AdWordService::getLastError()
AdWordService::getResponseHeaders()
AdWordService::setAccount()
AdWordService::setClientCustomerId()
AdWordService::setClientEmail()