Sklik API



Set campaigns attributes.


struct user {
string session Session (as retrieved from client.login())
int userId (optional) User ID
array campaigns (
struct { Campaign attributes to be updated
int id Campaign ID
string name (optional) Campaign name
string status (optional) Set campaign status:
  • active: Active
  • suspend: Suspended
array excludedSearchServices ( (optional) Excluded search services (only for type in ["fulltext", "combined", "product"])
int (optional) Search service id (see listSearchServices() for search service enumeration)
array excludedUrls ( (optional) Excluded URLs (only for type in ["context", "combined", "product"])
string (optional) URL to be excluded from context targeting
array negativeKeywords ( (optional) Negative keywords (for all groups in this campaign) (only for type in ['combined', 'context', 'fulltext', 'product'])
struct { (optional)
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 sharedBudgetId (optional) (can be null) Shared budget ID to set
int dayBudget (optional) Set day budget (in halers)
int totalBudget (optional) (can be null) Set total budget (in halers); set to nil to unset
int totalClicks (optional) (can be null) Set total click count; set to nil to unset (only for type in ['combined', 'context', 'fulltext', 'product'])
bool resetExhaustedTotalBudget (optional) Reset exhausted total budget to zero; default: false (do not reset)
bool resetExhaustedTotalClicks (optional) Reset exhausted total clicks to zero; default: false (do not reset) (only for type in ['combined', 'context', 'fulltext', 'product'])
string adSelection (optional) Ad selection strategy [default: weighted] (only for type in ["fulltext", "context", "combined"]):
  • weighted: Prefer an ad with higher CTR (default)
  • random: Every ads with same frequency
  • cpa: Prefer an ad with lower CPA
  • cos: Prefer an ad with lower CTR
datetime startDate (optional) (can be null) Set campaign start date, or nil to unset
datetime endDate (optional) (can be null) Set campaign end date, or nil to unset
string type (optional) Type of campaign (cannot be changed): [default: combined]
  • combined: combined campaign
  • fulltext: fulltext campaign
  • context: context campaign
  • product: product campaign
  • video: video campaign
bool context (optional) whether context placement will be enabled (only for type in ["combined", "product"])
bool fulltext (optional) whether fulltext placement will be enabled (only for type in ["combined", "product"])
string paymentMethod (optional) Payment method for paying for ads (only for type in ["context", "combined"]):
  • 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.
array ( One day of schedule, contains 24 items for each hour of the day.
int Percentage of given hour.
struct premise { (optional) Connection with (only for type in ["fulltext", "combined"])
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 targetDevices { (optional) Specify target devices [deprecated: will be removed in next Major version] (These values are overridden by values in devicesPriceRatio)
bool desktop (optional) Desktop/Notebook devices [deprecated]
bool mobile (optional) Smartphones/Mobile devices [deprecated]
bool tablet (optional) Tablet devices [deprecated]
bool other (optional) Other devices [deprecated]
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) Sets allowed videoformat type


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-2020   Help   Contact