Sklik API - dokumentace

13.02.2017
Praktická dokumentace k Sklik API pro Google Apps Script s úkázkami kódu.
Popisuje vybrané metody z oficiální Sklik API dokumentace.
Komunikace s JSON Sklik API vychází z této funkce, kterou je potřeba si zkopírovat.
Pokud se naučíte na jednoduchém příkladu základní principy komunikace a čtení dokumentace, pak si napíšete jakýkoliv složitý skript.
Pro úplnost možnosti kde skriptovat a jak jednoduše získat Sklik token.

Client (přihlášení a statistiky na úrovni účtu)

(základem je přihlášení a získání session)

client.login (přihlášení pomocí uživatelského jména a hesla)

var client_login = sklik_api(['username', 'password'], 'client.login');
//(získání session)
var session = client_login.session;

client.loginByToken (přihlášení pomocí tokenu)

var client_login = sklik_api(['token'], 'client.loginByToken');
//(získání session)
var session = client_login.session;

client.get (pokud se přihlašujete pomocí MCC účtu, je třeba získat ještě userId pro konkrétní účet)

var client_get = sklik_api([{'session': session}], 'client.get');
Logger.log(client_get);

(statistiky)

client.stats (impressions, clicks, price, conversions, conversionValue, ...)

var client_stats = sklik_api([{'session': session},
{'dateFrom': '2017-01-01', 'dateTo': '2017-01-01', 'granularity': 'total'}], 'client.stats'
);
var impressions = client_stats.report[0].impressions;

(nakonec je dobré se odhlásit a session ukončit)

client.logout (odhlášení)

var client_logout = sklik_api([{'session': session}], 'client.logout');

ukázkový skript (ke stažení)

Co umí
- skript vytáhne údaje z skliku na úrovni účtu za včerejší den
- vloží je na nový řádek do spreadsheetu

Nasazení
- vytvořte si nový spreadsheet a list v něm pojmenujte: data
- vložte url spreadsheetu do skriptu a ve skriptu nastavte přihlašovácí údaje
- Skript (skript už si můžete libovolně upravovat k obrazu svému)

Historická data
- stejné nasazení jako předchozí "přírůstkový" skript
- na řádku 39 nastavte počet dní zpětně nebo odkomentujte řádek 43 a nadefinujte počáteční datum
- Skript (skript už si můžete libovolně upravovat k obrazu svému)

Campaigns (statistiky na úrovni kampaní)

(v prvním kroku je třeba vytvořit report)

campaigns.createReport

//(je mnoho možností podle čeho filtrovat, všechny najdete v Sklik API dokumentaci)
var campaigns_createReport = sklik_api([{'session': session},
{'statisticsConditions': [{'columnName': 'impressions', 'operator': 'GT', 'intValue': 10}],
'isDeleted': false,
'dateFrom': '2017-01-01',
'dateTo': '2017-01-01'}],
'campaigns.createReport'
);
//(získání report id)
var report_id = campaigns_createReport.reportId;
//(získání počtu výsledků)
var limit = campaigns_createReport.totalCount;

(v druhém kroku si vytvořený report stáhnete)

campaigns.readReport

var campaigns_readReport = sklik_api([{'session': session},
report_id,
{'offset': 0,
'limit': limit, //(pokud je limit větší než 5 000, je třeba postupně stránkovat, řešeno v ukázkovém skriptu)
'allowEmptyStatistics': false,
'displayColumns': ['name', 'clicks', 'impressions', 'totalMoney', 'conversions', 'conversionValue']}],
'campaigns.readReport'
);


ukázkový skript (ke stažení)

Co umí
- skript vytáhne souhrné údaje z skliku na úrovni kampaní za posledních 7 dní, které mají více jak 10 zobrazení
- vloží je do spreadsheetu

Nasazení
- vytvořte si nový spreadsheet a list v něm pojmenujte: data
- vložte url spreadsheetu do skriptu a ve skriptu nastavte přihlašovácí údaje
- Skript (skript už si můžete libovolně upravovat k obrazu svému)

Groups (statistiky na úrovni sestav)

(v prvním kroku je třeba vytvořit report)

groups.createReport

//(je mnoho možností podle čeho filtrovat, všechny najdete v Sklik API dokumentaci)
var groups_createReport = sklik_api([{'session': session},
{'statisticsConditions': [{'columnName': 'impressions', 'operator': 'GT', 'intValue': 10}],
'mixedStatus': ['active'],
'isDeleted': false,
'campaign': {'status': ['active'], 'isDeleted': false},
'dateFrom': '2017-01-01',
'dateTo': '2017-01-01'}],
'groups.createReport'
);
//(získání report id)
var report_id = groups_createReport.reportId;
//(získání počtu výsledků)
var limit = groups_createReport.totalCount;

(v druhém kroku si vytvořený report stáhnete)

groups.readReport

var groups_readReport = sklik_api([{'session': session},
report_id,
{'offset': 0,
'limit': limit, //(pokud je limit větší než 5 000, je třeba postupně stránkovat, řešeno v ukázkovém skriptu)
'allowEmptyStatistics': false,
'displayColumns': ['campaign.name', 'name', 'clicks', 'impressions', 'totalMoney', 'conversions', 'conversionValue']}],
'groups.readReport'
);


ukázkový skript (ke stažení)

Co umí
- skript vytáhne souhrné údaje z skliku na úrovni sestav za posledních 7 dní, které mají více jak 10 zobrazení
- vloží je do spreadsheetu

Nasazení
- vytvořte si nový spreadsheet a list v něm pojmenujte: data
- vložte url spreadsheetu do skriptu a ve skriptu nastavte přihlašovácí údaje
- Skript (skript už si můžete libovolně upravovat k obrazu svému)

Keywords (statistiky na úrovni klíčových slov)

(v prvním kroku je třeba vytvořit report)

keywords.createReport

//(je mnoho možností podle čeho filtrovat, všechny najdete v Sklik API dokumentaci)
var keywords_createReport = sklik_api([{'session': session},
{'statisticsConditions': [{'columnName': 'impressions', 'operator': 'GT', 'intValue': 10}],
'mixedStatus': ['active'],
'isDeleted': false,
'campaign': {'status': ['active'], 'isDeleted': false},
'group': {'status': ['active'], 'isDeleted': false},
'dateFrom': '2017-01-01',
'dateTo': '2017-01-01'}],
'keywords.createReport'
);
//(získání report id)
var report_id = keywords_createReport.reportId;
//(získání počtu výsledků)
var limit = keywords_createReport.totalCount;

(v druhém kroku si vytvořený report stáhnete)

keywords.readReport

var keywords_readReport = sklik_api([{'session': session},
report_id,
{'offset': 0,
'limit': limit, //(pokud je limit větší než 5 000, je třeba postupně stránkovat, řešeno v ukázkovém skriptu)
'allowEmptyStatistics': false,
'displayColumns': ['campaign.name', 'group.name', 'name', 'clicks', 'impressions', 'totalMoney', 'conversions', 'conversionValue']}],
'keywords.readReport'
);


ukázkový skript (ke stažení)

Co umí
- skript vytáhne souhrné údaje z skliku na úrovni klíčových slov za posledních 7 dní, které mají více jak 10 zobrazení
- vloží je do spreadsheetu

Nasazení
- vytvořte si nový spreadsheet a list v něm pojmenujte: data
- vložte url spreadsheetu do skriptu a ve skriptu nastavte přihlašovácí údaje
- Skript (skript už si můžete libovolně upravovat k obrazu svému)