AdGroup (Bing Ads Java SDK 13.0.19 API)

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

public class AdGroup
extends Object

Java class for AdGroup complex type.

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


 <complexType name="AdGroup">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="AdRotation" type="{https://bingads.microsoft.com/CampaignManagement/v13}AdRotation" minOccurs="0"/>
         <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="CommissionRate" type="{https://bingads.microsoft.com/CampaignManagement/v13}RateBid" minOccurs="0"/>
         <element name="CpcBid" type="{https://bingads.microsoft.com/CampaignManagement/v13}Bid" minOccurs="0"/>
         <element name="EndDate" type="{https://bingads.microsoft.com/CampaignManagement/v13}Date" 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="FrequencyCapSettings" type="{https://bingads.microsoft.com/CampaignManagement/v13}ArrayOfFrequencyCapSettings" minOccurs="0"/>
         <element name="Id" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="Language" type="{http://www.w3.org/2001/XMLSchema}string" 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="Network" type="{https://bingads.microsoft.com/CampaignManagement/v13}Network" minOccurs="0"/>
         <element name="PercentCpcBid" type="{https://bingads.microsoft.com/CampaignManagement/v13}RateBid" minOccurs="0"/>
         <element name="PrivacyStatus" type="{https://bingads.microsoft.com/CampaignManagement/v13}AdGroupPrivacyStatus" minOccurs="0"/>
         <element name="Settings" type="{https://bingads.microsoft.com/CampaignManagement/v13}ArrayOfSetting" minOccurs="0"/>
         <element name="StartDate" type="{https://bingads.microsoft.com/CampaignManagement/v13}Date" minOccurs="0"/>
         <element name="Status" type="{https://bingads.microsoft.com/CampaignManagement/v13}AdGroupStatus" 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="UseOptimizedTargeting" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="UsePredictiveTargeting" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="AdScheduleUseSearcherTimeZone" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="AdGroupType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CpvBid" type="{https://bingads.microsoft.com/CampaignManagement/v13}Bid" minOccurs="0"/>
         <element name="CpmBid" type="{https://bingads.microsoft.com/CampaignManagement/v13}Bid" minOccurs="0"/>
         <element name="McpaBid" type="{https://bingads.microsoft.com/CampaignManagement/v13}Bid" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`adGroupType`
`protected AdRotation`	`adRotation`
`protected Boolean`	`adScheduleUseSearcherTimeZone`
`protected Integer`	`audienceAdsBidAdjustment`
`protected BiddingScheme`	`biddingScheme`
`protected RateBid`	`commissionRate`
`protected Bid`	`cpcBid`
`protected Bid`	`cpmBid`
`protected Bid`	`cpvBid`
`protected Date`	`endDate`
`protected String`	`finalUrlSuffix`
`protected ArrayOfKeyValuePairOfstringstring`	`forwardCompatibilityMap`
`protected ArrayOfFrequencyCapSettings`	`frequencyCapSettings`
`protected Long`	`id`
`protected String`	`language`
`protected Bid`	`mcpaBid`
`protected Integer`	`multimediaAdsBidAdjustment`
`protected String`	`name`
`protected Network`	`network`
`protected RateBid`	`percentCpcBid`
`protected AdGroupPrivacyStatus`	`privacyStatus`
`protected ArrayOfSetting`	`settings`
`protected Date`	`startDate`
`protected AdGroupStatus`	`status`
`protected String`	`trackingUrlTemplate`
`protected CustomParameters`	`urlCustomParameters`
`protected Boolean`	`useOptimizedTargeting`
`protected Boolean`	`usePredictiveTargeting`

Constructor Summary

Constructors
Constructor and Description

AdGroup()

Constructors
Constructor and Description
`AdGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAdGroupType()` Gets the value of the adGroupType property.
`AdRotation`	`getAdRotation()` Gets the value of the adRotation property.
`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.
`RateBid`	`getCommissionRate()` Gets the value of the commissionRate property.
`Bid`	`getCpcBid()` Gets the value of the cpcBid property.
`Bid`	`getCpmBid()` Gets the value of the cpmBid property.
`Bid`	`getCpvBid()` Gets the value of the cpvBid property.
`Date`	`getEndDate()` Gets the value of the endDate property.
`String`	`getFinalUrlSuffix()` Gets the value of the finalUrlSuffix property.
`ArrayOfKeyValuePairOfstringstring`	`getForwardCompatibilityMap()` Gets the value of the forwardCompatibilityMap property.
`ArrayOfFrequencyCapSettings`	`getFrequencyCapSettings()` Gets the value of the frequencyCapSettings property.
`Long`	`getId()` Gets the value of the id property.
`String`	`getLanguage()` Gets the value of the language property.
`Bid`	`getMcpaBid()` Gets the value of the mcpaBid property.
`Integer`	`getMultimediaAdsBidAdjustment()` Gets the value of the multimediaAdsBidAdjustment property.
`String`	`getName()` Gets the value of the name property.
`Network`	`getNetwork()` Gets the value of the network property.
`RateBid`	`getPercentCpcBid()` Gets the value of the percentCpcBid property.
`AdGroupPrivacyStatus`	`getPrivacyStatus()` Gets the value of the privacyStatus property.
`ArrayOfSetting`	`getSettings()` Gets the value of the settings property.
`Date`	`getStartDate()` Gets the value of the startDate property.
`AdGroupStatus`	`getStatus()` Gets the value of the status property.
`String`	`getTrackingUrlTemplate()` Gets the value of the trackingUrlTemplate property.
`CustomParameters`	`getUrlCustomParameters()` Gets the value of the urlCustomParameters property.
`Boolean`	`getUseOptimizedTargeting()` Gets the value of the useOptimizedTargeting property.
`Boolean`	`getUsePredictiveTargeting()` Gets the value of the usePredictiveTargeting property.
`void`	`setAdGroupType(String value)` Sets the value of the adGroupType property.
`void`	`setAdRotation(AdRotation value)` Sets the value of the adRotation 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`	`setCommissionRate(RateBid value)` Sets the value of the commissionRate property.
`void`	`setCpcBid(Bid value)` Sets the value of the cpcBid property.
`void`	`setCpmBid(Bid value)` Sets the value of the cpmBid property.
`void`	`setCpvBid(Bid value)` Sets the value of the cpvBid property.
`void`	`setEndDate(Date value)` Sets the value of the endDate property.
`void`	`setFinalUrlSuffix(String value)` Sets the value of the finalUrlSuffix property.
`void`	`setForwardCompatibilityMap(ArrayOfKeyValuePairOfstringstring value)` Sets the value of the forwardCompatibilityMap property.
`void`	`setFrequencyCapSettings(ArrayOfFrequencyCapSettings value)` Sets the value of the frequencyCapSettings property.
`void`	`setId(Long value)` Sets the value of the id property.
`void`	`setLanguage(String value)` Sets the value of the language property.
`void`	`setMcpaBid(Bid value)` Sets the value of the mcpaBid property.
`void`	`setMultimediaAdsBidAdjustment(Integer value)` Sets the value of the multimediaAdsBidAdjustment property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setNetwork(Network value)` Sets the value of the network property.
`void`	`setPercentCpcBid(RateBid value)` Sets the value of the percentCpcBid property.
`void`	`setPrivacyStatus(AdGroupPrivacyStatus value)` Sets the value of the privacyStatus property.
`void`	`setSettings(ArrayOfSetting value)` Sets the value of the settings property.
`void`	`setStartDate(Date value)` Sets the value of the startDate property.
`void`	`setStatus(AdGroupStatus value)` Sets the value of the status property.
`void`	`setTrackingUrlTemplate(String value)` Sets the value of the trackingUrlTemplate property.
`void`	`setUrlCustomParameters(CustomParameters value)` Sets the value of the urlCustomParameters property.
`void`	`setUseOptimizedTargeting(Boolean value)` Sets the value of the useOptimizedTargeting property.
`void`	`setUsePredictiveTargeting(Boolean value)` Sets the value of the usePredictiveTargeting property.

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

- Field Detail
  - adRotation
```
protected AdRotation adRotation
```
  - audienceAdsBidAdjustment
```
protected Integer audienceAdsBidAdjustment
```
  - biddingScheme
```
protected BiddingScheme biddingScheme
```
  - commissionRate
```
protected RateBid commissionRate
```
  - cpcBid
```
protected Bid cpcBid
```
  - endDate
```
protected Date endDate
```
  - finalUrlSuffix
```
protected String finalUrlSuffix
```
  - forwardCompatibilityMap
```
protected ArrayOfKeyValuePairOfstringstring forwardCompatibilityMap
```
  - frequencyCapSettings
```
protected ArrayOfFrequencyCapSettings frequencyCapSettings
```
  - id
```
protected Long id
```
  - language
```
protected String language
```
  - multimediaAdsBidAdjustment
```
protected Integer multimediaAdsBidAdjustment
```
  - name
```
protected String name
```
  - network
```
protected Network network
```
  - percentCpcBid
```
protected RateBid percentCpcBid
```
  - privacyStatus
```
protected AdGroupPrivacyStatus privacyStatus
```
  - settings
```
protected ArrayOfSetting settings
```
  - startDate
```
protected Date startDate
```
  - status
```
protected AdGroupStatus status
```
  - trackingUrlTemplate
```
protected String trackingUrlTemplate
```
  - urlCustomParameters
```
protected CustomParameters urlCustomParameters
```
  - useOptimizedTargeting
```
protected Boolean useOptimizedTargeting
```
  - usePredictiveTargeting
```
protected Boolean usePredictiveTargeting
```
  - adScheduleUseSearcherTimeZone
```
protected Boolean adScheduleUseSearcherTimeZone
```
  - adGroupType
```
protected String adGroupType
```
  - cpvBid
```
protected Bid cpvBid
```
  - cpmBid
```
protected Bid cpmBid
```
  - mcpaBid
```
protected Bid mcpaBid
```
- Constructor Detail
  - AdGroup
```
public AdGroup()
```
- Method Detail
  - getAdRotation
```
public AdRotation getAdRotation()
```
    Gets the value of the adRotation property.
    
    Returns:
    
    possible object is AdRotation
  - setAdRotation
```
public void setAdRotation(AdRotation value)
```
    Sets the value of the adRotation property.
    
    Parameters:
    
    value - allowed object is AdRotation
  - 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
  - getCommissionRate
```
public RateBid getCommissionRate()
```
    Gets the value of the commissionRate property.
    
    Returns:
    
    possible object is RateBid
  - setCommissionRate
```
public void setCommissionRate(RateBid value)
```
    Sets the value of the commissionRate property.
    
    Parameters:
    
    value - allowed object is RateBid
  - getCpcBid
```
public Bid getCpcBid()
```
    Gets the value of the cpcBid property.
    
    Returns:
    
    possible object is Bid
  - setCpcBid
```
public void setCpcBid(Bid value)
```
    Sets the value of the cpcBid property.
    
    Parameters:
    
    value - allowed object is Bid
  - getEndDate
```
public Date getEndDate()
```
    Gets the value of the endDate property.
    
    Returns:
    
    possible object is Date
  - setEndDate
```
public void setEndDate(Date value)
```
    Sets the value of the endDate property.
    
    Parameters:
    
    value - allowed object is Date
  - 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
  - getFrequencyCapSettings
```
public ArrayOfFrequencyCapSettings getFrequencyCapSettings()
```
    Gets the value of the frequencyCapSettings property.
    
    Returns:
    
    possible object is ArrayOfFrequencyCapSettings
  - setFrequencyCapSettings
```
public void setFrequencyCapSettings(ArrayOfFrequencyCapSettings value)
```
    Sets the value of the frequencyCapSettings property.
    
    Parameters:
    
    value - allowed object is ArrayOfFrequencyCapSettings
  - 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
  - getLanguage
```
public String getLanguage()
```
    Gets the value of the language property.
    
    Returns:
    
    possible object is String
  - setLanguage
```
public void setLanguage(String value)
```
    Sets the value of the language property.
    
    Parameters:
    
    value - allowed object is String
  - 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
  - getNetwork
```
public Network getNetwork()
```
    Gets the value of the network property.
    
    Returns:
    
    possible object is Network
  - setNetwork
```
public void setNetwork(Network value)
```
    Sets the value of the network property.
    
    Parameters:
    
    value - allowed object is Network
  - getPercentCpcBid
```
public RateBid getPercentCpcBid()
```
    Gets the value of the percentCpcBid property.
    
    Returns:
    
    possible object is RateBid
  - setPercentCpcBid
```
public void setPercentCpcBid(RateBid value)
```
    Sets the value of the percentCpcBid property.
    
    Parameters:
    
    value - allowed object is RateBid
  - getPrivacyStatus
```
public AdGroupPrivacyStatus getPrivacyStatus()
```
    Gets the value of the privacyStatus property.
    
    Returns:
    
    possible object is AdGroupPrivacyStatus
  - setPrivacyStatus
```
public void setPrivacyStatus(AdGroupPrivacyStatus value)
```
    Sets the value of the privacyStatus property.
    
    Parameters:
    
    value - allowed object is AdGroupPrivacyStatus
  - 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
  - getStartDate
```
public Date getStartDate()
```
    Gets the value of the startDate property.
    
    Returns:
    
    possible object is Date
  - setStartDate
```
public void setStartDate(Date value)
```
    Sets the value of the startDate property.
    
    Parameters:
    
    value - allowed object is Date
  - getStatus
```
public AdGroupStatus getStatus()
```
    Gets the value of the status property.
    
    Returns:
    
    possible object is AdGroupStatus
  - setStatus
```
public void setStatus(AdGroupStatus value)
```
    Sets the value of the status property.
    
    Parameters:
    
    value - allowed object is AdGroupStatus
  - 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
  - getUseOptimizedTargeting
```
public Boolean getUseOptimizedTargeting()
```
    Gets the value of the useOptimizedTargeting property.
    
    Returns:
    
    possible object is Boolean
  - setUseOptimizedTargeting
```
public void setUseOptimizedTargeting(Boolean value)
```
    Sets the value of the useOptimizedTargeting property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getUsePredictiveTargeting
```
public Boolean getUsePredictiveTargeting()
```
    Gets the value of the usePredictiveTargeting property.
    
    Returns:
    
    possible object is Boolean
  - setUsePredictiveTargeting
```
public void setUsePredictiveTargeting(Boolean value)
```
    Sets the value of the usePredictiveTargeting property.
    
    Parameters:
    
    value - allowed object is Boolean
  - 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
  - getAdGroupType
```
public String getAdGroupType()
```
    Gets the value of the adGroupType property.
    
    Returns:
    
    possible object is String
  - setAdGroupType
```
public void setAdGroupType(String value)
```
    Sets the value of the adGroupType property.
    
    Parameters:
    
    value - allowed object is String
  - getCpvBid
```
public Bid getCpvBid()
```
    Gets the value of the cpvBid property.
    
    Returns:
    
    possible object is Bid
  - setCpvBid
```
public void setCpvBid(Bid value)
```
    Sets the value of the cpvBid property.
    
    Parameters:
    
    value - allowed object is Bid
  - getCpmBid
```
public Bid getCpmBid()
```
    Gets the value of the cpmBid property.
    
    Returns:
    
    possible object is Bid
  - setCpmBid
```
public void setCpmBid(Bid value)
```
    Sets the value of the cpmBid property.
    
    Parameters:
    
    value - allowed object is Bid
  - getMcpaBid
```
public Bid getMcpaBid()
```
    Gets the value of the mcpaBid property.
    
    Returns:
    
    possible object is Bid
  - setMcpaBid
```
public void setMcpaBid(Bid value)
```
    Sets the value of the mcpaBid property.
    
    Parameters:
    
    value - allowed object is Bid

Class AdGroup

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

adRotation

audienceAdsBidAdjustment

biddingScheme

commissionRate

cpcBid

endDate

finalUrlSuffix

forwardCompatibilityMap

frequencyCapSettings

id

language

multimediaAdsBidAdjustment

name

network

percentCpcBid

privacyStatus

settings

startDate

status

trackingUrlTemplate

urlCustomParameters

useOptimizedTargeting

usePredictiveTargeting

adScheduleUseSearcherTimeZone

adGroupType

cpvBid

cpmBid

mcpaBid

Constructor Detail

AdGroup

Method Detail

getAdRotation

setAdRotation

getAudienceAdsBidAdjustment

setAudienceAdsBidAdjustment

getBiddingScheme

setBiddingScheme

getCommissionRate

setCommissionRate

getCpcBid

setCpcBid

getEndDate

setEndDate

getFinalUrlSuffix

setFinalUrlSuffix

getForwardCompatibilityMap

setForwardCompatibilityMap

getFrequencyCapSettings

setFrequencyCapSettings

getId

setId

getLanguage

setLanguage

getMultimediaAdsBidAdjustment

setMultimediaAdsBidAdjustment

getName

setName

getNetwork

setNetwork

getPercentCpcBid

setPercentCpcBid

getPrivacyStatus

setPrivacyStatus

getSettings

setSettings

getStartDate

setStartDate

getStatus

setStatus

getTrackingUrlTemplate

setTrackingUrlTemplate

getUrlCustomParameters

setUrlCustomParameters

getUseOptimizedTargeting