Sklik API

Campaigns

campaigns.list

List user campaigns.

If you need to access someone other's account (who allowed you to enter it), pass their userId the user struct.

Parameters

struct user {
string session Session (as retrieved from client.login())
int userId (optional) User ID
}
struct restrictionFilter { (optional)
bool includeDeleted (optional) Return also deleted campaigns in result [default: False]
}

Response

struct {
int status Status code
string statusMessage Status code description
string session Refreshed session
array campaigns (
struct {
int id Campaign ID
string name Campaign name
bool deleted Whether campaign is deleted
string status Campaign status:
  • active: Active
  • suspend: Suspended
int dayBudget Campaign day budget (in halers)
int exhaustedDayBudget How much of the day budget is already exhausted (in halers)
string adSelection Ad selection type:
  • weighted: Weighted ad selection
  • random: Random ad selection
datetime createDate Campaign create date
int totalBudget Campaign total budget (if set; in halers)
int exhaustedTotalBudget If campaign total budget is set, how much of it is exhausted (in halers)
int totalClicks Campaign total clicks
int exhaustedTotalClicks If campaign total clicks is set, how much of them are exhausted
struct premise { Connection to Firmy.cz
int id (can be null) Premise id from Firmy.cz (or nil if not connected)
}
struct targetDevices { Specify target devices
bool desktop Desktop/Notebook devices
bool mobile Smartphones/Mobile devices
bool tablet Tablet devices
bool other Other devices
}
}
)
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-2017

www.seznam.cz   Help   Contact