Sklik API

Keywords

keywords.list

List groups keywords.

Parameters

struct user {
string session Session (as retrieved from client.login())
int userId (optional) Managed user ID
}
struct restrictionFilter {
array groupIds (
int Group ID
)
int limit (optional) How many results to return (default no-limited)
int offset (optional) How many results to skip [default: 0]
bool positiveKeywords (optional) Return positive keywords [default: True]
bool negativeKeywords (optional) Return negative keywords [default: True]
bool includeDeleted (optional) Return also deleted keywords [default: False]
}
struct listOptions { (optional)
bool onlyId (optional) Return only id fields in result [default: False]
}

Response

struct {
int status Status code
string statusMessage Status code description
string session Refreshed session
int total How many items is available
array keywords (
struct {
int id Keyword ID
struct group { Info about group
int id Group ID
}
string name Keyword name
string matchType Keyword match type:
  • broad: Broad match; query must contain all words from keyword, in any order
  • phrase: Phrase match ("keyword"); keyword must match query with words in correct order
  • exact: Exact match ([keyword]); keyword must match exactly entire query
  • negativeBroad: Negative broad match (-keyword); query must not contain words from this keyword
  • negativePhrase: Negative phrase match (-"keyword"); query must not contain keyword words in correct order
  • negativeExact: Negative exact match (-[keyword]); query must not exactly match this keyword
bool deleted Whether keyword was removed
string status Keyword status:
  • active: Active
  • suspend: Suspended
bool disabled Whether keyword is disabled (for copyright issues etc.)
int cpc Keyword max cost per click (in halers)
string url Target URL
datetime createDate Keyword create date
}
)
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