Sklik API

Retargeting

retargeting.group.negative.createReport

Create statistic report for retargeting.

Parameters

struct user {
string session Session (as retrieved from client.login())
int userId (optional) Managed user ID
}
struct restrictionFilter {
array ids ( (optional) display retargetings by given ids
int retargeting id
)
bool isDeleted (optional) return deleted/undeleted. If unassigned returns both.
array type ( (optional) return only retargetings with following types:
string types:
  • list: list
  • combination: combination
  • dynamic_list: dynamic list
)
array status ( (optional) return only retargetings with following states:
string states:
  • active: active
  • noactive: suspended by system
  • suspend: suspended by user
)
struct group { (optional) filters for superior group
array ids ( (optional) display insterests from next groups (excludes: names)
int group id
)
array names ( (optional) definition of searching in groups names
struct { (optional) condition
string operator comparison for following operators:
string value value
}
)
array mixedStatus ( (optional) return only insterests with following states of their groups:
string states:
  • active: active
  • noactive: suspended by system
  • suspended: suspended by user
  • deleted: deleted
)
array status ( (optional) return only insterests with following states of their groups:
string states:
  • active: active
  • noactive: suspended by system
  • suspend: suspended by user
)
bool isDeleted (optional) return deleted/undeleted. If unassigned returns both.
}
struct campaign { (optional) filters for superior campaign
array ids ( (optional) display insterests from next campaigns (excludes: names)
int campaign id
)
array names ( (optional) definition of searching in campaign names
struct { (optional) condition
string operator comparison for following operators:
string value value
}
)
array mixedStatus ( (optional) return only insterests with following states of their 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 insterests with following states of their campaigns:
string states:
  • active: active
  • noactive: suspended by system
  • suspend: suspended by user
)
bool isDeleted (optional) return deleted/undeleted. If unassigned returns both.
}
}

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