public final class CreativePlaceholder extends GeneratedMessageV3 implements CreativePlaceholderOrBuilder
Describes a slot that a creative is expected to fill. This is used in
forecasting and to validate that the correct creatives are associated with
the line item.
Protobuf type google.ads.admanager.v1.CreativePlaceholder
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
AMP_ONLY_FIELD_NUMBER
public static final int AMP_ONLY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
APPLIED_LABELS_FIELD_NUMBER
public static final int APPLIED_LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
COMPANION_SIZES_FIELD_NUMBER
public static final int COMPANION_SIZES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATIVE_TARGETING_DISPLAY_NAME_FIELD_NUMBER
public static final int CREATIVE_TARGETING_DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXPECTED_CREATIVE_COUNT_FIELD_NUMBER
public static final int EXPECTED_CREATIVE_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SIZE_FIELD_NUMBER
public static final int SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static CreativePlaceholder getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CreativePlaceholder.Builder newBuilder()
newBuilder(CreativePlaceholder prototype)
public static CreativePlaceholder.Builder newBuilder(CreativePlaceholder prototype)
public static CreativePlaceholder parseDelimitedFrom(InputStream input)
public static CreativePlaceholder parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CreativePlaceholder parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CreativePlaceholder parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CreativePlaceholder parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreativePlaceholder parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreativePlaceholder parseFrom(CodedInputStream input)
public static CreativePlaceholder parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CreativePlaceholder parseFrom(InputStream input)
public static CreativePlaceholder parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CreativePlaceholder parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CreativePlaceholder parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CreativePlaceholder> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAmpOnly()
public boolean getAmpOnly()
Indicates if the expected creative of this placeholder has an AMP only
variant. This is used to improve the accuracy of forecasting and has no
effect on serving.
bool amp_only = 5;
| Returns |
| Type |
Description |
boolean |
The ampOnly.
|
getAppliedLabels(int index)
public AppliedLabel getAppliedLabels(int index)
Set of labels applied directly to this CreativePlaceholder.
repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;
| Parameter |
| Name |
Description |
index |
int
|
getAppliedLabelsCount()
public int getAppliedLabelsCount()
Set of labels applied directly to this CreativePlaceholder.
repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;
| Returns |
| Type |
Description |
int |
|
getAppliedLabelsList()
public List<AppliedLabel> getAppliedLabelsList()
Set of labels applied directly to this CreativePlaceholder.
repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;
getAppliedLabelsOrBuilder(int index)
public AppliedLabelOrBuilder getAppliedLabelsOrBuilder(int index)
Set of labels applied directly to this CreativePlaceholder.
repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;
| Parameter |
| Name |
Description |
index |
int
|
getAppliedLabelsOrBuilderList()
public List<? extends AppliedLabelOrBuilder> getAppliedLabelsOrBuilderList()
Set of labels applied directly to this CreativePlaceholder.
repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;
| Returns |
| Type |
Description |
List<? extends com.google.ads.admanager.v1.AppliedLabelOrBuilder> |
|
getCompanionSizes(int index)
public Size getCompanionSizes(int index)
The companions that the creative is expected to have. This attribute can
only be set if the line item it belongs to has an
EnvironmentType
of VIDEO_PLAYER or roadblocking_type of
CREATIVE_SET.
repeated .google.ads.admanager.v1.Size companion_sizes = 2;
| Parameter |
| Name |
Description |
index |
int
|
| Returns |
| Type |
Description |
Size |
|
getCompanionSizesCount()
public int getCompanionSizesCount()
The companions that the creative is expected to have. This attribute can
only be set if the line item it belongs to has an
EnvironmentType
of VIDEO_PLAYER or roadblocking_type of
CREATIVE_SET.
repeated .google.ads.admanager.v1.Size companion_sizes = 2;
| Returns |
| Type |
Description |
int |
|
getCompanionSizesList()
public List<Size> getCompanionSizesList()
The companions that the creative is expected to have. This attribute can
only be set if the line item it belongs to has an
EnvironmentType
of VIDEO_PLAYER or roadblocking_type of
CREATIVE_SET.
repeated .google.ads.admanager.v1.Size companion_sizes = 2;
getCompanionSizesOrBuilder(int index)
public SizeOrBuilder getCompanionSizesOrBuilder(int index)
The companions that the creative is expected to have. This attribute can
only be set if the line item it belongs to has an
EnvironmentType
of VIDEO_PLAYER or roadblocking_type of
CREATIVE_SET.
repeated .google.ads.admanager.v1.Size companion_sizes = 2;
| Parameter |
| Name |
Description |
index |
int
|
getCompanionSizesOrBuilderList()
public List<? extends SizeOrBuilder> getCompanionSizesOrBuilderList()
The companions that the creative is expected to have. This attribute can
only be set if the line item it belongs to has an
EnvironmentType
of VIDEO_PLAYER or roadblocking_type of
CREATIVE_SET.
repeated .google.ads.admanager.v1.Size companion_sizes = 2;
| Returns |
| Type |
Description |
List<? extends com.google.ads.admanager.v1.SizeOrBuilder> |
|
getCreativeTargetingDisplayName()
public String getCreativeTargetingDisplayName()
The display name of the creative targeting that this CreativePlaceholder
represents.
string creative_targeting_display_name = 6;
| Returns |
| Type |
Description |
String |
The creativeTargetingDisplayName.
|
getCreativeTargetingDisplayNameBytes()
public ByteString getCreativeTargetingDisplayNameBytes()
The display name of the creative targeting that this CreativePlaceholder
represents.
string creative_targeting_display_name = 6;
| Returns |
| Type |
Description |
ByteString |
The bytes for creativeTargetingDisplayName.
|
getDefaultInstanceForType()
public CreativePlaceholder getDefaultInstanceForType()
getExpectedCreativeCount()
public int getExpectedCreativeCount()
Expected number of creatives that will be uploaded corresponding to this
creative placeholder. This estimate is used to improve the accuracy of
forecasting; for example, if label frequency capping limits the number of
times a creative may be served.
int32 expected_creative_count = 3;
| Returns |
| Type |
Description |
int |
The expectedCreativeCount.
|
getParserForType()
public Parser<CreativePlaceholder> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSize()
Required. The size that the creative is expected to have.
.google.ads.admanager.v1.Size size = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
Size |
The size.
|
getSizeOrBuilder()
public SizeOrBuilder getSizeOrBuilder()
Required. The size that the creative is expected to have.
.google.ads.admanager.v1.Size size = 1 [(.google.api.field_behavior) = REQUIRED];
hasSize()
Required. The size that the creative is expected to have.
.google.ads.admanager.v1.Size size = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the size field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CreativePlaceholder.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CreativePlaceholder.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public CreativePlaceholder.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
