Class TaxonomyCategory (0.11.0)

public final class TaxonomyCategory extends GeneratedMessageV3 implements TaxonomyCategoryOrBuilder

The TaxonomyCategory resource.

Protobuf type google.ads.admanager.v1.TaxonomyCategory

Static Fields

ANCESTOR_NAMES_FIELD_NUMBER

public static final int ANCESTOR_NAMES_FIELD_NUMBER
Field Value
Type Description
int

ANCESTOR_TAXONOMY_CATEGORY_IDS_FIELD_NUMBER

public static final int ANCESTOR_TAXONOMY_CATEGORY_IDS_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

GROUPING_ONLY_FIELD_NUMBER

public static final int GROUPING_ONLY_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PARENT_TAXONOMY_CATEGORY_ID_FIELD_NUMBER

public static final int PARENT_TAXONOMY_CATEGORY_ID_FIELD_NUMBER
Field Value
Type Description
int

TAXONOMY_CATEGORY_ID_FIELD_NUMBER

public static final int TAXONOMY_CATEGORY_ID_FIELD_NUMBER
Field Value
Type Description
int

TAXONOMY_TYPE_FIELD_NUMBER

public static final int TAXONOMY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TaxonomyCategory getDefaultInstance()
Returns
Type Description
TaxonomyCategory

getDescriptor()

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

newBuilder()

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

newBuilder(TaxonomyCategory prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAncestorNames(int index)

public String getAncestorNames(int index)

Output only. The list of names of the ancestors of this TaxonomyCategory.

repeated string ancestor_names = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The ancestorNames at the given index.

getAncestorNamesBytes(int index)

public ByteString getAncestorNamesBytes(int index)

Output only. The list of names of the ancestors of this TaxonomyCategory.

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

getAncestorNamesCount()

public int getAncestorNamesCount()

Output only. The list of names of the ancestors of this TaxonomyCategory.

repeated string ancestor_names = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of ancestorNames.

getAncestorNamesList()

public ProtocolStringList getAncestorNamesList()

Output only. The list of names of the ancestors of this TaxonomyCategory.

repeated string ancestor_names = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the ancestorNames.

getAncestorTaxonomyCategoryIds(int index)

public long getAncestorTaxonomyCategoryIds(int index)

Output only. The list of IDs of the ancestors of this TaxonomyCategory.

repeated int64 ancestor_taxonomy_category_ids = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
long

The ancestorTaxonomyCategoryIds at the given index.

getAncestorTaxonomyCategoryIdsCount()

public int getAncestorTaxonomyCategoryIdsCount()

Output only. The list of IDs of the ancestors of this TaxonomyCategory.

repeated int64 ancestor_taxonomy_category_ids = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of ancestorTaxonomyCategoryIds.

getAncestorTaxonomyCategoryIdsList()

public List<Long> getAncestorTaxonomyCategoryIdsList()

Output only. The list of IDs of the ancestors of this TaxonomyCategory.

repeated int64 ancestor_taxonomy_category_ids = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Long>

A list containing the ancestorTaxonomyCategoryIds.

getDefaultInstanceForType()

public TaxonomyCategory getDefaultInstanceForType()
Returns
Type Description
TaxonomyCategory

getDisplayName()

public String getDisplayName()

Output only. Display name of the TaxonomyCategory.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Output only. Display name of the TaxonomyCategory.

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

Returns
Type Description
ByteString

The bytes for displayName.

getGroupingOnly()

public boolean getGroupingOnly()

Output only. Whether this TaxonomyCategory only serves to group its children.

bool grouping_only = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The groupingOnly.

getName()

public String getName()

Identifier. The resource name of the TaxonomyCategory. Format: networks/{network_code}/taxonomyCategories/{taxonomy_category_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 TaxonomyCategory. Format: networks/{network_code}/taxonomyCategories/{taxonomy_category_id}

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

Returns
Type Description
ByteString

The bytes for name.

getParentTaxonomyCategoryId()

public long getParentTaxonomyCategoryId()

Output only. The ID of the parent category this TaxonomyCategory descends from.

int64 parent_taxonomy_category_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The parentTaxonomyCategoryId.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTaxonomyCategoryId()

public long getTaxonomyCategoryId()

Output only. TaxonomyCategory ID.

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

Returns
Type Description
long

The taxonomyCategoryId.

getTaxonomyType()

public TaxonomyTypeEnum.TaxonomyType getTaxonomyType()

Output only. The taxonomy that this TaxonomyCategory belongs to.

.google.ads.admanager.v1.TaxonomyTypeEnum.TaxonomyType taxonomy_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TaxonomyTypeEnum.TaxonomyType

The taxonomyType.

getTaxonomyTypeValue()

public int getTaxonomyTypeValue()

Output only. The taxonomy that this TaxonomyCategory belongs to.

.google.ads.admanager.v1.TaxonomyTypeEnum.TaxonomyType taxonomy_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for taxonomyType.

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 TaxonomyCategory.Builder newBuilderForType()
Returns
Type Description
TaxonomyCategory.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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