Class awCampaign

Description

Class representing a campaign for the CampaignService.

Located in /classes/cm/Campaign.php

awComplexObject
   |
   --awCampaign
Variable Summary
Variables
string $adServingOptimizationStatus

Ad serving optimization status.

  • var: awAdServingOptimizationStatus
string $autoKeywordMatchingStatus

Customer has opted in/out of Automatic Matching.

  • var: awAutoKeywordMatchingStatus
awBiddingStrategy $biddingStrategy

Bidding strategy (such as Manual CPC (cost per click), Budget Optimizer, etc) This field is required during campaign creation to indicate what bidding strategy to apply.

To modify an existing campaign's bidding strategy, use CampaignOperation.biddingTransition field instead. <span class="constraint Required">This field is required and should not be {@code null} when it is contained within Operators : ADD.</span>

awBudget $budget

Current base budget of campaign; default if no custom budgets are active.

<span class="constraint Required">This field is required and should not be {@code null} when it is contained within Operators : ADD.</span>

string $endDate

Campaign ended serving date; {@code null} indicates serving indefinitely.

awFrequencyCap $frequencyCap

Frequency cap for this campaign.

long $id

Campaign id; {@code null} if creating a new one.

<span class="constraint ReadOnly">This field is read only and should not be set for following Operators : ADD.</span> <span class="constraint Required">This field is required and should not be {@code null} when it is contained within Operators : SET.</span>

string $name

Campaign name. On add defaults to "Campaign #N", just like GetNew action.

<span class="constraint StringLength">This string must not be empty.</span>

string $servingStatus

Serving status.

<span class="constraint ReadOnly">This field is read only and should not be set.</span>

  • var: awServingStatus
string $startDate

Campaign started serving date; {@code null} indicates started on creation.

awStats $stats

Campaign statistics. {@code Output only if requested.}

<span class="constraint ReadOnly">This field is read only and should not be set.</span>

string $status

Status of the campaign. On add defaults to ACTIVE.

  • var: awCampaignStatus
mixed $_checkFields = array(
'budget' => array(
'objName' => 'awBudget',
'type' => 'obj'
),'biddingStrategy'=>array('objName'=>'awBiddingStrategy','type'=>'obj'),'stats'=>array('objName'=>'awStats','type'=>'obj'),'frequencyCap'=>array('objName'=>'awFrequencyCap','type'=>'obj'),)
  • access: public

Inherited Variables

Inherited from awComplexObject

awComplexObject::$_cachedCheckFields
awComplexObject::$_row
Methods

Documentation generated on Thu, 15 Apr 2010 19:06:12 +0300 by phpDocumentor 1.4.3