Help Center Manage Your Account AdSpeed API
Advertiser
Documentation for API methods to manage one or multiple advertisers.API Version
1.4.6 (build 20240530). This page was updated on Sun, 06 Oct 24 06:33:49 -0400. Since the API method and response format can change from one version to another, you should check this page for updates.API Methods - Advertiser
- AS.Advertisers.getCounts
- AS.Advertisers.getList
- AS.Advertisers.create
- AS.Advertisers.checkUsernamePassword
- AS.Advertiser.getInfo
- AS.Advertiser.changePassword
- AS.Advertiser.editContact
AS.Advertisers.getCounts
Return the number of active, pending, deleted and total advertisers linked to my account.Additional Parameters
- None
Sample Request
Sample Response
<Advertisers total="9" active="3" pending="6" deleted="0"/>
AS.Advertisers.getList
Return the list of advertisers linked to my account.Additional Parameters
Parameter | Required | Description |
---|---|---|
status | Optional Default value is empty | Filter advertisers with this status. Possible value: 'active','pending','archived' |
perpage | Optional Default value is "10" | The number of items per page. Maximum value is 100. |
page | Optional Default value is "1" | The page number |
Sample Request
Sample Response
<Advertisers total="9" page="1" numpage="3" perpage="4"> <Advertiser id="1772" name="advertiser" status="active"/> <Advertiser id="26664" name="apitest1615746247875" status="pending"/> <Advertiser id="26665" name="apitest1615746251308" status="pending"/> <Advertiser id="26666" name="apitest1615746253180" status="pending"/> </Advertisers>
AS.Advertisers.create
Create a new advertiser and link to my account. Limit 50 calls/day. Submit via POST.Additional Parameters
Parameter | Required | Description |
---|---|---|
username | Required | Username for this advertiser |
password | Required | Password. Min 8 chars, at least one letter and one number |
fullname | Required | Contact's full name (First Last) |
Required | Email address | |
company | Required | Company name |
companyurl | Required | Company website (begins with http:// or https://) |
sendwelcome | Optional Default value is "yes" | Do you want to send a welcome email to this advertiser? |
address | Optional Default value is empty | Contact's address |
address2 | Optional Default value is empty | Address line 2 |
city | Optional Default value is empty | City |
state | Optional Default value is empty | State/province |
country | Optional Default value is empty | Country. Use ISO-3166 2-character country code |
postal | Optional Default value is empty | Zip/postal code |
phone | Optional Default value is empty | Phone number |
Sample Request
Sample Response
<Advertiser id="1234" name="SampleAdvertiserUserName" status="active"></Advertiser>
AS.Advertisers.checkUsernamePassword
Return TRUE if both the linked advertiser's username and password are correct. Otherwise, return FALSE. Available to certain authorized accounts. Submit via POST.Additional Parameters
Parameter | Required | Description |
---|---|---|
username | Required | Username for this advertiser |
password | Required | Password |
loginrequest | Optional Default value is empty | With a valid login request, a special login response will return |
Sample Request
Sample Response
<Result>FALSE</Result>
AS.Advertiser.getInfo
Return the information for a linked advertiser.Additional Parameters
Parameter | Required | Description |
---|---|---|
advertiser | Required | The advertiser ID |
token | Required | The authentication MD5 hash generated from concatenating [Advertiser ID][Advertiser Username] |
Sample Request
Sample Response
<Advertiser id="1772" name="advertiser" status="active"> <FullName>Mrs Joe New</FullName> <Email>demo@adspeed.com</Email> <Company>Demo Corp</Company> <Address>100 Madison Ave<br/> NY 10100<br/> United States</Address> <Phone>212-555-5555</Phone> </Advertiser>
AS.Advertiser.changePassword
Change a linked advertiser's password. Available to certain authorized accounts. Submit via POST.Additional Parameters
Parameter | Required | Description |
---|---|---|
advertiser | Required | The advertiser ID |
token | Required | The authentication MD5 hash generated from concatenating [Advertiser ID][Advertiser Username] |
current | Required | Current password |
new | Required | New password. Min 8 chars, at least one letter and one number |
Sample Request
Sample Response
<Result>TRUE</Result>
AS.Advertiser.editContact
Edit the contact information of a linked advertiser. Set a value to change. Skip or leave blank to retain current value. Submit via POST.Additional Parameters
Parameter | Required | Description |
---|---|---|
advertiser | Required | The advertiser ID |
token | Required | The authentication MD5 hash generated from concatenating [Advertiser ID][Advertiser Username] |
fullname | Optional Default value is empty | Change full name (First Last) |
Optional Default value is empty | Change email address | |
address | Optional Default value is empty | Change address |
address2 | Optional Default value is empty | Change address line 2 |
city | Optional Default value is empty | Change city |
state | Optional Default value is empty | Change state/province |
country | Optional Default value is empty | Change country. Use ISO-3166 2-character country code |
postal | Optional Default value is empty | Change zip/postal code |
phone | Optional Default value is empty | Change phone number |
Sample Request
Sample Response
<Advertiser id="1772" name="advertiser" status="active"> <FullName>Mrs Joe New</FullName> <Email>demo@adspeed.com</Email> <Company>Demo Corp</Company> <Address>100 Madison Ave<br/> NY 10100<br/> United States</Address> <Phone>212-555-5555</Phone> </Advertiser>
Other Articles in AdSpeed API
Documentation to use AdSpeed API to integrate AdSpeed AdServer into your own platform.
Cannot find an answer for your question? Ask our Customer Care team
Related
- Campaign
"Documentation for API methods to manage your campaigns in our ad server. API Version1.4.6 (build 20240530). This page was updated ..."
- Website
"Documentation for API methods to manage one or multiple websites. API Version1.4.6 (build 20240530). This page was updated on Tue, ..."
- Group
"Documentation for API methods to manage one or multiple groups. API Version1.4.6 (build 20240530). This page was updated on Fri, ..."
- Advertiser
"Advertisers buy ad inventory/space on websites from publishers to promote certain products or services. Advertisers can sign into their advertiser ..."
- Publisher
"Publishers operate websites, blogs, newsletters, mobile apps, mobile games and any online properties that attract viewers. Publishers generate revenue from ..."