Sklik API



Check campaign attributes before updating or creating a new one.

You can specify either campaignId or name and dayBudget. In the first
case, update check is performed. In the second, create check is performed.

You cannot combine update and create checks in one API call.


struct user {
string session

Session (as retrieved from client.loginByToken())

int userId

(optional) User ID

array campaigns (
struct {
int id

(optional) Campaign ID (only if you want to check update)

string name

(optional) Campaign name

int dayBudget

(optional) Campaign daily budget (in halers; 100 = 1 Kc)

array excludedSearchServices (

(optional) Excluded search services (only for type in ["fulltext", "product"])


(optional) Search service id (see listSearchServices() for search service enumeration)

array excludedUrls (

(optional) Excluded URLs (only for type in ["context", "product", "simple"]) ("simple" only for update check)


(optional) URL to be excluded from context targeting

array negativeKeywords (

(optional) Negative keywords (for all groups in this campaign) (only for type in ['context', 'fulltext', 'product', 'simple']) ('simple' only for update check)

struct {
string name

Negative keyword

string matchType

(optional) Negative keyword match type:

  • negativeBroad: Negative broad match; query must not contain words from this keyword
  • negativePhrase: Negative phrase match; query must not contain keyword words in correct order
  • negativeExact: Negative exact match; query must not exactly match this keyword
int totalBudget

(optional) (can be null) Campaign total budget limit (in halers) or nil for no limit (default for check create)

int totalClicks

(optional) (can be null) Campaign total clicks limit or nil for no limit (default for check create) (only for type in ['context', 'fulltext', 'product'])

datetime startDate

(optional) (can be null) Campaign start date; default: nil (for check create)

datetime endDate

(optional) (can be null) Campaign end date; default: nil (for check create)

string adSelection

(optional) Ad selection strategy [default: weighted] (only for type in ["fulltext", "context"]):

  • weighted: Prefer an ad with higher CTR (default)
  • random: Every ads with same frequency only for type in ['combined', 'video', 'context', 'product', 'zbozi', 'social', 'simple']
  • cpa: Prefer an ad with lower CPA
  • cos: Prefer an ad with lower CTR
string type

Type of campaign (cannot be changed):

  • fulltext: fulltext campaign
  • context: context campaign
  • product: product campaign
  • video: video campaign
  • simple: simple ads campaign
  • zbozi: non default campaign
string paymentMethod

(optional) Payment method for paying for ads (only for type=context):

  • cpc: Payment per click
  • cpm: Payment per thousand views
array regions (

(optional) Geotargeting

struct {
int predefinedId

(optional) Predefined region id only if type is predefined.

array schedule (

(optional) (can be null) Spending schedule of campaign. Array of 7 days, week starts at monday.

struct premise {

(optional) Connection with (only for type=fulltext)

int id

(optional) (can be null) Connection with

string defaultMode

(optional) connection display mode:

  • disabled: No branch is displayed (default)
  • one: Premise specified in defaultPremiseId is shown
  • nearest: Client nearest premise is shown
int defaultId

Branch premise id for connection with catalog (only for defaultMode=one)

struct devicesPriceRatio {

(optional) Specific ratio of max CPC/CPT for target device (These values override values in targetDevices)

int desktop

(optional) Desktop/Notebook devices

int mobile

(optional) Smartphones/Mobile devices

int tablet

(optional) Tablet devices

int other

(optional) Other devices

string videoFormat

(optional)(only for type=video) Checks allowed videoformat type:

  • both: Include instream and outstream
  • instream: campaign allows only instream format
  • outstream: campaign allows only outstream format
string zboziBiddingType

(optional) (only for type=zbozi) bidding type

int zboziPremiseId

(optional) (only for type=zbozi) premise to link the campaign to



struct {
int status

Status code

string statusMessage

Status code description

string session

Refreshed session

array diagnostics (

(optional) Various diagnostics(warnings, errors, other information)

struct {

Response status codes:

List of all possible response status codes:


List of all possible diagnostics:

Copyright © 1996-2024 Help Contact