Docs For Class AdWordObject

Description

AdWords Lib Object Class

Base class for all AdWords data types.

copyright: Mirchev Ideas Ltd. © 2003, 2004, 2005

Direct descendents

Class	Description
AdWordAdGroup	AdWords Lib AdGroup Class
AdWordAddress	AdWords Lib Address Class
AdWordComplexObject	AdWords Lib AdWordComplexObject Class
AdWordCoverageType	AdWords Lib CoverageType Class
AdWordCircle	AdWords Lib AdWordCircle Class
AdWordCreditCard	AdWords Lib CreditCard Class
AdWordCriterion	AdWords Lib AdWordCriterion Class
AdWordEmailPromotionsPreferences	AdWords Lib EmailPromotionsPreferences Class
AdWordLanguageTarget	AdWords Lib AdWordLanguageTarget Class
AdWordReportJob	AdWords Lib AdWordReportJob Class
AdWordStatsRecord	AdWords Lib AdWordStatsRecord Class
AdWordKeywordVariation	AdWords Lib KeywordVariation Class
AdWordNetworkTarget	AdWords Lib AdWordNetworkTarget Class
AdWordSeedKeyword	AdWords Lib SeedKeyword Class
AdWordSiteKeyword	AdWords Lib SiteKeyword Class
AdWordApiError	AdWords Lib ApiError Class
AdWordClientUsageRecord	AdWords Lib ClientUsageRecord Class
AdWordSchedulingInterval	AdWords Lib AdWordSchedulingInterval Class
AdWordBusiness	AdWords Lib Business Class
AdWordBudgetOptimizerSettings	AdWords Lib BudgetOptimizerSettings Class
AdWordImage	AdWords Lib Image Class
AdWordVideo	AdWords Lib Video Class
AdWordCountryTargets	AdWords Lib AdWordCountryTargets Class
AdWordKeywordTrafficRequest	AdWords Lib AdWordKeywordTrafficRequest Class
AdWordSiteSuggestion	AdWords Lib AdWordSiteSuggestion Class
AdWordCityTargets	AdWords Lib AdWordCityTargets Class
AdWordMetroTargets	AdWords Lib AdWordMetroTargets Class
AdWordRegionTargets	AdWords Lib AdWordRegionTargets Class
AdWordDemographicsTarget	AdWords Lib AdWordDemographicsTarget Class
AdWordKeywordEstimate	AdWords Lib AdWordKeywordEstimate Class
AdWordKeywordRequest	AdWords Lib AdWordKeywordRequest Class

Method Summary

AdWordObject AdWordObject ([array $row = array()])

mixed get (string $field)

array getRow ()

string getXML ()

bool isEmpty ()

void remove (string $field)

void set (string $field, mixed $value)

void setRow (array $array)

Methods

AdWordObject Constructor. It takes one optional parameter - array to set all AdWords data type fields

access: public

AdWordObject AdWordObject ([array $row = array()])

array $row: array with all AdWords data type fields

Returns the value of a field

Example:

 <?php
 $obj = new AdWordObject(array($field => $value));
 $value = $obj->get($field);
 ?>

return: the value of the field or NULL if there is no field with such name
access: public

mixed get (string $field)

string $field: field name

Returns all AdWords data type fields

Example:

 <?php
 $obj = new AdWordObject(array($field => $value));
 $array = $obj->getRow(); // returns array($field => $value)
 ?>

return: which holds the data for an AdWords data type
access: public

array getRow ()

Returns the AdWords data type in XML format If the object is empty returns empty string

Example:

 <?php
 $obj = new AdWordObject(array($field => $value));
 $xml = $obj->getXML(); // returns string '<field>value</field>'
 ?>

return: the AdWords data type in XML format
access: public

string getXML ()

Redefined in descendants as:

AdWordComplexObject::getXML()
AdWordGeoTarget::getXML() : Returns this GeoTarget data type in XML format
AdWordLanguageTarget::getXML() : Returns all information for a LanguageTarget data type in XML format
AdWordReportJob::getXML()
AdWordNetworkTarget::getXML() : Returns all information for a NetworkTarget data type in XML format
AdWordSeedKeyword::getXML()

Checks if the object is empty An object is empty if it doesn't have any fields

Example:

 <?php
 $obj = new AdWordObject();
 $bool = $obj->isEmpty(); // $bool = true;
 $obj->set($field, $value);
 $bool = $obj->isEmpty(); // $bool = false;
 ?>

return: true if the object is empty, false otherwise
access: public

bool isEmpty ()

Removes a field from this object

access: public

void remove (string $field)

string $field: field name

Sets the value a field

Example:

 <?php
 $obj = new AdWordObject();
 $obj->set($field, $value);
 ?>

access: public

void set (string $field, mixed $value)

string $field: the name of the field
mixed $value: value of the field

Redefined in descendants as:

AdWordComplexObject::set()

Sets all AdWords data type fields.

If the input parameter is not an array the object will be emptied.

Example:

 <?php
 $obj = new AdWordObject();
 $obj->setRow($array); // $array is an array which holds the data we want to set.
 ?>

access: public

void setRow (array $array)

array $array: which holds the needed information for a definite AdWords data type

Redefined in descendants as:

AdWordComplexObject::setRow()