com.google.api.services.displayvideo.v2.model

Class YoutubeAdGroup

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.v2.model.YoutubeAdGroup

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class YoutubeAdGroup
extends com.google.api.client.json.GenericJson

A single YouTube ad group associated with a YouTube and Partners 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
YoutubeAdGroup()

Method Summary

Modifier and Type	Method and Description
YoutubeAdGroup	clone()
String	getAdGroupFormat() The format of the ads in the ad group.
Long	getAdGroupId() The unique ID of the ad group.
Long	getAdvertiserId() The unique ID of the advertiser the ad group belongs to.
YoutubeAndPartnersBiddingStrategy	getBiddingStrategy() The bidding strategy used by the ad group.
String	getDisplayName() The display name of the ad group.
String	getEntityStatus() Controls whether or not the ad group can spend its budget and bid on inventory.
Long	getLineItemId() The unique ID of the line item that the ad group belongs to.
String	getName() The resource name of the ad group.
ProductFeedData	getProductFeedData() The settings of the product feed in this ad group.
TargetingExpansionConfig	getTargetingExpansion() The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the ad group.
List<Long>	getYoutubeAdIds() The IDs of the youtube_ad_group_ad resources associated with the ad group.
YoutubeAdGroup	set(String fieldName, Object value)
YoutubeAdGroup	setAdGroupFormat(String adGroupFormat) The format of the ads in the ad group.
YoutubeAdGroup	setAdGroupId(Long adGroupId) The unique ID of the ad group.
YoutubeAdGroup	setAdvertiserId(Long advertiserId) The unique ID of the advertiser the ad group belongs to.
YoutubeAdGroup	setBiddingStrategy(YoutubeAndPartnersBiddingStrategy biddingStrategy) The bidding strategy used by the ad group.
YoutubeAdGroup	setDisplayName(String displayName) The display name of the ad group.
YoutubeAdGroup	setEntityStatus(String entityStatus) Controls whether or not the ad group can spend its budget and bid on inventory.
YoutubeAdGroup	setLineItemId(Long lineItemId) The unique ID of the line item that the ad group belongs to.
YoutubeAdGroup	setName(String name) The resource name of the ad group.
YoutubeAdGroup	setProductFeedData(ProductFeedData productFeedData) The settings of the product feed in this ad group.
YoutubeAdGroup	setTargetingExpansion(TargetingExpansionConfig targetingExpansion) The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the ad group.
YoutubeAdGroup	setYoutubeAdIds(List<Long> youtubeAdIds) The IDs of the youtube_ad_group_ad resources associated with the ad group.

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

YoutubeAdGroup

public YoutubeAdGroup()

Method Detail

getAdGroupFormat

public String getAdGroupFormat()

The format of the ads in the ad group.

Returns:

value or null for none

setAdGroupFormat

public YoutubeAdGroup setAdGroupFormat(String adGroupFormat)

The format of the ads in the ad group.

Parameters:

adGroupFormat - adGroupFormat or null for none

getAdGroupId

public Long getAdGroupId()

The unique ID of the ad group. Assigned by the system.

Returns:

value or null for none

setAdGroupId

public YoutubeAdGroup setAdGroupId(Long adGroupId)

The unique ID of the ad group. Assigned by the system.

Parameters:

adGroupId - adGroupId or null for none

getAdvertiserId

public Long getAdvertiserId()

The unique ID of the advertiser the ad group belongs to.

Returns:

value or null for none

setAdvertiserId

public YoutubeAdGroup setAdvertiserId(Long advertiserId)

The unique ID of the advertiser the ad group belongs to.

Parameters:

advertiserId - advertiserId or null for none

getBiddingStrategy

public YoutubeAndPartnersBiddingStrategy getBiddingStrategy()

The bidding strategy used by the ad group.

Returns:

value or null for none

setBiddingStrategy

public YoutubeAdGroup setBiddingStrategy(YoutubeAndPartnersBiddingStrategy biddingStrategy)

The bidding strategy used by the ad group.

Parameters:

biddingStrategy - biddingStrategy or null for none

getDisplayName

public String getDisplayName()

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 YoutubeAdGroup setDisplayName(String displayName)

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()

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 YoutubeAdGroup setEntityStatus(String entityStatus)

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()

The unique ID of the line item that the ad group belongs to.

Returns:

value or null for none

setLineItemId

public YoutubeAdGroup setLineItemId(Long lineItemId)

The unique ID of the line item that the ad group belongs to.

Parameters:

lineItemId - lineItemId or null for none

getName

public String getName()

The resource name of the ad group.

Returns:

value or null for none

setName

public YoutubeAdGroup setName(String name)

The resource name of the ad group.

Parameters:

name - name or null for none

getProductFeedData

public ProductFeedData getProductFeedData()

The settings of the product feed in this ad group.

Returns:

value or null for none

setProductFeedData

public YoutubeAdGroup setProductFeedData(ProductFeedData productFeedData)

The settings of the product feed in this ad group.

Parameters:

productFeedData - productFeedData or null for none

getTargetingExpansion

public TargetingExpansionConfig getTargetingExpansion()

The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the ad group. This config is only applicable when eligible audience list targeting is assigned to the ad group.

Returns:

value or null for none

setTargetingExpansion

public YoutubeAdGroup setTargetingExpansion(TargetingExpansionConfig targetingExpansion)

The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the ad group. This config is only applicable when eligible audience list targeting is assigned to the ad group.

Parameters:

targetingExpansion - targetingExpansion or null for none

getYoutubeAdIds

public List<Long> getYoutubeAdIds()

The IDs of the youtube_ad_group_ad resources associated with the ad group.

Returns:

value or null for none

setYoutubeAdIds

public YoutubeAdGroup setYoutubeAdIds(List<Long> youtubeAdIds)

The IDs of the youtube_ad_group_ad resources associated with the ad group.

Parameters:

youtubeAdIds - youtubeAdIds or null for none

set

public YoutubeAdGroup set(String fieldName,
                          Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public YoutubeAdGroup clone()

Overrides:

clone in class com.google.api.client.json.GenericJson