Skip to end of metadata
Go to start of metadata

Domain List Service

The Domain List service lets you define a list of domains that can be included or excluded from a campaign's targeting profile. Domain lists in targeting profiles are used to place domains with similar characteristics in groups that you can use to easily include or exclude domains from campaign targeting. They're generally used as whitelists or blacklists. Whitelists contain domains that you want to include in your campaign targeting, and blacklists contain domains that you want to exclude. (See domain_list_targets and domain_list_action in the Profile Service to see how to include these lists in your profiles).

On this Page

REST API

View all domain lists:
GET https://api.appnexus.com/domain-list

View a specific domain list:
GET https://api.appnexus.com/domain-list?id=DOMAIN_LIST_ID

Search for domain lists with names or descriptions containing certain characters:
GET https://api.appnexus.com/domain-list?search=SEARCH_TERM

Add a new domain list:
POST https://api.appnexus.com/domain-list
(domain-list JSON)

Modify an existing domain list:
PUT https://api.appnexus.com/domain-list?id=DOMAIN_LIST_ID
(domain-list JSON)

Delete an existing domain list:
DELETE https://api.appnexus.com/domain-list?id=DOMAIN_LIST_ID

JSON Fields

Field

Type

Description

Default

Requirements On

id

int

The internal system identifier for the domain list

 

PUT, in query string

name

string(100)

The name of the domain list as specified by the user. This name must be unique.

 

POST

description

string(100)

A description of the domain list.

 

 

type

string

The type of domain list. Possible values are black and white. This value is strictly informational; it does not determine whether the list is included or excluded in targeting.

white

 

domains

array

Array of domains in the format ["domain1.com", "domain2.com", ... , "domain10.com"].

"www" is stripped from domains

Domains which begin with "www" will have the "www" substring stripped out before being stored in our system. For example, "www.example.org" will be shortened to "example.org".

 

 

last_modified

string

Read-only timestamp of when the domain list was last changed.

 

 

Examples

Adding a domain list
Viewing domain list 9
Adding domain lists to profile 35 as a "whitelist"
Searching for domain lists with names or descriptions containing "test"

Related Topics