AdGroup (Display & Video 360 API v4-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.v4.model.AdGroup

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class AdGroup
extends com.google.api.client.json.GenericJson
```
A single ad group associated with a line item.
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

AdGroup()

Constructors
Constructor and Description
`AdGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdGroup`	`clone()`
`String`	`getAdGroupFormat()` Required.
`Long`	`getAdGroupId()` Output only.
`AdGroupInventoryControl`	`getAdGroupInventoryControl()` Optional.
`Long`	`getAdvertiserId()` Output only.
`BiddingStrategy`	`getBidStrategy()` Optional.
`String`	`getDisplayName()` Required.
`String`	`getEntityStatus()` Required.
`Long`	`getLineItemId()` Required.
`String`	`getName()` Output only.
`ProductFeedData`	`getProductFeedData()` Optional.
`TargetingExpansionConfig`	`getTargetingExpansion()` Optional.
`AdGroup`	`set(String fieldName, Object value)`
`AdGroup`	`setAdGroupFormat(String adGroupFormat)` Required.
`AdGroup`	`setAdGroupId(Long adGroupId)` Output only.
`AdGroup`	`setAdGroupInventoryControl(AdGroupInventoryControl adGroupInventoryControl)` Optional.
`AdGroup`	`setAdvertiserId(Long advertiserId)` Output only.
`AdGroup`	`setBidStrategy(BiddingStrategy bidStrategy)` Optional.
`AdGroup`	`setDisplayName(String displayName)` Required.
`AdGroup`	`setEntityStatus(String entityStatus)` Required.
`AdGroup`	`setLineItemId(Long lineItemId)` Required.
`AdGroup`	`setName(String name)` Output only.
`AdGroup`	`setProductFeedData(ProductFeedData productFeedData)` Optional.
`AdGroup`	`setTargetingExpansion(TargetingExpansionConfig targetingExpansion)` Optional.

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
  - AdGroup
```
public AdGroup()
```
- Method Detail
  - getAdGroupFormat
```
public String getAdGroupFormat()
```
    Required. Immutable. The format of the ads in the ad group.
    
    Returns:
    
    value or null for none
  - setAdGroupFormat
```
public AdGroup setAdGroupFormat(String adGroupFormat)
```
    Required. Immutable. The format of the ads in the ad group.
    
    Parameters:
    
    adGroupFormat - adGroupFormat or null for none
  - getAdGroupId
```
public Long getAdGroupId()
```
    Output only. The unique ID of the ad group. Assigned by the system.
    
    Returns:
    
    value or null for none
  - setAdGroupId
```
public AdGroup setAdGroupId(Long adGroupId)
```
    Output only. The unique ID of the ad group. Assigned by the system.
    
    Parameters:
    
    adGroupId - adGroupId or null for none
  - getAdGroupInventoryControl
```
public AdGroupInventoryControl getAdGroupInventoryControl()
```
    Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group.
    
    Returns:
    
    value or null for none
  - setAdGroupInventoryControl
```
public AdGroup setAdGroupInventoryControl(AdGroupInventoryControl adGroupInventoryControl)
```
    Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group.
    
    Parameters:
    
    adGroupInventoryControl - adGroupInventoryControl or null for none
  - getAdvertiserId
```
public Long getAdvertiserId()
```
    Output only. The unique ID of the advertiser the ad group belongs to.
    
    Returns:
    
    value or null for none
  - setAdvertiserId
```
public AdGroup setAdvertiserId(Long advertiserId)
```
    Output only. The unique ID of the advertiser the ad group belongs to.
    
    Parameters:
    
    advertiserId - advertiserId or null for none
  - getBidStrategy
```
public BiddingStrategy getBidStrategy()
```
    Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy.
    
    Returns:
    
    value or null for none
  - setBidStrategy
```
public AdGroup setBidStrategy(BiddingStrategy bidStrategy)
```
    Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy.
    
    Parameters:
    
    bidStrategy - bidStrategy or null for none
  - getDisplayName
```
public String getDisplayName()
```
    Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public AdGroup setDisplayName(String displayName)
```
    Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
    
    Parameters:
    
    displayName - displayName or null for none
  - getEntityStatus
```
public String getEntityStatus()
```
    Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
    
    Returns:
    
    value or null for none
  - setEntityStatus
```
public AdGroup setEntityStatus(String entityStatus)
```
    Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
    
    Parameters:
    
    entityStatus - entityStatus or null for none
  - getLineItemId
```
public Long getLineItemId()
```
    Required. Immutable. The unique ID of the line item that the ad group belongs to.
    
    Returns:
    
    value or null for none
  - setLineItemId
```
public AdGroup setLineItemId(Long lineItemId)
```
    Required. Immutable. The unique ID of the line item that the ad group belongs to.
    
    Parameters:
    
    lineItemId - lineItemId or null for none
  - getName
```
public String getName()
```
    Output only. Identifier. The resource name of the ad group.
    
    Returns:
    
    value or null for none
  - setName
```
public AdGroup setName(String name)
```
    Output only. Identifier. The resource name of the ad group.
    
    Parameters:
    
    name - name or null for none
  - getProductFeedData
```
public ProductFeedData getProductFeedData()
```
    Optional. The settings of the product feed in this ad group.
    
    Returns:
    
    value or null for none
  - setProductFeedData
```
public AdGroup setProductFeedData(ProductFeedData productFeedData)
```
    Optional. The settings of the product feed in this ad group.
    
    Parameters:
    
    productFeedData - productFeedData or null for none
  - getTargetingExpansion
```
public TargetingExpansionConfig getTargetingExpansion()
```
    Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
    
    Returns:
    
    value or null for none
  - setTargetingExpansion
```
public AdGroup setTargetingExpansion(TargetingExpansionConfig targetingExpansion)
```
    Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
    
    Parameters:
    
    targetingExpansion - targetingExpansion or null for none
  - set
```
public AdGroup set(String fieldName,
                   Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public AdGroup clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class AdGroup

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

AdGroup

Method Detail

getAdGroupFormat

setAdGroupFormat

getAdGroupId

setAdGroupId

getAdGroupInventoryControl

setAdGroupInventoryControl

getAdvertiserId

setAdvertiserId

getBidStrategy

setBidStrategy

getDisplayName

setDisplayName

getEntityStatus

setEntityStatus

getLineItemId

setLineItemId

getName

setName

getProductFeedData

setProductFeedData

getTargetingExpansion

setTargetingExpansion

set

clone