Class awComplexObject

Description

AdWords Lib awComplexObject Class

Base class for all complex AdWords data types. Complex are the data types that contain other data types. Example of complex data type is a Campaign which contains Keyword, GeoTarget and LanguageTarget data types.

  • copyright: Mirchev Ideas Ltd. © 2011

Located in /classes/ComplexObject.php


	
			
Direct descendents
Class Description
 class awCampaignChangeData Holds information about a changed campaign and any adgroups under that have changed.
 class awCustomerChangeData Holds information about changes to a customer
 class awCustomerSyncSelector A filter for selecting changehistory events for a customer.
 class awAdGroupChangeData Holds information about a changed adgroup
 class awLink Represents an AdWords manager-client link.
 class awServicedAccountGraph Represents a list of the requested managers and clients, and the relationships between them.
 class awAlert Alert for a single client. Triggering events are grouped by AlertType into the same alert with multiple Details.
 class awCustomerId The 10-digit ID for identifying an AdWords account.
 class awAccount Represents a single AdWords account.
 class awAlertSelector Selector for querying for alerts.
 class awDetail Detail refers to a single event or condition that triggered its owning Alert.
 class awServicedAccountSelector Selector for querying the ServicedAccount graph.
 class awAlertQuery Querying criteria for getting alerts.
 class awTargetingIdea Represents a TargetingIdea returned by search criteria specified in the TargetingIdeaSelector. Targeting ideas are keywords or placements that are similar to those the user inputs.
 class awRange Represents a range of values that has either an upper or a lower bound.
 class awDoubleComparisonOperation Object representing double comparison operations. This is usually used within
 class awLongComparisonOperation Pojo representing integer comparison operations. This is usually used within
 class awOpportunityAttribute_AttributeMapEntry This represents an entry in a map with a key of type OpportunityAttribute and value of type Attribute.
 class awTrafficEstimatorSelector Contains a list of campaigns to perform a traffic estimate on.
Abstract class awAttribute Attributes encompass the core information about a particular
 class awTargetingIdeaPage Contains a subset of TargetingIdeas from the search criteria specified by a TargetingIdeaSelector.
 class awOpportunity
 class awBulkOpportunitySelector
 class awBulkOpportunityPage
 class awInStreamAdInfo Information specific to the instream ad format. Instream ads are video ads which play as part of the delivery of video content, either before, during, or after the content itself.
 class awType_AttributeMapEntry This represents an entry in a map with a key of type Type and value of type Attribute.
 class awWebpageDescriptor Basic information about a webpage.
 class awStatsEstimate Represents a set of stats for a traffic estimate.
Abstract class awSearchParameter A set of SearchParameters are supplied to the com.google.ads.api.services.targetingideas.TargetingIdeaSelector to specify how the user wants to filter the set of all possible com.google.ads.api.services.targetingideas.TargetingIdeas.
 class awTrafficEstimatorResult Contains results of traffic estimation request.
 class awMonthlySearchVolume A keyword response value representing search volume for a single month. An instance with a {@code null} count is valid, indicating that the information is unavailable.
 class awOpportunityIdea
 class awAdFormatSpec A placement response object which provides information about one of the ad formats supported by a placement.
Abstract class awEstimateRequest Abstract class representing a request to estimate stats.
 class awEstimate Abstract class representing an reply to an EstimateRequest.
 class awTargetingIdeaSelector A descriptor for finding TargetingIdeas that match the specified criteria.
 class awConversionOptimizerEligibility Eligibility data for Campaign to transition to Conversion Optimizer
 class awEntityId A qualified long-valued identity that can identify different types of AdWords entities such as campaigns and ad-groups.
 class awAdGroupAdExperimentData Data associated with an advertiser experiment for an AdGroupAd
 class awPolicyViolationKey Key of the violation. The key is used for referring to a violation when filing an exemption request.
 class awUserList Represents a UserList object that is sent over the wire.
 class awDimensions Represents a simple height-width dimension.
 class awApiErrorReason Interface that has a reason return an associated service error.
 class awExperiment Class representing a experiment for the ExperimentService.
 class awProductConditionOperand Attribute for the product condition.
 class awBulkMutateRequest A request part of a BulkMutateJob.
 class awJobEvent An event defined by a status change of a job.
Abstract class awListReturnValue Base list return value type.
 class awAdExtension Base class for AdExtension objects. An AdExtension is an extension to an existing ad or metadata that will process into an extension.
Abstract class awOperation This represents an operation that includes an operator and an operand specified type.
 class awAdParam Represents an ad parameter. Use ad parameters to update numeric values
 class awAdExtensionOverride Represents an ad level ad extension override. An ad extension override specifies the ad extension that must be used if the ad is served with any ad extension data.
 class awBulkMutateJobPolicy A basic job policy.
Abstract class awAdGroupCriterionBids Represents criterion level bids.
Abstract class awPage Contains the results from a get call.
Abstract class awTarget Target abstract class.
 class awExperimentSummaryStats Contains how many changes were made associated with an experiment at
 class awPlaceHolder A place holder for a result which is not available.
 class awDate Represents a date.
 class awBulkMutateResult Represents a result part of a BulkMutateJob.
 class awBiddableAdGroupCriterionExperimentData Data associated with an advertiser experiment for this BiddableAdGroupCriterion.
 class awJobResult Represents the result data of a job. This contains both the results of successfully processed operations as well as errors returned by failed operations.
 class awDateTimeRange
 class awQualityInfo Container for criterion quality information.
 class awSimpleMutateResult The results of a simple mutation job.
 class awAdGroupCriterion Represents a criterion in an ad group, used with AdGroupCriterionService.
 class awSoapResponseHeader Defines the elements within the header of a SOAP response.
 class awAdGroupAd Represents an ad in an ad group.
 class awCampaignTargetSelector A campaign targeting selector to specify which targets to return.
 class awAdUnionId Represents an id indicating a grouping of Ads under some heuristic.
 class awLocationCriterion Represents data that encapsulates a location criterion.
 class awDateRange Represents a range of dates that has either an upper or a lower bound.
 class awUserInterest Represents a particular interest based vertical to be targeted.
 class awSelector A generic selector to specify the type of information to return.
 class awBidMultiplier Represents a multiplier to modify a bid. The final value after modification is represented by the multiplied bid value.
Abstract class awAdGroupCriterionExperimentBidMultiplier Bid multiplier used to modify the bid of a criterion while running an experiment.
 class awCampaign Data representing an AdWords campaign.
 class awPredicate Specifies how an entity (eg. adgroup, campaign, criterion, ad) should be filtered.
 class awOperationStream A stream of AdWords API mutate operations that must be performed serially.
 class awBiddingTransition Used to switch a campaign's bidding strategy.
 class awAdGroupExperimentData Data associated with an advertiser experiment for this adgroup.
 class awNetworkSetting Network settings for a Campaign.
Abstract class awAdGroupExperimentBidMultipliers Bid multiplier used to modify the bid of an adgroup while running an experiment.
 class awOperand A marker interface for entities that can be operated upon in mutate operations.
 class awApplicationException Base class for exceptions.
 class awCampaignAdExtension Represents a campaign level ad extension. A campaign ad extension specifies a campaign and an ad extension which can extend any ad under that campaign.
Abstract class awApiError The API error base class that provides details about an error that occurred while processing a service request.
 class awAddress Structure to specify an address location.
 class awOrderBy Specifies how the resulting information should be sorted.
 class awReportDefinitionField Represents the fields that can be used to create a ReportDefinition.
Abstract class awAdGroupBids Represents bids at the adgroup level, which could be of different subtypes based on campaign's bidding strategy.
 class awConversionTrackerStats Usage stats about a single ConversionTracker.
 class awBid Represents a bid of a certain amount.
Abstract class awConversionTracker An abstract Conversion base class.
 class awBudget Data representing the budget for a campaign.
 class awCriterion Represents a criterion (such as a keyword, placement, or vertical).
 class awTemplateElement Represents an element in a template. Each template element is composed of a list of fields (actual value data).
 class awExemptionRequest A request to be exempted from a PolicyViolationError.
 class awGeoPoint Specifies a geo location with the supplied latitude/longitude.
 class awSoapHeader Defines the required and optional elements within the header of a SOAP request.
Abstract class awJobSelector For selecting jobs whose information will be returned from a get method call of a job service.
 class awCampaignCriterion Represents a campaign level criterion (either keyword or placement).
 class awAd The base class of all ad types. To update basic ad fields, you can construct an {@code Ad} object (instead of the ad's concrete type) with the appropriate fields set.
 class awStats Statistics about an ad or criterion within an ad group or campaign.
 class awJobStats Job-handling statistics.
Abstract class awJob Represents an asynchronous macro unit of work.
 class awUserListConversionType Represents a conversion type used for building remarketing user lists.
 class awFrequencyCap A frequency cap is the maximum number of times an ad (or some set of ads) can be shown to a user over a particular time period.
Abstract class awSetting Base type for AdWords campaign settings.
 class awMedia Represents some kind of media.
 class awAdGroup Represents an ad group.
 class awOverrideInfo Represents additional override info with which to augment the override extension.
Abstract class awComparableValue Comparable types for constructing ranges with.
 class awGeoLocationSelector A selector used to fetch geographic coordinates for given addresses.
 class awAdParamPage Represents a page of AdParams returned by the AdParamService.
 class awLocationOverrideInfo Represents override info for ad level LocationExtension overrides.
 class awEnumValuePair Represents information about enum values.
 class awAdExtensionOverrideSelector Specifies criteria for selecting a set of AdExtensionOverrides.
 class awGeoLocation Class representing a location with its geographic coordinates.
 class awTemplateElementField
 class awMedia_Size_StringMapEntry This represents an entry in a map with a key of type Size and value of type String.
 class awBillingSummary Represents the billing summary of the job that provides the overall cost of the job's operations, i.e., for the work done by the job. This therefore excludes the cost of operating on the job itself - setting up the job, polling for its status, retrieving the result, etc.
 class awSitelink Class to represent a single sitelink
 class awMediaPage Page of media returned by the MediaService which includes the media.
 class awUserListLogicalRule A user list logical rule. A rule has a logical operator (and/or/not) and a list of operands that can be user lists or user interests.
 class awReportDefinition Represents a report definition.
 class awOperationStreamResult The result of processing an OperationStream.
 class awReportDefinitionSelector A selector used to specify which report definitions should be returned.
Abstract class awDataEntry The base class of all return types of the table service.
 class awProductConditionAndGroup Groups a list of product conditions to be evaluated together as an AND condition (ie. true if all conditions are true, false otherwise).
 class awProductCondition Conditions to filter the products defined in product feed for targeting.
 class awLogicalUserListOperand An interface for a logical user list operand. A logical user list is a combination of logical rules. Each rule is defined as a logical operator and a list of operands. Those operands can be of type UserList or UserInterest.
 class awReportDefinitionPage Contains a subset of report definitions resulting from the filtering and paging of the get call.
Abstract class awBiddingStrategy A campaign's bidding strategy, such as manual CPC, manual CPM, budget optimizer, etc.
Abstract class awTargetList Targets list abstract class (a list of a given type of targets along with their campaign ID).
 class awPolicyViolationError_Part Points to a substring within an ad field or criterion.
 class awMedia_Size_DimensionsMapEntry This represents an entry in a map with a key of type Size and value of type Dimensions.
Abstract class awOperationResult Represents the result of an individual mutate operation.
 class awBidLandscape_LandscapePoint A set of estimates for a criterion's performance for a specific bid amount.
 class awPaging Specifies the page of results to return in the response. A page is specified by the result position to start at and the maximum number of results to return.
 class awApiUsageInfo Represents the API usage information.
 class awApiUsageRecord Data record for per client API units.
 class awInfoSelector Specifies the type of API usage information to be returned. API usage information returned is based on the #apiUsageType specified. All returned values are specific to the developer token being used to call
  1. InfoService.get
.
Variable Summary
Method Summary
 awComplexObject __construct ([ $row = array()])
 void factory ( $row,  $className)
 void get ( $field)
 void getAsObj ( $row,  $className)
 void getCheckFields ()
 void getRow ()
 void getSoapVars ()
 void getXml ()
 void isEmpty ()
 void remove ( $field)
 void set ( $field,  $value)
 void setRow ( $row)
Variables
mixed $_cachedCheckFields = null
  • access: protected
mixed $_checkFields = array()
  • access: protected

Redefined in descendants as:
mixed $_row = array()
  • access: protected
Methods
  • access: public
awComplexObject __construct ([ $row = array()])
  • $row
  • access: public
void get ( $field)
  • $field
  • access: protected
void getAsObj ( $row,  $className)
  • $row
  • $className
  • access: protected
void getCheckFields ()
  • access: public
void getRow ()

Redefined in descendants as:
  • access: protected
void getSoapVars ()
  • access: public
void getXml ()
void isEmpty ()
  • access: public
void remove ( $field)
  • $field
  • access: public
void set ( $field,  $value)
  • $field
  • $value
  • access: public
void setRow ( $row)
  • $row

Documentation generated on Fri, 23 Mar 2012 13:43:52 +0200 by phpDocumentor 1.4.3