Sklik skript pro kontrolu chybových stránek

Nasazení skriptu. Pro nasazení je nutné získat přístup k naší knihovně komunikující s Sklik API, vyplňte formulář zde a my Vám dáme přístup.

Formulář zde

Skript slouží ke kontrole a a reportu chybových stránek v rámci všech Vašich účtů na Skliku.

Jak funguje

Skript načte při prvním načtení seznam Vašich účtů na Skliku na Váš vložený dokument.
Je dobré nechat maximálně 10 účtů pro kontrolu. Smažte tedy účtu ze sešitu, které nechcete kontrolovat.
Následně skript projde všechny aktivní reklamy, vezme URL adresy a zkontroluje jejich odezvu.
V případě problémů zapíše do reportu v jakých sestavách figurují chybové URL adresy.
V případě chybových URL pošle email správci s upozorněním, že inzerujete na chybovou stránku.

Zdrojový kód skriptu

/** ID of spreadsheet to use. Fill-in either ID or URL. */
var SPREADSHEET_ID = '';
/** URL of spreadsheet to use. Fill-in either ID or URL. */
var SPREADSHEET_URL = '';
/** Fetch only ads in active campaigns? Set to false if you have a large campaigns with almost everything active. */
var ACTIVE_ONLY = true;
/** Number of URL's to check at once. */
var URL_CHECK_BATCH_SIZE = 100;


/**
 * Script entry-point.
 */
function main() {
  var spreadsheet;
  if (SPREADSHEET_ID) {
    spreadsheet = SpreadsheetApp.openById(SPREADSHEET_ID);
  }
  else {
    spreadsheet = SpreadsheetApp.openByUrl(SPREADSHEET_URL);
  }
  var sklik = SklikAPI.Connect();
  sklik.loginFromProperties();
  var locale = Session.getActiveUserLocale();
  spreadsheet.setSpreadsheetLocale(locale);
  var accountToCheckSheet = lynt_create_or_get_sheet(spreadsheet, "Účty ke kontrole");
  var accounts = getAccountsToCheck(accountToCheckSheet);
  if (accounts.length > 0) {
    var results = {};
    for (var i = 0; i < accounts.length; i++) {
      var result = checkUrlsForAccount(sklik, accounts[i], spreadsheet);
      results[accounts[i].username] = result;
      Logger.log(result);
    }
    var historySheet = lynt_create_or_get_sheet(spreadsheet, "Přehled");
    spreadsheet.setActiveSheet(historySheet);
    spreadsheet.moveActiveSheet(1);
    writeHistory(historySheet, results);
  }
  else {
    var clientInfo = sklik.Client.get();
    var allAccountList = [["ID", "E-mail"]];
    for (var i = 0; i < clientInfo.foreignAccounts.length; i++) {
      allAccountList.push([
                clientInfo.foreignAccounts[i].userId,
                clientInfo.foreignAccounts[i].username
            ]);
    }
    accountToCheckSheet.clear();
    var range = accountToCheckSheet.getRange(1, 1, allAccountList.length, allAccountList[0].length);
    range.setValues(allAccountList);
    range.offset(0, 0, 1, 2).setFontWeight("bold");
    Logger.log("Na list Účty ke kontrole byl zapsán seznam všech účtů. Odstraňte ty, které si nepřejete kontrolovat, a spustťe skript znovu.");
  }
  sklik.Client.logout();
  lynt_remove_empty_sheets(spreadsheet);
}


/**
 * Gets the today date.
 * @returns {string}
 */
function getToday() {
  var date = new Date();
  date.toDateString();
  return date.toLocaleDateString();
}


/**
 * Gets the list of accounts specified for checking.
 */
function getAccountsToCheck(sheet) {
  var lastRow = sheet.getLastRow();
  var lastCol = sheet.getLastColumn();
  if (lastRow > 1 && lastCol >= 2) {
    var accounts = [];
    var range = sheet.getRange(1, 1, lastRow, lastCol);
    var data = range.getValues();
    for (var row = 1; row < data.length; row++) {
      accounts.push({
        userId: data[row][0],
        username: data[row][1]
      });
    }
    return accounts;
  }
  else {
    return [];
  }
}


/**
 * Checks URL addresses for all adverts in the given account and creates a new report on separate sheet.
 */
function checkUrlsForAccount(sklik, accountInfo, spreadsheet) {
  if (accountInfo) {
    sklik.setUserId(accountInfo.userId);
  }
  var ads = [];
  if (ACTIVE_ONLY) {
    ads = [];
    var campaignIds = [];
    var campaigns = sklik.Campaigns.list({}, ['name', 'deleted', 'dayBudget', 'exhaustedDayBudget', 'adSelection', 'createDate', 'totalBudget', 'exhaustedTotalBudget', 'exhaustedTotalClicks', 'premise ', 'targetDevices']).campaigns;
    for (var i = 0; i < campaigns.length; i++) {
      if (campaigns[i].status == 'active') {
        campaignIds.push(campaigns[i].id);
      }
    }
    var groupIds = [];
    var batchSize = 100;
    for (var offset = 0; offset < campaignIds.length; offset += batchSize) {
      var groups = sklik.Groups.list({
        campaignIds: campaignIds.slice(offset, offset + batchSize)
      }, ['deleted', 'campaign', 'cpc', 'cpcContext', 'cpt', 'createDate', 'maxUserDailyImpression']).groups;
      for (var i = 0; i < groups.length; i++) {
        if (groups[i].status == 'active') {
          groupIds.push(groups[i].id);
        }
      }
    }
    for (var offset = 0; offset < groupIds.length; offset += batchSize) {
      var adsBatch = sklik.Ads.list({
        groupIds: groupIds.slice(offset, offset + batchSize)
      }, {
        showId: true,
        showCreative1: true,
        showCreative2: false,
        showCreative3: false,
        showClickthruUrl: true,
        showClickthruText: false,
        showStatus: true,
        showStatusId: true,
        showSensitivity: false,
        showSensitivityId: false,
        showDeleted: false,
        showDeletedDate: false,
        showCreateDate: false,
        showPremiseMode: false,
        showPremiseId: false,
        showGroupId: true,
        showGroupName: true,
        showCampaignId: true,
        showCampaignName: true
      }).ads;
      ads = ads.concat(adsBatch);
    }
  }
  else {
    // Get all ads.
    ads = sklik.Ads.list({}, {
      showId: true,
      showCreative1: true,
      showCreative2: false,
      showCreative3: false,
      showClickthruUrl: true,
      showClickthruText: false,
      showStatus: true,
      showStatusId: true,
      showSensitivity: false,
      showSensitivityId: false,
      showDeleted: false,
      showDeletedDate: false,
      showCreateDate: false,
      showPremiseMode: false,
      showPremiseId: false,
      showGroupId: true,
      showGroupName: true,
      showCampaignId: true,
      showCampaignName: true
    }).ads;
  }
  // Iterate all ads and extract all unique URLs.
  var urls = {};
  for (var i = 0; i < ads.length; i++) {
    var ad = ads[i];
    if (ad.status == 'active') {
      var url = stripUtmFromUrl(ad.clickthruUrl);
      if (urls[url] != undefined) {
        urls[url].ads.push(ad);
      }
      else {
        urls[url] = {
          url: url,
          responseCode: null,
          ads: [ad]
        };
      }
    }
  }
  // Sends the extracted URLs to the specified gateway.
  // Prepare the list as a simple array.
  var urlsToCheck = [];
  for (var url in urls) {
    if (!urls.hasOwnProperty(url)) {
      continue;
    }
    urlsToCheck.push(url);
  }
  var bulkSize = URL_CHECK_BATCH_SIZE;
  for (var offset = 0; offset < urlsToCheck.length; offset += bulkSize) {
    var responseList = sklik.connector.urlCheck(urlsToCheck.slice(offset, offset + bulkSize));
    // Process the response and set the HTTP codes for each URL.
    for (var url in responseList) {
      if (!responseList.hasOwnProperty(url)) {
        continue;
      }
      urls[url].responseCode = responseList[url];
    }
  }
  // Convert the URL object (used for deduplication) to array.
  // Additionally, count the invalid URLs.
  var urlArray = [];
  var invalidUrlCount = 0;
  var redirectCount = 0;
  for (var url in urls) {
    if (urls.hasOwnProperty(url)) {
      urlArray.push(urls[url]);
      if (!isNumeric(urls[url].responseCode) || urls[url].responseCode >= 400) {
        invalidUrlCount++;
      }
      else if (urls[url].responseCode >= 300) {
        redirectCount++;
      }
    }
  }
  // Sort the URLs by response code.
  urlArray.sort(function(lhs, rhs) {
    var lnum = isNumeric(lhs.responseCode);
    var rnum = isNumeric(rhs.responseCode);
    if (lnum && rnum) {
      return rhs.responseCode - lhs.responseCode;
    }
    else if (lnum) {
      return -1;
    }
    else if (rnum) {
      return 1;
    }
    else {
      return 0;
    }
  });
  // Write the report.
  var sheet = lynt_create_or_get_sheet(spreadsheet, accountInfo.username);
  writeUrlReport(sheet, urlArray);
  if (accountInfo) {
    sklik.setUserId(null);
  }
  return {
    errors: invalidUrlCount,
    redirects: redirectCount
  };
}


/**
 * Writes the URL checking history.
 */
function writeHistory(historySheet, results) {
  var lastRow = historySheet.getLastRow();
  var lastCol = historySheet.getLastColumn();
  var data;
  if (lastRow > 0 && lastCol > 0) {
    var historyRange = historySheet.getRange(1, 1, lastRow, lastCol);
    data = historyRange.getValues();
  }
  else {
    data = [];
  }
  var today = getToday();
  if (data.length > 0) {
    data[0].splice(1, 0, today);
  }
  else {
    data.push(["Účet [chyby/přesměrování]", today]);
  }
  for (var row = 1; row < data.length; row++) {
    var account = data[row][0];
    if (results[account]) {
      data[row].splice(1, 0, results[account].errors + "/" + results[account].redirects);
      delete results[account];
    }
    else {
      data[row].splice(1, 0, "");
    }
  }
  for (var account in results) {
    if (results.hasOwnProperty(account)) {
      var newRow = new Array(data[0].length);
      newRow[0] = account;
      newRow[1] = results[account].errors + "/" + results[account].redirects;
      for (var i = 2; i < newRow.length; i++) {
        newRow[i] = "";
      }
      data.push(newRow);
    }
  }
  historySheet.clear();
  var outRange = historySheet.getRange(1, 1, data.length, data[0].length);
  outRange.setValues(data);
  outRange.setBorder(true, true, true, true, false, false);
  if (data.length > 1) {
    var colors = new Array(data.length - 1);
    for (var row = 1; row < data.length; row++) {
      colors[row - 1] = new Array(data[0].length - 1);
      for (var col = 1; col < data[0].length; col++) {
        var color = null;
        if (typeof(data[row][col]) == "string") {
          var value = data[row][col].split('/');
          if (value.length == 2) {
            if (parseInt(value[0], 10) > 0) {
              color = '#FF0000';
            }
            else if (parseInt(value[1], 10) > 0) {
              color = '#FFCC00';
            }
            else {
              color = '#80FF80';
            }
          }
        }
        else {
          color = '#FFFFFF';
        }
        colors[row - 1][col - 1] = color;
      }
    }
    outRange.offset(1, 1, data.length - 1, data[0].length - 1).setBackgrounds(colors);
  }
  outRange.offset(0, 0, 1, data[0].length).setFontWeight('bold').setBorder(true, true, true, true, null, null);
  outRange.offset(0, 0, data.length, 1).setFontWeight('bold').setBorder(true, true, true, true, null, null);
  for (var i = 1; i <= data[0].length; i++) {
    historySheet.autoResizeColumn(i);
  }
}


/**
 * Strips UTM parameters from the given URL. This function also removes the fragment part of the URL.
 */
function stripUtmFromUrl(url) {
  var match, search = /([^&=]+)=?([^&]*)/g,
    query;
  var hashPos = url.indexOf('#');
  if (hashPos === -1) {
    hashPos = url.length;
  }
  var queryPos = url.indexOf('?');
  if (queryPos === -1) {
    return url.substr(0, hashPos);
  }
  query = url.substring(queryPos + 1, hashPos);
  var newQueryParts = [];
  while (match = search.exec(query)) {
    if (match[1].substr(0, 4) != 'utm_') {
      newQueryParts.push(match[0]);
    }
  }
  if (newQueryParts.length > 0) {
    var newQuery = newQueryParts.join('&');
    return url.substr(0, queryPos + 1) + newQuery;
  }
  else {
    return url.substr(0, queryPos);
  }
}


/**
 * Checks if the given string is a number.
 * @param n String possibly containing a number.
 * @returns `true` if the given string contains a number (and nothing else than number).
 */
function isNumeric(n) {
  return !isNaN(parseFloat(n)) && isFinite(n);
}


/**
 * Writes URL report.
 */
function writeUrlReport(sheet, urls) {
  sheet.clear();
  var lastEmptyRow = sheet.getMaxRows();
  if (lastEmptyRow > 2) {
    sheet.deleteRows(3, lastEmptyRow - 2);
  }
  var overviewLen = createUrlOverview(sheet, 1, urls);
  var offset = overviewLen + 2;
  for (var i = 0; i < urls.length; i++) {
    if (urls[i].responseCode == 200) {
      continue;
    }
    var detailLen = createUrlAdsDetail(sheet, offset, urls[i]);
    offset += detailLen + 2;
  }
  for (var i = 1; i <= 4; i++) {
    sheet.autoResizeColumn(i);
  }
}


/**
 * Creates URL overview table.
 */
function createUrlOverview(sheet, offset, urls) {
  var rows = new Array(urls.length + 2);
  rows[0] = ["Přehled odkazovaných URL z inzerátů", ""];
  rows[1] = ["URL adresa", "Stavový kód"];
  var colors = [];
  var rowN = 2;
  var code;
  for (var i = 0; i < urls.length; i++) {
    code = urls[i].responseCode;
    rows[rowN] = [urls[i].url, formatResponseCode(code)];
    colors.push([getResponseColor(code)]);
    rowN++;
  }
  sheet.insertRows(offset, rows.length + 2);
  var range = sheet.getRange(offset, 1, rows.length, rows[0].length);
  range.setValues(rows);
  range.setBorder(true, true, true, true, false, false);
  if (urls.length > 0) {
    range.offset(2, 1, urls.length, 1).setBackgrounds(colors);
  }
  range.offset(0, 0, 2, 2).setFontWeight('bold').setBorder(true, true, true, true, false, true);
  return rows.length;
}
var httpStatusCodes = {
  "100": "100 Continue",
  "101": "101 Switching Protocols",
  "200": "200 OK",
  "201": "201 Created",
  "202": "202 Accepted",
  "203": "203 Non-Authoritative Information",
  "204": "204 No Content",
  "205": "205 Reset Content",
  "206": "206 Partial Content",
  "300": "300 Multiple Choices",
  "301": "301 Moved Permanently",
  "302": "302 Found",
  "303": "303 See Other",
  "304": "304 Not Modified",
  "305": "305 Use Proxy",
  "307": "307 Temporary Redirect",
  "400": "400 Bad Request",
  "401": "401 Unauthorized",
  "402": "402 Payment Required",
  "403": "403 Forbidden",
  "404": "404 Not Found",
  "405": "405 Method Not Allowed",
  "406": "406 Not Acceptable",
  "407": "407 Proxy Authentication Required",
  "408": "408 Request Timeout",
  "409": "409 Conflict",
  "410": "410 Gone",
  "411": "411 Length Required",
  "412": "412 Precondition Failed",
  "413": "413 Request Entity Too Large",
  "414": "414 Request-URI Too Long",
  "415": "415 Unsupported Media Type",
  "416": "416 Requested Range Not Satisfiable",
  "417": "417 Expectation Failed",
  "500": "500 Internal Server Error",
  "501": "501 Not Implemented",
  "502": "502 Bad Gateway",
  "503": "503 Service Unavailable",
  "504": "504 Gateway Timeout",
  "505": "505 HTTP Version Not Supported"
};


/**
 * Gets the response code with human-friendly description (if available).
 */
function formatResponseCode(code) {
  if (httpStatusCodes[code]) {
    return httpStatusCodes[code];
  }
  else {
    return code;
  }
}


/**
 * Gets the color for coloring the response code.
 */
function getResponseColor(code) {
  var numeric = isNumeric(code);
  var codeNum = parseInt(code, 10);
  if (numeric && codeNum < 300) {
    return '#80FF80';
  }
  else if (numeric && codeNum >= 300 && codeNum < 400) {
    return '#FFCC00';
  }
  else {
    return '#FF0000';
  }
}


/**
 * Creates ad details for the given URL.
 */
function createUrlAdsDetail(sheet, offset, url) {
  var rows = new Array(url.ads.length + 2);
  rows[0] = [url.url, formatResponseCode(url.responseCode), "", ""];
  rows[1] = ["Kampaň", "Sestava", "Inzerát", "URL"];
  var rowN = 2;
  for (var i = 0; i < url.ads.length; i++) {
    var ad = url.ads[i];
    rows[rowN] = [
            ad.campaign.name,
            ad.group.name,
            ad.creative1,
            formatAdvertUrl(ad)
        ];
    rowN++;
  }
  sheet.insertRows(offset, rows.length + 2);
  var range = sheet.getRange(offset, 1, rows.length, rows[0].length);
  range.setBorder(true, true, true, true, false, false);
  range.setValues(rows);
  range.offset(0, 0, 1, 2).setFontSize(14);
  range.offset(0, 1, 1, 1).setBackground(getResponseColor(url.responseCode));
  range.offset(0, 0, 2, 4).setFontWeight('bold').setBorder(true, true, true, true, false, true);
  return rows.length;
}


/**
 * Gets URL for editing the given advert.
 */
function formatAdvertUrl(advert) {
  return 'https://www.sklik.cz/detail-inzeratu?id=' + advert.id + '&referrerPage=group&returnUrl=%2Fcampaigns%2F' + advert.campaign.id + '%2Fgroups%2F' + advert.group.id + '%2Fadverts';
}


/**
 * Gets the day specified number of days before today.
 *
 * This function correctly transforms between normal time and DST.
 */
function lynt_get_date(daysBack) {
  var past = new Date();
  past.setHours(0);
  past.setMinutes(0);
  past.setSeconds(0);
  past.setMilliseconds(0);
  var originalOffset = past.getTimezoneOffset();
  var pastTime = past.getTime() - daysBack * 86400 * 1000;
  past.setTime(pastTime);
  var newOffset = past.getTimezoneOffset();
  var offsetDiff = newOffset - originalOffset;
  if (offsetDiff != 0) {
    pastTime += offsetDiff * 60 * 1000;
    past.setTime(pastTime);
  }
  return past;
}


/**
 * Gets the last sunday.
 */
function lynt_get_suday() {
  var dayOffset = new Date().getDay();
  return lynt_get_date(dayOffset);
}


/**
 * Gets the date specified number of days before the last sunday.
 */
function lynt_get_xdays_back_from_sunday(pocet_dni) {
  var dayOffset = new Date().getDay();
  return lynt_get_date(dayOffset + pocet_dni);
}


/**
 * Adds specified number of milliseconds to the specified date.
 *
 * This function correctly transforms between normal time and DST.
 */
function lynt_date_add(date, miliseconds) {
  var newTime = date.getTime() + miliseconds;
  var newDate = new Date(newTime);
  var offsetDiff = newDate.getTimezoneOffset() - date.getTimezoneOffset();
  if (offsetDiff != 0) {
    newTime += offsetDiff * 60 * 1000;
    newDate.setTime(newTime);
  }
  return newDate;
}


var SortOrder;
(function(SortOrder) {
  SortOrder[SortOrder["ASC"] = 0] = "ASC";
  SortOrder[SortOrder["DESC"] = 1] = "DESC";
})(SortOrder || (SortOrder = {}));


/**
 * Creates or opens specified sheet in spreadsheet.
 */
function lynt_create_or_get_sheet(spreadsheet, name, position) {
  var sheet = spreadsheet.getSheetByName(name);
  if (sheet == null) {
    sheet = spreadsheet.insertSheet(name, position);
  }
  return sheet;
}

function lynt_remove_empty_sheets(spreadsheet) {
  var sheets = spreadsheet.getSheets();
  for (var i = 0; i < sheets.length; i++) {
    if (sheets[i].getLastRow() == 0) {
      spreadsheet.deleteSheet(sheets[i]);
    }
  }
}

function lynt_highlight_range(range, higlightingRules) {
  var rows = range.getNumRows();
  var cols = range.getNumColumns();
  var values = range.getValues();
  var backgrounds = new Array(rows);
  var value, color;
  for (var r = 0; r < rows; r++) {
    backgrounds[r] = new Array(cols);
    for (var c = 0; c < cols; c++) {
      color = '#FFFFFF';
      value = values[r][c];
      if (typeof(value) == 'number') {
        for (var ri = 1; ri < higlightingRules.length; ri++) {
          if (value <= higlightingRules[ri].value) {
            color = lynt_color_to_hex(lynt_get_color_from_range(value, higlightingRules[ri - 1], higlightingRules[ri]));
            break;
          }
        }
      }
      backgrounds[r][c] = color;
    }
  }
  range.setBackgrounds(backgrounds);
}


/**
 * Computes color from the given range.
 */
function lynt_get_color_from_range(value, upper, lower) {
  var ratio = (value - lower.value) / (upper.value - lower.value);
  return {
    r: lower.color.r + ratio * (upper.color.r - lower.color.r),
    g: lower.color.g + ratio * (upper.color.g - lower.color.g),
    b: lower.color.b + ratio * (upper.color.b - lower.color.b),
  };
}

function lynt_color_to_hex(color) {
  var rHex = Math.round(color.r).toString(16);
  var gHex = Math.round(color.g).toString(16);
  var bHex = Math.round(color.b).toString(16);
  if (rHex.length < 2) {
    rHex = '0' + rHex;
  }
  if (gHex.length < 2) {
    gHex = '0' + gHex;
  }
  if (bHex.length < 2) {
    bHex = '0' + bHex;
  }
  return '#' + rHex + gHex + bHex;
}


function lynt_store_save(dataFolderName, fileName, object) {
  var objectJson = JSON.stringify(object);
  var dataFolder = lynt_get_data_folder(dataFolderName);
  var files = dataFolder.getFilesByName(fileName);
  var dataFile;
  if (files.hasNext()) {
    dataFile = files.next();
    dataFile.setContent(objectJson);
  }
  else {
    dataFolder.createFile(fileName, objectJson, "application/json");
  }
  return true;
}

function lynt_store_load(dataFolderName, fileName) {
  var dataFolder = lynt_get_data_folder(dataFolderName);
  var files = dataFolder.getFilesByName(fileName);
  var dataFile;
  if (files.hasNext()) {
    dataFile = files.next();
  }
  if (dataFile) {
    var objectJson = dataFile.getBlob().getDataAsString("UTF-8");
    return JSON.parse(objectJson);
  }
  else {
    return null;
  }
}

function lynt_get_data_folder(dataFolderName) {
  var root = DriveApp.getRootFolder();
  var folders = root.getFoldersByName(dataFolderName);
  var dataFolder;
  if (folders.hasNext()) {
    dataFolder = folders.next();
  }
  else {
    dataFolder = root.createFolder(dataFolderName);
  }
  return dataFolder;
}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

/** ID of spreadsheet to use. Fill-in either ID or URL. */

var SPREADSHEET_ID = '';

/** URL of spreadsheet to use. Fill-in either ID or URL. */

var SPREADSHEET_URL = '';

/** Fetch only ads in active campaigns? Set to false if you have a large campaigns with almost everything active. */

var ACTIVE_ONLY = true;

/** Number of URL's to check at once. */

var URL_CHECK_BATCH_SIZE = 100;

/**

* Script entry-point.

function main() {

var spreadsheet;

if (SPREADSHEET_ID) {

spreadsheet = SpreadsheetApp.openById(SPREADSHEET_ID);

}

else {

spreadsheet = SpreadsheetApp.openByUrl(SPREADSHEET_URL);

}

var sklik = SklikAPI.Connect();

sklik.loginFromProperties();

var locale = Session.getActiveUserLocale();

spreadsheet.setSpreadsheetLocale(locale);

var accountToCheckSheet = lynt_create_or_get_sheet(spreadsheet, "Účty ke kontrole");

var accounts = getAccountsToCheck(accountToCheckSheet);

if (accounts.length > 0) {

var results = {};

for (var i = 0; i < accounts.length; i++) {

var result = checkUrlsForAccount(sklik, accounts[i], spreadsheet);

results[accounts[i].username] = result;

Logger.log(result);

}

var historySheet = lynt_create_or_get_sheet(spreadsheet, "Přehled");

spreadsheet.setActiveSheet(historySheet);

spreadsheet.moveActiveSheet(1);

writeHistory(historySheet, results);

}

else {

var clientInfo = sklik.Client.get();

var allAccountList = [["ID", "E-mail"]];

for (var i = 0; i < clientInfo.foreignAccounts.length; i++) {

allAccountList.push([

clientInfo.foreignAccounts[i].userId,

clientInfo.foreignAccounts[i].username

]);

}

accountToCheckSheet.clear();

var range = accountToCheckSheet.getRange(1, 1, allAccountList.length, allAccountList[0].length);

range.setValues(allAccountList);

range.offset(0, 0, 1, 2).setFontWeight("bold");

Logger.log("Na list Účty ke kontrole byl zapsán seznam všech účtů. Odstraňte ty, které si nepřejete kontrolovat, a spustťe skript znovu.");

}

sklik.Client.logout();

lynt_remove_empty_sheets(spreadsheet);

}

/**

* Gets the today date.

* @returns {string}

function getToday() {

var date = new Date();

date.toDateString();

return date.toLocaleDateString();

}

/**

* Gets the list of accounts specified for checking.

function getAccountsToCheck(sheet) {

var lastRow = sheet.getLastRow();

var lastCol = sheet.getLastColumn();

if (lastRow > 1 && lastCol >= 2) {

var accounts = [];

var range = sheet.getRange(1, 1, lastRow, lastCol);

var data = range.getValues();

for (var row = 1; row < data.length; row++) {

accounts.push({

userId: data[row][0],

username: data[row][1]

});

}

return accounts;

}

else {

return [];

}

/**

* Checks URL addresses for all adverts in the given account and creates a new report on separate sheet.

function checkUrlsForAccount(sklik, accountInfo, spreadsheet) {

if (accountInfo) {

sklik.setUserId(accountInfo.userId);

}

var ads = [];

if (ACTIVE_ONLY) {

ads = [];

var campaignIds = [];

var campaigns = sklik.Campaigns.list({}, ['name', 'deleted', 'dayBudget', 'exhaustedDayBudget', 'adSelection', 'createDate', 'totalBudget', 'exhaustedTotalBudget', 'exhaustedTotalClicks', 'premise ', 'targetDevices']).campaigns;

for (var i = 0; i < campaigns.length; i++) {

if (campaigns[i].status == 'active') {

campaignIds.push(campaigns[i].id);

}

var groupIds = [];

var batchSize = 100;

for (var offset = 0; offset < campaignIds.length; offset += batchSize) {

var groups = sklik.Groups.list({

campaignIds: campaignIds.slice(offset, offset + batchSize)

}, ['deleted', 'campaign', 'cpc', 'cpcContext', 'cpt', 'createDate', 'maxUserDailyImpression']).groups;

for (var i = 0; i < groups.length; i++) {

if (groups[i].status == 'active') {

groupIds.push(groups[i].id);

}

for (var offset = 0; offset < groupIds.length; offset += batchSize) {

var adsBatch = sklik.Ads.list({

groupIds: groupIds.slice(offset, offset + batchSize)

}, {

showId: true,

showCreative1: true,

showCreative2: false,

showCreative3: false,

showClickthruUrl: true,

showClickthruText: false,

showStatus: true,

showStatusId: true,

showSensitivity: false,

showSensitivityId: false,

showDeleted: false,

showDeletedDate: false,

showCreateDate: false,

showPremiseMode: false,

showPremiseId: false,

showGroupId: true,

showGroupName: true,

showCampaignId: true,

showCampaignName: true

}).ads;

ads = ads.concat(adsBatch);

}

else {

// Get all ads.

ads = sklik.Ads.list({}, {

showId: true,

showCreative1: true,

showCreative2: false,

showCreative3: false,

showClickthruUrl: true,

showClickthruText: false,

showStatus: true,

showStatusId: true,

showSensitivity: false,

showSensitivityId: false,

showDeleted: false,

showDeletedDate: false,

showCreateDate: false,

showPremiseMode: false,

showPremiseId: false,

showGroupId: true,

showGroupName: true,

showCampaignId: true,

showCampaignName: true

}).ads;

}

// Iterate all ads and extract all unique URLs.

var urls = {};

for (var i = 0; i < ads.length; i++) {

var ad = ads[i];

if (ad.status == 'active') {

var url = stripUtmFromUrl(ad.clickthruUrl);

if (urls[url] != undefined) {

urls[url].ads.push(ad);

}

else {

urls[url] = {

url: url,

responseCode: null,

ads: [ad]

};

}

// Sends the extracted URLs to the specified gateway.

// Prepare the list as a simple array.

var urlsToCheck = [];

for (var url in urls) {

if (!urls.hasOwnProperty(url)) {

continue;

}

urlsToCheck.push(url);

}

var bulkSize = URL_CHECK_BATCH_SIZE;

for (var offset = 0; offset < urlsToCheck.length; offset += bulkSize) {

var responseList = sklik.connector.urlCheck(urlsToCheck.slice(offset, offset + bulkSize));

// Process the response and set the HTTP codes for each URL.

for (var url in responseList) {

if (!responseList.hasOwnProperty(url)) {

continue;

}

urls[url].responseCode = responseList[url];

}

// Convert the URL object (used for deduplication) to array.

// Additionally, count the invalid URLs.

var urlArray = [];

var invalidUrlCount = 0;

var redirectCount = 0;

for (var url in urls) {

if (urls.hasOwnProperty(url)) {

urlArray.push(urls[url]);

if (!isNumeric(urls[url].responseCode) || urls[url].responseCode >= 400) {

invalidUrlCount++;

}

else if (urls[url].responseCode >= 300) {

redirectCount++;

}

// Sort the URLs by response code.

urlArray.sort(function(lhs, rhs) {

var lnum = isNumeric(lhs.responseCode);

var rnum = isNumeric(rhs.responseCode);

if (lnum && rnum) {

return rhs.responseCode - lhs.responseCode;

}

else if (lnum) {

return -1;

}

else if (rnum) {

return 1;

}

else {

return 0;

}

});

// Write the report.

var sheet = lynt_create_or_get_sheet(spreadsheet, accountInfo.username);

writeUrlReport(sheet, urlArray);

if (accountInfo) {

sklik.setUserId(null);

}

return {

errors: invalidUrlCount,

redirects: redirectCount

};

}

/**

* Writes the URL checking history.

function writeHistory(historySheet, results) {

var lastRow = historySheet.getLastRow();

var lastCol = historySheet.getLastColumn();

var data;

if (lastRow > 0 && lastCol > 0) {

var historyRange = historySheet.getRange(1, 1, lastRow, lastCol);

data = historyRange.getValues();

}

else {

data = [];

}

var today = getToday();

if (data.length > 0) {

data[0].splice(1, 0, today);

}

else {

data.push(["Účet [chyby/přesměrování]", today]);

}

for (var row = 1; row < data.length; row++) {

var account = data[row][0];

if (results[account]) {

data[row].splice(1, 0, results[account].errors + "/" + results[account].redirects);

delete results[account];

}

else {

data[row].splice(1, 0, "");

}

for (var account in results) {

if (results.hasOwnProperty(account)) {

var newRow = new Array(data[0].length);

newRow[0] = account;

newRow[1] = results[account].errors + "/" + results[account].redirects;

for (var i = 2; i < newRow.length; i++) {

newRow[i] = "";

}

data.push(newRow);

}

historySheet.clear();

var outRange = historySheet.getRange(1, 1, data.length, data[0].length);

outRange.setValues(data);

outRange.setBorder(true, true, true, true, false, false);

if (data.length > 1) {

var colors = new Array(data.length - 1);

for (var row = 1; row < data.length; row++) {

colors[row - 1] = new Array(data[0].length - 1);

for (var col = 1; col < data[0].length; col++) {

var color = null;

if (typeof(data[row][col]) == "string") {

var value = data[row][col].split('/');

if (value.length == 2) {

if (parseInt(value[0], 10) > 0) {

color = '#FF0000';

}

else if (parseInt(value[1], 10) > 0) {

color = '#FFCC00';

}

else {

color = '#80FF80';

}

else {

color = '#FFFFFF';

}

colors[row - 1][col - 1] = color;

}

outRange.offset(1, 1, data.length - 1, data[0].length - 1).setBackgrounds(colors);

}

outRange.offset(0, 0, 1, data[0].length).setFontWeight('bold').setBorder(true, true, true, true, null, null);

outRange.offset(0, 0, data.length, 1).setFontWeight('bold').setBorder(true, true, true, true, null, null);

for (var i = 1; i <= data[0].length; i++) {

historySheet.autoResizeColumn(i);

}

/**

* Strips UTM parameters from the given URL. This function also removes the fragment part of the URL.

function stripUtmFromUrl(url) {

var match, search = /([^&=]+)=?([^&]*)/g,

query;

var hashPos = url.indexOf('#');

if (hashPos === -1) {

hashPos = url.length;

}

var queryPos = url.indexOf('?');

if (queryPos === -1) {

return url.substr(0, hashPos);

}

query = url.substring(queryPos + 1, hashPos);

var newQueryParts = [];

while (match = search.exec(query)) {

if (match[1].substr(0, 4) != 'utm_') {

newQueryParts.push(match[0]);

}

if (newQueryParts.length > 0) {

var newQuery = newQueryParts.join('&');

return url.substr(0, queryPos + 1) + newQuery;

}

else {

return url.substr(0, queryPos);

}

/**

* Checks if the given string is a number.

* @param n String possibly containing a number.

* @returns `true` if the given string contains a number (and nothing else than number).

function isNumeric(n) {

return !isNaN(parseFloat(n)) && isFinite(n);

}

/**

* Writes URL report.

function writeUrlReport(sheet, urls) {

sheet.clear();

var lastEmptyRow = sheet.getMaxRows();

if (lastEmptyRow > 2) {

sheet.deleteRows(3, lastEmptyRow - 2);

}

var overviewLen = createUrlOverview(sheet, 1, urls);

var offset = overviewLen + 2;

for (var i = 0; i < urls.length; i++) {

if (urls[i].responseCode == 200) {

continue;

}

var detailLen = createUrlAdsDetail(sheet, offset, urls[i]);

offset += detailLen + 2;

}

for (var i = 1; i <= 4; i++) {

sheet.autoResizeColumn(i);

}

/**

* Creates URL overview table.

function createUrlOverview(sheet, offset, urls) {

var rows = new Array(urls.length + 2);

rows[0] = ["Přehled odkazovaných URL z inzerátů", ""];

rows[1] = ["URL adresa", "Stavový kód"];

var colors = [];

var rowN = 2;

var code;

for (var i = 0; i < urls.length; i++) {

code = urls[i].responseCode;

rows[rowN] = [urls[i].url, formatResponseCode(code)];

colors.push([getResponseColor(code)]);

rowN++;

}

sheet.insertRows(offset, rows.length + 2);

var range = sheet.getRange(offset, 1, rows.length, rows[0].length);

range.setValues(rows);

range.setBorder(true, true, true, true, false, false);

if (urls.length > 0) {

range.offset(2, 1, urls.length, 1).setBackgrounds(colors);

}

range.offset(0, 0, 2, 2).setFontWeight('bold').setBorder(true, true, true, true, false, true);

return rows.length;

}

var httpStatusCodes = {

"100": "100 Continue",

"101": "101 Switching Protocols",

"200": "200 OK",

"201": "201 Created",

"202": "202 Accepted",

"203": "203 Non-Authoritative Information",

"204": "204 No Content",

"205": "205 Reset Content",

"206": "206 Partial Content",

"300": "300 Multiple Choices",

"301": "301 Moved Permanently",

"302": "302 Found",

"303": "303 See Other",

"304": "304 Not Modified",

"305": "305 Use Proxy",

"307": "307 Temporary Redirect",

"400": "400 Bad Request",

"401": "401 Unauthorized",

"402": "402 Payment Required",

"403": "403 Forbidden",

"404": "404 Not Found",

"405": "405 Method Not Allowed",

"406": "406 Not Acceptable",

"407": "407 Proxy Authentication Required",

"408": "408 Request Timeout",

"409": "409 Conflict",

"410": "410 Gone",

"411": "411 Length Required",

"412": "412 Precondition Failed",

"413": "413 Request Entity Too Large",

"414": "414 Request-URI Too Long",

"415": "415 Unsupported Media Type",

"416": "416 Requested Range Not Satisfiable",

"417": "417 Expectation Failed",

"500": "500 Internal Server Error",

"501": "501 Not Implemented",

"502": "502 Bad Gateway",

"503": "503 Service Unavailable",

"504": "504 Gateway Timeout",

"505": "505 HTTP Version Not Supported"

};

/**

* Gets the response code with human-friendly description (if available).

function formatResponseCode(code) {

if (httpStatusCodes[code]) {

return httpStatusCodes[code];

}

else {

return code;

}

/**

* Gets the color for coloring the response code.

function getResponseColor(code) {

var numeric = isNumeric(code);

var codeNum = parseInt(code, 10);

if (numeric && codeNum < 300) {

return '#80FF80';

}

else if (numeric && codeNum >= 300 && codeNum < 400) {

return '#FFCC00';

}

else {

return '#FF0000';

}

/**

* Creates ad details for the given URL.

function createUrlAdsDetail(sheet, offset, url) {

var rows = new Array(url.ads.length + 2);

rows[0] = [url.url, formatResponseCode(url.responseCode), "", ""];

rows[1] = ["Kampaň", "Sestava", "Inzerát", "URL"];

var rowN = 2;

for (var i = 0; i < url.ads.length; i++) {

var ad = url.ads[i];

rows[rowN] = [

ad.campaign.name,

ad.group.name,

ad.creative1,

formatAdvertUrl(ad)

];

rowN++;

}

sheet.insertRows(offset, rows.length + 2);

var range = sheet.getRange(offset, 1, rows.length, rows[0].length);

range.setBorder(true, true, true, true, false, false);

range.setValues(rows);

range.offset(0, 0, 1, 2).setFontSize(14);

range.offset(0, 1, 1, 1).setBackground(getResponseColor(url.responseCode));

range.offset(0, 0, 2, 4).setFontWeight('bold').setBorder(true, true, true, true, false, true);

return rows.length;

}

/**

* Gets URL for editing the given advert.

function formatAdvertUrl(advert) {

return 'https://www.sklik.cz/detail-inzeratu?id=' + advert.id + '&referrerPage=group&returnUrl=%2Fcampaigns%2F' + advert.campaign.id + '%2Fgroups%2F' + advert.group.id + '%2Fadverts';

}

/**

* Gets the day specified number of days before today.

* This function correctly transforms between normal time and DST.

function lynt_get_date(daysBack) {

var past = new Date();

past.setHours(0);

past.setMinutes(0);

past.setSeconds(0);

past.setMilliseconds(0);

var originalOffset = past.getTimezoneOffset();

var pastTime = past.getTime() - daysBack * 86400 * 1000;

past.setTime(pastTime);

var newOffset = past.getTimezoneOffset();

var offsetDiff = newOffset - originalOffset;

if (offsetDiff != 0) {

pastTime += offsetDiff * 60 * 1000;

past.setTime(pastTime);

}

return past;

}

/**

* Gets the last sunday.

function lynt_get_suday() {

var dayOffset = new Date().getDay();

return lynt_get_date(dayOffset);

}

/**

* Gets the date specified number of days before the last sunday.

function lynt_get_xdays_back_from_sunday(pocet_dni) {

var dayOffset = new Date().getDay();

return lynt_get_date(dayOffset + pocet_dni);

}

/**

* Adds specified number of milliseconds to the specified date.

* This function correctly transforms between normal time and DST.

function lynt_date_add(date, miliseconds) {

var newTime = date.getTime() + miliseconds;

var newDate = new Date(newTime);

var offsetDiff = newDate.getTimezoneOffset() - date.getTimezoneOffset();

if (offsetDiff != 0) {

newTime += offsetDiff * 60 * 1000;

newDate.setTime(newTime);

}

return newDate;

}

var SortOrder;

(function(SortOrder) {

SortOrder[SortOrder["ASC"] = 0] = "ASC";

SortOrder[SortOrder["DESC"] = 1] = "DESC";

})(SortOrder || (SortOrder = {}));

/**

* Creates or opens specified sheet in spreadsheet.

function lynt_create_or_get_sheet(spreadsheet, name, position) {

var sheet = spreadsheet.getSheetByName(name);

if (sheet == null) {

sheet = spreadsheet.insertSheet(name, position);

}

return sheet;

}

function lynt_remove_empty_sheets(spreadsheet) {

var sheets = spreadsheet.getSheets();

for (var i = 0; i < sheets.length; i++) {

if (sheets[i].getLastRow() == 0) {

spreadsheet.deleteSheet(sheets[i]);

}

function lynt_highlight_range(range, higlightingRules) {

var rows = range.getNumRows();

var cols = range.getNumColumns();

var values = range.getValues();

var backgrounds = new Array(rows);

var value, color;

for (var r = 0; r < rows; r++) {

backgrounds[r] = new Array(cols);

for (var c = 0; c < cols; c++) {

color = '#FFFFFF';

value = values[r][c];

if (typeof(value) == 'number') {

for (var ri = 1; ri < higlightingRules.length; ri++) {

if (value <= higlightingRules[ri].value) {

color = lynt_color_to_hex(lynt_get_color_from_range(value, higlightingRules[ri - 1], higlightingRules[ri]));

break;

}

backgrounds[r][c] = color;

}

range.setBackgrounds(backgrounds);

}

/**

* Computes color from the given range.

function lynt_get_color_from_range(value, upper, lower) {

var ratio = (value - lower.value) / (upper.value - lower.value);

return {

r: lower.color.r + ratio * (upper.color.r - lower.color.r),

g: lower.color.g + ratio * (upper.color.g - lower.color.g),

b: lower.color.b + ratio * (upper.color.b - lower.color.b),

};

}

function lynt_color_to_hex(color) {

var rHex = Math.round(color.r).toString(16);

var gHex = Math.round(color.g).toString(16);

var bHex = Math.round(color.b).toString(16);

if (rHex.length < 2) {

rHex = '0' + rHex;

}

if (gHex.length < 2) {

gHex = '0' + gHex;

}

if (bHex.length < 2) {

bHex = '0' + bHex;

}

return '#' + rHex + gHex + bHex;

}

function lynt_store_save(dataFolderName, fileName, object) {

var objectJson = JSON.stringify(object);

var dataFolder = lynt_get_data_folder(dataFolderName);

var files = dataFolder.getFilesByName(fileName);

var dataFile;

if (files.hasNext()) {

dataFile = files.next();

dataFile.setContent(objectJson);

}

else {

dataFolder.createFile(fileName, objectJson, "application/json");

}

return true;

}

function lynt_store_load(dataFolderName, fileName) {

var dataFolder = lynt_get_data_folder(dataFolderName);

var files = dataFolder.getFilesByName(fileName);

var dataFile;

if (files.hasNext()) {

dataFile = files.next();

}

if (dataFile) {

var objectJson = dataFile.getBlob().getDataAsString("UTF-8");

return JSON.parse(objectJson);

}

else {

return null;

}

function lynt_get_data_folder(dataFolderName) {

var root = DriveApp.getRootFolder();

var folders = root.getFoldersByName(dataFolderName);

var dataFolder;

if (folders.hasNext()) {

dataFolder = folders.next();

}

else {

dataFolder = root.createFolder(dataFolderName);

}

return dataFolder;

}

Comments

Milan Merglevský says

9 ledna, 2016 at 11:09 am

Skvělá práce, děkuji moc!

Odpovědět
Hana Kobzová says

24 května, 2016 at 8:58 pm

Skript funguje bezvadně, ale bylo by možné jej rozšířit také o kontrolu url na úrovni klíčových slov a rozšíření reklam (odkazy)?

Odpovědět
- Jan Smitka says
  
  24 května, 2016 at 11:15 pm
  
  Děkujeme za podnět, bohužel při operacích na úrovni klíčových slov narážíme na limit času pro zpracování: i u menších účtů se nám často stávalo, že vypršel limit při načítání klíčových slov, natož aby pak zbyl čas na jejich kontrolu.
  
  Nad rozšířením o odkazy kampaní a sestav zapřemýšlíme. U nich může být trochu problém s jejich spárováním s kampaněmi/sestavami, v případě většího množství pak také s dobou běhu. Mohu se zeptat, kolik odkazů máte řádově nadefinovaných? Jak často se u kampaní/sestav opakují, tj. máte pro každou kampaň/sestavu unikátní odkazy, nebo jich střídáte jen určité množství?
  
  Odpovědět
  - Hana Kobzová says
    
    28 května, 2016 at 1:29 am
    
    Odkazů mám nadefinovaných cca 600. Většinou je odkaz přiřazen pouze 1 kampani na úrovni kampaně. Děkuji.
    
    Odpovědět
Lukáš Kolovrat says

5 listopadu, 2017 at 1:43 pm

Ahoj, Jakube,
1/ Při spuštění skriptu se zobrazítato hláška „TypeError: Nelze volat metodu „indexOf“ z null. (řádek 287, soubor „Kód“)“ Řádek 287: „var hashPos = url.indexOf(‚#‘);“ jak prosím chybu opravit?
2/ Lze někde zvolit přímo na které emaily se má zasílat upozornění na chybné URL? příp. kam zadávat?
Děkuji.

Odpovědět

Jak funguje

Zdrojový kód skriptu

Reader Interactions

Comments

Napsat komentář Zrušit odpověď na komentář