Class SuggestedAdUnit.Builder (0.54.0)

public static final class SuggestedAdUnit.Builder extends GeneratedMessage.Builder<SuggestedAdUnit.Builder> implements SuggestedAdUnitOrBuilder

A read-only suggestion for a new ad unit based on an ad tag that has served 10+ times in the past week for an undefined ad unit.

Protobuf type google.ads.admanager.v1.SuggestedAdUnit

Static Methods

getDescriptor()

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

Methods

addAdUnitSizes(AdUnitSize value)

public SuggestedAdUnit.Builder addAdUnitSizes(AdUnitSize value)

Output only. Sizes associated with this suggested ad unit.

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

Parameter
Name Description
value AdUnitSize
Returns
Type Description
SuggestedAdUnit.Builder

addAdUnitSizes(AdUnitSize.Builder builderForValue)

public SuggestedAdUnit.Builder addAdUnitSizes(AdUnitSize.Builder builderForValue)

Output only. Sizes associated with this suggested ad unit.

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

Parameter
Name Description
builderForValue AdUnitSize.Builder
Returns
Type Description
SuggestedAdUnit.Builder

addAdUnitSizes(int index, AdUnitSize value)

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

Output only. Sizes associated with this suggested ad unit.

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

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

addAdUnitSizes(int index, AdUnitSize.Builder builderForValue)

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

Output only. Sizes associated with this suggested ad unit.

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

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

addAdUnitSizesBuilder()

public AdUnitSize.Builder addAdUnitSizesBuilder()

Output only. Sizes associated with this suggested ad unit.

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

Returns
Type Description
AdUnitSize.Builder

addAdUnitSizesBuilder(int index)

public AdUnitSize.Builder addAdUnitSizesBuilder(int index)

Output only. Sizes associated with this suggested ad unit.

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

Parameter
Name Description
index int
Returns
Type Description
AdUnitSize.Builder

addAllAdUnitSizes(Iterable<? extends AdUnitSize> values)

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

Output only. Sizes associated with this suggested ad unit.

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

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.AdUnitSize>
Returns
Type Description
SuggestedAdUnit.Builder

addAllExistingCodePath(Iterable<? extends AdUnitParent> values)

public SuggestedAdUnit.Builder addAllExistingCodePath(Iterable<? extends AdUnitParent> values)

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.AdUnitParent>
Returns
Type Description
SuggestedAdUnit.Builder

addAllNewCodePath(Iterable<String> values)

public SuggestedAdUnit.Builder addAllNewCodePath(Iterable<String> values)

Output only. Path of suggested ad unit codes from the closest existing ancestor ad unit that will all be created as ad units when the suggestion is approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the new_code_path is (x). If x is the grandchild of c, the new_code_path is (y, x) where y is an ad unit that would be created as the parent ad unit of x (and the child of c) if the suggestion is approved.

repeated string new_code_path = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<String>

The newCodePath to add.

Returns
Type Description
SuggestedAdUnit.Builder

This builder for chaining.

addExistingCodePath(AdUnitParent value)

public SuggestedAdUnit.Builder addExistingCodePath(AdUnitParent value)

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

Parameter
Name Description
value AdUnitParent
Returns
Type Description
SuggestedAdUnit.Builder

addExistingCodePath(AdUnitParent.Builder builderForValue)

public SuggestedAdUnit.Builder addExistingCodePath(AdUnitParent.Builder builderForValue)

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

Parameter
Name Description
builderForValue AdUnitParent.Builder
Returns
Type Description
SuggestedAdUnit.Builder

addExistingCodePath(int index, AdUnitParent value)

public SuggestedAdUnit.Builder addExistingCodePath(int index, AdUnitParent value)

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

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

addExistingCodePath(int index, AdUnitParent.Builder builderForValue)

public SuggestedAdUnit.Builder addExistingCodePath(int index, AdUnitParent.Builder builderForValue)

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

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

addExistingCodePathBuilder()

public AdUnitParent.Builder addExistingCodePathBuilder()

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

Returns
Type Description
AdUnitParent.Builder

addExistingCodePathBuilder(int index)

public AdUnitParent.Builder addExistingCodePathBuilder(int index)

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

Parameter
Name Description
index int
Returns
Type Description
AdUnitParent.Builder

addNewCodePath(String value)

public SuggestedAdUnit.Builder addNewCodePath(String value)

Output only. Path of suggested ad unit codes from the closest existing ancestor ad unit that will all be created as ad units when the suggestion is approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the new_code_path is (x). If x is the grandchild of c, the new_code_path is (y, x) where y is an ad unit that would be created as the parent ad unit of x (and the child of c) if the suggestion is approved.

repeated string new_code_path = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The newCodePath to add.

Returns
Type Description
SuggestedAdUnit.Builder

This builder for chaining.

addNewCodePathBytes(ByteString value)

public SuggestedAdUnit.Builder addNewCodePathBytes(ByteString value)

Output only. Path of suggested ad unit codes from the closest existing ancestor ad unit that will all be created as ad units when the suggestion is approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the new_code_path is (x). If x is the grandchild of c, the new_code_path is (y, x) where y is an ad unit that would be created as the parent ad unit of x (and the child of c) if the suggestion is approved.

repeated string new_code_path = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes of the newCodePath to add.

Returns
Type Description
SuggestedAdUnit.Builder

This builder for chaining.

build()

public SuggestedAdUnit build()
Returns
Type Description
SuggestedAdUnit

buildPartial()

public SuggestedAdUnit buildPartial()
Returns
Type Description
SuggestedAdUnit

clear()

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

clearAdUnitSizes()

public SuggestedAdUnit.Builder clearAdUnitSizes()

Output only. Sizes associated with this suggested ad unit.

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

Returns
Type Description
SuggestedAdUnit.Builder

clearExistingCodePath()

public SuggestedAdUnit.Builder clearExistingCodePath()

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

Returns
Type Description
SuggestedAdUnit.Builder

clearName()

public SuggestedAdUnit.Builder clearName()

Identifier. Resource name of the SuggestedAdUnit. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

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

Returns
Type Description
SuggestedAdUnit.Builder

This builder for chaining.

clearNewCodePath()

public SuggestedAdUnit.Builder clearNewCodePath()

Output only. Path of suggested ad unit codes from the closest existing ancestor ad unit that will all be created as ad units when the suggestion is approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the new_code_path is (x). If x is the grandchild of c, the new_code_path is (y, x) where y is an ad unit that would be created as the parent ad unit of x (and the child of c) if the suggestion is approved.

repeated string new_code_path = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SuggestedAdUnit.Builder

This builder for chaining.

clearTargetPlatform()

public SuggestedAdUnit.Builder clearTargetPlatform()

Output only. Target platform for the browser that clicked the underlying ad tag.

optional .google.ads.admanager.v1.TargetPlatformEnum.TargetPlatform target_platform = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SuggestedAdUnit.Builder

This builder for chaining.

clearTargetWindow()

public SuggestedAdUnit.Builder clearTargetWindow()

Output only. Target window of the underlying ad tag which will be used in the ad unit if the suggestion is approved.

optional .google.ads.admanager.v1.TargetWindowEnum.TargetWindow target_window = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SuggestedAdUnit.Builder

This builder for chaining.

clearWeeklyRequestCount()

public SuggestedAdUnit.Builder clearWeeklyRequestCount()

Output only. Number of times the ad tag has been served in the past week.

optional int64 weekly_request_count = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SuggestedAdUnit.Builder

This builder for chaining.

getAdUnitSizes(int index)

public AdUnitSize getAdUnitSizes(int index)

Output only. Sizes associated with this suggested ad unit.

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

Parameter
Name Description
index int
Returns
Type Description
AdUnitSize

getAdUnitSizesBuilder(int index)

public AdUnitSize.Builder getAdUnitSizesBuilder(int index)

Output only. Sizes associated with this suggested ad unit.

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

Parameter
Name Description
index int
Returns
Type Description
AdUnitSize.Builder

getAdUnitSizesBuilderList()

public List<AdUnitSize.Builder> getAdUnitSizesBuilderList()

Output only. Sizes associated with this suggested ad unit.

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

Returns
Type Description
List<Builder>

getAdUnitSizesCount()

public int getAdUnitSizesCount()

Output only. Sizes associated with this suggested ad unit.

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

Returns
Type Description
int

getAdUnitSizesList()

public List<AdUnitSize> getAdUnitSizesList()

Output only. Sizes associated with this suggested ad unit.

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

Returns
Type Description
List<AdUnitSize>

getAdUnitSizesOrBuilder(int index)

public AdUnitSizeOrBuilder getAdUnitSizesOrBuilder(int index)

Output only. Sizes associated with this suggested ad unit.

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

Parameter
Name Description
index int
Returns
Type Description
AdUnitSizeOrBuilder

getAdUnitSizesOrBuilderList()

public List<? extends AdUnitSizeOrBuilder> getAdUnitSizesOrBuilderList()

Output only. Sizes associated with this suggested ad unit.

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

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

getDefaultInstanceForType()

public SuggestedAdUnit getDefaultInstanceForType()
Returns
Type Description
SuggestedAdUnit

getDescriptorForType()

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

getExistingCodePath(int index)

public AdUnitParent getExistingCodePath(int index)

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

Parameter
Name Description
index int
Returns
Type Description
AdUnitParent

getExistingCodePathBuilder(int index)

public AdUnitParent.Builder getExistingCodePathBuilder(int index)

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

Parameter
Name Description
index int
Returns
Type Description
AdUnitParent.Builder

getExistingCodePathBuilderList()

public List<AdUnitParent.Builder> getExistingCodePathBuilderList()

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

Returns
Type Description
List<Builder>

getExistingCodePathCount()

public int getExistingCodePathCount()

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

Returns
Type Description
int

getExistingCodePathList()

public List<AdUnitParent> getExistingCodePathList()

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

Returns
Type Description
List<AdUnitParent>

getExistingCodePathOrBuilder(int index)

public AdUnitParentOrBuilder getExistingCodePathOrBuilder(int index)

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

Parameter
Name Description
index int
Returns
Type Description
AdUnitParentOrBuilder

getExistingCodePathOrBuilderList()

public List<? extends AdUnitParentOrBuilder> getExistingCodePathOrBuilderList()

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

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

getName()

public String getName()

Identifier. Resource name of the SuggestedAdUnit. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Resource name of the SuggestedAdUnit. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

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

Returns
Type Description
ByteString

The bytes for name.

getNewCodePath(int index)

public String getNewCodePath(int index)

Output only. Path of suggested ad unit codes from the closest existing ancestor ad unit that will all be created as ad units when the suggestion is approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the new_code_path is (x). If x is the grandchild of c, the new_code_path is (y, x) where y is an ad unit that would be created as the parent ad unit of x (and the child of c) if the suggestion is approved.

repeated string new_code_path = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The newCodePath at the given index.

getNewCodePathBytes(int index)

public ByteString getNewCodePathBytes(int index)

Output only. Path of suggested ad unit codes from the closest existing ancestor ad unit that will all be created as ad units when the suggestion is approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the new_code_path is (x). If x is the grandchild of c, the new_code_path is (y, x) where y is an ad unit that would be created as the parent ad unit of x (and the child of c) if the suggestion is approved.

repeated string new_code_path = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the newCodePath at the given index.

getNewCodePathCount()

public int getNewCodePathCount()

Output only. Path of suggested ad unit codes from the closest existing ancestor ad unit that will all be created as ad units when the suggestion is approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the new_code_path is (x). If x is the grandchild of c, the new_code_path is (y, x) where y is an ad unit that would be created as the parent ad unit of x (and the child of c) if the suggestion is approved.

repeated string new_code_path = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of newCodePath.

getNewCodePathList()

public ProtocolStringList getNewCodePathList()

Output only. Path of suggested ad unit codes from the closest existing ancestor ad unit that will all be created as ad units when the suggestion is approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the new_code_path is (x). If x is the grandchild of c, the new_code_path is (y, x) where y is an ad unit that would be created as the parent ad unit of x (and the child of c) if the suggestion is approved.

repeated string new_code_path = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the newCodePath.

getTargetPlatform()

public TargetPlatformEnum.TargetPlatform getTargetPlatform()

Output only. Target platform for the browser that clicked the underlying ad tag.

optional .google.ads.admanager.v1.TargetPlatformEnum.TargetPlatform target_platform = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TargetPlatformEnum.TargetPlatform

The targetPlatform.

getTargetPlatformValue()

public int getTargetPlatformValue()

Output only. Target platform for the browser that clicked the underlying ad tag.

optional .google.ads.admanager.v1.TargetPlatformEnum.TargetPlatform target_platform = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for targetPlatform.

getTargetWindow()

public TargetWindowEnum.TargetWindow getTargetWindow()

Output only. Target window of the underlying ad tag which will be used in the ad unit if the suggestion is approved.

optional .google.ads.admanager.v1.TargetWindowEnum.TargetWindow target_window = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TargetWindowEnum.TargetWindow

The targetWindow.

getTargetWindowValue()

public int getTargetWindowValue()

Output only. Target window of the underlying ad tag which will be used in the ad unit if the suggestion is approved.

optional .google.ads.admanager.v1.TargetWindowEnum.TargetWindow target_window = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for targetWindow.

getWeeklyRequestCount()

public long getWeeklyRequestCount()

Output only. Number of times the ad tag has been served in the past week.

optional int64 weekly_request_count = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The weeklyRequestCount.

hasTargetPlatform()

public boolean hasTargetPlatform()

Output only. Target platform for the browser that clicked the underlying ad tag.

optional .google.ads.admanager.v1.TargetPlatformEnum.TargetPlatform target_platform = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the targetPlatform field is set.

hasTargetWindow()

public boolean hasTargetWindow()

Output only. Target window of the underlying ad tag which will be used in the ad unit if the suggestion is approved.

optional .google.ads.admanager.v1.TargetWindowEnum.TargetWindow target_window = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the targetWindow field is set.

hasWeeklyRequestCount()

public boolean hasWeeklyRequestCount()

Output only. Number of times the ad tag has been served in the past week.

optional int64 weekly_request_count = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the weeklyRequestCount field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SuggestedAdUnit other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

removeAdUnitSizes(int index)

public SuggestedAdUnit.Builder removeAdUnitSizes(int index)

Output only. Sizes associated with this suggested ad unit.

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

Parameter
Name Description
index int
Returns
Type Description
SuggestedAdUnit.Builder

removeExistingCodePath(int index)

public SuggestedAdUnit.Builder removeExistingCodePath(int index)

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

Parameter
Name Description
index int
Returns
Type Description
SuggestedAdUnit.Builder

setAdUnitSizes(int index, AdUnitSize value)

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

Output only. Sizes associated with this suggested ad unit.

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

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

setAdUnitSizes(int index, AdUnitSize.Builder builderForValue)

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

Output only. Sizes associated with this suggested ad unit.

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

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

setExistingCodePath(int index, AdUnitParent value)

public SuggestedAdUnit.Builder setExistingCodePath(int index, AdUnitParent value)

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

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

setExistingCodePath(int index, AdUnitParent.Builder builderForValue)

public SuggestedAdUnit.Builder setExistingCodePath(int index, AdUnitParent.Builder builderForValue)

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the new_code_path field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existing_code_path is (a, b, c). If x is the grandchild of c, the existing_code_path is also (a, b, c).

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

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

setName(String value)

public SuggestedAdUnit.Builder setName(String value)

Identifier. Resource name of the SuggestedAdUnit. Format: networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
SuggestedAdUnit.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SuggestedAdUnit.Builder setNameBytes(ByteString value)

Identifier. Resource name of the SuggestedAdUnit. Format: networks/{network_code}/suggestedAdUnits/{suggested_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
SuggestedAdUnit.Builder

This builder for chaining.

setNewCodePath(int index, String value)

public SuggestedAdUnit.Builder setNewCodePath(int index, String value)

Output only. Path of suggested ad unit codes from the closest existing ancestor ad unit that will all be created as ad units when the suggestion is approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the new_code_path is (x). If x is the grandchild of c, the new_code_path is (y, x) where y is an ad unit that would be created as the parent ad unit of x (and the child of c) if the suggestion is approved.

repeated string new_code_path = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int

The index to set the value at.

value String

The newCodePath to set.

Returns
Type Description
SuggestedAdUnit.Builder

This builder for chaining.

setTargetPlatform(TargetPlatformEnum.TargetPlatform value)

public SuggestedAdUnit.Builder setTargetPlatform(TargetPlatformEnum.TargetPlatform value)

Output only. Target platform for the browser that clicked the underlying ad tag.

optional .google.ads.admanager.v1.TargetPlatformEnum.TargetPlatform target_platform = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value TargetPlatformEnum.TargetPlatform

The targetPlatform to set.

Returns
Type Description
SuggestedAdUnit.Builder

This builder for chaining.

setTargetPlatformValue(int value)

public SuggestedAdUnit.Builder setTargetPlatformValue(int value)

Output only. Target platform for the browser that clicked the underlying ad tag.

optional .google.ads.admanager.v1.TargetPlatformEnum.TargetPlatform target_platform = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

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

Returns
Type Description
SuggestedAdUnit.Builder

This builder for chaining.

setTargetWindow(TargetWindowEnum.TargetWindow value)

public SuggestedAdUnit.Builder setTargetWindow(TargetWindowEnum.TargetWindow value)

Output only. Target window of the underlying ad tag which will be used in the ad unit if the suggestion is approved.

optional .google.ads.admanager.v1.TargetWindowEnum.TargetWindow target_window = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value TargetWindowEnum.TargetWindow

The targetWindow to set.

Returns
Type Description
SuggestedAdUnit.Builder

This builder for chaining.

setTargetWindowValue(int value)

public SuggestedAdUnit.Builder setTargetWindowValue(int value)

Output only. Target window of the underlying ad tag which will be used in the ad unit if the suggestion is approved.

optional .google.ads.admanager.v1.TargetWindowEnum.TargetWindow target_window = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

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

Returns
Type Description
SuggestedAdUnit.Builder

This builder for chaining.

setWeeklyRequestCount(long value)

public SuggestedAdUnit.Builder setWeeklyRequestCount(long value)

Output only. Number of times the ad tag has been served in the past week.

optional int64 weekly_request_count = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value long

The weeklyRequestCount to set.

Returns
Type Description
SuggestedAdUnit.Builder

This builder for chaining.