Interface AdUnitOrBuilder (0.11.0)

public interface AdUnitOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdUnitCode()

public abstract String getAdUnitCode()

Immutable. A string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is optional and can be set during ad unit creation. If it is not provided, it will be assigned by Google based on the ad unit ID.

string ad_unit_code = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The adUnitCode.

getAdUnitCodeBytes()

public abstract ByteString getAdUnitCodeBytes()

Immutable. A string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is optional and can be set during ad unit creation. If it is not provided, it will be assigned by Google based on the ad unit ID.

string ad_unit_code = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for adUnitCode.

getAdUnitId()

public abstract long getAdUnitId()

Output only. AdUnit ID.

int64 ad_unit_id = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The adUnitId.

getAdUnitSizes(int index)

public abstract AdUnitSize getAdUnitSizes(int index)

Optional. The sizes that can be served inside this ad unit.

repeated .google.ads.admanager.v1.AdUnitSize ad_unit_sizes = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AdUnitSize

getAdUnitSizesCount()

public abstract int getAdUnitSizesCount()

Optional. The sizes that can be served inside this ad unit.

repeated .google.ads.admanager.v1.AdUnitSize ad_unit_sizes = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAdUnitSizesList()

public abstract List<AdUnitSize> getAdUnitSizesList()

Optional. The sizes that can be served inside this ad unit.

repeated .google.ads.admanager.v1.AdUnitSize ad_unit_sizes = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<AdUnitSize>

getAdUnitSizesOrBuilder(int index)

public abstract AdUnitSizeOrBuilder getAdUnitSizesOrBuilder(int index)

Optional. The sizes that can be served inside this ad unit.

repeated .google.ads.admanager.v1.AdUnitSize ad_unit_sizes = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AdUnitSizeOrBuilder

getAdUnitSizesOrBuilderList()

public abstract List<? extends AdUnitSizeOrBuilder> getAdUnitSizesOrBuilderList()

Optional. The sizes that can be served inside this ad unit.

repeated .google.ads.admanager.v1.AdUnitSize ad_unit_sizes = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.AdUnitSizeOrBuilder>

getAppliedAdsenseEnabled()

public abstract boolean getAppliedAdsenseEnabled()

Optional. The value of AdSense enabled directly applied to this ad unit. This attribute is optional and if not specified this ad unit will inherit the value of effectiveAdsenseEnabled from its ancestors.

optional bool applied_adsense_enabled = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The appliedAdsenseEnabled.

getAppliedLabelFrequencyCaps(int index)

public abstract LabelFrequencyCap getAppliedLabelFrequencyCaps(int index)

Optional. The set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit.

repeated .google.ads.admanager.v1.LabelFrequencyCap applied_label_frequency_caps = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
LabelFrequencyCap

getAppliedLabelFrequencyCapsCount()

public abstract int getAppliedLabelFrequencyCapsCount()

Optional. The set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit.

repeated .google.ads.admanager.v1.LabelFrequencyCap applied_label_frequency_caps = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAppliedLabelFrequencyCapsList()

public abstract List<LabelFrequencyCap> getAppliedLabelFrequencyCapsList()

Optional. The set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit.

repeated .google.ads.admanager.v1.LabelFrequencyCap applied_label_frequency_caps = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<LabelFrequencyCap>

getAppliedLabelFrequencyCapsOrBuilder(int index)

public abstract LabelFrequencyCapOrBuilder getAppliedLabelFrequencyCapsOrBuilder(int index)

Optional. The set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit.

repeated .google.ads.admanager.v1.LabelFrequencyCap applied_label_frequency_caps = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
LabelFrequencyCapOrBuilder

getAppliedLabelFrequencyCapsOrBuilderList()

public abstract List<? extends LabelFrequencyCapOrBuilder> getAppliedLabelFrequencyCapsOrBuilderList()

Optional. The set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit.

repeated .google.ads.admanager.v1.LabelFrequencyCap applied_label_frequency_caps = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.LabelFrequencyCapOrBuilder>

getAppliedLabels(int index)

public abstract AppliedLabel getAppliedLabels(int index)

Optional. The set of labels applied directly to this ad unit.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel

getAppliedLabelsCount()

public abstract int getAppliedLabelsCount()

Optional. The set of labels applied directly to this ad unit.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAppliedLabelsList()

public abstract List<AppliedLabel> getAppliedLabelsList()

Optional. The set of labels applied directly to this ad unit.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<AppliedLabel>

getAppliedLabelsOrBuilder(int index)

public abstract AppliedLabelOrBuilder getAppliedLabelsOrBuilder(int index)

Optional. The set of labels applied directly to this ad unit.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabelOrBuilder

getAppliedLabelsOrBuilderList()

public abstract List<? extends AppliedLabelOrBuilder> getAppliedLabelsOrBuilderList()

Optional. The set of labels applied directly to this ad unit.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.AppliedLabelOrBuilder>

getAppliedTargetWindow()

public abstract TargetWindowEnum.TargetWindow getAppliedTargetWindow()

Optional. The target window directly applied to this AdUnit. If this field is not set, this AdUnit uses the target window specified in effectiveTargetWindow.

.google.ads.admanager.v1.TargetWindowEnum.TargetWindow applied_target_window = 44 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TargetWindowEnum.TargetWindow

The appliedTargetWindow.

getAppliedTargetWindowValue()

public abstract int getAppliedTargetWindowValue()

Optional. The target window directly applied to this AdUnit. If this field is not set, this AdUnit uses the target window specified in effectiveTargetWindow.

.google.ads.admanager.v1.TargetWindowEnum.TargetWindow applied_target_window = 44 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for appliedTargetWindow.

getAppliedTeams(int index)

public abstract String getAppliedTeams(int index)

Optional. The resource names of Teams directly applied to this AdUnit. Format: "networks/{network_code}/teams/{team_id}"

repeated string applied_teams = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The appliedTeams at the given index.

getAppliedTeamsBytes(int index)

public abstract ByteString getAppliedTeamsBytes(int index)

Optional. The resource names of Teams directly applied to this AdUnit. Format: "networks/{network_code}/teams/{team_id}"

repeated string applied_teams = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the appliedTeams at the given index.

getAppliedTeamsCount()

public abstract int getAppliedTeamsCount()

Optional. The resource names of Teams directly applied to this AdUnit. Format: "networks/{network_code}/teams/{team_id}"

repeated string applied_teams = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of appliedTeams.

getAppliedTeamsList()

public abstract List<String> getAppliedTeamsList()

Optional. The resource names of Teams directly applied to this AdUnit. Format: "networks/{network_code}/teams/{team_id}"

repeated string applied_teams = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
List<String>

A list containing the appliedTeams.

getDescription()

public abstract String getDescription()

Optional. A description of the ad unit. The maximum length is 65,535 characters.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. A description of the ad unit. The maximum length is 65,535 characters.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Required. The display name of the ad unit. Its maximum length is 255 characters.

string display_name = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The display name of the ad unit. Its maximum length is 255 characters.

string display_name = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getEffectiveAdsenseEnabled()

public abstract boolean getEffectiveAdsenseEnabled()

Output only. Specifies whether or not the AdUnit is enabled for serving ads from the AdSense content network. This attribute defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set appliedAdsenseEnabled, the attribute is defaulted to true.

bool effective_adsense_enabled = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The effectiveAdsenseEnabled.

getEffectiveAppliedLabels(int index)

public abstract AppliedLabel getEffectiveAppliedLabels(int index)

Output only. Contains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel

getEffectiveAppliedLabelsCount()

public abstract int getEffectiveAppliedLabelsCount()

Output only. Contains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getEffectiveAppliedLabelsList()

public abstract List<AppliedLabel> getEffectiveAppliedLabelsList()

Output only. Contains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<AppliedLabel>

getEffectiveAppliedLabelsOrBuilder(int index)

public abstract AppliedLabelOrBuilder getEffectiveAppliedLabelsOrBuilder(int index)

Output only. Contains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabelOrBuilder

getEffectiveAppliedLabelsOrBuilderList()

public abstract List<? extends AppliedLabelOrBuilder> getEffectiveAppliedLabelsOrBuilderList()

Output only. Contains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.AppliedLabelOrBuilder>

getEffectiveLabelFrequencyCaps(int index)

public abstract LabelFrequencyCap getEffectiveLabelFrequencyCaps(int index)

Output only. The label frequency caps applied directly to the ad unit as well as those inherited from parent ad units.

repeated .google.ads.admanager.v1.LabelFrequencyCap effective_label_frequency_caps = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
LabelFrequencyCap

getEffectiveLabelFrequencyCapsCount()

public abstract int getEffectiveLabelFrequencyCapsCount()

Output only. The label frequency caps applied directly to the ad unit as well as those inherited from parent ad units.

repeated .google.ads.admanager.v1.LabelFrequencyCap effective_label_frequency_caps = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getEffectiveLabelFrequencyCapsList()

public abstract List<LabelFrequencyCap> getEffectiveLabelFrequencyCapsList()

Output only. The label frequency caps applied directly to the ad unit as well as those inherited from parent ad units.

repeated .google.ads.admanager.v1.LabelFrequencyCap effective_label_frequency_caps = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<LabelFrequencyCap>

getEffectiveLabelFrequencyCapsOrBuilder(int index)

public abstract LabelFrequencyCapOrBuilder getEffectiveLabelFrequencyCapsOrBuilder(int index)

Output only. The label frequency caps applied directly to the ad unit as well as those inherited from parent ad units.

repeated .google.ads.admanager.v1.LabelFrequencyCap effective_label_frequency_caps = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
LabelFrequencyCapOrBuilder

getEffectiveLabelFrequencyCapsOrBuilderList()

public abstract List<? extends LabelFrequencyCapOrBuilder> getEffectiveLabelFrequencyCapsOrBuilderList()

Output only. The label frequency caps applied directly to the ad unit as well as those inherited from parent ad units.

repeated .google.ads.admanager.v1.LabelFrequencyCap effective_label_frequency_caps = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.LabelFrequencyCapOrBuilder>

getEffectiveTargetWindow()

public abstract TargetWindowEnum.TargetWindow getEffectiveTargetWindow()

Output only. Non-empty default. The target window of this AdUnit. This value is inherited from ancestor AdUnits and defaults to TOP if no AdUnit in the hierarchy specifies it.

.google.ads.admanager.v1.TargetWindowEnum.TargetWindow effective_target_window = 45 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TargetWindowEnum.TargetWindow

The effectiveTargetWindow.

getEffectiveTargetWindowValue()

public abstract int getEffectiveTargetWindowValue()

Output only. Non-empty default. The target window of this AdUnit. This value is inherited from ancestor AdUnits and defaults to TOP if no AdUnit in the hierarchy specifies it.

.google.ads.admanager.v1.TargetWindowEnum.TargetWindow effective_target_window = 45 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for effectiveTargetWindow.

getExplicitlyTargeted()

public abstract boolean getExplicitlyTargeted()

Optional. If this field is set to true, then the AdUnit will not be implicitly targeted when its parent is. Traffickers must explicitly target such an AdUnit or else no line items will serve to it. This feature is only available for Ad Manager 360 accounts.

bool explicitly_targeted = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The explicitlyTargeted.

getExternalSetTopBoxChannelId()

public abstract String getExternalSetTopBoxChannelId()

Optional. Determines what set top box video on demand channel this ad unit corresponds to in an external set top box ad campaign system.

string external_set_top_box_channel_id = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The externalSetTopBoxChannelId.

getExternalSetTopBoxChannelIdBytes()

public abstract ByteString getExternalSetTopBoxChannelIdBytes()

Optional. Determines what set top box video on demand channel this ad unit corresponds to in an external set top box ad campaign system.

string external_set_top_box_channel_id = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for externalSetTopBoxChannelId.

getHasChildren()

public abstract boolean getHasChildren()

Output only. This field is set to true if the ad unit has any children.

bool has_children = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The hasChildren.

getName()

public abstract String getName()

Identifier. The resource name of the AdUnit. Format: networks/{network_code}/adUnits/{ad_unit_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The resource name of the AdUnit. Format: networks/{network_code}/adUnits/{ad_unit_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParentAdUnit()

public abstract String getParentAdUnit()

Required. Immutable. The AdUnit's parent. Every ad unit has a parent except for the root ad unit, which is created by Google. Format: "networks/{network_code}/adUnits/{ad_unit_id}"

string parent_ad_unit = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parentAdUnit.

getParentAdUnitBytes()

public abstract ByteString getParentAdUnitBytes()

Required. Immutable. The AdUnit's parent. Every ad unit has a parent except for the root ad unit, which is created by Google. Format: "networks/{network_code}/adUnits/{ad_unit_id}"

string parent_ad_unit = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parentAdUnit.

getParentPath(int index)

public abstract AdUnitParent getParentPath(int index)

Output only. The path to this AdUnit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty.

repeated .google.ads.admanager.v1.AdUnitParent parent_path = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AdUnitParent

getParentPathCount()

public abstract int getParentPathCount()

Output only. The path to this AdUnit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty.

repeated .google.ads.admanager.v1.AdUnitParent parent_path = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getParentPathList()

public abstract List<AdUnitParent> getParentPathList()

Output only. The path to this AdUnit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty.

repeated .google.ads.admanager.v1.AdUnitParent parent_path = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<AdUnitParent>

getParentPathOrBuilder(int index)

public abstract AdUnitParentOrBuilder getParentPathOrBuilder(int index)

Output only. The path to this AdUnit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty.

repeated .google.ads.admanager.v1.AdUnitParent parent_path = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AdUnitParentOrBuilder

getParentPathOrBuilderList()

public abstract List<? extends AdUnitParentOrBuilder> getParentPathOrBuilderList()

Output only. The path to this AdUnit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty.

repeated .google.ads.admanager.v1.AdUnitParent parent_path = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.AdUnitParentOrBuilder>

getRefreshDelay()

public abstract Duration getRefreshDelay()

Optional. The duration after which an Ad Unit will automatically refresh. This is only valid for ad units in mobile apps. If not set, the ad unit will not refresh.

.google.protobuf.Duration refresh_delay = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The refreshDelay.

getRefreshDelayOrBuilder()

public abstract DurationOrBuilder getRefreshDelayOrBuilder()

Optional. The duration after which an Ad Unit will automatically refresh. This is only valid for ad units in mobile apps. If not set, the ad unit will not refresh.

.google.protobuf.Duration refresh_delay = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getSmartSizeMode()

public abstract SmartSizeModeEnum.SmartSizeMode getSmartSizeMode()

Optional. The smart size mode for this ad unit. This attribute is optional and defaults to SmartSizeMode.NONE for fixed sizes.

.google.ads.admanager.v1.SmartSizeModeEnum.SmartSizeMode smart_size_mode = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SmartSizeModeEnum.SmartSizeMode

The smartSizeMode.

getSmartSizeModeValue()

public abstract int getSmartSizeModeValue()

Optional. The smart size mode for this ad unit. This attribute is optional and defaults to SmartSizeMode.NONE for fixed sizes.

.google.ads.admanager.v1.SmartSizeModeEnum.SmartSizeMode smart_size_mode = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for smartSizeMode.

getStatus()

public abstract AdUnitStatusEnum.AdUnitStatus getStatus()

Output only. The status of this ad unit. It defaults to ACTIVE.

.google.ads.admanager.v1.AdUnitStatusEnum.AdUnitStatus status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AdUnitStatusEnum.AdUnitStatus

The status.

getStatusValue()

public abstract int getStatusValue()

Output only. The status of this ad unit. It defaults to ACTIVE.

.google.ads.admanager.v1.AdUnitStatusEnum.AdUnitStatus status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

getTeams(int index)

public abstract String getTeams(int index)

Output only. The resource names of all Teams that this AdUnit is on as well as those inherited from parent AdUnits. Format: "networks/{network_code}/teams/{team_id}"

repeated string teams = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The teams at the given index.

getTeamsBytes(int index)

public abstract ByteString getTeamsBytes(int index)

Output only. The resource names of all Teams that this AdUnit is on as well as those inherited from parent AdUnits. Format: "networks/{network_code}/teams/{team_id}"

repeated string teams = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the teams at the given index.

getTeamsCount()

public abstract int getTeamsCount()

Output only. The resource names of all Teams that this AdUnit is on as well as those inherited from parent AdUnits. Format: "networks/{network_code}/teams/{team_id}"

repeated string teams = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of teams.

getTeamsList()

public abstract List<String> getTeamsList()

Output only. The resource names of all Teams that this AdUnit is on as well as those inherited from parent AdUnits. Format: "networks/{network_code}/teams/{team_id}"

repeated string teams = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
List<String>

A list containing the teams.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The time this AdUnit was last modified.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time this AdUnit was last modified.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasAppliedAdsenseEnabled()

public abstract boolean hasAppliedAdsenseEnabled()

Optional. The value of AdSense enabled directly applied to this ad unit. This attribute is optional and if not specified this ad unit will inherit the value of effectiveAdsenseEnabled from its ancestors.

optional bool applied_adsense_enabled = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the appliedAdsenseEnabled field is set.

hasRefreshDelay()

public abstract boolean hasRefreshDelay()

Optional. The duration after which an Ad Unit will automatically refresh. This is only valid for ad units in mobile apps. If not set, the ad unit will not refresh.

.google.protobuf.Duration refresh_delay = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the refreshDelay field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The time this AdUnit was last modified.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.