Sklik API

Groups

groups.list

List groups.

Parameters

struct user {
string session

Session (as retrieved from client.login())

int userId

(optional) Managed user ID

}
struct restrictionFilter {

If no campaigns are selected, then all banners for current user are listed

array ids (

(optional) List these groups

int

Group ID

)
struct campaign {

(optional) Ads will be listed from these campaigns

array ids (

(optional) List groups from campaigns

int

Campaign ID

)
}
bool isDeleted

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

}
struct displayOptions {

Customize output

int offset

offset

int limit

count of items

array displayColumns (

(optional) show following entity attributes

string

column name:

  • createDate: Group's create date
  • deleted: Is group deleted?
  • deleteDate: Group's delete date
  • id: Group's id (default)
  • maxCpc: maximum cpc for group's targeting
  • maxUserDailyImpressions: max impressions per day for ads within this group
  • maxCpt: maximum cpt (Cost per Thousand) for group's targeting
  • name: Group's name (default)
  • sensitivity: group's erotic sensitivity
  • status: status (default)
  • statusId: status id
  • devicesPriceRatio: Specific ratio of max CPC/CPT for target device
  • campaign.actualClicks: Actual clicks for campaign
  • campaign.automaticLocation: Is automatic location enabled.
  • campaign.adSelection: Ad selection method
  • campaign.adSelectionId: Ad selection method id
  • campaign.createDate: Campaign's create date
  • campaign.context: is it context campaign?
  • campaign.contextNetwork: Name of targeted context networks
  • campaign.deleteDate: Campaign's Deletion date
  • campaign.deleted: Is campaign deleted?
  • campaign.deviceDesktop: Is targeting on desktop enabled? [deprecated]
  • campaign.deviceTablet: Is targeting on tablet enabled? [deprecated]
  • campaign.deviceMobil: Is targeting on mobil enabled? [deprecated]
  • campaign.deviceOther: Is targeting on other devices enabled? [deprecated]
  • campaign.devicesPriceRatio: Specific ratio of max CPC/CPT for target device
  • campaign.endDate: Campaign's end date
  • campaign.exhaustedTotalBudget: Exhausted total budget
  • campaign.fulltext: is it fulltext campaign?
  • campaign.id: Campaign's id (default)
  • campaign.name: Campaign's name (default)
  • campaign.paymentMethod: Payment method
  • campaign.paymentMethodId:
  • campaign.startDate: Campaign's start date
  • campaign.status: campaign status, returns campaign.status and campaign.statusId
  • campaign.statusId: campaign status id
  • campaign.totalClicks: Total clicks for campaign
  • campaign.totalBudget: Campaign total budget (if set; in halers)
  • campaign.totalBudgetFrom: Date from which total money budget is counting.
  • campaign.totalClicksFrom: Date from which total click budget is counting.
)
}

Response

struct {
int status

return code

string statusMessage

verbal description of return code

string session

Refreshed session

array groups (
struct {
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 maxUserDailyImpressions

(optional) max impressions per day for ads within this group

int maxCpc

(optional) maximum cpc for group's targeting

int maxCpt

(optional) maximum cpt (Cost per Thousand) for group's targeting

string sensitivity

(optional) group's erotic sensitivity

string status

(optional) group's status

int statusId

(optional) status id

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

}
struct campaign {

(optional) keyword's campaign info

int actualClicks

(optional) Actual clicks

string adSelection

(optional) Ad selection method

int adSelectionId

(optional) Ad selection method id

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 dayBudget

(optional) Day budget

int defaultBudgetId

(optional) Default budget id.

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

int statusId

(optional) campaign status id

string status

(optional) campaign status

int totalBudget

(optional) Total allowed budget for campaign

datetime totalBudgetFrom

(optional) Date from which total money budget is counting.

int totalClicks

(optional) Total allowed clicks for campaign

datetime totalClicksFrom

(optional) Date from which total click budget is counting.

}
}
)
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-2020

www.seznam.cz Help Contact