Campaign (Bing Ads Java SDK 13.0.19 API)

java.lang.Object
- com.microsoft.bingads.v13.campaignmanagement.Campaign

public class Campaign
extends Object

Java class for Campaign complex type.

The following schema fragment specifies the expected content contained within this class.


 <complexType name="Campaign">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="AudienceAdsBidAdjustment" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="BiddingScheme" type="{https://bingads.microsoft.com/CampaignManagement/v13}BiddingScheme" minOccurs="0"/>
         <element name="BudgetType" type="{https://bingads.microsoft.com/CampaignManagement/v13}BudgetLimitType" minOccurs="0"/>
         <element name="DailyBudget" type="{http://www.w3.org/2001/XMLSchema}double" minOccurs="0"/>
         <element name="DealIds" type="{http://schemas.microsoft.com/2003/10/Serialization/Arrays}ArrayOflong" minOccurs="0"/>
         <element name="ExperimentId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="FinalUrlSuffix" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ForwardCompatibilityMap" type="{http://schemas.datacontract.org/2004/07/System.Collections.Generic}ArrayOfKeyValuePairOfstringstring" minOccurs="0"/>
         <element name="GoalIds" type="{http://schemas.microsoft.com/2003/10/Serialization/Arrays}ArrayOflong" minOccurs="0"/>
         <element name="Id" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="MultimediaAdsBidAdjustment" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="Name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Status" type="{https://bingads.microsoft.com/CampaignManagement/v13}CampaignStatus" minOccurs="0"/>
         <element name="SubType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="TimeZone" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="TrackingUrlTemplate" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="UrlCustomParameters" type="{https://bingads.microsoft.com/CampaignManagement/v13}CustomParameters" minOccurs="0"/>
         <element name="CampaignType" type="{https://bingads.microsoft.com/CampaignManagement/v13}CampaignType" minOccurs="0"/>
         <element name="Settings" type="{https://bingads.microsoft.com/CampaignManagement/v13}ArrayOfSetting" minOccurs="0"/>
         <element name="BudgetId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="Languages" type="{http://schemas.microsoft.com/2003/10/Serialization/Arrays}ArrayOfstring" minOccurs="0"/>
         <element name="AdScheduleUseSearcherTimeZone" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="BidStrategyId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`adScheduleUseSearcherTimeZone`
`protected Integer`	`audienceAdsBidAdjustment`
`protected BiddingScheme`	`biddingScheme`
`protected Long`	`bidStrategyId`
`protected Long`	`budgetId`
`protected BudgetLimitType`	`budgetType`
`protected Collection<CampaignType>`	`campaignType`
`protected Double`	`dailyBudget`
`protected ArrayOflong`	`dealIds`
`protected Long`	`experimentId`
`protected String`	`finalUrlSuffix`
`protected ArrayOfKeyValuePairOfstringstring`	`forwardCompatibilityMap`
`protected ArrayOflong`	`goalIds`
`protected Long`	`id`
`protected ArrayOfstring`	`languages`
`protected Integer`	`multimediaAdsBidAdjustment`
`protected String`	`name`
`protected ArrayOfSetting`	`settings`
`protected CampaignStatus`	`status`
`protected String`	`subType`
`protected String`	`timeZone`
`protected String`	`trackingUrlTemplate`
`protected CustomParameters`	`urlCustomParameters`

Constructor Summary

Constructors
Constructor and Description

Campaign()

Constructors
Constructor and Description
`Campaign()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getAdScheduleUseSearcherTimeZone()` Gets the value of the adScheduleUseSearcherTimeZone property.
`Integer`	`getAudienceAdsBidAdjustment()` Gets the value of the audienceAdsBidAdjustment property.
`BiddingScheme`	`getBiddingScheme()` Gets the value of the biddingScheme property.
`Long`	`getBidStrategyId()` Gets the value of the bidStrategyId property.
`Long`	`getBudgetId()` Gets the value of the budgetId property.
`BudgetLimitType`	`getBudgetType()` Gets the value of the budgetType property.
`Collection<CampaignType>`	`getCampaignType()` Gets the value of the campaignType property.
`Double`	`getDailyBudget()` Gets the value of the dailyBudget property.
`ArrayOflong`	`getDealIds()` Gets the value of the dealIds property.
`Long`	`getExperimentId()` Gets the value of the experimentId property.
`String`	`getFinalUrlSuffix()` Gets the value of the finalUrlSuffix property.
`ArrayOfKeyValuePairOfstringstring`	`getForwardCompatibilityMap()` Gets the value of the forwardCompatibilityMap property.
`ArrayOflong`	`getGoalIds()` Gets the value of the goalIds property.
`Long`	`getId()` Gets the value of the id property.
`ArrayOfstring`	`getLanguages()` Gets the value of the languages property.
`Integer`	`getMultimediaAdsBidAdjustment()` Gets the value of the multimediaAdsBidAdjustment property.
`String`	`getName()` Gets the value of the name property.
`ArrayOfSetting`	`getSettings()` Gets the value of the settings property.
`CampaignStatus`	`getStatus()` Gets the value of the status property.
`String`	`getSubType()` Gets the value of the subType property.
`String`	`getTimeZone()` Gets the value of the timeZone property.
`String`	`getTrackingUrlTemplate()` Gets the value of the trackingUrlTemplate property.
`CustomParameters`	`getUrlCustomParameters()` Gets the value of the urlCustomParameters property.
`void`	`setAdScheduleUseSearcherTimeZone(Boolean value)` Sets the value of the adScheduleUseSearcherTimeZone property.
`void`	`setAudienceAdsBidAdjustment(Integer value)` Sets the value of the audienceAdsBidAdjustment property.
`void`	`setBiddingScheme(BiddingScheme value)` Sets the value of the biddingScheme property.
`void`	`setBidStrategyId(Long value)` Sets the value of the bidStrategyId property.
`void`	`setBudgetId(Long value)` Sets the value of the budgetId property.
`void`	`setBudgetType(BudgetLimitType value)` Sets the value of the budgetType property.
`void`	`setCampaignType(Collection<CampaignType> value)` Sets the value of the campaignType property.
`void`	`setDailyBudget(Double value)` Sets the value of the dailyBudget property.
`void`	`setDealIds(ArrayOflong value)` Sets the value of the dealIds property.
`void`	`setExperimentId(Long value)` Sets the value of the experimentId property.
`void`	`setFinalUrlSuffix(String value)` Sets the value of the finalUrlSuffix property.
`void`	`setForwardCompatibilityMap(ArrayOfKeyValuePairOfstringstring value)` Sets the value of the forwardCompatibilityMap property.
`void`	`setGoalIds(ArrayOflong value)` Sets the value of the goalIds property.
`void`	`setId(Long value)` Sets the value of the id property.
`void`	`setLanguages(ArrayOfstring value)` Sets the value of the languages property.
`void`	`setMultimediaAdsBidAdjustment(Integer value)` Sets the value of the multimediaAdsBidAdjustment property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setSettings(ArrayOfSetting value)` Sets the value of the settings property.
`void`	`setStatus(CampaignStatus value)` Sets the value of the status property.
`void`	`setSubType(String value)` Sets the value of the subType property.
`void`	`setTimeZone(String value)` Sets the value of the timeZone property.
`void`	`setTrackingUrlTemplate(String value)` Sets the value of the trackingUrlTemplate property.
`void`	`setUrlCustomParameters(CustomParameters value)` Sets the value of the urlCustomParameters property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - audienceAdsBidAdjustment
```
protected Integer audienceAdsBidAdjustment
```
  - biddingScheme
```
protected BiddingScheme biddingScheme
```
  - budgetType
```
protected BudgetLimitType budgetType
```
  - dailyBudget
```
protected Double dailyBudget
```
  - dealIds
```
protected ArrayOflong dealIds
```
  - experimentId
```
protected Long experimentId
```
  - finalUrlSuffix
```
protected String finalUrlSuffix
```
  - forwardCompatibilityMap
```
protected ArrayOfKeyValuePairOfstringstring forwardCompatibilityMap
```
  - goalIds
```
protected ArrayOflong goalIds
```
  - id
```
protected Long id
```
  - multimediaAdsBidAdjustment
```
protected Integer multimediaAdsBidAdjustment
```
  - name
```
protected String name
```
  - status
```
protected CampaignStatus status
```
  - subType
```
protected String subType
```
  - timeZone
```
protected String timeZone
```
  - trackingUrlTemplate
```
protected String trackingUrlTemplate
```
  - urlCustomParameters
```
protected CustomParameters urlCustomParameters
```
  - campaignType
```
protected Collection<CampaignType> campaignType
```
  - settings
```
protected ArrayOfSetting settings
```
  - budgetId
```
protected Long budgetId
```
  - languages
```
protected ArrayOfstring languages
```
  - adScheduleUseSearcherTimeZone
```
protected Boolean adScheduleUseSearcherTimeZone
```
  - bidStrategyId
```
protected Long bidStrategyId
```
- Constructor Detail
  - Campaign
```
public Campaign()
```
- Method Detail
  - getAudienceAdsBidAdjustment
```
public Integer getAudienceAdsBidAdjustment()
```
    Gets the value of the audienceAdsBidAdjustment property.
    
    Returns:
    
    possible object is Integer
  - setAudienceAdsBidAdjustment
```
public void setAudienceAdsBidAdjustment(Integer value)
```
    Sets the value of the audienceAdsBidAdjustment property.
    
    Parameters:
    
    value - allowed object is Integer
  - getBiddingScheme
```
public BiddingScheme getBiddingScheme()
```
    Gets the value of the biddingScheme property.
    
    Returns:
    
    possible object is BiddingScheme
  - setBiddingScheme
```
public void setBiddingScheme(BiddingScheme value)
```
    Sets the value of the biddingScheme property.
    
    Parameters:
    
    value - allowed object is BiddingScheme
  - getBudgetType
```
public BudgetLimitType getBudgetType()
```
    Gets the value of the budgetType property.
    
    Returns:
    
    possible object is BudgetLimitType
  - setBudgetType
```
public void setBudgetType(BudgetLimitType value)
```
    Sets the value of the budgetType property.
    
    Parameters:
    
    value - allowed object is BudgetLimitType
  - getDailyBudget
```
public Double getDailyBudget()
```
    Gets the value of the dailyBudget property.
    
    Returns:
    
    possible object is Double
  - setDailyBudget
```
public void setDailyBudget(Double value)
```
    Sets the value of the dailyBudget property.
    
    Parameters:
    
    value - allowed object is Double
  - getDealIds
```
public ArrayOflong getDealIds()
```
    Gets the value of the dealIds property.
    
    Returns:
    
    possible object is ArrayOflong
  - setDealIds
```
public void setDealIds(ArrayOflong value)
```
    Sets the value of the dealIds property.
    
    Parameters:
    
    value - allowed object is ArrayOflong
  - getExperimentId
```
public Long getExperimentId()
```
    Gets the value of the experimentId property.
    
    Returns:
    
    possible object is Long
  - setExperimentId
```
public void setExperimentId(Long value)
```
    Sets the value of the experimentId property.
    
    Parameters:
    
    value - allowed object is Long
  - getFinalUrlSuffix
```
public String getFinalUrlSuffix()
```
    Gets the value of the finalUrlSuffix property.
    
    Returns:
    
    possible object is String
  - setFinalUrlSuffix
```
public void setFinalUrlSuffix(String value)
```
    Sets the value of the finalUrlSuffix property.
    
    Parameters:
    
    value - allowed object is String
  - getForwardCompatibilityMap
```
public ArrayOfKeyValuePairOfstringstring getForwardCompatibilityMap()
```
    Gets the value of the forwardCompatibilityMap property.
    
    Returns:
    
    possible object is ArrayOfKeyValuePairOfstringstring
  - setForwardCompatibilityMap
```
public void setForwardCompatibilityMap(ArrayOfKeyValuePairOfstringstring value)
```
    Sets the value of the forwardCompatibilityMap property.
    
    Parameters:
    
    value - allowed object is ArrayOfKeyValuePairOfstringstring
  - getGoalIds
```
public ArrayOflong getGoalIds()
```
    Gets the value of the goalIds property.
    
    Returns:
    
    possible object is ArrayOflong
  - setGoalIds
```
public void setGoalIds(ArrayOflong value)
```
    Sets the value of the goalIds property.
    
    Parameters:
    
    value - allowed object is ArrayOflong
  - getId
```
public Long getId()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is Long
  - setId
```
public void setId(Long value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is Long
  - getMultimediaAdsBidAdjustment
```
public Integer getMultimediaAdsBidAdjustment()
```
    Gets the value of the multimediaAdsBidAdjustment property.
    
    Returns:
    
    possible object is Integer
  - setMultimediaAdsBidAdjustment
```
public void setMultimediaAdsBidAdjustment(Integer value)
```
    Sets the value of the multimediaAdsBidAdjustment property.
    
    Parameters:
    
    value - allowed object is Integer
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getStatus
```
public CampaignStatus getStatus()
```
    Gets the value of the status property.
    
    Returns:
    
    possible object is CampaignStatus
  - setStatus
```
public void setStatus(CampaignStatus value)
```
    Sets the value of the status property.
    
    Parameters:
    
    value - allowed object is CampaignStatus
  - getSubType
```
public String getSubType()
```
    Gets the value of the subType property.
    
    Returns:
    
    possible object is String
  - setSubType
```
public void setSubType(String value)
```
    Sets the value of the subType property.
    
    Parameters:
    
    value - allowed object is String
  - getTimeZone
```
public String getTimeZone()
```
    Gets the value of the timeZone property.
    
    Returns:
    
    possible object is String
  - setTimeZone
```
public void setTimeZone(String value)
```
    Sets the value of the timeZone property.
    
    Parameters:
    
    value - allowed object is String
  - getTrackingUrlTemplate
```
public String getTrackingUrlTemplate()
```
    Gets the value of the trackingUrlTemplate property.
    
    Returns:
    
    possible object is String
  - setTrackingUrlTemplate
```
public void setTrackingUrlTemplate(String value)
```
    Sets the value of the trackingUrlTemplate property.
    
    Parameters:
    
    value - allowed object is String
  - getUrlCustomParameters
```
public CustomParameters getUrlCustomParameters()
```
    Gets the value of the urlCustomParameters property.
    
    Returns:
    
    possible object is CustomParameters
  - setUrlCustomParameters
```
public void setUrlCustomParameters(CustomParameters value)
```
    Sets the value of the urlCustomParameters property.
    
    Parameters:
    
    value - allowed object is CustomParameters
  - getCampaignType
```
public Collection<CampaignType> getCampaignType()
```
    Gets the value of the campaignType property.
    
    Returns:
    
    possible object is String
  - setCampaignType
```
public void setCampaignType(Collection<CampaignType> value)
```
    Sets the value of the campaignType property.
    
    Parameters:
    
    value - allowed object is String
  - getSettings
```
public ArrayOfSetting getSettings()
```
    Gets the value of the settings property.
    
    Returns:
    
    possible object is ArrayOfSetting
  - setSettings
```
public void setSettings(ArrayOfSetting value)
```
    Sets the value of the settings property.
    
    Parameters:
    
    value - allowed object is ArrayOfSetting
  - getBudgetId
```
public Long getBudgetId()
```
    Gets the value of the budgetId property.
    
    Returns:
    
    possible object is Long
  - setBudgetId
```
public void setBudgetId(Long value)
```
    Sets the value of the budgetId property.
    
    Parameters:
    
    value - allowed object is Long
  - getLanguages
```
public ArrayOfstring getLanguages()
```
    Gets the value of the languages property.
    
    Returns:
    
    possible object is ArrayOfstring
  - setLanguages
```
public void setLanguages(ArrayOfstring value)
```
    Sets the value of the languages property.
    
    Parameters:
    
    value - allowed object is ArrayOfstring
  - getAdScheduleUseSearcherTimeZone
```
public Boolean getAdScheduleUseSearcherTimeZone()
```
    Gets the value of the adScheduleUseSearcherTimeZone property.
    
    Returns:
    
    possible object is Boolean
  - setAdScheduleUseSearcherTimeZone
```
public void setAdScheduleUseSearcherTimeZone(Boolean value)
```
    Sets the value of the adScheduleUseSearcherTimeZone property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getBidStrategyId
```
public Long getBidStrategyId()
```
    Gets the value of the bidStrategyId property.
    
    Returns:
    
    possible object is Long
  - setBidStrategyId
```
public void setBidStrategyId(Long value)
```
    Sets the value of the bidStrategyId property.
    
    Parameters:
    
    value - allowed object is Long

Class Campaign

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

audienceAdsBidAdjustment

biddingScheme

budgetType

dailyBudget

dealIds

experimentId

finalUrlSuffix

forwardCompatibilityMap

goalIds

id

multimediaAdsBidAdjustment

name

status

subType

timeZone

trackingUrlTemplate

urlCustomParameters

campaignType

settings

budgetId

languages

adScheduleUseSearcherTimeZone

bidStrategyId

Constructor Detail

Campaign

Method Detail

getAudienceAdsBidAdjustment

setAudienceAdsBidAdjustment

getBiddingScheme

setBiddingScheme

getBudgetType

setBudgetType

getDailyBudget

setDailyBudget

getDealIds

setDealIds

getExperimentId

setExperimentId

getFinalUrlSuffix

setFinalUrlSuffix

getForwardCompatibilityMap

setForwardCompatibilityMap

getGoalIds

setGoalIds

getId

setId

getMultimediaAdsBidAdjustment

setMultimediaAdsBidAdjustment

getName

setName

getStatus

setStatus

getSubType

setSubType

getTimeZone

setTimeZone

getTrackingUrlTemplate

setTrackingUrlTemplate

getUrlCustomParameters

setUrlCustomParameters

getCampaignType

setCampaignType

getSettings

setSettings

getBudgetId

setBudgetId

getLanguages

setLanguages

getAdScheduleUseSearcherTimeZone

setAdScheduleUseSearcherTimeZone

getBidStrategyId

setBidStrategyId