Class Placement (0.5.0)

public final class Placement extends GeneratedMessageV3 implements PlacementOrBuilder

The Placement resource.

Protobuf type google.ads.admanager.v1.Placement

Implements

PlacementOrBuilder

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PLACEMENT_CODE_FIELD_NUMBER

public static final int PLACEMENT_CODE_FIELD_NUMBER
Field Value
Type Description
int

PLACEMENT_ID_FIELD_NUMBER

public static final int PLACEMENT_ID_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TARGETED_AD_UNITS_FIELD_NUMBER

public static final int TARGETED_AD_UNITS_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Placement getDefaultInstance()
Returns
Type Description
Placement

getDescriptor()

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

newBuilder()

public static Placement.Builder newBuilder()
Returns
Type Description
Placement.Builder

newBuilder(Placement prototype)

public static Placement.Builder newBuilder(Placement prototype)
Parameter
Name Description
prototype Placement
Returns
Type Description
Placement.Builder

parseDelimitedFrom(InputStream input)

public static Placement parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Placement
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Placement parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Placement
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Placement parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Placement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Placement parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Placement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Placement parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Placement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Placement parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Placement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Placement parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Placement
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Placement parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Placement
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Placement parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Placement
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Placement parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Placement
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Placement parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Placement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Placement parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Placement
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Placement> parser()
Returns
Type Description
Parser<Placement>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Placement getDefaultInstanceForType()
Returns
Type Description
Placement

getDescription()

public String getDescription()

Optional. A description of the Placement. This value is optional and its maximum length is 65,535 characters.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. A description of the Placement. This value is optional and its maximum length is 65,535 characters.

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

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

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

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

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

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Identifier. The resource name of the Placement. Format: networks/{network_code}/placements/{placement_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 Placement. Format: networks/{network_code}/placements/{placement_id}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Placement> getParserForType()
Returns
Type Description
Parser<Placement>
Overrides

getPlacementCode()

public String getPlacementCode()

Output only. A string used to uniquely identify the Placement for purposes of serving the ad. This attribute is read-only and is assigned by Google when a placement is created.

string placement_code = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The placementCode.

getPlacementCodeBytes()

public ByteString getPlacementCodeBytes()

Output only. A string used to uniquely identify the Placement for purposes of serving the ad. This attribute is read-only and is assigned by Google when a placement is created.

string placement_code = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for placementCode.

getPlacementId()

public long getPlacementId()

Output only. Placement ID.

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

Returns
Type Description
long

The placementId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public PlacementStatusEnum.PlacementStatus getStatus()

Output only. The status of the Placement. This attribute is read-only.

.google.ads.admanager.v1.PlacementStatusEnum.PlacementStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PlacementStatusEnum.PlacementStatus

The status.

getStatusValue()

public int getStatusValue()

Output only. The status of the Placement. This attribute is read-only.

.google.ads.admanager.v1.PlacementStatusEnum.PlacementStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

getTargetedAdUnits(int index)

public String getTargetedAdUnits(int index)

Optional. The resource names of AdUnits that constitute the Placement. Format: "networks/{network_code}/adUnits/{ad_unit_id}"

repeated string targeted_ad_units = 7 [(.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 targetedAdUnits at the given index.

getTargetedAdUnitsBytes(int index)

public ByteString getTargetedAdUnitsBytes(int index)

Optional. The resource names of AdUnits that constitute the Placement. Format: "networks/{network_code}/adUnits/{ad_unit_id}"

repeated string targeted_ad_units = 7 [(.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 targetedAdUnits at the given index.

getTargetedAdUnitsCount()

public int getTargetedAdUnitsCount()

Optional. The resource names of AdUnits that constitute the Placement. Format: "networks/{network_code}/adUnits/{ad_unit_id}"

repeated string targeted_ad_units = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of targetedAdUnits.

getTargetedAdUnitsList()

public ProtocolStringList getTargetedAdUnitsList()

Optional. The resource names of AdUnits that constitute the Placement. Format: "networks/{network_code}/adUnits/{ad_unit_id}"

repeated string targeted_ad_units = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the targetedAdUnits.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The instant this Placement was last modified.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The instant this Placement was last modified.

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

Returns
Type Description
TimestampOrBuilder

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The instant this Placement was last modified.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Placement.Builder newBuilderForType()
Returns
Type Description
Placement.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Placement.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Placement.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Placement.Builder toBuilder()
Returns
Type Description
Placement.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException