Interface PlacementOrBuilder (0.3.0)

public interface PlacementOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescription()

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

getPlacementCode()

public abstract 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 abstract 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 abstract long getPlacementId()

Output only. Placement ID.

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

Returns
Type Description
long

The placementId.

getStatus()

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

A list containing the targetedAdUnits.

getUpdateTime()

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