Class GeoTarget (0.27.0)

public final class GeoTarget extends GeneratedMessageV3 implements GeoTargetOrBuilder

Represents a location in the world, for targeting.

Protobuf type google.ads.admanager.v1.GeoTarget

Implements

GeoTargetOrBuilder

Static Fields

CANONICAL_PARENT_FIELD_NUMBER

public static final int CANONICAL_PARENT_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

PARENT_NAMES_FIELD_NUMBER

public static final int PARENT_NAMES_FIELD_NUMBER
Field Value
Type Description
int

REGION_CODE_FIELD_NUMBER

public static final int REGION_CODE_FIELD_NUMBER
Field Value
Type Description
int

TARGETABLE_FIELD_NUMBER

public static final int TARGETABLE_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GeoTarget getDefaultInstance()
Returns
Type Description
GeoTarget

getDescriptor()

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

newBuilder()

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

newBuilder(GeoTarget prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCanonicalParent()

public String getCanonicalParent()

Output only. The name of the direct parent that defines the canonical name of the geo target. For example, if the current geo target is "San Francisco", its canonical name would be "San Francisco, California, United States" thus the canonical_parent would be the name of California and the canonical_parent of California would be the name of United states Format: networks/{network_code}/geoTargets/{geo_target}

optional string canonical_parent = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The canonicalParent.

getCanonicalParentBytes()

public ByteString getCanonicalParentBytes()

Output only. The name of the direct parent that defines the canonical name of the geo target. For example, if the current geo target is "San Francisco", its canonical name would be "San Francisco, California, United States" thus the canonical_parent would be the name of California and the canonical_parent of California would be the name of United states Format: networks/{network_code}/geoTargets/{geo_target}

optional string canonical_parent = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for canonicalParent.

getDefaultInstanceForType()

public GeoTarget getDefaultInstanceForType()
Returns
Type Description
GeoTarget

getDisplayName()

public String getDisplayName()

Output only. The display name of the GeoTarget.

optional string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Output only. The display name of the GeoTarget.

optional string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Identifier. The resource name of the GeoTarget. Format: networks/{network_code}/geoTargets/{geo_target_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 GeoTarget. Format: networks/{network_code}/geoTargets/{geo_target_id}

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

Returns
Type Description
ByteString

The bytes for name.

getParentNames(int index)

public String getParentNames(int index)

Output only. All parents of the geo target ordered by ascending size.

repeated string parent_names = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The parentNames at the given index.

getParentNamesBytes(int index)

public ByteString getParentNamesBytes(int index)

Output only. All parents of the geo target ordered by ascending size.

repeated string parent_names = 4 [(.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 parentNames at the given index.

getParentNamesCount()

public int getParentNamesCount()

Output only. All parents of the geo target ordered by ascending size.

repeated string parent_names = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of parentNames.

getParentNamesList()

public ProtocolStringList getParentNamesList()

Output only. All parents of the geo target ordered by ascending size.

repeated string parent_names = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the parentNames.

getParserForType()

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

getRegionCode()

public String getRegionCode()

Output only. The Unicode CLDR region code of the geo target.

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

Returns
Type Description
String

The regionCode.

getRegionCodeBytes()

public ByteString getRegionCodeBytes()

Output only. The Unicode CLDR region code of the geo target.

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

Returns
Type Description
ByteString

The bytes for regionCode.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTargetable()

public boolean getTargetable()

Output only. Whether the geo target is targetable.

optional bool targetable = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The targetable.

getType()

public String getType()

Output only. The location type (unlocalized) for this geographical entity.

optional string type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

Output only. The location type (unlocalized) for this geographical entity.

optional string type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for type.

hasCanonicalParent()

public boolean hasCanonicalParent()

Output only. The name of the direct parent that defines the canonical name of the geo target. For example, if the current geo target is "San Francisco", its canonical name would be "San Francisco, California, United States" thus the canonical_parent would be the name of California and the canonical_parent of California would be the name of United states Format: networks/{network_code}/geoTargets/{geo_target}

optional string canonical_parent = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the canonicalParent field is set.

hasDisplayName()

public boolean hasDisplayName()

Output only. The display name of the GeoTarget.

optional string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the displayName field is set.

hasRegionCode()

public boolean hasRegionCode()

Output only. The Unicode CLDR region code of the geo target.

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

Returns
Type Description
boolean

Whether the regionCode field is set.

hasTargetable()

public boolean hasTargetable()

Output only. Whether the geo target is targetable.

optional bool targetable = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the targetable field is set.

hasType()

public boolean hasType()

Output only. The location type (unlocalized) for this geographical entity.

optional string type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the type 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 GeoTarget.Builder newBuilderForType()
Returns
Type Description
GeoTarget.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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