AdGroup (AdWords AppEngine components 4.21.0 API)

java.lang.Object
- com.google.api.ads.adwords.jaxws.v201809.cm.AdGroup

public class AdGroup
extends Object

Represents an ad group.

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="id" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="campaignId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="campaignName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="status" type="{https://adwords.google.com/api/adwords/cm/v201809}AdGroup.Status" minOccurs="0"/>
         <element name="settings" type="{https://adwords.google.com/api/adwords/cm/v201809}Setting" maxOccurs="unbounded" minOccurs="0"/>
         <element name="labels" type="{https://adwords.google.com/api/adwords/cm/v201809}Label" maxOccurs="unbounded" minOccurs="0"/>
         <element name="forwardCompatibilityMap" type="{https://adwords.google.com/api/adwords/cm/v201809}String_StringMapEntry" maxOccurs="unbounded" minOccurs="0"/>
         <element name="biddingStrategyConfiguration" type="{https://adwords.google.com/api/adwords/cm/v201809}BiddingStrategyConfiguration" minOccurs="0"/>
         <element name="contentBidCriterionTypeGroup" type="{https://adwords.google.com/api/adwords/cm/v201809}CriterionTypeGroup" minOccurs="0"/>
         <element name="baseCampaignId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="baseAdGroupId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="trackingUrlTemplate" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="finalUrlSuffix" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="urlCustomParameters" type="{https://adwords.google.com/api/adwords/cm/v201809}CustomParameters" minOccurs="0"/>
         <element name="adGroupType" type="{https://adwords.google.com/api/adwords/cm/v201809}AdGroupType" minOccurs="0"/>
         <element name="adGroupAdRotationMode" type="{https://adwords.google.com/api/adwords/cm/v201809}AdGroupAdRotationMode" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected AdGroupAdRotationMode`	`adGroupAdRotationMode`
`protected AdGroupType`	`adGroupType`
`protected Long`	`baseAdGroupId`
`protected Long`	`baseCampaignId`
`protected BiddingStrategyConfiguration`	`biddingStrategyConfiguration`
`protected Long`	`campaignId`
`protected String`	`campaignName`
`protected CriterionTypeGroup`	`contentBidCriterionTypeGroup`
`protected String`	`finalUrlSuffix`
`protected List<StringStringMapEntry>`	`forwardCompatibilityMap`
`protected Long`	`id`
`protected List<Label>`	`labels`
`protected String`	`name`
`protected List<Setting>`	`settings`
`protected AdGroupStatus`	`status`
`protected String`	`trackingUrlTemplate`
`protected CustomParameters`	`urlCustomParameters`

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
`AdGroupAdRotationMode`	`getAdGroupAdRotationMode()` Gets the value of the adGroupAdRotationMode property.
`AdGroupType`	`getAdGroupType()` Gets the value of the adGroupType property.
`Long`	`getBaseAdGroupId()` Gets the value of the baseAdGroupId property.
`Long`	`getBaseCampaignId()` Gets the value of the baseCampaignId property.
`BiddingStrategyConfiguration`	`getBiddingStrategyConfiguration()` Gets the value of the biddingStrategyConfiguration property.
`Long`	`getCampaignId()` Gets the value of the campaignId property.
`String`	`getCampaignName()` Gets the value of the campaignName property.
`CriterionTypeGroup`	`getContentBidCriterionTypeGroup()` Gets the value of the contentBidCriterionTypeGroup property.
`String`	`getFinalUrlSuffix()` Gets the value of the finalUrlSuffix property.
`List<StringStringMapEntry>`	`getForwardCompatibilityMap()` Gets the value of the forwardCompatibilityMap property.
`Long`	`getId()` Gets the value of the id property.
`List<Label>`	`getLabels()` Gets the value of the labels property.
`String`	`getName()` Gets the value of the name property.
`List<Setting>`	`getSettings()` Gets the value of the settings 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.
`void`	`setAdGroupAdRotationMode(AdGroupAdRotationMode value)` Sets the value of the adGroupAdRotationMode property.
`void`	`setAdGroupType(AdGroupType value)` Sets the value of the adGroupType property.
`void`	`setBaseAdGroupId(Long value)` Sets the value of the baseAdGroupId property.
`void`	`setBaseCampaignId(Long value)` Sets the value of the baseCampaignId property.
`void`	`setBiddingStrategyConfiguration(BiddingStrategyConfiguration value)` Sets the value of the biddingStrategyConfiguration property.
`void`	`setCampaignId(Long value)` Sets the value of the campaignId property.
`void`	`setCampaignName(String value)` Sets the value of the campaignName property.
`void`	`setContentBidCriterionTypeGroup(CriterionTypeGroup value)` Sets the value of the contentBidCriterionTypeGroup property.
`void`	`setFinalUrlSuffix(String value)` Sets the value of the finalUrlSuffix property.
`void`	`setId(Long value)` Sets the value of the id property.
`void`	`setName(String value)` Sets the value of the name 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.

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

- Field Detail
  - id
```
protected Long id
```
  - campaignId
```
protected Long campaignId
```
  - campaignName
```
protected String campaignName
```
  - name
```
protected String name
```
  - status
```
protected AdGroupStatus status
```
  - settings
```
protected List<Setting> settings
```
  - labels
```
protected List<Label> labels
```
  - forwardCompatibilityMap
```
protected List<StringStringMapEntry> forwardCompatibilityMap
```
  - biddingStrategyConfiguration
```
protected BiddingStrategyConfiguration biddingStrategyConfiguration
```
  - contentBidCriterionTypeGroup
```
protected CriterionTypeGroup contentBidCriterionTypeGroup
```
  - baseCampaignId
```
protected Long baseCampaignId
```
  - baseAdGroupId
```
protected Long baseAdGroupId
```
  - trackingUrlTemplate
```
protected String trackingUrlTemplate
```
  - finalUrlSuffix
```
protected String finalUrlSuffix
```
  - urlCustomParameters
```
protected CustomParameters urlCustomParameters
```
  - adGroupType
```
protected AdGroupType adGroupType
```
  - adGroupAdRotationMode
```
protected AdGroupAdRotationMode adGroupAdRotationMode
```
- Constructor Detail
  - AdGroup
```
public AdGroup()
```
- Method Detail
  - 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
  - getCampaignId
```
public Long getCampaignId()
```
    Gets the value of the campaignId property.
    
    Returns:
    
    possible object is Long
  - setCampaignId
```
public void setCampaignId(Long value)
```
    Sets the value of the campaignId property.
    
    Parameters:
    
    value - allowed object is Long
  - getCampaignName
```
public String getCampaignName()
```
    Gets the value of the campaignName property.
    
    Returns:
    
    possible object is String
  - setCampaignName
```
public void setCampaignName(String value)
```
    Sets the value of the campaignName property.
    
    Parameters:
    
    value - allowed object is String
  - 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 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
  - getSettings
```
public List<Setting> getSettings()
```
    Gets the value of the settings property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the settings property.
    For example, to add a new item, do as follows:
```
    getSettings().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Setting
  - getLabels
```
public List<Label> getLabels()
```
    Gets the value of the labels property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the labels property.
    For example, to add a new item, do as follows:
```
    getLabels().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Label
  - getForwardCompatibilityMap
```
public List<StringStringMapEntry> getForwardCompatibilityMap()
```
    Gets the value of the forwardCompatibilityMap property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the forwardCompatibilityMap property.
    For example, to add a new item, do as follows:
```
    getForwardCompatibilityMap().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list StringStringMapEntry
  - getBiddingStrategyConfiguration
```
public BiddingStrategyConfiguration getBiddingStrategyConfiguration()
```
    Gets the value of the biddingStrategyConfiguration property.
    
    Returns:
    
    possible object is BiddingStrategyConfiguration
  - setBiddingStrategyConfiguration
```
public void setBiddingStrategyConfiguration(BiddingStrategyConfiguration value)
```
    Sets the value of the biddingStrategyConfiguration property.
    
    Parameters:
    
    value - allowed object is BiddingStrategyConfiguration
  - getContentBidCriterionTypeGroup
```
public CriterionTypeGroup getContentBidCriterionTypeGroup()
```
    Gets the value of the contentBidCriterionTypeGroup property.
    
    Returns:
    
    possible object is CriterionTypeGroup
  - setContentBidCriterionTypeGroup
```
public void setContentBidCriterionTypeGroup(CriterionTypeGroup value)
```
    Sets the value of the contentBidCriterionTypeGroup property.
    
    Parameters:
    
    value - allowed object is CriterionTypeGroup
  - getBaseCampaignId
```
public Long getBaseCampaignId()
```
    Gets the value of the baseCampaignId property.
    
    Returns:
    
    possible object is Long
  - setBaseCampaignId
```
public void setBaseCampaignId(Long value)
```
    Sets the value of the baseCampaignId property.
    
    Parameters:
    
    value - allowed object is Long
  - getBaseAdGroupId
```
public Long getBaseAdGroupId()
```
    Gets the value of the baseAdGroupId property.
    
    Returns:
    
    possible object is Long
  - setBaseAdGroupId
```
public void setBaseAdGroupId(Long value)
```
    Sets the value of the baseAdGroupId property.
    
    Parameters:
    
    value - allowed object is Long
  - 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
  - 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
  - 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
  - getAdGroupType
```
public AdGroupType getAdGroupType()
```
    Gets the value of the adGroupType property.
    
    Returns:
    
    possible object is AdGroupType
  - setAdGroupType
```
public void setAdGroupType(AdGroupType value)
```
    Sets the value of the adGroupType property.
    
    Parameters:
    
    value - allowed object is AdGroupType
  - getAdGroupAdRotationMode
```
public AdGroupAdRotationMode getAdGroupAdRotationMode()
```
    Gets the value of the adGroupAdRotationMode property.
    
    Returns:
    
    possible object is AdGroupAdRotationMode
  - setAdGroupAdRotationMode
```
public void setAdGroupAdRotationMode(AdGroupAdRotationMode value)
```
    Sets the value of the adGroupAdRotationMode property.
    
    Parameters:
    
    value - allowed object is AdGroupAdRotationMode

Class AdGroup

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

campaignId

campaignName

name

status

settings

labels

forwardCompatibilityMap

biddingStrategyConfiguration

contentBidCriterionTypeGroup

baseCampaignId

baseAdGroupId

trackingUrlTemplate

finalUrlSuffix

urlCustomParameters

adGroupType

adGroupAdRotationMode

Constructor Detail

AdGroup

Method Detail

getId

setId

getCampaignId

setCampaignId

getCampaignName

setCampaignName

getName

setName

getStatus

setStatus

getSettings

getLabels

getForwardCompatibilityMap

getBiddingStrategyConfiguration

setBiddingStrategyConfiguration

getContentBidCriterionTypeGroup

setContentBidCriterionTypeGroup

getBaseCampaignId

setBaseCampaignId

getBaseAdGroupId

setBaseAdGroupId

getTrackingUrlTemplate

setTrackingUrlTemplate

getFinalUrlSuffix

setFinalUrlSuffix

getUrlCustomParameters

setUrlCustomParameters

getAdGroupType

setAdGroupType

getAdGroupAdRotationMode

setAdGroupAdRotationMode