Sklik API

Themes

themes.negative.createReport

Prepare report for themes.

Parameters

struct user {
string session Session (as retrieved from client.login())
int userId (optional) Managed user ID
}
struct restrictionFilter {
array ids ( (optional) display themes by given ids
int theme id
)
bool isDeleted (optional) return deleted/not-deleted. Returns both when not set.
struct categories { (optional) filter only themes with following categories
array ids ( (optional) filter following category ids.
int theme category id
)
}
struct group { (optional) filters for theme's parent group
array ids ( (optional) display themes from following groups (excludes: names)
int group id
)
array names ( (optional) definition of parent group name filter
struct { (optional) condition
string operator comparison for following operators:
  • CONTAINS: contains
  • NOT_CONTAINS: does not contain
  • PHRASE: phrase (contains phrase)
  • NEGATIVE_PHRASE: negative phrase(does not contain phrase)
  • STARTS_WITH: starts with
  • NOT_STARTS_WITH: does not start with
  • ENDS_WITH: ends with
  • NOT_ENDS_WITH: does not end with
string value value
}
)
array mixedStatus ( (optional) return themes with following mixed states of their parent groups:
string states:
  • active: active
  • noactive: suspended by system
  • suspended: suspended by user
  • deleted: deleted
)
array status ( (optional) return themes with following states of their groups:
string states:
  • active: active
  • noactive: suspended by system
  • suspend: suspended by user
)
bool isDeleted (optional) return themes with their parent group deleted/not-deleted.
}
struct campaign { (optional) (optional) filters for theme's parent campaign
array ids ( (optional) display themes from following campaigns (excludes: names)
int campaign id
)
array names ( (optional) definition of parent campaign name filter
struct { (optional) condition
string operator comparison for following operators:
  • CONTAINS: contains
  • NOT_CONTAINS: does not contain
  • PHRASE: phrase (contains phrase)
  • NEGATIVE_PHRASE: negative phrase(does not contain phrase)
  • STARTS_WITH: starts with
  • NOT_STARTS_WITH: does not start with
  • ENDS_WITH: ends with
  • NOT_ENDS_WITH: does not end with
string value value
}
)
array mixedStatus ( (optional) return only themes with following mixed states of their parent campaigns
string allowed states:
  • active: active
  • active-exhausted_day_budget: exhausted day budget
  • active-expired_budget: expired budget
  • active-expired_clicks: max number of clicks has been reached
  • active-expired_time: outside time plan
  • active-low_budget: low budget
  • active-waiting: waiting for confirmation
  • suspended: suspended by user
  • deleted: deleted
)
array status ( (optional) return only themes with following states of their parent campaign:
string states:
  • active: active
  • noactive: suspended by system
  • suspend: suspended by user
)
bool isDeleted (optional) return themes with their parent campaign deleted/not-deleted.
}
}

Response

struct {
int reportId id of report
int status return code
long totalCount number of entities
string statusMessage verbal description of return code
string session Refreshed session
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