Sklik API

Banners

Back to home

Changelog

Usage

Ads

Api

Autotagging

Banners

Campaigns

Client

Conversions

Dynamictemplates

Groups

Images

Intends

Interests

Keywords

Patterns

Productsets

Queries

Retargeting

Sharedbudgets

Sitelinks

Stats

Themes

banners.list

List banners.

Parameters

struct user {
string session

Session (as retrieved from client.loginByToken())
int userId

(optional) Managed user ID
}
struct restrictionFilter {

If no entities are selected, then all banners for current user are listed
array ids (

(optional) List these banners
int

Banner ID
)
struct campaign {

(optional) Banners will be listed from these campaigns
array ids (

(optional) List banners from campaigns
int

Campaign ID
)
}
struct group {

(optional) Banners will be listed from these groups
array ids (

(optional) List banners from groups
int

Group ID
)
}
bool isDeleted

(optional) return deleted/undeleted. If unassigned returns both.
}
struct displayOptions {

Customize output
int offset

offset
int limit

count of items
array displayColumns (

(optional) show following entity attributes
string

column name:

  • adStatus: ad's status (set by system)
  • adType: ad's type (default)
  • bannerName: Banner's name (default)
  • createDate: create date
  • clickthruUrl: Ad's url
  • deleted: is ad deleted?
  • deleteDate: ad's delete date
  • description: Description
  • mobileFinalUrl: Final URL
  • height: Banner's height
  • id: banner id (default)
  • image.id: Image id
  • image.url: Image URL
  • image.width: Image width
  • image.height: Image height
  • image.size: Image size
  • imageType: Image type
  • imageUrl: (DEPRECATED, always returns empty string, use image.url instead)
  • width: Banner's width
  • premiseId: firmy premise ID for ad
  • premiseModeId: mode ID for firmy premise for ad
  • premiseMode: mode for firmy premise for ad
  • status: status of the ad (set by user)
  • statusId: status id
  • sensitivity: ad's sensitivity
  • schedule: banner schedule for next week
  • scheduleEnabled: banner has schedule
  • campaign.actualClicks: Actual clicks for campaign
  • campaign.createDate: Campaign's create date
  • campaign.deleteDate: Campaign's Deletion date
  • campaign.deleted: Is campaign deleted?
  • campaign.endDate: Campaign's end date
  • campaign.id: Campaign's id (default)
  • campaign.name: Campaign's name (default)
  • campaign.startDate: Campaign's start date
  • campaign.totalBudgetFrom: Date from which total money budget is counting.
  • campaign.totalClicksFrom: Date from which total click budget is counting.
  • campaign.totalClicks: Total clicks for campaign
  • campaign.status: campaign status
  • group.id: Group's id (default)
  • group.name: Group's name (default)
  • group.deleted: Is group deleted?
  • group.createDate: Group's create date
  • group.deleteDate: Group's delete date
  • group.maxCpc: maximum cpc for group's targeting
  • group.maxCpt: maximum cpt (Cost per Thousand) for group's targeting
  • group.status: group status
)
}

Response

struct {
int status

return code
string statusMessage

verbal description of return code
string session

Refreshed session
array banners (
struct {
string adStatus

(optional) ad's status (set by system)
string adType

(optional) ad's type
string bannerName

(optional) banner's name
datetime createDate

(optional) create date
string clickthruUrl

(optional) URL to which is the user redirected after clicking on the displayed URL
bool deleted

(optional) is ad deleted?
datetime deleteDate

(optional) delete date
string description

(optional) Description
int id

(optional) banner id
string imageType

(optional) Image Type
string imageURL

(optional) (deprecated) Temporary url for file data
string mobileFinalUrl

(optional) Mobile final URL
int height

(optional) banner's height
int premiseId

(optional) (can be null) firmy premise ID for ad
int premiseModeId

(optional) (can be null) mode ID for firmy premise for ad
string premiseMode

(optional) (can be null) mode for firmy premise for ad:

  • disabled: Assigned premise is not shown
  • one: Premise specified in premiseId is shown
  • nearest: Client nearest premise is shown
  • inherit: Premise specified in its campaign is shown
string status

(optional) status of the ad (set by user)
int statusId

(optional) id of the status
string sensitivity

(optional) erotic sensitivity of ad
int width

(optional) banner's width
struct image {

(optional)
int id

(optional) image id
int width

(optional) image width
int height

(optional) image height
int size

(optional) image size
string url

(optional) image url
}
struct group {

(optional)
int id

(optional) group id
string name

(optional) group name
bool deleted

(optional) is group deleted?
datetime createDate

(optional) create date
datetime deleteDate

(optional) delete date
int maxCpc

(optional) maximum cpc for group's targeting
int maxCpt

(optional) maximum cpt (Cost per Thousand) for group's targeting
}
struct campaign {

(optional)
int id

(optional) campaign id
string name

(optional) Campaign name
int totalClicks

(optional) Total clicks
int actualClicks

(optional) Actual clicks
bool deleted

(optional) is campaign deleted ?
datetime startDate

(optional) Campaign start date
datetime endDate

(optional) Campaign end date
datetime totalBudgetFrom

(optional) Date from which total money budget is counting.
datetime totalClicksFrom

(optional) Date from which total click budget is counting.
datetime createDate

(optional) create date
datetime deleteDate

(optional) Deletion date
}
array schedule (

(optional) (can be null) Delivery schedule of banner. Array of 7 days, week starts at monday.
)
bool scheduleEnabled

(optional) Banner has schedule?
}
)
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-2024

www.seznam.cz Help Contact