Ad (AdWords AppEngine components 4.21.0 API)

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

Direct Known Subclasses:: CallOnlyAd, DeprecatedAd, DynamicSearchAd, ExpandedDynamicSearchAd, ExpandedTextAd, GmailAd, GoalOptimizedShoppingAd, ImageAd, MultiAssetResponsiveDisplayAd, ProductAd, ResponsiveDisplayAd, ResponsiveSearchAd, RichMediaAd, ShowcaseAd, TemplateAd, TextAd, UniversalAppAd

public class Ad
extends Object

The base class of all ad types. Ads are created using the AdGroupAdService. Some ad types such as ExpandedTextAds may be modified using the AdService.

When calling AdGroupAdService to update the status of an AdGroupAd, you can construct an Ad object (instead of the Ad's concrete type) with the id field set. This is enabled for AdX.

Java class for Ad complex type.

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

 <complexType name="Ad">
   <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="url" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="displayUrl" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="finalUrls" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="finalMobileUrls" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="finalAppUrls" type="{https://adwords.google.com/api/adwords/cm/v201809}AppUrl" maxOccurs="unbounded" 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="urlData" type="{https://adwords.google.com/api/adwords/cm/v201809}UrlData" maxOccurs="unbounded" minOccurs="0"/>
         <element name="automated" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="type" type="{https://adwords.google.com/api/adwords/cm/v201809}Ad.Type" minOccurs="0"/>
         <element name="devicePreference" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="systemManagedEntitySource" type="{https://adwords.google.com/api/adwords/cm/v201809}SystemManagedEntitySource" minOccurs="0"/>
         <element name="Ad.Type" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`adType`
`protected Boolean`	`automated`
`protected Long`	`devicePreference`
`protected String`	`displayUrl`
`protected List<AppUrl>`	`finalAppUrls`
`protected List<String>`	`finalMobileUrls`
`protected List<String>`	`finalUrls`
`protected String`	`finalUrlSuffix`
`protected Long`	`id`
`protected SystemManagedEntitySource`	`systemManagedEntitySource`
`protected String`	`trackingUrlTemplate`
`protected AdType`	`type`
`protected String`	`url`
`protected CustomParameters`	`urlCustomParameters`
`protected List<UrlData>`	`urlData`

Constructor Summary

Constructors
Constructor and Description

Ad()

Constructors
Constructor and Description
`Ad()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAdType()` Gets the value of the adType property.
`Long`	`getDevicePreference()` Gets the value of the devicePreference property.
`String`	`getDisplayUrl()` Gets the value of the displayUrl property.
`List<AppUrl>`	`getFinalAppUrls()` Gets the value of the finalAppUrls property.
`List<String>`	`getFinalMobileUrls()` Gets the value of the finalMobileUrls property.
`List<String>`	`getFinalUrls()` Gets the value of the finalUrls property.
`String`	`getFinalUrlSuffix()` Gets the value of the finalUrlSuffix property.
`Long`	`getId()` Gets the value of the id property.
`SystemManagedEntitySource`	`getSystemManagedEntitySource()` Gets the value of the systemManagedEntitySource property.
`String`	`getTrackingUrlTemplate()` Gets the value of the trackingUrlTemplate property.
`AdType`	`getType()` Gets the value of the type property.
`String`	`getUrl()` Gets the value of the url property.
`CustomParameters`	`getUrlCustomParameters()` Gets the value of the urlCustomParameters property.
`List<UrlData>`	`getUrlData()` Gets the value of the urlData property.
`Boolean`	`isAutomated()` Gets the value of the automated property.
`void`	`setAdType(String value)` Sets the value of the adType property.
`void`	`setAutomated(Boolean value)` Sets the value of the automated property.
`void`	`setDevicePreference(Long value)` Sets the value of the devicePreference property.
`void`	`setDisplayUrl(String value)` Sets the value of the displayUrl property.
`void`	`setFinalUrlSuffix(String value)` Sets the value of the finalUrlSuffix property.
`void`	`setId(Long value)` Sets the value of the id property.
`void`	`setSystemManagedEntitySource(SystemManagedEntitySource value)` Sets the value of the systemManagedEntitySource property.
`void`	`setTrackingUrlTemplate(String value)` Sets the value of the trackingUrlTemplate property.
`void`	`setType(AdType value)` Sets the value of the type property.
`void`	`setUrl(String value)` Sets the value of the url 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
```
  - url
```
protected String url
```
  - displayUrl
```
protected String displayUrl
```
  - finalUrls
```
protected List<String> finalUrls
```
  - finalMobileUrls
```
protected List<String> finalMobileUrls
```
  - finalAppUrls
```
protected List<AppUrl> finalAppUrls
```
  - trackingUrlTemplate
```
protected String trackingUrlTemplate
```
  - finalUrlSuffix
```
protected String finalUrlSuffix
```
  - urlCustomParameters
```
protected CustomParameters urlCustomParameters
```
  - urlData
```
protected List<UrlData> urlData
```
  - automated
```
protected Boolean automated
```
  - type
```
protected AdType type
```
  - devicePreference
```
protected Long devicePreference
```
  - systemManagedEntitySource
```
protected SystemManagedEntitySource systemManagedEntitySource
```
  - adType
```
protected String adType
```
- Constructor Detail
  - Ad
```
public Ad()
```
- 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
  - getUrl
```
public String getUrl()
```
    Gets the value of the url property.
    
    Returns:
    
    possible object is String
  - setUrl
```
public void setUrl(String value)
```
    Sets the value of the url property.
    
    Parameters:
    
    value - allowed object is String
  - getDisplayUrl
```
public String getDisplayUrl()
```
    Gets the value of the displayUrl property.
    
    Returns:
    
    possible object is String
  - setDisplayUrl
```
public void setDisplayUrl(String value)
```
    Sets the value of the displayUrl property.
    
    Parameters:
    
    value - allowed object is String
  - getFinalUrls
```
public List<String> getFinalUrls()
```
    Gets the value of the finalUrls 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 finalUrls property.
    For example, to add a new item, do as follows:
```
    getFinalUrls().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getFinalMobileUrls
```
public List<String> getFinalMobileUrls()
```
    Gets the value of the finalMobileUrls 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 finalMobileUrls property.
    For example, to add a new item, do as follows:
```
    getFinalMobileUrls().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getFinalAppUrls
```
public List<AppUrl> getFinalAppUrls()
```
    Gets the value of the finalAppUrls 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 finalAppUrls property.
    For example, to add a new item, do as follows:
```
    getFinalAppUrls().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list AppUrl
  - 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
  - getUrlData
```
public List<UrlData> getUrlData()
```
    Gets the value of the urlData 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 urlData property.
    For example, to add a new item, do as follows:
```
    getUrlData().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list UrlData
  - isAutomated
```
public Boolean isAutomated()
```
    Gets the value of the automated property.
    
    Returns:
    
    possible object is Boolean
  - setAutomated
```
public void setAutomated(Boolean value)
```
    Sets the value of the automated property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getType
```
public AdType getType()
```
    Gets the value of the type property.
    
    Returns:
    
    possible object is AdType
  - setType
```
public void setType(AdType value)
```
    Sets the value of the type property.
    
    Parameters:
    
    value - allowed object is AdType
  - getDevicePreference
```
public Long getDevicePreference()
```
    Gets the value of the devicePreference property.
    
    Returns:
    
    possible object is Long
  - setDevicePreference
```
public void setDevicePreference(Long value)
```
    Sets the value of the devicePreference property.
    
    Parameters:
    
    value - allowed object is Long
  - getSystemManagedEntitySource
```
public SystemManagedEntitySource getSystemManagedEntitySource()
```
    Gets the value of the systemManagedEntitySource property.
    
    Returns:
    
    possible object is SystemManagedEntitySource
  - setSystemManagedEntitySource
```
public void setSystemManagedEntitySource(SystemManagedEntitySource value)
```
    Sets the value of the systemManagedEntitySource property.
    
    Parameters:
    
    value - allowed object is SystemManagedEntitySource
  - getAdType
```
public String getAdType()
```
    Gets the value of the adType property.
    
    Returns:
    
    possible object is String
  - setAdType
```
public void setAdType(String value)
```
    Sets the value of the adType property.
    
    Parameters:
    
    value - allowed object is String

Class Ad

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

url

displayUrl

finalUrls

finalMobileUrls

finalAppUrls

trackingUrlTemplate

finalUrlSuffix

urlCustomParameters

urlData

automated

type

devicePreference

systemManagedEntitySource

adType

Constructor Detail

Ad

Method Detail

getId

setId

getUrl

setUrl

getDisplayUrl

setDisplayUrl

getFinalUrls

getFinalMobileUrls

getFinalAppUrls

getTrackingUrlTemplate

setTrackingUrlTemplate

getFinalUrlSuffix

setFinalUrlSuffix

getUrlCustomParameters

setUrlCustomParameters

getUrlData

isAutomated

setAutomated

getType

setType

getDevicePreference

setDevicePreference

getSystemManagedEntitySource

setSystemManagedEntitySource

getAdType

setAdType