Skip to end of metadata
Go to start of metadata

Category Service

The read-only Category Service allows you to view all buy-side categories that are registered in our system. Categories are applied to both brands and creatives - you can see what categories are assigned to a brand or creative using the Brand Service or the Creative Service. Sellers can then allow or disallow these categories of brands and creatives using the Ad Profile Service. When looking at a creative in the UI, you will see "Sensitive categories" and "Offer category" - both of these pull from the Category Service. Sensitive categories will have the is_sensitive field set to true.

Sellers will categorize sites and placements using the Content Category Service.

On This Page

REST API

View all categories:
GET https://api.appnexus.com/category

View a particular category:
GET https://api.appnexus.com/category?id=CATEGORY_ID

Find out which fields you can filter and sort by:
GET https://api.appnexus.com/category/meta

JSON Fields

The fields countries_and_brands and countries_and_regions defined below are being used by our system to allow gambling-related creatives to serve in the countries and regions where they're legally allowed, putting us in compliance with applicable laws.

  • For more information about our official gambling-related policies, see our buy-side and sell-side gambling policies (customer login required).
  • For more information on how whitelisting works by country and region, contact Customer Support .

Field

Type

Description

id

int

The ID of the category.

name

string

The name of the category.

is_sensitive

bool

If true, the category is listed as "sensitive", and is often banned by publishers.

requires_whitelist

boolean

Whether brands or creatives in this category require whitelisting in order to serve.

requires_whitelist_on_managed

boolean

Whether brands or creatives in this category require whitelisting in order to serve on managed inventory.

requires_whitelist_on_external

boolean

Whether brands or creatives in this category require whitelisting in order to serve on external (i.e., RTB) inventory.

last_modified

timestamp

The date and time when the category was last modified.

is_brand_eligible

boolean

If true, Xandr's audit team may associate the category with brands.

countries_and_brands

array of objects

This array contains brand whitelist settings grouped by country. For more information, see Countries and Brands below.

Countries and Brands

Field

Type

Description

brand_id

int

The ID of the brand.

brand_name

string

The name of the brand.

brand

multi_object

An object containing information about the brand whitelisted in this country. For more information, see Brand below.

country

string

A 2-character string referencing the country in which the brand is whitelisted. For a list of supported codes, see the ISO 3166-1 country codes.

Regions and Brands

This array is deprecated and will no longer be available in version 1.15 of the API.

Field

Type

Description

brand_id

int

The ID of the brand.

brand_name

string

The name of the brand.

brand

multi_object

An object containing information about the brand whitelisted in this region. For more information, see Brand below.

region

string

A string referencing the region in which the brand is whitelisted. For a list of supported codes, see the ISO 3166-2.


Brand

Field

Type

Description

id

int

The ID of the brand.

name

string

The name of the brand.

Examples

View a single category
View all categories

Related Topics