AdGroupAd (Display & Video 360 API v3-rev20260505-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.displayvideo.v3.model.AdGroupAd

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class AdGroupAd
extends com.google.api.client.json.GenericJson
```
A single ad associated with an ad group.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Display & Video 360 API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

AdGroupAd()

Constructors
Constructor and Description
`AdGroupAd()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdGroupAd`	`clone()`
`Long`	`getAdGroupAdId()` Output only.
`Long`	`getAdGroupId()` Required.
`AdPolicy`	`getAdPolicy()` Output only.
`List<AdUrl>`	`getAdUrls()` Output only.
`Long`	`getAdvertiserId()` Output only.
`AudioAd`	`getAudioAd()` Output only.
`BumperAd`	`getBumperAd()` Output only.
`DcmTrackingInfo`	`getDcmTrackingInfo()` Optional.
`DemandGenCarouselAd`	`getDemandGenCarouselAd()` Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=1 1207068802760924844-NC#CarouselAd).
`DemandGenImageAd`	`getDemandGenImageAd()` Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd).
`DemandGenProductAd`	`getDemandGenProductAd()` Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product- onlyAd).
`DemandGenVideoAd`	`getDemandGenVideoAd()` Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd).
`String`	`getDisplayName()` Required.
`DisplayVideoSourceAd`	`getDisplayVideoSourceAd()` Output only.
`String`	`getEntityStatus()` Required.
`InStreamAd`	`getInStreamAd()` Output only.
`MastheadAd`	`getMastheadAd()` Output only.
`String`	`getName()` Output only.
`NonSkippableAd`	`getNonSkippableAd()` Output only.
`VideoDiscoveryAd`	`getVideoDiscoverAd()` Output only.
`VideoPerformanceAd`	`getVideoPerformanceAd()` Output only.
`AdGroupAd`	`set(String fieldName, Object value)`
`AdGroupAd`	`setAdGroupAdId(Long adGroupAdId)` Output only.
`AdGroupAd`	`setAdGroupId(Long adGroupId)` Required.
`AdGroupAd`	`setAdPolicy(AdPolicy adPolicy)` Output only.
`AdGroupAd`	`setAdUrls(List<AdUrl> adUrls)` Output only.
`AdGroupAd`	`setAdvertiserId(Long advertiserId)` Output only.
`AdGroupAd`	`setAudioAd(AudioAd audioAd)` Output only.
`AdGroupAd`	`setBumperAd(BumperAd bumperAd)` Output only.
`AdGroupAd`	`setDcmTrackingInfo(DcmTrackingInfo dcmTrackingInfo)` Optional.
`AdGroupAd`	`setDemandGenCarouselAd(DemandGenCarouselAd demandGenCarouselAd)` Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=1 1207068802760924844-NC#CarouselAd).
`AdGroupAd`	`setDemandGenImageAd(DemandGenImageAd demandGenImageAd)` Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd).
`AdGroupAd`	`setDemandGenProductAd(DemandGenProductAd demandGenProductAd)` Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product- onlyAd).
`AdGroupAd`	`setDemandGenVideoAd(DemandGenVideoAd demandGenVideoAd)` Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd).
`AdGroupAd`	`setDisplayName(String displayName)` Required.
`AdGroupAd`	`setDisplayVideoSourceAd(DisplayVideoSourceAd displayVideoSourceAd)` Output only.
`AdGroupAd`	`setEntityStatus(String entityStatus)` Required.
`AdGroupAd`	`setInStreamAd(InStreamAd inStreamAd)` Output only.
`AdGroupAd`	`setMastheadAd(MastheadAd mastheadAd)` Output only.
`AdGroupAd`	`setName(String name)` Output only.
`AdGroupAd`	`setNonSkippableAd(NonSkippableAd nonSkippableAd)` Output only.
`AdGroupAd`	`setVideoDiscoverAd(VideoDiscoveryAd videoDiscoverAd)` Output only.
`AdGroupAd`	`setVideoPerformanceAd(VideoPerformanceAd videoPerformanceAd)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - AdGroupAd
```
public AdGroupAd()
```
- Method Detail
  - getAdGroupAdId
```
public Long getAdGroupAdId()
```
    Output only. The unique ID of the ad. Assigned by the system.
    
    Returns:
    
    value or null for none
  - setAdGroupAdId
```
public AdGroupAd setAdGroupAdId(Long adGroupAdId)
```
    Output only. The unique ID of the ad. Assigned by the system.
    
    Parameters:
    
    adGroupAdId - adGroupAdId or null for none
  - getAdGroupId
```
public Long getAdGroupId()
```
    Required. Immutable. The unique ID of the ad group that the ad belongs to.
    
    Returns:
    
    value or null for none
  - setAdGroupId
```
public AdGroupAd setAdGroupId(Long adGroupId)
```
    Required. Immutable. The unique ID of the ad group that the ad belongs to.
    
    Parameters:
    
    adGroupId - adGroupId or null for none
  - getAdPolicy
```
public AdPolicy getAdPolicy()
```
    Output only. The policy approval status of the ad.
    
    Returns:
    
    value or null for none
  - setAdPolicy
```
public AdGroupAd setAdPolicy(AdPolicy adPolicy)
```
    Output only. The policy approval status of the ad.
    
    Parameters:
    
    adPolicy - adPolicy or null for none
  - getAdUrls
```
public List<AdUrl> getAdUrls()
```
    Output only. List of URLs used by the ad.
    
    Returns:
    
    value or null for none
  - setAdUrls
```
public AdGroupAd setAdUrls(List<AdUrl> adUrls)
```
    Output only. List of URLs used by the ad.
    
    Parameters:
    
    adUrls - adUrls or null for none
  - getAdvertiserId
```
public Long getAdvertiserId()
```
    Output only. The unique ID of the advertiser the ad belongs to.
    
    Returns:
    
    value or null for none
  - setAdvertiserId
```
public AdGroupAd setAdvertiserId(Long advertiserId)
```
    Output only. The unique ID of the advertiser the ad belongs to.
    
    Parameters:
    
    advertiserId - advertiserId or null for none
  - getAudioAd
```
public AudioAd getAudioAd()
```
    Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
    
    Returns:
    
    value or null for none
  - setAudioAd
```
public AdGroupAd setAudioAd(AudioAd audioAd)
```
    Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
    
    Parameters:
    
    audioAd - audioAd or null for none
  - getBumperAd
```
public BumperAd getBumperAd()
```
    Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
    
    Returns:
    
    value or null for none
  - setBumperAd
```
public AdGroupAd setBumperAd(BumperAd bumperAd)
```
    Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
    
    Parameters:
    
    bumperAd - bumperAd or null for none
  - getDcmTrackingInfo
```
public DcmTrackingInfo getDcmTrackingInfo()
```
    Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.
    
    Returns:
    
    value or null for none
  - setDcmTrackingInfo
```
public AdGroupAd setDcmTrackingInfo(DcmTrackingInfo dcmTrackingInfo)
```
    Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.
    
    Parameters:
    
    dcmTrackingInfo - dcmTrackingInfo or null for none
  - getDemandGenCarouselAd
```
public DemandGenCarouselAd getDemandGenCarouselAd()
```
    Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=1 1207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.
    
    Returns:
    
    value or null for none
  - setDemandGenCarouselAd
```
public AdGroupAd setDemandGenCarouselAd(DemandGenCarouselAd demandGenCarouselAd)
```
    Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=1 1207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.
    
    Parameters:
    
    demandGenCarouselAd - demandGenCarouselAd or null for none
  - getDemandGenImageAd
```
public DemandGenImageAd getDemandGenImageAd()
```
    Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.
    
    Returns:
    
    value or null for none
  - setDemandGenImageAd
```
public AdGroupAd setDemandGenImageAd(DemandGenImageAd demandGenImageAd)
```
    Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.
    
    Parameters:
    
    demandGenImageAd - demandGenImageAd or null for none
  - getDemandGenProductAd
```
public DemandGenProductAd getDemandGenProductAd()
```
    Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product- onlyAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.
    
    Returns:
    
    value or null for none
  - setDemandGenProductAd
```
public AdGroupAd setDemandGenProductAd(DemandGenProductAd demandGenProductAd)
```
    Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product- onlyAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.
    
    Parameters:
    
    demandGenProductAd - demandGenProductAd or null for none
  - getDemandGenVideoAd
```
public DemandGenVideoAd getDemandGenVideoAd()
```
    Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.
    
    Returns:
    
    value or null for none
  - setDemandGenVideoAd
```
public AdGroupAd setDemandGenVideoAd(DemandGenVideoAd demandGenVideoAd)
```
    Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.
    
    Parameters:
    
    demandGenVideoAd - demandGenVideoAd or null for none
  - getDisplayName
```
public String getDisplayName()
```
    Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public AdGroupAd setDisplayName(String displayName)
```
    Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
    
    Parameters:
    
    displayName - displayName or null for none
  - getDisplayVideoSourceAd
```
public DisplayVideoSourceAd getDisplayVideoSourceAd()
```
    Output only. Details of an ad sourced from a Display & Video 360 creative.
    
    Returns:
    
    value or null for none
  - setDisplayVideoSourceAd
```
public AdGroupAd setDisplayVideoSourceAd(DisplayVideoSourceAd displayVideoSourceAd)
```
    Output only. Details of an ad sourced from a Display & Video 360 creative.
    
    Parameters:
    
    displayVideoSourceAd - displayVideoSourceAd or null for none
  - getEntityStatus
```
public String getEntityStatus()
```
    Required. The entity status of the ad.
    
    Returns:
    
    value or null for none
  - setEntityStatus
```
public AdGroupAd setEntityStatus(String entityStatus)
```
    Required. The entity status of the ad.
    
    Parameters:
    
    entityStatus - entityStatus or null for none
  - getInStreamAd
```
public InStreamAd getInStreamAd()
```
    Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
    
    Returns:
    
    value or null for none
  - setInStreamAd
```
public AdGroupAd setInStreamAd(InStreamAd inStreamAd)
```
    Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
    
    Parameters:
    
    inStreamAd - inStreamAd or null for none
  - getMastheadAd
```
public MastheadAd getMastheadAd()
```
    Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google- ads/answer/9709826).
    
    Returns:
    
    value or null for none
  - setMastheadAd
```
public AdGroupAd setMastheadAd(MastheadAd mastheadAd)
```
    Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google- ads/answer/9709826).
    
    Parameters:
    
    mastheadAd - mastheadAd or null for none
  - getName
```
public String getName()
```
    Output only. The resource name of the ad.
    
    Returns:
    
    value or null for none
  - setName
```
public AdGroupAd setName(String name)
```
    Output only. The resource name of the ad.
    
    Parameters:
    
    name - name or null for none
  - getNonSkippableAd
```
public NonSkippableAd getNonSkippableAd()
```
    Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
    
    Returns:
    
    value or null for none
  - setNonSkippableAd
```
public AdGroupAd setNonSkippableAd(NonSkippableAd nonSkippableAd)
```
    Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
    
    Parameters:
    
    nonSkippableAd - nonSkippableAd or null for none
  - getVideoDiscoverAd
```
public VideoDiscoveryAd getVideoDiscoverAd()
```
    Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
    
    Returns:
    
    value or null for none
  - setVideoDiscoverAd
```
public AdGroupAd setVideoDiscoverAd(VideoDiscoveryAd videoDiscoverAd)
```
    Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
    
    Parameters:
    
    videoDiscoverAd - videoDiscoverAd or null for none
  - getVideoPerformanceAd
```
public VideoPerformanceAd getVideoPerformanceAd()
```
    Output only. Details of an [ad used in a video action campaign](//support.google.com/google- ads/answer/10147229) to drive actions to the business, service or product.
    
    Returns:
    
    value or null for none
  - setVideoPerformanceAd
```
public AdGroupAd setVideoPerformanceAd(VideoPerformanceAd videoPerformanceAd)
```
    Output only. Details of an [ad used in a video action campaign](//support.google.com/google- ads/answer/10147229) to drive actions to the business, service or product.
    
    Parameters:
    
    videoPerformanceAd - videoPerformanceAd or null for none
  - set
```
public AdGroupAd set(String fieldName,
                     Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public AdGroupAd clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class AdGroupAd

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

AdGroupAd

Method Detail

getAdGroupAdId

setAdGroupAdId

getAdGroupId

setAdGroupId

getAdPolicy

setAdPolicy

getAdUrls

setAdUrls

getAdvertiserId

setAdvertiserId

getAudioAd

setAudioAd

getBumperAd

setBumperAd

getDcmTrackingInfo

setDcmTrackingInfo

getDemandGenCarouselAd

setDemandGenCarouselAd

getDemandGenImageAd

setDemandGenImageAd

getDemandGenProductAd

setDemandGenProductAd

getDemandGenVideoAd

setDemandGenVideoAd

getDisplayName

setDisplayName

getDisplayVideoSourceAd

setDisplayVideoSourceAd

getEntityStatus

setEntityStatus

getInStreamAd

setInStreamAd

getMastheadAd

setMastheadAd

getName

setName

getNonSkippableAd

setNonSkippableAd

getVideoDiscoverAd

setVideoDiscoverAd

getVideoPerformanceAd

setVideoPerformanceAd

set

clone