Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Service

/domain-listprofile

Method

GETParameters


Service

/profile

Method

POST/PUT


NameTypeRequiredDescription
idnameintstringNYDomain List Id.
advertiser_idintYIf this is set, it will only return the domain lists where the name contains the advertiser id.

Response

Example where the advertiser id is 12345.

Code Block
{
 "response":{
  "status":"OK",
  "domainlists":[{
   "id":1,
   "name":"[12345] name",
   "description":"short description",
   "type":"white",
   "last_modified":"2014-08-27 11:57:08",
   "domains":[
    "domain1.com",
    "domain2.com"
   ],
   "num_domains":2
  },{...}
 ]
 }
}

 

Service

/domain-list

Method

POST

Parameters

NameTypeRequiredDescription
namestringYThe name of the domain list as specified by the user
descriptionstringN A description of the domain list as specified by the user
typestringY

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.

domainsstringN String of domains where each domain is on a new line ("\n)
advertiser_idintYUsed as a prefix for the name

Service

/domain-list

Method

PUT

Parameters

Same as POST.


NameTypeRequiredDescription
idintYThe internal system identifier for the domain liststatestringNactive/inactive
Default: active
currencystringY
daily_budgetdoubleN
lifetime_budgetdoubleN
enable_pacingbooleanNDefault: true
start_datestringN

Default: null, corresponds to "immediately".
Example: 2014-08-01 01:30:00

end_datestringN

Default: null, corresponds to "immediately".
Example: 2014-08-01 01:30:00

run_indefinitelybooleanN

Default: false
if true, end_date is set to null

pixelsarrayNConversion pixel ids. (key: id, state)
timezonestringN
profile_idintNSee Profile Service