To discuss and provide feedback on our products, join the official Ad Manager Discord channel in the Google Advertising and Measurement Community server.

REST Resource: networks.labels

Page Summary

The Label resource allows you to organize objects in your network with custom labels.
Labels are identified by a name field in the format networks/{networkCode}/labels/{label_id} .
You can use the provided methods to get a single label or retrieve a list of labels.

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

JSON representation
{ "name" : string , "types" : [ enum ( `LabelType` ) ] , "displayName" : string , "description" : string , "active" : boolean }

Fields
`name`	`string` Identifier. The resource name of the `Label` . Format: `networks/{networkCode}/labels/{labelId}`
`types[]`	`enum ( LabelType )` Required. Unordered list. The types of the Label.
`displayName`	`string` Required. Display name of the Label. This attribute has a maximum length of 127 characters.
`description`	`string` Optional. A description of the label. This attribute has a maximum length of 255 characters.
`active`	`boolean` Output only. Specifies whether or not the label is active.

Represents the types of labels supported.

Enums
`LABEL_TYPE_UNSPECIFIED`	Default value. This value is unused.
`AD_EXCLUSION`	Allows for the creation of labels to exclude ads from showing against a tag that specifies the label as an exclusion.
`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.
`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.
`COMPETITIVE_EXCLUSION`	Allows for the creation of labels to exclude competing ads from showing on the same page.
`CREATIVE_WRAPPER`	Allows for the creation of labels that can be used to force the wrapping of a delivering creative with header/footer creatives.

Methods
`batchActivate`	API to activate `Label` objects.
`batchCreate`	API to batch create `Label` objects.
`batchDeactivate`	API to deactivate `Label` objects.
`batchUpdate`	API to batch update `Label` objects.
`create`	API to create a `Label` object.
`get`	API to retrieve a `Label` object.
`list`	API to retrieve a list of `Label` objects.
`patch`	API to update a `Label` object.