Sklik API

Keywords

keywords.list

List keywords.

Parameters

struct user {
string session Session (as retrieved from client.login())
int userId (optional) Managed user ID
}
struct restrictionFilter { If no groups are selected, then all banners for current user are listed
array ids ( (optional) List these keywords
long Keyword ID
)
struct campaign { (optional) Keywords will be listed from these campaigns
array ids ( (optional) List keywords from campaigns
int Campaign ID
)
}
struct group { (optional) Ads will be listed from these groups
array ids ( (optional) List keywords from groups
int Group ID
)
}
bool isDeleted (optional) return deleted/undeleted. If unassigned returns both.
}
struct displayOptions { Customize output
int limit count of items
int offset offset
array displayColumns ( (optional) show following entity attributes
string column name:
  • cpc: cpc
  • createDate: create date
  • deleteDate: delete date
  • deleted: is keyword deleted ?
  • disabled: is keyword disabled ?
  • id: keyword id (default)
  • matchTypeId: keyword's match type
  • matchType: keyword's match type id (default)
  • name: keyword itself (default)
  • status: status (default)
  • statusId: status id
  • url: keyword url (default)
  • 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.maxCpcContext: maximum cpc on Context network for group's targeting
  • group.maxCpt: maximum cpt (Cost per Thousand) for group's targeting
  • campaign.id: Campaign's id (default)
  • campaign.totalBudgetFrom: Date from which total money budget is counting.
  • campaign.exhaustedTotalBudget: Exhausted total budget
  • campaign.totalBudget: Campaign total budget (if set; in halers)
  • campaign.name: Campaign name (default)
  • campaign.totalClicks: Total allowed clicks for campaign
  • campaign.actualClicks: Actual clicks
  • campaign.totalClicksFrom: Date from which the total click budget is counted
  • campaign.context: is it context campaign?
  • campaign.contextNetwork: Name of targeted context networks
  • campaign.fulltext: is it fulltext campaign?
  • campaign.deleted: is campaign deleted ?
  • campaign.deleteDate: Deletion date
  • campaign.adSelection: Ad selection method
  • campaign.adSelectionId: Ad selection method id
  • campaign.paymentMethod: Payment method
  • campaign.paymentMethodId: Payment method id
  • campaign.startDate: Campaign start date
  • campaign.endDate: Campaign end date
  • campaign.createDate: create date
  • campaign.automaticLocation: Is automatic location enabled.
  • campaign.budgetId: Actual budget id
  • campaign.defaultBudgetId: Default budget id.
  • campaign.deviceDesktop: Is targeting on desktop enabled? [deprecated]
  • campaign.deviceTablet: Is targeting on tablet enabled? [deprecated]
  • campaign.deviceMobil: Is targeting on mobile enabled? [deprecated]
  • campaign.deviceOther: Is targeting on other devices enabled? [deprecated]
  • campaign.devicesPriceRatio: Specific ratio of max CPC/CPT for target device
  • campaign.status: campaign status, returns campaign.status and campaign.statusId
  • campaign.statusId: campaign status id
)
}

Response

struct {
int status return code
string statusMessage verbal description of return code
string session Refreshed session
array keywords (
struct {
int cpc (optional) cpc
datetime createDate (optional) create date
datetime deleteDate (optional) delete date
bool deleted (optional) is keyword deleted ?
bool disabled (optional) is keyword disabled?
long id (optional) keyword id
string name (optional) keyword itself
int matchTypeId (optional) keyword's match type
string matchType (optional) keyword's match type id
int maxCpc (optional) maximum cpc for keyword
string status (optional) status
int statusId (optional) status id
string url (optional) keyword url
struct group { (optional)
datetime createDate (optional) create date
bool deleted (optional) is group deleted?
datetime deleteDate (optional) delete date
int id (optional) group id
string name (optional) group name
int maxCpc (optional) maximum cpc for group's targeting
int maxCpcContext (optional) maximum cpc on Context network for group's targeting
int maxCpt (optional) maximum cpt (Cost per Thousand) for group's targeting
}
struct campaign { (optional) keyword's campaign info
int actualClicks (optional) Actual clicks
int adSelectionId (optional) Ad selection method id
string adSelection (optional) Ad selection method
bool automaticLocation (optional) Is automatic location enabled.
int budgetId (optional) Actual budget id
bool context (optional) is it context campaign?
string contextNetwork (optional) Name of targeted context networks
datetime createDate (optional) create date
int defaultBudgetId (optional) Default budget id.
int dayBudget (optional) Day budget
bool deleted (optional) is campaign deleted ?
datetime deleteDate (optional) Deletion date
bool deviceDesktop (optional) Is targeting on desktop enabled? [deprecated]
bool deviceTablet (optional) Is targeting on tablet enabled? [deprecated]
bool deviceMobil (optional) Is targeting on mobile enabled? [deprecated]
bool deviceOther (optional) Is targeting on other devices enabled? [deprecated]
struct devicesPriceRatio { (optional) Specific ratio of max CPC/CPT for target device
int desktop Desktop/Notebook devices
int mobile Smartphones/Mobile devices
int tablet Tablet devices
int other Other devices
}
datetime endDate (optional) Campaign end date
int exhaustedTotalBudget (optional) Exhausted total budget
bool fulltext (optional) is it fulltext campaign?
int id (optional) campaign id
string name (optional) Campaign name
int paymentMethodId (optional) Payment method id
string paymentMethod (optional) Payment method
datetime startDate (optional) Campaign start date
string status (optional) Campaign status
int statusId (optional) Campaign status idint totalBudget
int totalBudget (optional) Total allowed budget for campaign
datetime totalBudgetFrom (optional) Date from which the total money budget is counted
int totalClicks (optional) Total allowed clicks for campaign
datetime totalClicksFrom (optional) Date from which the total click budget is counted
}
}
)
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-2019

www.seznam.cz   Help   Contact