Sklik API

Productsets

Back to home

Changelog

Usage

Ads

Api

Autotagging

Banners

Campaigns

Client

Conversions

Dynamictemplates

Groups

Images

Intends

Interests

Keywords

Patterns

Productsets

Queries

Retargeting

Sharedbudgets

Sitelinks

Stats

Themes

productSets.createReport

Create statistic report for PIs.

Parameters

struct user {
string session

Session (as retrieved from client.loginByToken())
int userId

(optional) Managed user ID
}
struct restrictionFilter {
array ids (

(optional) display pis by given ids
int

ad id
)
array names (

(optional) definition of searching in producted groups
struct {
string operator

comparison for following operators:
string value

value
}
)
bool isDeleted

(optional) return deleted/undeleted. If unassigned returns both.
array mixedStatus (

(optional) return only keywords with following substates:
string

kexword states:
)
array maxCpc (

(optional) Maximal price per click(Cost Per Click)
struct {
string operator

comparison for following operators:
int value

value
}
)
struct group {

(optional) filters for superior group
array ids (

(optional) display kws from next groups (excludes: names)
int

group id
)
array names (

(optional) definition of searching in groups names
struct {
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 kw 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 ads 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 ads from next campaigns (excludes: names)
int

campaign id
)
array names (

(optional) definition of searching in campaign names
struct {
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 status (

(optional) return only ads with following states of their campaigns:
string

states:

  • active: active
  • noactive: suspended by system
  • suspend: suspended by user
)
array mixedStatus (

(optional) return only ads 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
)
bool isDeleted

(optional) return deleted/undeleted. If unassigned returns both.
}
array statisticsConditions (

(optional) conditions for statistics
struct {
string columnName

(optional) type of statistic:

  • impressions: type int
  • clicks: type int
  • ctr: type double
  • avgCpc: type double
  • avgPosition: type double (1.0 and greater)
  • conversions: type int
  • conversionRatio: type double (range 0.0 – 1.0)
  • conversionPrice: type double
  • conversionValue: type int
  • transactions: type int
  • pno: type double (range 0.0 – 1.0)
  • quality: type int
  • ishExhaustedBudget: type int
  • ishExhaustedBudgetShare: type double (range 0.0 – 1.0)
  • ishStoppedBySchedule: type int
  • ishStoppedByScheduleShare: type double (range 0.0 – 1.0)
  • ishUnderForestThreshold: type int
  • ishUnderForestThresholdShare: type double (range 0.0 – 1.0)
  • ish: type double
string operator

comparison for following operators:

  • EQ: equal
  • NEQ: not equal
  • GT: greater than
  • GTE: greater than or equal
  • LT: less than
  • LTE: less than or equal
int intValue

(optional) value (excludes: doubleValue)
double doubleValue

(optional) value
}
)
datetime dateFrom

date from
datetime dateTo

date to
}
struct displayOptions {

(optional) Determines which information are returned.
bool includeCurrentDayStats

(optional) Return inaccurate current day statistics. Date range has to contain actual date! [default: False] (only for statGranularity in ["daily", "total"])
string statGranularity

(optional) Granularity of statistics: [default: total]

  • total: do not split
  • daily: split by days
  • weekly: split by weeks
  • monthly: split by months
  • quarterly: split by quarters
  • yearly: split by year
bool allowEmptyStatistics

(optional) Return empty statistics [default: false]
string columnName

(optional) column name:
}

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
}

Response status codes:

List of all possible response status codes:

Diagnostics:

List of all possible diagnostics:

Copyright © 1996-2024

www.seznam.cz Help Contact