Class AdUnit.Builder (0.4.0)

public static final class AdUnit.Builder extends GeneratedMessageV3.Builder<AdUnit.Builder> implements AdUnitOrBuilder

The AdUnit resource.

Protobuf type google.ads.admanager.v1.AdUnit

Implements

AdUnitOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAdUnitSizes(AdUnitSize value)

public AdUnit.Builder addAdUnitSizes(AdUnitSize value)

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
value AdUnitSize
Returns
Type Description
AdUnit.Builder

addAdUnitSizes(AdUnitSize.Builder builderForValue)

public AdUnit.Builder addAdUnitSizes(AdUnitSize.Builder builderForValue)

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
builderForValue AdUnitSize.Builder
Returns
Type Description
AdUnit.Builder

addAdUnitSizes(int index, AdUnitSize value)

public AdUnit.Builder addAdUnitSizes(int index, AdUnitSize value)

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];

Parameters
Name Description
index int
value AdUnitSize
Returns
Type Description
AdUnit.Builder

addAdUnitSizes(int index, AdUnitSize.Builder builderForValue)

public AdUnit.Builder addAdUnitSizes(int index, AdUnitSize.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue AdUnitSize.Builder
Returns
Type Description
AdUnit.Builder

addAdUnitSizesBuilder()

public AdUnitSize.Builder addAdUnitSizesBuilder()

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
AdUnitSize.Builder

addAdUnitSizesBuilder(int index)

public AdUnitSize.Builder addAdUnitSizesBuilder(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.Builder

addAllAdUnitSizes(Iterable<? extends AdUnitSize> values)

public AdUnit.Builder addAllAdUnitSizes(Iterable<? extends AdUnitSize> values)

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
values Iterable<? extends com.google.ads.admanager.v1.AdUnitSize>
Returns
Type Description
AdUnit.Builder

addAllAppliedLabelFrequencyCaps(Iterable<? extends LabelFrequencyCap> values)

public AdUnit.Builder addAllAppliedLabelFrequencyCaps(Iterable<? extends LabelFrequencyCap> values)

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
values Iterable<? extends com.google.ads.admanager.v1.LabelFrequencyCap>
Returns
Type Description
AdUnit.Builder

addAllAppliedLabels(Iterable<? extends AppliedLabel> values)

public AdUnit.Builder addAllAppliedLabels(Iterable<? extends AppliedLabel> values)

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
values Iterable<? extends com.google.ads.admanager.v1.AppliedLabel>
Returns
Type Description
AdUnit.Builder

addAllAppliedTeams(Iterable<String> values)

public AdUnit.Builder addAllAppliedTeams(Iterable<String> values)

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
values Iterable<String>

The appliedTeams to add.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

addAllEffectiveAppliedLabels(Iterable<? extends AppliedLabel> values)

public AdUnit.Builder addAllEffectiveAppliedLabels(Iterable<? extends AppliedLabel> values)

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
values Iterable<? extends com.google.ads.admanager.v1.AppliedLabel>
Returns
Type Description
AdUnit.Builder

addAllEffectiveLabelFrequencyCaps(Iterable<? extends LabelFrequencyCap> values)

public AdUnit.Builder addAllEffectiveLabelFrequencyCaps(Iterable<? extends LabelFrequencyCap> values)

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
values Iterable<? extends com.google.ads.admanager.v1.LabelFrequencyCap>
Returns
Type Description
AdUnit.Builder

addAllParentPath(Iterable<? extends AdUnitParent> values)

public AdUnit.Builder addAllParentPath(Iterable<? extends AdUnitParent> values)

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
values Iterable<? extends com.google.ads.admanager.v1.AdUnitParent>
Returns
Type Description
AdUnit.Builder

addAllTeams(Iterable<String> values)

public AdUnit.Builder addAllTeams(Iterable<String> values)

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
values Iterable<String>

The teams to add.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

addAppliedLabelFrequencyCaps(LabelFrequencyCap value)

public AdUnit.Builder addAppliedLabelFrequencyCaps(LabelFrequencyCap value)

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
value LabelFrequencyCap
Returns
Type Description
AdUnit.Builder

addAppliedLabelFrequencyCaps(LabelFrequencyCap.Builder builderForValue)

public AdUnit.Builder addAppliedLabelFrequencyCaps(LabelFrequencyCap.Builder builderForValue)

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
builderForValue LabelFrequencyCap.Builder
Returns
Type Description
AdUnit.Builder

addAppliedLabelFrequencyCaps(int index, LabelFrequencyCap value)

public AdUnit.Builder addAppliedLabelFrequencyCaps(int index, LabelFrequencyCap value)

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];

Parameters
Name Description
index int
value LabelFrequencyCap
Returns
Type Description
AdUnit.Builder

addAppliedLabelFrequencyCaps(int index, LabelFrequencyCap.Builder builderForValue)

public AdUnit.Builder addAppliedLabelFrequencyCaps(int index, LabelFrequencyCap.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue LabelFrequencyCap.Builder
Returns
Type Description
AdUnit.Builder

addAppliedLabelFrequencyCapsBuilder()

public LabelFrequencyCap.Builder addAppliedLabelFrequencyCapsBuilder()

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
LabelFrequencyCap.Builder

addAppliedLabelFrequencyCapsBuilder(int index)

public LabelFrequencyCap.Builder addAppliedLabelFrequencyCapsBuilder(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.Builder

addAppliedLabels(AppliedLabel value)

public AdUnit.Builder addAppliedLabels(AppliedLabel value)

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
value AppliedLabel
Returns
Type Description
AdUnit.Builder

addAppliedLabels(AppliedLabel.Builder builderForValue)

public AdUnit.Builder addAppliedLabels(AppliedLabel.Builder builderForValue)

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
builderForValue AppliedLabel.Builder
Returns
Type Description
AdUnit.Builder

addAppliedLabels(int index, AppliedLabel value)

public AdUnit.Builder addAppliedLabels(int index, AppliedLabel value)

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];

Parameters
Name Description
index int
value AppliedLabel
Returns
Type Description
AdUnit.Builder

addAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public AdUnit.Builder addAppliedLabels(int index, AppliedLabel.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
AdUnit.Builder

addAppliedLabelsBuilder()

public AppliedLabel.Builder addAppliedLabelsBuilder()

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
AppliedLabel.Builder

addAppliedLabelsBuilder(int index)

public AppliedLabel.Builder addAppliedLabelsBuilder(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.Builder

addAppliedTeams(String value)

public AdUnit.Builder addAppliedTeams(String value)

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
value String

The appliedTeams to add.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

addAppliedTeamsBytes(ByteString value)

public AdUnit.Builder addAppliedTeamsBytes(ByteString value)

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
value ByteString

The bytes of the appliedTeams to add.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

addEffectiveAppliedLabels(AppliedLabel value)

public AdUnit.Builder addEffectiveAppliedLabels(AppliedLabel value)

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
value AppliedLabel
Returns
Type Description
AdUnit.Builder

addEffectiveAppliedLabels(AppliedLabel.Builder builderForValue)

public AdUnit.Builder addEffectiveAppliedLabels(AppliedLabel.Builder builderForValue)

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
builderForValue AppliedLabel.Builder
Returns
Type Description
AdUnit.Builder

addEffectiveAppliedLabels(int index, AppliedLabel value)

public AdUnit.Builder addEffectiveAppliedLabels(int index, AppliedLabel value)

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];

Parameters
Name Description
index int
value AppliedLabel
Returns
Type Description
AdUnit.Builder

addEffectiveAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public AdUnit.Builder addEffectiveAppliedLabels(int index, AppliedLabel.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
AdUnit.Builder

addEffectiveAppliedLabelsBuilder()

public AppliedLabel.Builder addEffectiveAppliedLabelsBuilder()

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
AppliedLabel.Builder

addEffectiveAppliedLabelsBuilder(int index)

public AppliedLabel.Builder addEffectiveAppliedLabelsBuilder(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.Builder

addEffectiveLabelFrequencyCaps(LabelFrequencyCap value)

public AdUnit.Builder addEffectiveLabelFrequencyCaps(LabelFrequencyCap value)

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
value LabelFrequencyCap
Returns
Type Description
AdUnit.Builder

addEffectiveLabelFrequencyCaps(LabelFrequencyCap.Builder builderForValue)

public AdUnit.Builder addEffectiveLabelFrequencyCaps(LabelFrequencyCap.Builder builderForValue)

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
builderForValue LabelFrequencyCap.Builder
Returns
Type Description
AdUnit.Builder

addEffectiveLabelFrequencyCaps(int index, LabelFrequencyCap value)

public AdUnit.Builder addEffectiveLabelFrequencyCaps(int index, LabelFrequencyCap value)

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];

Parameters
Name Description
index int
value LabelFrequencyCap
Returns
Type Description
AdUnit.Builder

addEffectiveLabelFrequencyCaps(int index, LabelFrequencyCap.Builder builderForValue)

public AdUnit.Builder addEffectiveLabelFrequencyCaps(int index, LabelFrequencyCap.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue LabelFrequencyCap.Builder
Returns
Type Description
AdUnit.Builder

addEffectiveLabelFrequencyCapsBuilder()

public LabelFrequencyCap.Builder addEffectiveLabelFrequencyCapsBuilder()

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
LabelFrequencyCap.Builder

addEffectiveLabelFrequencyCapsBuilder(int index)

public LabelFrequencyCap.Builder addEffectiveLabelFrequencyCapsBuilder(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.Builder

addParentPath(AdUnitParent value)

public AdUnit.Builder addParentPath(AdUnitParent value)

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
value AdUnitParent
Returns
Type Description
AdUnit.Builder

addParentPath(AdUnitParent.Builder builderForValue)

public AdUnit.Builder addParentPath(AdUnitParent.Builder builderForValue)

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
builderForValue AdUnitParent.Builder
Returns
Type Description
AdUnit.Builder

addParentPath(int index, AdUnitParent value)

public AdUnit.Builder addParentPath(int index, AdUnitParent value)

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];

Parameters
Name Description
index int
value AdUnitParent
Returns
Type Description
AdUnit.Builder

addParentPath(int index, AdUnitParent.Builder builderForValue)

public AdUnit.Builder addParentPath(int index, AdUnitParent.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue AdUnitParent.Builder
Returns
Type Description
AdUnit.Builder

addParentPathBuilder()

public AdUnitParent.Builder addParentPathBuilder()

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
AdUnitParent.Builder

addParentPathBuilder(int index)

public AdUnitParent.Builder addParentPathBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AdUnit.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AdUnit.Builder
Overrides

addTeams(String value)

public AdUnit.Builder addTeams(String value)

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
value String

The teams to add.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

addTeamsBytes(ByteString value)

public AdUnit.Builder addTeamsBytes(ByteString value)

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
value ByteString

The bytes of the teams to add.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

build()

public AdUnit build()
Returns
Type Description
AdUnit

buildPartial()

public AdUnit buildPartial()
Returns
Type Description
AdUnit

clear()

public AdUnit.Builder clear()
Returns
Type Description
AdUnit.Builder
Overrides

clearAdUnitCode()

public AdUnit.Builder clearAdUnitCode()

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 off of the ad unit ID.

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

Returns
Type Description
AdUnit.Builder

This builder for chaining.

clearAdUnitId()

public AdUnit.Builder clearAdUnitId()

Output only. AdUnit ID.

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

Returns
Type Description
AdUnit.Builder

This builder for chaining.

clearAdUnitSizes()

public AdUnit.Builder clearAdUnitSizes()

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
AdUnit.Builder

clearAppliedAdsenseEnabled()

public AdUnit.Builder clearAppliedAdsenseEnabled()

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.

.google.ads.admanager.v1.AppliedAdsenseEnabledEnum.AppliedAdsenseEnabled applied_adsense_enabled = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AdUnit.Builder

This builder for chaining.

clearAppliedLabelFrequencyCaps()

public AdUnit.Builder clearAppliedLabelFrequencyCaps()

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
AdUnit.Builder

clearAppliedLabels()

public AdUnit.Builder clearAppliedLabels()

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
AdUnit.Builder

clearAppliedTeams()

public AdUnit.Builder clearAppliedTeams()

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
AdUnit.Builder

This builder for chaining.

clearCtvApplicationId()

public AdUnit.Builder clearCtvApplicationId()

Optional. The ID of the CTV application that this ad unit is within.

int64 ctv_application_id = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AdUnit.Builder

This builder for chaining.

clearDescription()

public AdUnit.Builder clearDescription()

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
AdUnit.Builder

This builder for chaining.

clearDisplayName()

public AdUnit.Builder clearDisplayName()

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
AdUnit.Builder

This builder for chaining.

clearEffectiveAdsenseEnabled()

public AdUnit.Builder clearEffectiveAdsenseEnabled()

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
AdUnit.Builder

This builder for chaining.

clearEffectiveAppliedLabels()

public AdUnit.Builder clearEffectiveAppliedLabels()

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
AdUnit.Builder

clearEffectiveLabelFrequencyCaps()

public AdUnit.Builder clearEffectiveLabelFrequencyCaps()

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
AdUnit.Builder

clearExplicitlyTargeted()

public AdUnit.Builder clearExplicitlyTargeted()

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
AdUnit.Builder

This builder for chaining.

clearExternalSetTopBoxChannelId()

public AdUnit.Builder clearExternalSetTopBoxChannelId()

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
AdUnit.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AdUnit.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AdUnit.Builder
Overrides

clearHasChildren()

public AdUnit.Builder clearHasChildren()

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
AdUnit.Builder

This builder for chaining.

clearName()

public AdUnit.Builder clearName()

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
AdUnit.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AdUnit.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AdUnit.Builder
Overrides

clearParentAdUnit()

public AdUnit.Builder clearParentAdUnit()

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
AdUnit.Builder

This builder for chaining.

clearParentPath()

public AdUnit.Builder clearParentPath()

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
AdUnit.Builder

clearRefreshDelay()

public AdUnit.Builder clearRefreshDelay()

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
AdUnit.Builder

clearSmartSizeMode()

public AdUnit.Builder clearSmartSizeMode()

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
AdUnit.Builder

This builder for chaining.

clearStatus()

public AdUnit.Builder clearStatus()

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

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

Returns
Type Description
AdUnit.Builder

This builder for chaining.

clearTargetWindow()

public AdUnit.Builder clearTargetWindow()

Non-empty default. The value to use for the HTML link's target attribute. This value will be interpreted as TOP if left blank.

.google.ads.admanager.v1.TargetWindowEnum.TargetWindow target_window = 12 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
AdUnit.Builder

This builder for chaining.

clearTeams()

public AdUnit.Builder clearTeams()

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
AdUnit.Builder

This builder for chaining.

clearUpdateTime()

public AdUnit.Builder clearUpdateTime()

Output only. The instant this AdUnit was last modified.

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

Returns
Type Description
AdUnit.Builder

clone()

public AdUnit.Builder clone()
Returns
Type Description
AdUnit.Builder
Overrides

getAdUnitCode()

public 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 off of the ad unit ID.

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

Returns
Type Description
String

The adUnitCode.

getAdUnitCodeBytes()

public 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 off of the ad unit ID.

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

Returns
Type Description
ByteString

The bytes for adUnitCode.

getAdUnitId()

public 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 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

getAdUnitSizesBuilder(int index)

public AdUnitSize.Builder getAdUnitSizesBuilder(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.Builder

getAdUnitSizesBuilderList()

public List<AdUnitSize.Builder> getAdUnitSizesBuilderList()

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<Builder>

getAdUnitSizesCount()

public 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 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 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 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 AppliedAdsenseEnabledEnum.AppliedAdsenseEnabled 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.

.google.ads.admanager.v1.AppliedAdsenseEnabledEnum.AppliedAdsenseEnabled applied_adsense_enabled = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AppliedAdsenseEnabledEnum.AppliedAdsenseEnabled

The appliedAdsenseEnabled.

getAppliedAdsenseEnabledValue()

public int getAppliedAdsenseEnabledValue()

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.

.google.ads.admanager.v1.AppliedAdsenseEnabledEnum.AppliedAdsenseEnabled applied_adsense_enabled = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for appliedAdsenseEnabled.

getAppliedLabelFrequencyCaps(int index)

public 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

getAppliedLabelFrequencyCapsBuilder(int index)

public LabelFrequencyCap.Builder getAppliedLabelFrequencyCapsBuilder(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.Builder

getAppliedLabelFrequencyCapsBuilderList()

public List<LabelFrequencyCap.Builder> getAppliedLabelFrequencyCapsBuilderList()

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<Builder>

getAppliedLabelFrequencyCapsCount()

public 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 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 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 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 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

getAppliedLabelsBuilder(int index)

public AppliedLabel.Builder getAppliedLabelsBuilder(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.Builder

getAppliedLabelsBuilderList()

public List<AppliedLabel.Builder> getAppliedLabelsBuilderList()

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<Builder>

getAppliedLabelsCount()

public 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 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 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 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>

getAppliedTeams(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the appliedTeams.

getCtvApplicationId()

public long getCtvApplicationId()

Optional. The ID of the CTV application that this ad unit is within.

int64 ctv_application_id = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The ctvApplicationId.

getDefaultInstanceForType()

public AdUnit getDefaultInstanceForType()
Returns
Type Description
AdUnit

getDescription()

public 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 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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public 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 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 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 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

getEffectiveAppliedLabelsBuilder(int index)

public AppliedLabel.Builder getEffectiveAppliedLabelsBuilder(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.Builder

getEffectiveAppliedLabelsBuilderList()

public List<AppliedLabel.Builder> getEffectiveAppliedLabelsBuilderList()

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<Builder>

getEffectiveAppliedLabelsCount()

public 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 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 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 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 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

getEffectiveLabelFrequencyCapsBuilder(int index)

public LabelFrequencyCap.Builder getEffectiveLabelFrequencyCapsBuilder(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.Builder

getEffectiveLabelFrequencyCapsBuilderList()

public List<LabelFrequencyCap.Builder> getEffectiveLabelFrequencyCapsBuilderList()

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<Builder>

getEffectiveLabelFrequencyCapsCount()

public 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 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 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 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>

getExplicitlyTargeted()

public 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 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 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 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 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 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 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 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 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

getParentPathBuilder(int index)

public AdUnitParent.Builder getParentPathBuilder(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.Builder

getParentPathBuilderList()

public List<AdUnitParent.Builder> getParentPathBuilderList()

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<Builder>

getParentPathCount()

public 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 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 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 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 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.

getRefreshDelayBuilder()

public Duration.Builder getRefreshDelayBuilder()

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
Builder

getRefreshDelayOrBuilder()

public 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 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 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 AdUnit.Status getStatus()

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

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

Returns
Type Description
AdUnit.Status

The status.

getStatusValue()

public int getStatusValue()

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

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

Returns
Type Description
int

The enum numeric value on the wire for status.

getTargetWindow()

public TargetWindowEnum.TargetWindow getTargetWindow()

Non-empty default. The value to use for the HTML link's target attribute. This value will be interpreted as TOP if left blank.

.google.ads.admanager.v1.TargetWindowEnum.TargetWindow target_window = 12 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
TargetWindowEnum.TargetWindow

The targetWindow.

getTargetWindowValue()

public int getTargetWindowValue()

Non-empty default. The value to use for the HTML link's target attribute. This value will be interpreted as TOP if left blank.

.google.ads.admanager.v1.TargetWindowEnum.TargetWindow target_window = 12 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The enum numeric value on the wire for targetWindow.

getTeams(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the teams.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The instant this AdUnit was last modified.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The instant this AdUnit was last modified.

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The instant this AdUnit was last modified.

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

Returns
Type Description
TimestampOrBuilder

hasRefreshDelay()

public 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 boolean hasUpdateTime()

Output only. The instant 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AdUnit other)

public AdUnit.Builder mergeFrom(AdUnit other)
Parameter
Name Description
other AdUnit
Returns
Type Description
AdUnit.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AdUnit.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdUnit.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AdUnit.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AdUnit.Builder
Overrides

mergeRefreshDelay(Duration value)

public AdUnit.Builder mergeRefreshDelay(Duration value)

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];

Parameter
Name Description
value Duration
Returns
Type Description
AdUnit.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AdUnit.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AdUnit.Builder
Overrides

mergeUpdateTime(Timestamp value)

public AdUnit.Builder mergeUpdateTime(Timestamp value)

Output only. The instant this AdUnit was last modified.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
AdUnit.Builder

removeAdUnitSizes(int index)

public AdUnit.Builder removeAdUnitSizes(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
AdUnit.Builder

removeAppliedLabelFrequencyCaps(int index)

public AdUnit.Builder removeAppliedLabelFrequencyCaps(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
AdUnit.Builder

removeAppliedLabels(int index)

public AdUnit.Builder removeAppliedLabels(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
AdUnit.Builder

removeEffectiveAppliedLabels(int index)

public AdUnit.Builder removeEffectiveAppliedLabels(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
AdUnit.Builder

removeEffectiveLabelFrequencyCaps(int index)

public AdUnit.Builder removeEffectiveLabelFrequencyCaps(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
AdUnit.Builder

removeParentPath(int index)

public AdUnit.Builder removeParentPath(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
AdUnit.Builder

setAdUnitCode(String value)

public AdUnit.Builder setAdUnitCode(String value)

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 off of the ad unit ID.

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

Parameter
Name Description
value String

The adUnitCode to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setAdUnitCodeBytes(ByteString value)

public AdUnit.Builder setAdUnitCodeBytes(ByteString value)

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 off of the ad unit ID.

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

Parameter
Name Description
value ByteString

The bytes for adUnitCode to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setAdUnitId(long value)

public AdUnit.Builder setAdUnitId(long value)

Output only. AdUnit ID.

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

Parameter
Name Description
value long

The adUnitId to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setAdUnitSizes(int index, AdUnitSize value)

public AdUnit.Builder setAdUnitSizes(int index, AdUnitSize value)

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];

Parameters
Name Description
index int
value AdUnitSize
Returns
Type Description
AdUnit.Builder

setAdUnitSizes(int index, AdUnitSize.Builder builderForValue)

public AdUnit.Builder setAdUnitSizes(int index, AdUnitSize.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue AdUnitSize.Builder
Returns
Type Description
AdUnit.Builder

setAppliedAdsenseEnabled(AppliedAdsenseEnabledEnum.AppliedAdsenseEnabled value)

public AdUnit.Builder setAppliedAdsenseEnabled(AppliedAdsenseEnabledEnum.AppliedAdsenseEnabled value)

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.

.google.ads.admanager.v1.AppliedAdsenseEnabledEnum.AppliedAdsenseEnabled applied_adsense_enabled = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AppliedAdsenseEnabledEnum.AppliedAdsenseEnabled

The appliedAdsenseEnabled to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setAppliedAdsenseEnabledValue(int value)

public AdUnit.Builder setAppliedAdsenseEnabledValue(int value)

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.

.google.ads.admanager.v1.AppliedAdsenseEnabledEnum.AppliedAdsenseEnabled applied_adsense_enabled = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for appliedAdsenseEnabled to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setAppliedLabelFrequencyCaps(int index, LabelFrequencyCap value)

public AdUnit.Builder setAppliedLabelFrequencyCaps(int index, LabelFrequencyCap value)

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];

Parameters
Name Description
index int
value LabelFrequencyCap
Returns
Type Description
AdUnit.Builder

setAppliedLabelFrequencyCaps(int index, LabelFrequencyCap.Builder builderForValue)

public AdUnit.Builder setAppliedLabelFrequencyCaps(int index, LabelFrequencyCap.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue LabelFrequencyCap.Builder
Returns
Type Description
AdUnit.Builder

setAppliedLabels(int index, AppliedLabel value)

public AdUnit.Builder setAppliedLabels(int index, AppliedLabel value)

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];

Parameters
Name Description
index int
value AppliedLabel
Returns
Type Description
AdUnit.Builder

setAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public AdUnit.Builder setAppliedLabels(int index, AppliedLabel.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
AdUnit.Builder

setAppliedTeams(int index, String value)

public AdUnit.Builder setAppliedTeams(int index, String value)

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) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The appliedTeams to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setCtvApplicationId(long value)

public AdUnit.Builder setCtvApplicationId(long value)

Optional. The ID of the CTV application that this ad unit is within.

int64 ctv_application_id = 20 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The ctvApplicationId to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setDescription(String value)

public AdUnit.Builder setDescription(String value)

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

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

Parameter
Name Description
value String

The description to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public AdUnit.Builder setDescriptionBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setDisplayName(String value)

public AdUnit.Builder setDisplayName(String value)

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

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public AdUnit.Builder setDisplayNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setEffectiveAdsenseEnabled(boolean value)

public AdUnit.Builder setEffectiveAdsenseEnabled(boolean value)

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];

Parameter
Name Description
value boolean

The effectiveAdsenseEnabled to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setEffectiveAppliedLabels(int index, AppliedLabel value)

public AdUnit.Builder setEffectiveAppliedLabels(int index, AppliedLabel value)

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];

Parameters
Name Description
index int
value AppliedLabel
Returns
Type Description
AdUnit.Builder

setEffectiveAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public AdUnit.Builder setEffectiveAppliedLabels(int index, AppliedLabel.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
AdUnit.Builder

setEffectiveLabelFrequencyCaps(int index, LabelFrequencyCap value)

public AdUnit.Builder setEffectiveLabelFrequencyCaps(int index, LabelFrequencyCap value)

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];

Parameters
Name Description
index int
value LabelFrequencyCap
Returns
Type Description
AdUnit.Builder

setEffectiveLabelFrequencyCaps(int index, LabelFrequencyCap.Builder builderForValue)

public AdUnit.Builder setEffectiveLabelFrequencyCaps(int index, LabelFrequencyCap.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue LabelFrequencyCap.Builder
Returns
Type Description
AdUnit.Builder

setExplicitlyTargeted(boolean value)

public AdUnit.Builder setExplicitlyTargeted(boolean value)

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];

Parameter
Name Description
value boolean

The explicitlyTargeted to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setExternalSetTopBoxChannelId(String value)

public AdUnit.Builder setExternalSetTopBoxChannelId(String value)

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];

Parameter
Name Description
value String

The externalSetTopBoxChannelId to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setExternalSetTopBoxChannelIdBytes(ByteString value)

public AdUnit.Builder setExternalSetTopBoxChannelIdBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for externalSetTopBoxChannelId to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AdUnit.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AdUnit.Builder
Overrides

setHasChildren(boolean value)

public AdUnit.Builder setHasChildren(boolean value)

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];

Parameter
Name Description
value boolean

The hasChildren to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setName(String value)

public AdUnit.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setNameBytes(ByteString value)

public AdUnit.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setParentAdUnit(String value)

public AdUnit.Builder setParentAdUnit(String value)

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) = { ... }

Parameter
Name Description
value String

The parentAdUnit to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setParentAdUnitBytes(ByteString value)

public AdUnit.Builder setParentAdUnitBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parentAdUnit to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setParentPath(int index, AdUnitParent value)

public AdUnit.Builder setParentPath(int index, AdUnitParent value)

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];

Parameters
Name Description
index int
value AdUnitParent
Returns
Type Description
AdUnit.Builder

setParentPath(int index, AdUnitParent.Builder builderForValue)

public AdUnit.Builder setParentPath(int index, AdUnitParent.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue AdUnitParent.Builder
Returns
Type Description
AdUnit.Builder

setRefreshDelay(Duration value)

public AdUnit.Builder setRefreshDelay(Duration value)

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];

Parameter
Name Description
value Duration
Returns
Type Description
AdUnit.Builder

setRefreshDelay(Duration.Builder builderForValue)

public AdUnit.Builder setRefreshDelay(Duration.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AdUnit.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AdUnit.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AdUnit.Builder
Overrides

setSmartSizeMode(SmartSizeModeEnum.SmartSizeMode value)

public AdUnit.Builder setSmartSizeMode(SmartSizeModeEnum.SmartSizeMode value)

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];

Parameter
Name Description
value SmartSizeModeEnum.SmartSizeMode

The smartSizeMode to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setSmartSizeModeValue(int value)

public AdUnit.Builder setSmartSizeModeValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for smartSizeMode to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setStatus(AdUnit.Status value)

public AdUnit.Builder setStatus(AdUnit.Status value)

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

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

Parameter
Name Description
value AdUnit.Status

The status to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setStatusValue(int value)

public AdUnit.Builder setStatusValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for status to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setTargetWindow(TargetWindowEnum.TargetWindow value)

public AdUnit.Builder setTargetWindow(TargetWindowEnum.TargetWindow value)

Non-empty default. The value to use for the HTML link's target attribute. This value will be interpreted as TOP if left blank.

.google.ads.admanager.v1.TargetWindowEnum.TargetWindow target_window = 12 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value TargetWindowEnum.TargetWindow

The targetWindow to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setTargetWindowValue(int value)

public AdUnit.Builder setTargetWindowValue(int value)

Non-empty default. The value to use for the HTML link's target attribute. This value will be interpreted as TOP if left blank.

.google.ads.admanager.v1.TargetWindowEnum.TargetWindow target_window = 12 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value int

The enum numeric value on the wire for targetWindow to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setTeams(int index, String value)

public AdUnit.Builder setTeams(int index, String value)

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) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The teams to set.

Returns
Type Description
AdUnit.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AdUnit.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AdUnit.Builder
Overrides

setUpdateTime(Timestamp value)

public AdUnit.Builder setUpdateTime(Timestamp value)

Output only. The instant this AdUnit was last modified.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
AdUnit.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public AdUnit.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The instant this AdUnit was last modified.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AdUnit.Builder