Skip to end of metadata
Go to start of metadata

Domain List Service

Domain lists can be used to create a whitelist or a blacklist of domains which should be included or excluded, respectively, from targeting. The domain list IDs are used with the Legacy Bidder Profile Service to specify which domains should be included or excluded from targeting. Please be advised that specifying whether a domain list is a "whitelist" or a "blacklist" does not determine whether that list will be included or excluded. Rather, the domain_list_action must be specified in the Legacy Bidder Profile Service as "include" for whitelists and "exclude" for blacklists.

On This Page

REST API

View all domain lists:

View a specific domain list:

Note: The api use must have the field, "is_admin" set to true.

Add a new domain list:

Modify an existing domain list:

Delete an existing domain list:

Search for domain lists with names or descriptions containing certain characters :

JSON Fields

Field

Type

Description

Default

Required On

id

int

The internal ID for the domain list.

 

PUT, in query string

name

string(100)

The name of the domain list as specified by the user.

 

POST

description

string(100)

A description of the domain list as specified by the user.

 

 

type

string

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

"white"

 

domains

array or strings

The domains included in the domain list. See examples below for format.

"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

timestamp

Read-only. The day and time when the domain list was last changed.

 

 

Note: Only the api user that creates a domain list can see and edit the contents of that domain list

Examples

Add a domain list

View a domain list

Add a domain list to your bidder profile as a "blacklist"

This example targets domain lists using the Legacy Bidder Profile Service.

Search for domain lists with names or descriptions containing "Test"

Related Topics