Skip to end of metadata
Go to start of metadata

Label Service

This read-only service allows you to view the labels that can be applied to your advertisers, insertion orders, line items, campaigns, and publishers. It also allows you to view the labels that have already been applied. 

An example of an advertiser label is "Salesperson". You might use this label to specify the name of the salesperson responsible for each of your advertisers. You might then run the Network Analytics report filtered by "salesperson_for_advertiser" to focus on the advertisers that a particular salesperson is responsible for, or grouped by "salesperson_for_advertiser" to rank the performance of your salespeople.

The following reports currently support labels: Network Analytics, Network Advertiser Analytics, and Advertiser Analytics. See "report_field" below for the full list of report columns associated with labels.

On This Page

REST API

View all available labels:

View a specific label:

View the labels that are applied to a specific object type:

The following object types are available: advertiser, publisher, line_item, campaign, and insertion_order.

JSON Fields

Field

Type

Description

id

int

The ID of the label. Possible values: 1, 2, 3, 4, 5, 7, 8, 9, 11, 12, 14, 15, 16.

name

string

The name of the label. Possible values: "Salesperson", "Account Manager", "Trafficker", "Sales Rep", "Test/Control", "Campaign Type", or "Advertiser Type". See the first example below for id/name/object_type mappings.

member_id

int

Since all labels are currently available to all members, this field will always be NULL. In the future, it may become possible for a member to create unique labels, in which case this field would return the ID of the owning member. 

is_user_associated

boolean

This field is specific to the UI. If true, the label is associated with a person (i.e. "Salesperson" or "Account Manager") and the UI will allow for auto-completion of the label value by the firstname, lastname of a user.

is_reporting_enabled

boolean

If true, the label is available for use in reporting.

object_type

enum

The type of object to which the label can be applied. Possible values: "advertiser", "insertion_order", "line_item", "campaign", or "publisher". See the first example below for id/name/object_type mappings.

report_field

string 

The report column with which you can report on the label. Possible report columns (with corresponding reports):
- salesperson_for_advertiser (Network Analytics)
- salesperson_for_publisher (Network Analytics)
- account_manager_for_advertiser (Network Analytics)
- account_manager_for_publisher (Network Analytics)
- trafficker_for_line_item (Network Analytics, Network Advertiser Analytics)
- salesrep_for_line_item (Network Analytics, Network Advertiser Analytics)
- user_group_for_campaign (Network Analytics, Network Advertiser Analytics, Advertiser Analytics)
- advertiser_type (Network Analytics, Network Advertiser Analytics) 
- line_item_type (Network Analytics, Network Advertiser Analytics)  
- insertion_order_type (Network Analytics, Network Advertiser Analytics)  

values

array of objects

This field is return when using the request GET https://api.appnexus.com/label?show_values=true&object_type=OBJECT_TYPE. See Values and the second example below for more details.

last_modified

timestamp

The date and time when the label was last modified.

Values

Field

Type

Description

object_id

int

The ID of the object to which the label is applied. For example, if object_type is "advertiser", object_id would be the ID of the advertiser.

value

string

The value assigned to the label. For example, for the publisher "Salesperson" label, this would be a name such as "Michael Sellers".

Examples

View all available labels
View the labels that are applied to your advertisers