type Label (v202505)

  • A Label is additional information that can be added to an entity.

  • The Label object includes fields such as id, name, description, isActive, adCategory, and types.

  • The types field indicates the function of the label, including competitive exclusion, ad unit frequency capping, ad exclusion, creative wrapper, and canonical category.
Service
LabelService
Dependencies
LabelPage createLabels() updateLabels()
▼
Label

A Label is additional information that can be added to an entity.

Namespace
https://www.google.com/apis/ads/publisher/v202505

Field

id

xsd:long

Unique ID of the Label. This value is readonly and is assigned by Google.

name

xsd:string

Name of the Label. This is value is required to create a label and has a maximum length of 127 characters.

description

xsd:string

A description of the label. This value is optional and its maximum length is 255 characters.

isActive

xsd:boolean

Specifies whether or not the label is active. This attribute is read-only.

adCategory

AdCategoryDto

Indicates the Ad Category associated with the label.

types

LabelType[]

The types of the Label.

Enumerations
COMPETITIVE_EXCLUSION
Allows for the creation of labels to exclude competing ads from showing on the same page.
AD_UNIT_FREQUENCY_CAP
Allows for the creation of limits on the frequency that a user sees a particular type of creative over a portion of the inventory.
AD_EXCLUSION
Allows for the creation of labels to exclude ads from showing against a tag that specifies the label as an exclusion.
CREATIVE_WRAPPER
Allows for the creation of labels that can be used to force the wrapping of a delivering creative with header/footer creatives. These labels are paired with a CreativeWrapper.
CANONICAL_CATEGORY
Allows for the creation of labels mapped to a Google canonical ad category, which can be used for competitive exclusions and blocking across Google systems.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.