public final class SuggestedAdUnit extends GeneratedMessage 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
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
AD_UNIT_SIZES_FIELD_NUMBER
public static final int AD_UNIT_SIZES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXISTING_CODE_PATH_FIELD_NUMBER
public static final int EXISTING_CODE_PATH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NEW_CODE_PATH_FIELD_NUMBER
public static final int NEW_CODE_PATH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TARGET_PLATFORM_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TARGET_WINDOW_FIELD_NUMBER
public static final int TARGET_WINDOW_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
WEEKLY_REQUEST_COUNT_FIELD_NUMBER
public static final int WEEKLY_REQUEST_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static SuggestedAdUnit getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SuggestedAdUnit.Builder newBuilder()
newBuilder(SuggestedAdUnit prototype)
public static SuggestedAdUnit.Builder newBuilder(SuggestedAdUnit prototype)
public static SuggestedAdUnit parseDelimitedFrom(InputStream input)
public static SuggestedAdUnit parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SuggestedAdUnit parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SuggestedAdUnit parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SuggestedAdUnit parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SuggestedAdUnit parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SuggestedAdUnit parseFrom(CodedInputStream input)
public static SuggestedAdUnit parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SuggestedAdUnit parseFrom(InputStream input)
public static SuggestedAdUnit parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SuggestedAdUnit parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SuggestedAdUnit parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SuggestedAdUnit> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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
|
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];
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
|
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()
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
|
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];
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
|
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()
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];
getParserForType()
public Parser<SuggestedAdUnit> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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];
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];
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.
|
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SuggestedAdUnit.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected SuggestedAdUnit.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public SuggestedAdUnit.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
