Help Center Manage Your Account AdSpeed API

Advertiser

Documentation for API methods to manage one or multiple advertisers.

API Version

1.4.0 (build 20210701). This page was updated on Sun, 19 Sep 21 20:48:23 -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

Return the number of active, pending, deleted and total advertisers linked to my account.
Additional Parameters
  • None
Sample Request
Sample Response
<Advertisers total="5" active="1" pending="3" deleted="1"/>

AS.Advertisers.getList

Return the list of advertisers linked to my account.
Additional Parameters
ParameterRequiredDescription
statusOptional
Default value is empty
Filter advertisers with this status. Possible value: 'active','pending','archived'
perpageOptional
Default value is "10"
The number of items per page. Maximum value is 100.
pageOptional
Default value is "1"
The page number
Sample Request
Sample Response
<Advertisers total="5" page="1" numpage="2" perpage="4">
  <Advertiser id="1772" name="advertiser" status="active"/>
  <Advertiser id="25617" name="demoname" status="deleted"/>
  <Advertiser id="26664" name="apitest1615746247875" status="pending"/>
  <Advertiser id="26665" name="apitest1615746251308" status="pending"/>
</Advertisers>

AS.Advertisers.create

Create a new advertiser and link to my account. Limit 50 calls/day. Submit via POST.
Additional Parameters
ParameterRequiredDescription
usernameRequiredUsername for this advertiser
passwordRequiredPassword. Min 8 chars, at least one letter and one number
fullnameRequiredContact's full name (First Last)
emailRequiredEmail address
companyRequiredCompany name
companyurlRequiredCompany website (begins with http:// or https://)
sendwelcomeOptional
Default value is "yes"
Do you want to send a welcome email to this advertiser?
addressOptional
Default value is empty
Contact's address
address2Optional
Default value is empty
Address line 2
cityOptional
Default value is empty
City
stateOptional
Default value is empty
State/province
countryOptional
Default value is empty
Country. Use ISO-3166 2-character country code
postalOptional
Default value is empty
Zip/postal code
phoneOptional
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
ParameterRequiredDescription
usernameRequiredUsername for this advertiser
passwordRequiredPassword
loginrequestOptional
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
ParameterRequiredDescription
advertiserRequiredThe advertiser ID
tokenRequiredThe 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
ParameterRequiredDescription
advertiserRequiredThe advertiser ID
tokenRequiredThe authentication MD5 hash generated from concatenating [Advertiser ID][Advertiser Username]
currentRequiredCurrent password
newRequiredNew 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
ParameterRequiredDescription
advertiserRequiredThe advertiser ID
tokenRequiredThe authentication MD5 hash generated from concatenating [Advertiser ID][Advertiser Username]
fullnameOptional
Default value is empty
Change full name (First Last)
emailOptional
Default value is empty
Change email address
addressOptional
Default value is empty
Change address
address2Optional
Default value is empty
Change address line 2
cityOptional
Default value is empty
Change city
stateOptional
Default value is empty
Change state/province
countryOptional
Default value is empty
Change country. Use ISO-3166 2-character country code
postalOptional
Default value is empty
Change zip/postal code
phoneOptional
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.0 (build 20210701). This page was updated ..."
  • Website
    "Documentation for API methods to manage one or multiple websites. API Version1.4.0 (build 20210701). This page was updated on Sun, ..."
  • Channels
    "Documentation for API methods to manage one or multiple channels. API Version1.4.0 (build 20210701). This page was updated on Sun, ..."
  • Advertiser
    "Advertisers buy ad inventory/space on websites from publishers to promote certain products or services. Advertisers can sign into their advertiser ..."
  • Creative
    "An ad creative displays on publishing sites and it can be in any format: image/banner ad, text link ad, Flash ..."