Google Ads Ad Manager V1 Client - Class TaxonomyCategory (0.4.1)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class TaxonomyCategory.

The TaxonomyCategory resource.

Generated from protobuf message google.ads.admanager.v1.TaxonomyCategory

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. The resource name of the `TaxonomyCategory`. Format: `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}`
`↳ taxonomy_category_id`	`int\|string` Output only. `TaxonomyCategory` ID.
`↳ display_name`	`string` Output only. Display name of the `TaxonomyCategory`.
`↳ grouping_only`	`bool` Output only. Whether this `TaxonomyCategory` only serves to group its children.
`↳ parent_taxonomy_category_id`	`int\|string` Output only. The ID of the parent category this `TaxonomyCategory` descends from.
`↳ taxonomy_type`	`int` Output only. The taxonomy that this `TaxonomyCategory` belongs to.
`↳ ancestor_names`	`array` Output only. The list of names of the ancestors of this `TaxonomyCategory`.
`↳ ancestor_taxonomy_category_ids`	`array` Output only. The list of IDs of the ancestors of this `TaxonomyCategory`.

getName

Identifier. The resource name of the TaxonomyCategory.

Format: networks/{network_code}/taxonomyCategories/{taxonomy_category_id}

Returns
Type	Description
`string`

setName

Identifier. The resource name of the TaxonomyCategory.

Format: networks/{network_code}/taxonomyCategories/{taxonomy_category_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTaxonomyCategoryId

Output only. TaxonomyCategory ID.

Returns
Type	Description
`int\|string`

hasTaxonomyCategoryId

clearTaxonomyCategoryId

setTaxonomyCategoryId

Output only. TaxonomyCategory ID.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getDisplayName

Output only. Display name of the TaxonomyCategory.

Returns
Type	Description
`string`

hasDisplayName

clearDisplayName

setDisplayName

Output only. Display name of the TaxonomyCategory.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getGroupingOnly

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

Returns
Type	Description
`bool`

hasGroupingOnly

clearGroupingOnly

setGroupingOnly

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getParentTaxonomyCategoryId

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

Returns
Type	Description
`int\|string`

hasParentTaxonomyCategoryId

clearParentTaxonomyCategoryId

setParentTaxonomyCategoryId

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

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getTaxonomyType

Output only. The taxonomy that this TaxonomyCategory belongs to.

Returns
Type	Description
`int`

hasTaxonomyType

clearTaxonomyType

setTaxonomyType

Output only. The taxonomy that this TaxonomyCategory belongs to.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getAncestorNames

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setAncestorNames

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

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getAncestorTaxonomyCategoryIds

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setAncestorTaxonomyCategoryIds

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

Parameter
Name	Description
`var`	`int[]\|string[]\|Google\Protobuf\Internal\RepeatedField`

Returns
Type	Description
`$this`