Docs For Class AdWordSiteSuggestionService

Description

AdWords Lib Site Suggestion Service Class

Provides operations for getting web site suggestions by category, topics, URLs or demographics.

copyright: Mirchev Ideas Ltd. © 2007
link: http://www.google.com/apis/adwords/developer/SiteSuggestionService.html For more information about SiteSuggestionService see in Google AdWords Developer's Guide

Located in /services/AdWordSiteSuggestionService.inc

AdWordService
   |
   --AdWordSiteSuggestionService

Method Summary

AdWordSiteSuggestionService AdWordSiteSuggestionService (string $soapToolkit)

array|false getSitesByCategoryName (string $categoryName, object $targeting, [string $clientEmail = ''])

array|false getSitesByDemographics (object $demo, object $targeting, [string $clientEmail = ''])

array|false getSitesByTopics (array $topics, object $targeting, [string $clientEmail = ''])

array|false getSitesByUrls (array $urls, object $targeting, [string $clientEmail = ''])

Methods

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

Example:

 <?php
 $service = new AdWordSiteSuggestionService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 ?>

Please use defined constants for supported by AdWords Lib toolkit names

see: AdWordsConsts.inc

AdWordSiteSuggestionService AdWordSiteSuggestionService (string $soapToolkit)

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

Returns site suggestions based on the specified category name.

Each suggestion contains useful information such as the URL, accepted ad formats and page views.

Example:

 <?php
 $service = new AdWordSiteSuggestionService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $service->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 // $targeting is object of class AdWordLanguageGeoTargeting
 $response = $service->getSitesByCategoryName('Animals', $targeting);
 if ($response === false) { // if an error appears
         $err = $service->getLastError(); //get error object
         echo $err->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordSiteSuggestion
 ?>

return: array of objects of class AdWordSiteSuggestion or false on error
link: http://www.google.com/apis/adwords/developer/SiteSuggestionService.html#getSitesByCategoryName For more information about getSitesByCategoryName see in Google AdWords Developer's Guide

array|false getSitesByCategoryName (string $categoryName, object $targeting, [string $clientEmail = ''])

string $categoryName: the name of a category
object $targeting: object of class AdWordLanguageGeoTargeting
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Returns site suggestions based on the specified demographics criteria, including gender, age, income, ethnicity and whether there are children in the household.

Each suggestion contains useful information such as the URL, accepted ad formats and page views.

Example:

 <?php
 $service = new AdWordSiteSuggestionService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $service->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 // $demo is object of class AdWordDemographicsTarget
 // $targeting is object of class AdWordLanguageGeoTargeting
 $response = $service->getSitesByDemographics($demo, $targeting);
 if ($response === false) { // if an error appears
         $err = $service->getLastError(); //get error object
         echo $err->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordSiteSuggestion
 ?>

return: array of objects of class AdWordSiteSuggestion or false on error
link: http://www.google.com/apis/adwords/developer/SiteSuggestionService.html#getSitesByDemographics For more information about getSitesByDemographics see in Google AdWords Developer's Guide

array|false getSitesByDemographics (object $demo, object $targeting, [string $clientEmail = ''])

object $demo: object of class AdWordDemographicsTarget
object $targeting: object of class AdWordLanguageGeoTargeting
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Returns site suggestions based on the specified topics.

Each suggestion contains useful information such as the URL, accepted ad formats and page views.

Example:

 <?php
 $service = new AdWordSiteSuggestionService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $service->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 // $targeting is object of class AdWordLanguageGeoTargeting
 $response = $service->getSitesByTopics(array('car', 'flower'), $targeting);
 if ($response === false) { // if an error appears
         $err = $service->getLastError(); //get error object
         echo $err->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordSiteSuggestion
 ?>

return: array of objects of class AdWordSiteSuggestion or false on error
link: http://www.google.com/apis/adwords/developer/SiteSuggestionService.html#getSitesByTopics For more information about getSitesByTopics see in Google AdWords Developer's Guide

array|false getSitesByTopics (array $topics, object $targeting, [string $clientEmail = ''])

array $topics: a list of keywords, each of which can be a word or phrase
object $targeting: object of class AdWordLanguageGeoTargeting
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Returns site suggestions based on the specified URLs.

Each suggestion contains useful information such as the URL, accepted ad formats and page views.

Example:

 <?php
 $service = new AdWordSiteSuggestionService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $service->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 // $targeting is object of class AdWordLanguageGeoTargeting
 $response = $service->getSitesByUrls(array('http://google.com', 'http://yahoo.com'), $targeting);
 if ($response === false) { // if an error appears
         $err = $service->getLastError(); //get error object
         echo $err->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordSiteSuggestion
 ?>

return: array of objects of class AdWordSiteSuggestion or false on error
link: http://www.google.com/apis/adwords/developer/SiteSuggestionService.html#getSitesByUrls For more information about getSitesByUrls see in Google AdWords Developer's Guide

array|false getSitesByUrls (array $urls, object $targeting, [string $clientEmail = ''])

array $urls: a list of seed URLs
object $targeting: object of class AdWordLanguageGeoTargeting
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Inherited Methods

Inherited From AdWordService

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