Advertiser Domain Lists API

Advertiser domain lists can be created, edited and viewed using the advertiser domain list api.  When you have created an advertiser domain list, you can attach that advertiser domain list to a demand or supply tag for competitive exclusions targeting. 



Creating an advertiser domain list

SDK

Use tab completion with SDK to auto-complete function names or show field options!

REST API

POST /api/v0/advertiser_domain_lists

Headers

Body (example)

{
    "name": "My Advertiser Domain List",
        "description": "My description"
}

Required parameters: name

Response

Status code 200


Get a Domain List

SDK

REST API

GET /api/v0/advertiser_domain_lists/<id>

Headers


Response

Status code 200



Add Advertiser Domains

SDK

REST API

POST /api/v0/advertiser_domain_lists/<id>/advertiser_domains/bulk_create

Headers

Body (example)


Response

Status code 200


Append Advertiser Domains to an Advertiser Domain List From a File

SDK

REST API

POST /api/v0/advertiser_domain_lists/<id>/advertiser_domains/file_bulk_create

curl --location --request POST 'https://console.springserve.com/api/v0/advertiser_domain_lists/<id>/advertiser_domains/file_bulk_create' \
--header 'Content-Type: application/json' \
--header 'Authorization: <yourAuthToken>' \
--form 'csv_file=@"/<filepath>/adomain_list.csv"'

Response

Status code 201

{"created": True}

Get Domains in Advertiser Domain List

SDK

REST API

GET /api/v0/advertiser_domain_lists/<id>/advertiser_domains

Headers


Response (note you need to paginate)

Status code 200


Replace Advertiser Domains

SDK

REST API

POST /api/v0/advertiser_domain_lists/<id>/advertiser_domains/bulk_replace

Headers

Body (example)

Replace All Domains with a File

SDK

REST API

POST /api/v0/advertiser_domain_lists/<id>/advertiser_domains/file_bulk_replace

curl --location --request POST 'https://console.springserve.com/api/v0/advertiser_domain_lists/<id>/advertiser_domains/file_bulk_replace' \
--header 'Content-Type: application/json' \
--header 'Authorization: <yourAuthToken>' \
--form 'csv_file=@"/<filepath>/replacement_adomain_list.csv"'

Response

Status code 201

{"created": True}

Remove Domains

SDK

REST API

DELETE /api/v0/advertiser_domain_lists/<id>/advertiser_domains/bulk_delete

Headers

Body (example)


Response (note you need to paginate)

Status code 200


Remove Domains in a File from an Advertiser Domain List

SDK

REST API

DELETE /api/v0/advertiser_domain_lists/<id>/advertiser_domains/file_bulk_delete

curl --location --request DELETE 'https://console.springserve.com/api/v0/advertiser_domain_lists/<id>/advertiser_domains/file_bulk_delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: <yourAuthToken>' \
--form 'csv_file=@"/<filepath>/deletion_adomain_list.csv"'

Response

Status code 201

{"created": True}


Attach to a Demand or Supply Tag

To attach an advertiser domain list to a supply or demand tag you must set the following fields on a supply or demand tag

  • advertiser_domain_list_ids → this is a list of advertiser domain list ids that you want to target on the supply or demand tag
  • advertiser_domain_targeting → Whether or not to treat it like an 'Allowlist' or 'Blocklist'

SDK

REST API

See documentation on the Supply and Demand Tag APIs