Sklik API

Ads

ads.list

List ads in groups.

Parameters

struct user {
string session Session (as retrieved from client.login())
int userId (optional) User ID
}
struct restrictionFilter { If no ids is selected, then all ads for current user are listed.
array campaignIds ( (optional) Ads will be listed from these campaigns. (excludes: groupIds, adIds)
int
)
array groupIds ( (optional) Ads will be listed from these groups. (excludes: campaignIds, adIds)
int
)
array adIds ( (optional) These Ads will be listed. (excludes: campaignIds, groupIds)
int
)
bool includeDeleted (optional) [default: False]
}
struct displayOptions { (optional) Customize output [default: see below]
bool showId (optional) Show ad id [default: True]
bool showCreative1 (optional) Show creative1 [default: True]
bool showCreative2 (optional) Show creative2 [default: True]
bool showCreative3 (optional) Show creative3 [default: True]
bool showClickthruUrl (optional) Show clickthruUrl [default: True]
bool showClickthruText (optional) Show clickthruText [default: True]
bool showStatus (optional) Show status [default: True]
bool showStatusId (optional) Show status id [default: False]
bool showSensitivity (optional) Show erotic sensitivity flag [default: False]
bool showSensitivityId (optional) Show erotic sensitivity flag id [default: False]
bool showDeleted (optional) Show deleted status of ad [default: True]
bool showDeletedDate (optional) Show deleted date [default: False]
bool showCreateDate (optional) Show create date [default: True]
bool showPremiseMode (optional) Show connection with firmy.cz mode [default: True]
bool showPremiseId (optional) Show id of connected premise on firmy.cz [default: True]
bool showGroupId (optional) Show group id [default: True]
bool showGroupName (optional) Show group name [default: False]
bool showCampaignId (optional) Show campaign id [default: False]
bool showCampaignName (optional) Show campaign name [default: False]
}

Response

struct {
int status Status code
string statusMessage Status code description
string session Refreshed session
array ads (
struct {
int id (optional) Ad ID
string creative1 (optional) First line of ad (title)
string creative2 (optional) Second line of ad
string creative3 (optional) Third line of ad
string clickthruText (optional) URL that is displayed
string clickthruUrl (optional) URL to which is the user redirected after clicking on the displayed URL
bool deleted (optional) Whether this ad was removed
datetime deletedDate (optional) Whether this ad was removed
int statusId (optional) Ad status Id
string status (optional) Ad status:
  • active: Ad is displayed
  • suspend: Ad is currently not displayed
int sensitivityId (optional) ID statusu
string sensitivity (optional) Ad sensitivity:
  • harmless: Harmless content
  • erotic: Erotic content
  • porn: Porn content
datetime createDate (optional) Create date of the ad
string premiseMode (optional) Premise display mode (for connection with catalog Firmy.cz):
  • disabled: Assigned premise is not shown
  • random: Random premise is shown (deprecated)
  • one: Premise specified in premiseId is shown
  • nearest: Client nearest premise is shown
  • inherit: Premise specified in its campaign is shown
int premiseId (optional)(can be null) Premise id (or nil; for connection with catalog Firmy.cz)
struct group { (optional) Group info
int id (optional) Group ID
string name (optional) Group name
}
struct campaign { (optional) Campaign info
int id (optional) Group ID
string name (optional) Group name
}
}
)
array diagnostics ( (optional) Various diagnostics(warnings, errors, other information)
struct {
...
}
)
}

Response status codes:

List of all possible response status codes:

Diagnostics:

List of all possible diagnostics:

            
        

Copyright © 1996-2018

www.seznam.cz   Help   Contact