Interface SuggestedAdUnitOrBuilder (0.54.0)

0.54.0 (latest) 0.53.0 0.52.0 0.50.0 0.47.0 0.46.0 0.44.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.29.0 0.27.0 0.26.0 0.23.0 0.22.0 0.21.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public interface SuggestedAdUnitOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdUnitSizes(int index)

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

getAdUnitSizesCount()

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

getExistingCodePath(int index)

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

getExistingCodePathCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>	A list containing the newCodePath.

getTargetPlatform()

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