Script báo link không hoạt động trong Google Adwrods

17/05/2018

1853

Trong quá trình hoạt động của website, vì lý do nào đó khiến một vài link bài viết, hoặc link sản phẩm/dịch vụ không còn hoạt động. Nếu tài khoản Adwords của bạn chạy nhiều chiến dịch thì việc kiểm tra từng chiến dịch mỗi ngày là rất tốn thời gian và đôi khi bị bỏ sót.

Vì vậy, việc cài đặt script này là việc không thể thiếu cho người quản lý tài khoản.

Dưới đây là hướng dẫn cài đặt script báo link không hoạt động trong Google Adwords

Bước 1: Tạo một file Google Sheet để hệ thống ghi dữ liệu những link không hoạt động

Truy cập VÀO ĐÂY để tạo bản sao file và lưu vào thư mục drive của bạn.

Chia sẻ file có thể sửa cho những người có link các bạn có thể xem hình bên dưới để script Google Adwords có thể ghi giá trị.

Bước 2: Cài đặt Script kiểm tra link không hoạt động quảng cáo trong tài khoản Adwords

Một trình soạn thảo sẽ xuất hiện, các bạn dán đoạn code dưới đây vào.

Lưu ý:

SPREADSHEET_URL: ‘YOUR_SPREADSHEET_URL’, thay link Google Sheet bạn tạo bước 1 vào.
RECIPIENT_EMAILS: [ ‘YOUR_EMAIL_HERE’ ], thay địa chỉ email của bạn để nhận thông báo link hỏng.
LABEL: ‘LinkChecker_Done’, tạo label để script gắn lable link đã check

// Copyright 2016, Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * @name Link Checker
 *
 * @overview The Link Checker script iterates through the ads, keywords, and
 *     sitelinks in your account and makes sure their URLs do not produce "Page
 *     not found" or other types of error responses. See
 *     https://developers.google.com/adwords/scripts/docs/solutions/link-checker
 *     for more details.
 *
 * @author AdWords Scripts Team [adwords-scripts@googlegroups.com]
 *
 * @version 2.1
 *
 * @changelog
 * - version 2.1
 *   - Added expansion of conditional ValueTrack parameters (e.g. ifmobile).
 *   - Added expanded text ad and other ad format support.
 * - version 2.0.3
 *   - Added validation for external spreadsheet setup.
 * - version 2.0.2
 *   - Allow the custom tracking label to include spaces.
 * - version 2.0.1
 *   - Catch and output all UrlFetchApp exceptions.
 * - version 2.0
 *   - Completely revised the script to work on larger accounts.
 *   - Check URLs in campaign and ad group sitelinks.
 * - version 1.2
 *   - Released initial version.
 */

var CONFIG = {
  // URL of the spreadsheet template.
  // This should be a copy of https://goo.gl/8YLeMj.
  SPREADSHEET_URL: 'YOUR_SPREADSHEET_URL',

  // Array of addresses to be alerted via email if issues are found.
  RECIPIENT_EMAILS: [
    'YOUR_EMAIL_HERE'
  ],

  // Label to use when a link has been checked.
  LABEL: 'LinkChecker_Done',

  // Number of milliseconds to sleep after each URL request. If your URLs are
  // all on one or a few domains, use this throttle to reduce the load that the
  // script imposes on your web server(s).
  THROTTLE: 0,

  // Number of seconds before timeout that the script should stop checking URLs
  // to make sure it has time to output its findings.
  TIMEOUT_BUFFER: 120
};

/**
 * Parameters controlling the script's behavior after hitting a UrlFetchApp
 * QPS quota limit.
 */
var QUOTA_CONFIG = {
  INIT_SLEEP_TIME: 250,
  BACKOFF_FACTOR: 2,
  MAX_TRIES: 5
};

/**
 * Exceptions that prevent the script from finishing checking all URLs in an
 * account but allow it to resume next time.
 */
var EXCEPTIONS = {
  QPS: 'Reached UrlFetchApp QPS limit',
  LIMIT: 'Reached UrlFetchApp daily quota',
  TIMEOUT: 'Approached script execution time limit'
};

/**
 * Named ranges in the spreadsheet.
 */
var NAMES = {
  CHECK_AD_URLS: 'checkAdUrls',
  CHECK_KEYWORD_URLS: 'checkKeywordUrls',
  CHECK_SITELINK_URLS: 'checkSitelinkUrls',
  CHECK_PAUSED_ADS: 'checkPausedAds',
  CHECK_PAUSED_KEYWORDS: 'checkPausedKeywords',
  CHECK_PAUSED_SITELINKS: 'checkPausedSitelinks',
  VALID_CODES: 'validCodes',
  EMAIL_EACH_RUN: 'emailEachRun',
  EMAIL_NON_ERRORS: 'emailNonErrors',
  EMAIL_ON_COMPLETION: 'emailOnCompletion',
  SAVE_ALL_URLS: 'saveAllUrls',
  FREQUENCY: 'frequency',
  DATE_STARTED: 'dateStarted',
  DATE_COMPLETED: 'dateCompleted',
  DATE_EMAILED: 'dateEmailed',
  NUM_ERRORS: 'numErrors',
  RESULT_HEADERS: 'resultHeaders',
  ARCHIVE_HEADERS: 'archiveHeaders'
};

function main() {
  var spreadsheet = validateAndGetSpreadsheet(CONFIG.SPREADSHEET_URL);
  validateEmailAddresses(CONFIG.RECIPIENT_EMAILS);
  spreadsheet.setSpreadsheetTimeZone(AdWordsApp.currentAccount().getTimeZone());

  var options = loadOptions(spreadsheet);
  var status = loadStatus(spreadsheet);

  if (!status.dateStarted) {
    // This is the very first execution of the script.
    startNewAnalysis(spreadsheet);
  } else if (status.dateStarted > status.dateCompleted) {
    Logger.log('Resuming work from a previous execution.');
  } else if (dayDifference(status.dateStarted, new Date()) <
             options.frequency) {
    Logger.log('Waiting until ' + options.frequency +
               ' days have elapsed since the start of the last analysis.');
    return;
  } else {
    // Enough time has passed since the last analysis to start a new one.
    removeLabels([CONFIG.LABEL]);
    startNewAnalysis(spreadsheet);
  }

  var results = analyzeAccount(options);
  outputResults(results, options);
}

/**
 * Checks as many new URLs as possible that have not previously been checked,
 * subject to quota and time limits.
 *
 * @param {Object} options Dictionary of options.
 * @return {Object} An object with fields for the URLs checked and an indication
 *     if the analysis was completed (no remaining URLs to check).
 */
function analyzeAccount(options) {
  // Ensure the label exists before attempting to retrieve already checked URLs.
  ensureLabels([CONFIG.LABEL]);

  var checkedUrls = getAlreadyCheckedUrls(options);
  var urlChecks = [];
  var didComplete = false;

  try {
    // If the script throws an exception, didComplete will remain false.
    didComplete = checkUrls(checkedUrls, urlChecks, options);
  } catch(e) {
    if (e == EXCEPTIONS.QPS ||
        e == EXCEPTIONS.LIMIT ||
        e == EXCEPTIONS.TIMEOUT) {
      Logger.log('Stopped checking URLs early because: ' + e);
      Logger.log('Checked URLs will still be output.');
    } else {
      throw e;
    }
  }

  return {
    urlChecks: urlChecks,
    didComplete: didComplete
  };
}

/**
 * Outputs the results to a spreadsheet and sends emails if appropriate.
 *
 * @param {Object} results An object with fields for the URLs checked and an
 *     indication if the analysis was completed (no remaining URLs to check).
 * @param {Object} options Dictionary of options.
 */
function outputResults(results, options) {
  var spreadsheet = SpreadsheetApp.openByUrl(CONFIG.SPREADSHEET_URL);

  var numErrors = countErrors(results.urlChecks, options);
  Logger.log('Found ' + numErrors + ' this execution.');

  saveUrlsToSpreadsheet(spreadsheet, results.urlChecks, options);

  // Reload the status to get the total number of errors for the entire
  // analysis, which is calculated by the spreadsheet.
  status = loadStatus(spreadsheet);

  if (results.didComplete) {
    spreadsheet.getRangeByName(NAMES.DATE_COMPLETED).setValue(new Date());
    Logger.log('Found ' + status.numErrors + ' across the entire analysis.');
  }

  if (CONFIG.RECIPIENT_EMAILS) {
    if (!results.didComplete && options.emailEachRun &&
        (options.emailNonErrors || numErrors > 0)) {
      sendIntermediateEmail(spreadsheet, numErrors);
    }

    if (results.didComplete &&
        (options.emailEachRun || options.emailOnCompletion) &&
        (options.emailNonErrors || status.numErrors > 0)) {
      sendFinalEmail(spreadsheet, status.numErrors);
    }
  }
}

/**
 * Loads data from a spreadsheet based on named ranges. Strings 'Yes' and 'No'
 * are converted to booleans. One-dimensional ranges are converted to arrays
 * with blank cells omitted. Assumes each named range exists.
 *
 * @param {Object} spreadsheet The spreadsheet object.
 * @param {Array.<string>} names A list of named ranges that should be loaded.
 * @return {Object} A dictionary with the names as keys and the values
 *     as the cell values from the spreadsheet.
 */
function loadDatabyName(spreadsheet, names) {
  var data = {};

  for (var i = 0; i < names.length; i++) {
    var name = names[i];
    var range = spreadsheet.getRangeByName(name);

    if (range.getNumRows() > 1 && range.getNumColumns() > 1) {
      // Name refers to a 2d range, so load it as a 2d array.
      data[name] = range.getValues();
    } else if (range.getNumRows() == 1 && range.getNumColumns() == 1) {
      // Name refers to a single cell, so load it as a value and replace
      // Yes/No with boolean true/false.
      data[name] = range.getValue();
      data[name] = data[name] === 'Yes' ? true : data[name];
      data[name] = data[name] === 'No' ? false : data[name];
    } else {
      // Name refers to a 1d range, so load it as an array (regardless of
      // whether the 1d range is oriented horizontally or vertically).
      var isByRow = range.getNumRows() > 1;
      var limit = isByRow ? range.getNumRows() : range.getNumColumns();
      var cellValues = range.getValues();

      data[name] = [];
      for (var j = 0; j < limit; j++) {
        var cellValue = isByRow ? cellValues[j][0] : cellValues[0][j];
        if (cellValue) {
          data[name].push(cellValue);
        }
      }
    }
  }

  return data;
}

/**
 * Loads options from the spreadsheet.
 *
 * @param {Object} spreadsheet The spreadsheet object.
 * @return {Object} A dictionary of options.
 */
function loadOptions(spreadsheet) {
  return loadDatabyName(spreadsheet,
      [NAMES.CHECK_AD_URLS, NAMES.CHECK_KEYWORD_URLS,
       NAMES.CHECK_SITELINK_URLS, NAMES.CHECK_PAUSED_ADS,
       NAMES.CHECK_PAUSED_KEYWORDS, NAMES.CHECK_PAUSED_SITELINKS,
       NAMES.VALID_CODES, NAMES.EMAIL_EACH_RUN,
       NAMES.EMAIL_NON_ERRORS, NAMES.EMAIL_ON_COMPLETION,
       NAMES.SAVE_ALL_URLS, NAMES.FREQUENCY]);
}

/**
 * Loads state information from the spreadsheet.
 *
 * @param {Object} spreadsheet The spreadsheet object.
 * @return {Object} A dictionary of status information.
 */
function loadStatus(spreadsheet) {
  return loadDatabyName(spreadsheet,
      [NAMES.DATE_STARTED, NAMES.DATE_COMPLETED,
       NAMES.DATE_EMAILED, NAMES.NUM_ERRORS]);
}

/**
 * Saves the start date to the spreadsheet and archives results of the last
 * analysis to a separate sheet.
 *
 * @param {Object} spreadsheet The spreadsheet object.
 */
function startNewAnalysis(spreadsheet) {
  Logger.log('Starting a new analysis.');

  spreadsheet.getRangeByName(NAMES.DATE_STARTED).setValue(new Date());

  // Helper method to get the output area on the results or archive sheets.
  var getOutputRange = function(rangeName) {
    var headers = spreadsheet.getRangeByName(rangeName);
    return headers.offset(1, 0, headers.getSheet().getDataRange().getLastRow());
  };

  getOutputRange(NAMES.ARCHIVE_HEADERS).clearContent();

  var results = getOutputRange(NAMES.RESULT_HEADERS);
  results.copyTo(getOutputRange(NAMES.ARCHIVE_HEADERS));

  getOutputRange(NAMES.RESULT_HEADERS).clearContent();
}

/**
 * Counts the number of errors in the results.
 *
 * @param {Array.<Object>} urlChecks A list of URL check results.
 * @param {Object} options Dictionary of options.
 * @return {number} The number of errors in the results.
 */
function countErrors(urlChecks, options) {
  var numErrors = 0;

  for (var i = 0; i < urlChecks.length; i++) {
    if (options.validCodes.indexOf(urlChecks[i].responseCode) == -1) {
      numErrors++;
    }
  }

  return numErrors;
}

/**
 * Saves URLs for a particular account to the spreadsheet starting at the first
 * unused row.
 *
 * @param {Object} spreadsheet The spreadsheet object.
 * @param {Array.<Object>} urlChecks A list of URL check results.
 * @param {Object} options Dictionary of options.
 */
function saveUrlsToSpreadsheet(spreadsheet, urlChecks, options) {
  // Build each row of output values in the order of the columns.
  var outputValues = [];
  for (var i = 0; i < urlChecks.length; i++) {
    var urlCheck = urlChecks[i];

    if (options.saveAllUrls ||
        options.validCodes.indexOf(urlCheck.responseCode) == -1) {
      outputValues.push([
        urlCheck.customerId,
        new Date(urlCheck.timestamp),
        urlCheck.url,
        urlCheck.responseCode,
        urlCheck.entityType,
        urlCheck.campaign,
        urlCheck.adGroup,
        urlCheck.ad,
        urlCheck.keyword,
        urlCheck.sitelink
      ]);
    }
  }

  if (outputValues.length > 0) {
    // Find the first open row on the Results tab below the headers and create a
    // range large enough to hold all of the output, one per row.
    var headers = spreadsheet.getRangeByName(NAMES.RESULT_HEADERS);
    var lastRow = headers.getSheet().getDataRange().getLastRow();
    var outputRange = headers.offset(lastRow - headers.getRow() + 1,
                                     0, outputValues.length);
    outputRange.setValues(outputValues);
  }

  for (var i = 0; i < CONFIG.RECIPIENT_EMAILS.length; i++) {
    spreadsheet.addEditor(CONFIG.RECIPIENT_EMAILS[i]);
  }
}

/**
 * Sends an email to a list of email addresses with a link to the spreadsheet
 * and the results of this execution of the script.
 *
 * @param {Object} spreadsheet The spreadsheet object.
 * @param {boolean} numErrors The number of errors found in this execution.
 */
function sendIntermediateEmail(spreadsheet, numErrors) {
  spreadsheet.getRangeByName(NAMES.DATE_EMAILED).setValue(new Date());

  MailApp.sendEmail(CONFIG.RECIPIENT_EMAILS.join(','),
      'Link Checker Results',
      'The Link Checker script found ' + numErrors + ' URLs with errors in ' +
      'an execution that just finished. See ' +
      spreadsheet.getUrl() + ' for details.');
}

/**
 * Sends an email to a list of email addresses with a link to the spreadsheet
 * and the results across the entire account.
 *
 * @param {Object} spreadsheet The spreadsheet object.
 * @param {boolean} numErrors The number of errors found in the entire account.
 */
function sendFinalEmail(spreadsheet, numErrors) {
  spreadsheet.getRangeByName(NAMES.DATE_EMAILED).setValue(new Date());

  MailApp.sendEmail(CONFIG.RECIPIENT_EMAILS.join(','),
      'Link Checker Results',
      'The Link Checker script found ' + numErrors + ' URLs with errors ' +
      'across its entire analysis. See ' +
      spreadsheet.getUrl() + ' for details.');
}

/**
 * Retrieves all final URLs and mobile final URLs in the account across ads,
 * keywords, and sitelinks that were checked in a previous run, as indicated by
 * them having been labeled.
 *
 * @param {Object} options Dictionary of options.
 * @return {Object} A map of previously checked URLs with the URL as the key.
 */
function getAlreadyCheckedUrls(options) {
  var urlMap = {};

  var addToMap = function(items) {
    for (var i = 0; i < items.length; i++) {
      var urls = expandUrlModifiers(items[i]);
      urls.forEach(function(url) {
        urlMap[url] = true;
      });
    }
  };

  if (options.checkAdUrls) {
    addToMap(getUrlsBySelector(AdWordsApp.ads().
                               withCondition(labelCondition(true))));
  }

  if (options.checkKeywordUrls) {
    addToMap(getUrlsBySelector(AdWordsApp.keywords().
                               withCondition(labelCondition(true))));
  }

  if (options.checkSitelinkUrls) {
    addToMap(getAlreadyCheckedSitelinkUrls());
  }

  return urlMap;
}

/**
 * Retrieves all final URLs and mobile final URLs for campaign and ad group
 * sitelinks.
 *
 * @return {Array.<string>} An array of URLs.
 */
function getAlreadyCheckedSitelinkUrls() {
  var urls = [];

  // Helper method to get campaign or ad group sitelink URLs.
  var addSitelinkUrls = function(selector) {
    var iterator = selector.withCondition(labelCondition(true)).get();

    while (iterator.hasNext()) {
      var entity = iterator.next();
      var sitelinks = entity.extensions().sitelinks();
      urls = urls.concat(getUrlsBySelector(sitelinks));
    }
  };

  addSitelinkUrls(AdWordsApp.campaigns());
  addSitelinkUrls(AdWordsApp.adGroups());

  return urls;
}

/**
 * Retrieves all URLs in the entities specified by a selector.
 *
 * @param {Object} selector The selector specifying the entities to use.
 *     The entities should be of a type that has a urls() method.
 * @return {Array.<string>} An array of URLs.
 */
function getUrlsBySelector(selector) {
  var urls = [];
  var entities = selector.get();

  // Helper method to add the url to the list if it exists.
  var addToList = function(url) {
    if (url) {
      urls.push(url);
    }
  };

  while (entities.hasNext()) {
    var entity = entities.next();

    addToList(entity.urls().getFinalUrl());
    addToList(entity.urls().getMobileFinalUrl());
  }

  return urls;
}

/**
 * Retrieves all final URLs and mobile final URLs in the account across ads,
 * keywords, and sitelinks, and checks their response code. Does not check
 * previously checked URLs.
 *
 * @param {Object} checkedUrls A map of previously checked URLs with the URL as
 *     the key.
 * @param {Array.<Object>} urlChecks An array into which the results of each URL
 *     check will be inserted.
 * @param {Object} options Dictionary of options.
 * @return {boolean} True if all URLs were checked.
 */
function checkUrls(checkedUrls, urlChecks, options) {
  var didComplete = true;

  // Helper method to add common conditions to ad group and keyword selectors.
  var addConditions = function(selector, includePaused) {
    var statuses = ['ENABLED'];
    if (includePaused) {
      statuses.push('PAUSED');
    }

    var predicate = ' IN [' + statuses.join(',') + ']';
    return selector.withCondition(labelCondition(false)).
        withCondition('Status' + predicate).
        withCondition('CampaignStatus' + predicate).
        withCondition('AdGroupStatus' + predicate);
  };

  if (options.checkAdUrls) {
    didComplete = didComplete && checkUrlsBySelector(checkedUrls, urlChecks,
        addConditions(AdWordsApp.ads().withCondition('CreativeFinalUrls != ""'),
                      options.checkPausedAds));
  }

  if (options.checkKeywordUrls) {
    didComplete = didComplete && checkUrlsBySelector(checkedUrls, urlChecks,
        addConditions(AdWordsApp.keywords().withCondition('FinalUrls != ""'),
                      options.checkPausedKeywords));
  }

  if (options.checkSitelinkUrls) {
    didComplete = didComplete &&
        checkSitelinkUrls(checkedUrls, urlChecks, options);
  }

  return didComplete;
}

/**
 * Retrieves all final URLs and mobile final URLs in a selector and checks them
 * for a valid response code. Does not check previously checked URLs. Labels the
 * entity that it was checked, if possible.
 *
 * @param {Object} checkedUrls A map of previously checked URLs with the URL as
 *     the key.
 * @param {Array.<Object>} urlChecks An array into which the results of each URL
 *     check will be inserted.
 * @param {Object} selector The selector specifying the entities to use.
 *     The entities should be of a type that has a urls() method.
 * @return {boolean} True if all URLs were checked.
 */
function checkUrlsBySelector(checkedUrls, urlChecks, selector) {
  var customerId = AdWordsApp.currentAccount().getCustomerId();
  var iterator = selector.get();
  var entities = [];

  // Helper method to check a URL.
  var checkUrl = function(entity, url) {
    if (!url) {
      return;
    }

    var urlsToCheck = expandUrlModifiers(url);

    for (var i = 0; i < urlsToCheck.length; i++) {
      var expandedUrl = urlsToCheck[i];
      if (checkedUrls[expandedUrl]) {
        continue;
      }

      var responseCode = requestUrl(expandedUrl);
      var entityType = entity.getEntityType();

      urlChecks.push({
        customerId: customerId,
        timestamp: new Date(),
        url: expandedUrl,
        responseCode: responseCode,
        entityType: entityType,
        campaign: entity.getCampaign ? entity.getCampaign().getName() : '',
        adGroup: entity.getAdGroup ? entity.getAdGroup().getName() : '',
        ad: entityType == 'Ad' ? getAdAsText(entity) : '',
        keyword: entityType == 'Keyword' ? entity.getText() : '',
        sitelink: entityType.indexOf('Sitelink') != -1 ?
            entity.getLinkText() : ''
      });

      checkedUrls[expandedUrl] = true;
    }
  };

  while (iterator.hasNext()) {
    entities.push(iterator.next());
  }

  for (var i = 0; i < entities.length; i++) {
    var entity = entities[i];

    checkUrl(entity, entity.urls().getFinalUrl());
    checkUrl(entity, entity.urls().getMobileFinalUrl());

    // Sitelinks do not have labels.
    if (entity.applyLabel) {
      entity.applyLabel(CONFIG.LABEL);
      checkTimeout();
    }
  }

  // True only if we did not breach an iterator limit.
  return entities.length == iterator.totalNumEntities();
}

/**
 * Retrieves a text representation of an ad, casting the ad to the appropriate
 * type if necessary.
 *
 * @param {Ad} ad The ad object.
 * @return {string} The text representation.
 */
function getAdAsText(ad) {
  // There is no AdTypeSpace method for textAd
  if (ad.getType() === 'TEXT_AD') {
    return ad.getHeadline();
  } else if (ad.isType().expandedTextAd()) {
    var eta = ad.asType().expandedTextAd();
    return eta.getHeadlinePart1() + ' - ' + eta.getHeadlinePart2();
  } else if (ad.isType().gmailImageAd()) {
    return ad.asType().gmailImageAd().getName();
  } else if (ad.isType().gmailMultiProductAd()) {
    return ad.asType().gmailMultiProductAd().getHeadline();
  } else if (ad.isType().gmailSinglePromotionAd()) {
    return ad.asType().gmailSinglePromotionAd().getHeadline();
  } else if (ad.isType().html5Ad()) {
    return ad.asType().html5Ad().getName();
  } else if (ad.isType().imageAd()) {
    return ad.asType().imageAd().getName();
  } else if (ad.isType().responsiveDisplayAd()) {
    return ad.asType().responsiveDisplayAd().getLongHeadline();
  }
  return 'N/A';
}

/**
 * Retrieves all final URLs and mobile final URLs for campaign and ad group
 * sitelinks and checks them for a valid response code. Does not check
 * previously checked URLs. Labels the containing campaign or ad group that it
 * has been checked.
 *
 * @param {Object} checkedUrls A map of previously checked URLs with the URL as
 *     the key.
 * @param {Array.<Object>} urlChecks An array into which the results of each URL
 *     check will be inserted.
 * @param {Object} options Dictionary of options.
 * @return {boolean} True if all URLs were checked.
 */
function checkSitelinkUrls(checkedUrls, urlChecks, options) {
  var didComplete = true;

  // Helper method to check URLs for sitelinks in a campaign or ad group
  // selector.
  var checkSitelinkUrls = function(selector) {
    var iterator = selector.withCondition(labelCondition(false)).get();
    var entities = [];

    while (iterator.hasNext()) {
      entities.push(iterator.next());
    }

    for (var i = 0; i < entities.length; i++) {
      var entity = entities[i];
      var sitelinks = entity.extensions().sitelinks();

      if (sitelinks.get().hasNext()) {
        didComplete = didComplete &&
            checkUrlsBySelector(checkedUrls, urlChecks, sitelinks);
        entity.applyLabel(CONFIG.LABEL);
        checkTimeout();
      }
    }

    // True only if we did not breach an iterator limit.
    didComplete = didComplete &&
        entities.length == iterator.totalNumEntities();
  };

  var statuses = ['ENABLED'];
  if (options.checkPausedSitelinks) {
    statuses.push('PAUSED');
  }

  var predicate = ' IN [' + statuses.join(',') + ']';
  checkSitelinkUrls(AdWordsApp.campaigns().
                    withCondition('Status' + predicate));
  checkSitelinkUrls(AdWordsApp.adGroups().
                    withCondition('Status' + predicate).
                    withCondition('CampaignStatus' + predicate));

  return didComplete;
}

/**
 * Expands a URL that contains ValueTrack parameters such as {ifmobile:mobile}
 * to all the combinations, and returns as an array. The following pairs of
 * ValueTrack parameters are currently expanded:
 *     1. {ifmobile:<...>} and {ifnotmobile:<...>} to produce URLs simulating
 *        clicks from either mobile or non-mobile devices.
 *     2. {ifsearch:<...>} and {ifcontent:<...>} to produce URLs simulating
 *        clicks on either the search or display networks.
 * Any other ValueTrack parameters or customer parameters are stripped out from
 * the URL entirely.
 *
 * @param {string} url The URL which may contain ValueTrack parameters.
 * @return {!Array.<string>} An array of one or more expanded URLs.
 */
function expandUrlModifiers(url) {
  var ifRegex = /({(if\w+):([^}]+)})/gi;
  var modifiers = {};
  var matches;
  while (matches = ifRegex.exec(url)) {
    // Tags are case-insensitive, e.g. IfMobile is valid.
    modifiers[matches[2].toLowerCase()] = {
      substitute: matches[0],
      replacement: matches[3]
    };
  }
  if (Object.keys(modifiers).length) {
    if (modifiers.ifmobile || modifiers.ifnotmobile) {
      var mobileCombinations =
          pairedUrlModifierReplace(modifiers, 'ifmobile', 'ifnotmobile', url);
    } else {
      var mobileCombinations = [url];
    }

    // Store in a map on the offchance that there are duplicates.
    var combinations = {};
    mobileCombinations.forEach(function(url) {
      if (modifiers.ifsearch || modifiers.ifcontent) {
        pairedUrlModifierReplace(modifiers, 'ifsearch', 'ifcontent', url)
            .forEach(function(modifiedUrl) {
              combinations[modifiedUrl] = true;
            });
      } else {
        combinations[url] = true;
      }
    });
    var modifiedUrls = Object.keys(combinations);
  } else {
    var modifiedUrls = [url];
  }
  // Remove any custom parameters
  return modifiedUrls.map(function(url) {
    return url.replace(/{[0-9a-zA-Z\_\+\:]+}/g, '');
  });
}

/**
 * Return a pair of URLs, where each of the two modifiers is mutually exclusive,
 * one for each combination. e.g. Evaluating ifmobile and ifnotmobile for a
 * mobile and a non-mobile scenario.
 *
 * @param {Object} modifiers A map of ValueTrack modifiers.
 * @param {string} modifier1 The modifier to honour in the URL.
 * @param {string} modifier2 The modifier to remove from the URL.
 * @param {string} url The URL potentially containing ValueTrack parameters.
 * @return {Array.<string>} A pair of URLs, as a list.
 */
function pairedUrlModifierReplace(modifiers, modifier1, modifier2, url) {
  return [
    urlModifierReplace(modifiers, modifier1, modifier2, url),
    urlModifierReplace(modifiers, modifier2, modifier1, url)
  ];
}

/**
 * Produces a URL where the first {if...} modifier is set, and the second is
 * deleted.
 *
 * @param {Object} mods A map of ValueTrack modifiers.
 * @param {string} mod1 The modifier to honour in the URL.
 * @param {string} mod2 The modifier to remove from the URL.
 * @param {string} url The URL potentially containing ValueTrack parameters.
 * @return {string} The resulting URL with substitions.
 */
function urlModifierReplace(mods, mod1, mod2, url) {
  var modUrl = mods[mod1] ?
      url.replace(mods[mod1].substitute, mods[mod1].replacement) :
      url;
  return mods[mod2] ? modUrl.replace(mods[mod2].substitute, '') : modUrl;
}

/**
 * Requests a given URL. Retries if the UrlFetchApp QPS limit was reached,
 * exponentially backing off on each retry. Throws an exception if it reaches
 * the maximum number of retries. Throws an exception if the UrlFetchApp daily
 * quota limit was reached.
 *
 * @param {string} url The URL to test.
 * @return {number|string} The response code received when requesting the URL,
 *     or an error message.
 */
function requestUrl(url) {
  var responseCode;
  var sleepTime = QUOTA_CONFIG.INIT_SLEEP_TIME;
  var numTries = 0;

  while (numTries < QUOTA_CONFIG.MAX_TRIES && !responseCode) {
    try {
      // If UrlFetchApp.fetch() throws an exception, responseCode will remain
      // undefined.
      responseCode =
        UrlFetchApp.fetch(url, {muteHttpExceptions: true}).getResponseCode();

      if (CONFIG.THROTTLE > 0) {
        Utilities.sleep(CONFIG.THROTTLE);
      }
    } catch(e) {
      if (e.message.indexOf('Service invoked too many times in a short time:')
          != -1) {
        Utilities.sleep(sleepTime);
        sleepTime *= QUOTA_CONFIG.BACKOFF_FACTOR;
      } else if (e.message.indexOf('Service invoked too many times:') != -1) {
        throw EXCEPTIONS.LIMIT;
      } else {
        return e.message;
      }
    }

    numTries++;
  }

  if (!responseCode) {
    throw EXCEPTIONS.QPS;
  } else {
    return responseCode;
  }
}

/**
 * Throws an exception if the script is close to timing out.
 */
function checkTimeout() {
  if (AdWordsApp.getExecutionInfo().getRemainingTime() <
      CONFIG.TIMEOUT_BUFFER) {
    throw EXCEPTIONS.TIMEOUT;
  }
}

/**
 * Returns the number of days between two dates.
 *
 * @param {Object} from The older Date object.
 * @param {Object} to The newer (more recent) Date object.
 * @return {number} The number of days between the given dates (possibly
 *     fractional).
 */
function dayDifference(from, to) {
  return (to.getTime() - from.getTime()) / (24 * 3600 * 1000);
}

/**
 * Builds a string to be used for withCondition() filtering for whether the
 * label is present or not.
 *
 * @param {boolean} hasLabel True if the label should be present, false if the
 *     label should not be present.
 * @return {string} A condition that can be used in withCondition().
 */
function labelCondition(hasLabel) {
  return 'LabelNames ' + (hasLabel ? 'CONTAINS_ANY' : 'CONTAINS_NONE') +
      ' ["' + CONFIG.LABEL + '"]';
}

/**
 * Retrieves an entity by name.
 *
 * @param {Object} selector A selector for an entity type with a Name field.
 * @param {string} name The name to retrieve the entity by.
 * @return {Object} The entity, if it exists, or null otherwise.
 */
function getEntityByName(selector, name) {
  var entities = selector.withCondition('Name = "' + name + '"').get();

  if (entities.hasNext()) {
    return entities.next();
  } else {
    return null;
  }
}

/**
 * Retrieves a Label object by name.
 *
 * @param {string} labelName The label name to retrieve.
 * @return {Object} The Label object, if it exists, or null otherwise.
 */
function getLabel(labelName) {
  return getEntityByName(AdWordsApp.labels(), labelName);
}

/**
 * Checks that the account has all provided labels and creates any that are
 * missing. Since labels cannot be created in preview mode, throws an exception
 * if a label is missing.
 *
 * @param {Array.<string>} labelNames An array of label names.
 */
function ensureLabels(labelNames) {
  for (var i = 0; i < labelNames.length; i++) {
    var labelName = labelNames[i];
    var label = getLabel(labelName);

    if (!label) {
      if (!AdWordsApp.getExecutionInfo().isPreview()) {
        AdWordsApp.createLabel(labelName);
      } else {
        throw 'Label ' + labelName + ' is missing and cannot be created in ' +
            'preview mode. Please run the script or create the label manually.';
      }
    }
  }
}

/**
 * Removes all provided labels from the account. Since labels cannot be removed
 * in preview mode, throws an exception in preview mode.
 *
 * @param {Array.<string>} labelNames An array of label names.
 */
function removeLabels(labelNames) {
  if (AdWordsApp.getExecutionInfo().isPreview()) {
    throw 'Cannot remove labels in preview mode. Please run the script or ' +
        'remove the labels manually.';
  }

  for (var i = 0; i < labelNames.length; i++) {
    var label = getLabel(labelNames[i]);

    if (label) {
      label.remove();
    }
  }
}

/**
 * Validates the provided spreadsheet URL to make sure that it's set up
 * properly. Throws a descriptive error message if validation fails.
 *
 * @param {string} spreadsheeturl The URL of the spreadsheet to open.
 * @return {Spreadsheet} The spreadsheet object itself, fetched from the URL.
 * @throws {Error} If the spreadsheet URL hasn't been set
 */
function validateAndGetSpreadsheet(spreadsheeturl) {
  if (spreadsheeturl == 'YOUR_SPREADSHEET_URL') {
    throw new Error('Please specify a valid Spreadsheet URL. You can find' +
        ' a link to a template in the associated guide for this script.');
  }
  return SpreadsheetApp.openByUrl(spreadsheeturl);
}

/**
 * Validates the provided email addresses to make sure it's not the default.
 * Throws a descriptive error message if validation fails.
 *
 * @param {Array.<string>} recipientEmails The list of email adresses.
 * @throws {Error} If the list of email addresses is still the default
 */
function validateEmailAddresses(recipientEmails) {
  if (recipientEmails &&
      recipientEmails[0] == 'YOUR_EMAIL_HERE') {
    throw new Error('Please either specify a valid email address or clear' +
        ' the RECIPIENT_EMAILS field.');
  }
}

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

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

// Licensed under the Apache License, Version 2.0 (the "License");

// you may not use this file except in compliance with the License.

// You may obtain a copy of the License at

// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software

// distributed under the License is distributed on an "AS IS" BASIS,

// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

// See the License for the specific language governing permissions and

// limitations under the License.

/**

* @name Link Checker

* @overview The Link Checker script iterates through the ads, keywords, and

* sitelinks in your account and makes sure their URLs do not produce "Page

* not found" or other types of error responses. See

* https://developers.google.com/adwords/scripts/docs/solutions/link-checker

* for more details.

* @author AdWords Scripts Team [adwords-scripts@googlegroups.com]

* @version 2.1

* @changelog

* - version 2.1

* - Added expansion of conditional ValueTrack parameters (e.g. ifmobile).

* - Added expanded text ad and other ad format support.

* - version 2.0.3

* - Added validation for external spreadsheet setup.

* - version 2.0.2

* - Allow the custom tracking label to include spaces.

* - version 2.0.1

* - Catch and output all UrlFetchApp exceptions.

* - version 2.0

* - Completely revised the script to work on larger accounts.

* - Check URLs in campaign and ad group sitelinks.

* - version 1.2

* - Released initial version.

var CONFIG = {

// URL of the spreadsheet template.

// This should be a copy of https://goo.gl/8YLeMj.

SPREADSHEET_URL: 'YOUR_SPREADSHEET_URL',

// Array of addresses to be alerted via email if issues are found.

RECIPIENT_EMAILS: [

'YOUR_EMAIL_HERE'

// Label to use when a link has been checked.

LABEL: 'LinkChecker_Done',

// Number of milliseconds to sleep after each URL request. If your URLs are

// all on one or a few domains, use this throttle to reduce the load that the

// script imposes on your web server(s).

THROTTLE: 0,

// Number of seconds before timeout that the script should stop checking URLs

// to make sure it has time to output its findings.

TIMEOUT_BUFFER: 120

};

/**

* Parameters controlling the script's behavior after hitting a UrlFetchApp

* QPS quota limit.

var QUOTA_CONFIG = {

INIT_SLEEP_TIME: 250,

BACKOFF_FACTOR: 2,

MAX_TRIES: 5

};

/**

* Exceptions that prevent the script from finishing checking all URLs in an

* account but allow it to resume next time.

var EXCEPTIONS = {

QPS: 'Reached UrlFetchApp QPS limit',

LIMIT: 'Reached UrlFetchApp daily quota',

TIMEOUT: 'Approached script execution time limit'

};

/**

* Named ranges in the spreadsheet.

var NAMES = {

CHECK_AD_URLS: 'checkAdUrls',

CHECK_KEYWORD_URLS: 'checkKeywordUrls',

CHECK_SITELINK_URLS: 'checkSitelinkUrls',

CHECK_PAUSED_ADS: 'checkPausedAds',

CHECK_PAUSED_KEYWORDS: 'checkPausedKeywords',

CHECK_PAUSED_SITELINKS: 'checkPausedSitelinks',

VALID_CODES: 'validCodes',

EMAIL_EACH_RUN: 'emailEachRun',

EMAIL_NON_ERRORS: 'emailNonErrors',

EMAIL_ON_COMPLETION: 'emailOnCompletion',

SAVE_ALL_URLS: 'saveAllUrls',

FREQUENCY: 'frequency',

DATE_STARTED: 'dateStarted',

DATE_COMPLETED: 'dateCompleted',

DATE_EMAILED: 'dateEmailed',

NUM_ERRORS: 'numErrors',

RESULT_HEADERS: 'resultHeaders',

ARCHIVE_HEADERS: 'archiveHeaders'

};

function main() {

var spreadsheet = validateAndGetSpreadsheet(CONFIG.SPREADSHEET_URL);

validateEmailAddresses(CONFIG.RECIPIENT_EMAILS);

spreadsheet.setSpreadsheetTimeZone(AdWordsApp.currentAccount().getTimeZone());

var options = loadOptions(spreadsheet);

var status = loadStatus(spreadsheet);

if (!status.dateStarted) {

// This is the very first execution of the script.

startNewAnalysis(spreadsheet);

} else if (status.dateStarted > status.dateCompleted) {

Logger.log('Resuming work from a previous execution.');

} else if (dayDifference(status.dateStarted, new Date()) <

options.frequency) {

Logger.log('Waiting until ' + options.frequency +

' days have elapsed since the start of the last analysis.');

return;

} else {

// Enough time has passed since the last analysis to start a new one.

removeLabels([CONFIG.LABEL]);

startNewAnalysis(spreadsheet);

}

var results = analyzeAccount(options);

outputResults(results, options);

}

/**

* Checks as many new URLs as possible that have not previously been checked,

* subject to quota and time limits.

* @param {Object} options Dictionary of options.

* @return {Object} An object with fields for the URLs checked and an indication

* if the analysis was completed (no remaining URLs to check).

function analyzeAccount(options) {

// Ensure the label exists before attempting to retrieve already checked URLs.

ensureLabels([CONFIG.LABEL]);

var checkedUrls = getAlreadyCheckedUrls(options);

var urlChecks = [];

var didComplete = false;

try {

// If the script throws an exception, didComplete will remain false.

didComplete = checkUrls(checkedUrls, urlChecks, options);

} catch(e) {

if (e == EXCEPTIONS.QPS ||

e == EXCEPTIONS.LIMIT ||

e == EXCEPTIONS.TIMEOUT) {

Logger.log('Stopped checking URLs early because: ' + e);

Logger.log('Checked URLs will still be output.');

} else {

throw e;

}

return {

urlChecks: urlChecks,

didComplete: didComplete

};

}

/**

* Outputs the results to a spreadsheet and sends emails if appropriate.

* @param {Object} results An object with fields for the URLs checked and an

* indication if the analysis was completed (no remaining URLs to check).

* @param {Object} options Dictionary of options.

function outputResults(results, options) {

var spreadsheet = SpreadsheetApp.openByUrl(CONFIG.SPREADSHEET_URL);

var numErrors = countErrors(results.urlChecks, options);

Logger.log('Found ' + numErrors + ' this execution.');

saveUrlsToSpreadsheet(spreadsheet, results.urlChecks, options);

// Reload the status to get the total number of errors for the entire

// analysis, which is calculated by the spreadsheet.

status = loadStatus(spreadsheet);

if (results.didComplete) {

spreadsheet.getRangeByName(NAMES.DATE_COMPLETED).setValue(new Date());

Logger.log('Found ' + status.numErrors + ' across the entire analysis.');

}

if (CONFIG.RECIPIENT_EMAILS) {

if (!results.didComplete && options.emailEachRun &&

(options.emailNonErrors || numErrors > 0)) {

sendIntermediateEmail(spreadsheet, numErrors);

}

if (results.didComplete &&

(options.emailEachRun || options.emailOnCompletion) &&

(options.emailNonErrors || status.numErrors > 0)) {

sendFinalEmail(spreadsheet, status.numErrors);

}

/**

* Loads data from a spreadsheet based on named ranges. Strings 'Yes' and 'No'

* are converted to booleans. One-dimensional ranges are converted to arrays

* with blank cells omitted. Assumes each named range exists.

* @param {Object} spreadsheet The spreadsheet object.

* @param {Array.<string>} names A list of named ranges that should be loaded.

* @return {Object} A dictionary with the names as keys and the values

* as the cell values from the spreadsheet.

function loadDatabyName(spreadsheet, names) {

var data = {};

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

var name = names[i];

var range = spreadsheet.getRangeByName(name);

if (range.getNumRows() > 1 && range.getNumColumns() > 1) {

// Name refers to a 2d range, so load it as a 2d array.

data[name] = range.getValues();

} else if (range.getNumRows() == 1 && range.getNumColumns() == 1) {

// Name refers to a single cell, so load it as a value and replace

// Yes/No with boolean true/false.

data[name] = range.getValue();

data[name] = data[name] === 'Yes' ? true : data[name];

data[name] = data[name] === 'No' ? false : data[name];

} else {

// Name refers to a 1d range, so load it as an array (regardless of

// whether the 1d range is oriented horizontally or vertically).

var isByRow = range.getNumRows() > 1;

var limit = isByRow ? range.getNumRows() : range.getNumColumns();

var cellValues = range.getValues();

data[name] = [];

for (var j = 0; j < limit; j++) {

var cellValue = isByRow ? cellValues[j][0] : cellValues[0][j];

if (cellValue) {

data[name].push(cellValue);

}

return data;

}

/**

* Loads options from the spreadsheet.

* @param {Object} spreadsheet The spreadsheet object.

* @return {Object} A dictionary of options.

function loadOptions(spreadsheet) {

return loadDatabyName(spreadsheet,

[NAMES.CHECK_AD_URLS, NAMES.CHECK_KEYWORD_URLS,

NAMES.CHECK_SITELINK_URLS, NAMES.CHECK_PAUSED_ADS,

NAMES.CHECK_PAUSED_KEYWORDS, NAMES.CHECK_PAUSED_SITELINKS,

NAMES.VALID_CODES, NAMES.EMAIL_EACH_RUN,

NAMES.EMAIL_NON_ERRORS, NAMES.EMAIL_ON_COMPLETION,

NAMES.SAVE_ALL_URLS, NAMES.FREQUENCY]);

}

/**

* Loads state information from the spreadsheet.

* @param {Object} spreadsheet The spreadsheet object.

* @return {Object} A dictionary of status information.

function loadStatus(spreadsheet) {

return loadDatabyName(spreadsheet,

[NAMES.DATE_STARTED, NAMES.DATE_COMPLETED,

NAMES.DATE_EMAILED, NAMES.NUM_ERRORS]);

}

/**

* Saves the start date to the spreadsheet and archives results of the last

* analysis to a separate sheet.

* @param {Object} spreadsheet The spreadsheet object.

function startNewAnalysis(spreadsheet) {

Logger.log('Starting a new analysis.');

spreadsheet.getRangeByName(NAMES.DATE_STARTED).setValue(new Date());

// Helper method to get the output area on the results or archive sheets.

var getOutputRange = function(rangeName) {

var headers = spreadsheet.getRangeByName(rangeName);

return headers.offset(1, 0, headers.getSheet().getDataRange().getLastRow());

};

getOutputRange(NAMES.ARCHIVE_HEADERS).clearContent();

var results = getOutputRange(NAMES.RESULT_HEADERS);

results.copyTo(getOutputRange(NAMES.ARCHIVE_HEADERS));

getOutputRange(NAMES.RESULT_HEADERS).clearContent();

}

/**

* Counts the number of errors in the results.

* @param {Array.<Object>} urlChecks A list of URL check results.

* @param {Object} options Dictionary of options.

* @return {number} The number of errors in the results.

function countErrors(urlChecks, options) {

var numErrors = 0;

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

if (options.validCodes.indexOf(urlChecks[i].responseCode) == -1) {

numErrors++;

}

return numErrors;

}

/**

* Saves URLs for a particular account to the spreadsheet starting at the first

* unused row.

* @param {Object} spreadsheet The spreadsheet object.

* @param {Array.<Object>} urlChecks A list of URL check results.

* @param {Object} options Dictionary of options.

function saveUrlsToSpreadsheet(spreadsheet, urlChecks, options) {

// Build each row of output values in the order of the columns.

var outputValues = [];

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

var urlCheck = urlChecks[i];

if (options.saveAllUrls ||

options.validCodes.indexOf(urlCheck.responseCode) == -1) {

outputValues.push([

urlCheck.customerId,

new Date(urlCheck.timestamp),

urlCheck.url,

urlCheck.responseCode,

urlCheck.entityType,

urlCheck.campaign,

urlCheck.adGroup,

urlCheck.ad,

urlCheck.keyword,

urlCheck.sitelink

]);

}

if (outputValues.length > 0) {

// Find the first open row on the Results tab below the headers and create a

// range large enough to hold all of the output, one per row.

var headers = spreadsheet.getRangeByName(NAMES.RESULT_HEADERS);

var lastRow = headers.getSheet().getDataRange().getLastRow();

var outputRange = headers.offset(lastRow - headers.getRow() + 1,

0, outputValues.length);

outputRange.setValues(outputValues);

}

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

spreadsheet.addEditor(CONFIG.RECIPIENT_EMAILS[i]);

}

/**

* Sends an email to a list of email addresses with a link to the spreadsheet

* and the results of this execution of the script.

* @param {Object} spreadsheet The spreadsheet object.

* @param {boolean} numErrors The number of errors found in this execution.

function sendIntermediateEmail(spreadsheet, numErrors) {

spreadsheet.getRangeByName(NAMES.DATE_EMAILED).setValue(new Date());

MailApp.sendEmail(CONFIG.RECIPIENT_EMAILS.join(','),

'Link Checker Results',

'The Link Checker script found ' + numErrors + ' URLs with errors in ' +

'an execution that just finished. See ' +

spreadsheet.getUrl() + ' for details.');

}

/**

* Sends an email to a list of email addresses with a link to the spreadsheet

* and the results across the entire account.

* @param {Object} spreadsheet The spreadsheet object.

* @param {boolean} numErrors The number of errors found in the entire account.

function sendFinalEmail(spreadsheet, numErrors) {

spreadsheet.getRangeByName(NAMES.DATE_EMAILED).setValue(new Date());

MailApp.sendEmail(CONFIG.RECIPIENT_EMAILS.join(','),

'Link Checker Results',

'The Link Checker script found ' + numErrors + ' URLs with errors ' +

'across its entire analysis. See ' +

spreadsheet.getUrl() + ' for details.');

}

/**

* Retrieves all final URLs and mobile final URLs in the account across ads,

* keywords, and sitelinks that were checked in a previous run, as indicated by

* them having been labeled.

* @param {Object} options Dictionary of options.

* @return {Object} A map of previously checked URLs with the URL as the key.

function getAlreadyCheckedUrls(options) {

var urlMap = {};

var addToMap = function(items) {

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

var urls = expandUrlModifiers(items[i]);

urls.forEach(function(url) {

urlMap[url] = true;

});

}

};

if (options.checkAdUrls) {

addToMap(getUrlsBySelector(AdWordsApp.ads().

withCondition(labelCondition(true))));

}

if (options.checkKeywordUrls) {

addToMap(getUrlsBySelector(AdWordsApp.keywords().

withCondition(labelCondition(true))));

}

if (options.checkSitelinkUrls) {

addToMap(getAlreadyCheckedSitelinkUrls());

}

return urlMap;

}

/**

* Retrieves all final URLs and mobile final URLs for campaign and ad group

* sitelinks.

* @return {Array.<string>} An array of URLs.

function getAlreadyCheckedSitelinkUrls() {

var urls = [];

// Helper method to get campaign or ad group sitelink URLs.

var addSitelinkUrls = function(selector) {

var iterator = selector.withCondition(labelCondition(true)).get();

while (iterator.hasNext()) {

var entity = iterator.next();

var sitelinks = entity.extensions().sitelinks();

urls = urls.concat(getUrlsBySelector(sitelinks));

}

};

addSitelinkUrls(AdWordsApp.campaigns());

addSitelinkUrls(AdWordsApp.adGroups());

return urls;

}

/**

* Retrieves all URLs in the entities specified by a selector.

* @param {Object} selector The selector specifying the entities to use.

* The entities should be of a type that has a urls() method.

* @return {Array.<string>} An array of URLs.

function getUrlsBySelector(selector) {

var urls = [];

var entities = selector.get();

// Helper method to add the url to the list if it exists.

var addToList = function(url) {

if (url) {

urls.push(url);

}

};

while (entities.hasNext()) {

var entity = entities.next();

addToList(entity.urls().getFinalUrl());

addToList(entity.urls().getMobileFinalUrl());

}

return urls;

}

/**

* Retrieves all final URLs and mobile final URLs in the account across ads,

* keywords, and sitelinks, and checks their response code. Does not check

* previously checked URLs.

* @param {Object} checkedUrls A map of previously checked URLs with the URL as

* the key.

* @param {Array.<Object>} urlChecks An array into which the results of each URL

* check will be inserted.

* @param {Object} options Dictionary of options.

* @return {boolean} True if all URLs were checked.

function checkUrls(checkedUrls, urlChecks, options) {

var didComplete = true;

// Helper method to add common conditions to ad group and keyword selectors.

var addConditions = function(selector, includePaused) {

var statuses = ['ENABLED'];

if (includePaused) {

statuses.push('PAUSED');

}

var predicate = ' IN [' + statuses.join(',') + ']';

return selector.withCondition(labelCondition(false)).

withCondition('Status' + predicate).

withCondition('CampaignStatus' + predicate).

withCondition('AdGroupStatus' + predicate);

};

if (options.checkAdUrls) {

didComplete = didComplete && checkUrlsBySelector(checkedUrls, urlChecks,

addConditions(AdWordsApp.ads().withCondition('CreativeFinalUrls != ""'),

options.checkPausedAds));

}

if (options.checkKeywordUrls) {

didComplete = didComplete && checkUrlsBySelector(checkedUrls, urlChecks,

addConditions(AdWordsApp.keywords().withCondition('FinalUrls != ""'),

options.checkPausedKeywords));

}

if (options.checkSitelinkUrls) {

didComplete = didComplete &&

checkSitelinkUrls(checkedUrls, urlChecks, options);

}

return didComplete;

}

/**

* Retrieves all final URLs and mobile final URLs in a selector and checks them

* for a valid response code. Does not check previously checked URLs. Labels the

* entity that it was checked, if possible.

* @param {Object} checkedUrls A map of previously checked URLs with the URL as

* the key.

* @param {Array.<Object>} urlChecks An array into which the results of each URL

* check will be inserted.

* @param {Object} selector The selector specifying the entities to use.

* The entities should be of a type that has a urls() method.

* @return {boolean} True if all URLs were checked.

function checkUrlsBySelector(checkedUrls, urlChecks, selector) {

var customerId = AdWordsApp.currentAccount().getCustomerId();

var iterator = selector.get();

var entities = [];

// Helper method to check a URL.

var checkUrl = function(entity, url) {

if (!url) {

return;

}

var urlsToCheck = expandUrlModifiers(url);

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

var expandedUrl = urlsToCheck[i];

if (checkedUrls[expandedUrl]) {

continue;

}

var responseCode = requestUrl(expandedUrl);

var entityType = entity.getEntityType();

urlChecks.push({

customerId: customerId,

timestamp: new Date(),

url: expandedUrl,

responseCode: responseCode,

entityType: entityType,

campaign: entity.getCampaign ? entity.getCampaign().getName() : '',

adGroup: entity.getAdGroup ? entity.getAdGroup().getName() : '',

ad: entityType == 'Ad' ? getAdAsText(entity) : '',

keyword: entityType == 'Keyword' ? entity.getText() : '',

sitelink: entityType.indexOf('Sitelink') != -1 ?

entity.getLinkText() : ''

});

checkedUrls[expandedUrl] = true;

}

};

while (iterator.hasNext()) {

entities.push(iterator.next());

}

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

var entity = entities[i];

checkUrl(entity, entity.urls().getFinalUrl());

checkUrl(entity, entity.urls().getMobileFinalUrl());

// Sitelinks do not have labels.

if (entity.applyLabel) {

entity.applyLabel(CONFIG.LABEL);

checkTimeout();

}

// True only if we did not breach an iterator limit.

return entities.length == iterator.totalNumEntities();

}

/**

* Retrieves a text representation of an ad, casting the ad to the appropriate

* type if necessary.

* @param {Ad} ad The ad object.

* @return {string} The text representation.

function getAdAsText(ad) {

// There is no AdTypeSpace method for textAd

if (ad.getType() === 'TEXT_AD') {

return ad.getHeadline();

} else if (ad.isType().expandedTextAd()) {

var eta = ad.asType().expandedTextAd();

return eta.getHeadlinePart1() + ' - ' + eta.getHeadlinePart2();

} else if (ad.isType().gmailImageAd()) {

return ad.asType().gmailImageAd().getName();

} else if (ad.isType().gmailMultiProductAd()) {

return ad.asType().gmailMultiProductAd().getHeadline();

} else if (ad.isType().gmailSinglePromotionAd()) {

return ad.asType().gmailSinglePromotionAd().getHeadline();

} else if (ad.isType().html5Ad()) {

return ad.asType().html5Ad().getName();

} else if (ad.isType().imageAd()) {

return ad.asType().imageAd().getName();

} else if (ad.isType().responsiveDisplayAd()) {

return ad.asType().responsiveDisplayAd().getLongHeadline();

}

return 'N/A';

}

/**

* Retrieves all final URLs and mobile final URLs for campaign and ad group

* sitelinks and checks them for a valid response code. Does not check

* previously checked URLs. Labels the containing campaign or ad group that it

* has been checked.

* @param {Object} checkedUrls A map of previously checked URLs with the URL as

* the key.

* @param {Array.<Object>} urlChecks An array into which the results of each URL

* check will be inserted.

* @param {Object} options Dictionary of options.

* @return {boolean} True if all URLs were checked.

function checkSitelinkUrls(checkedUrls, urlChecks, options) {

var didComplete = true;

// Helper method to check URLs for sitelinks in a campaign or ad group

// selector.

var checkSitelinkUrls = function(selector) {

var iterator = selector.withCondition(labelCondition(false)).get();

var entities = [];

while (iterator.hasNext()) {

entities.push(iterator.next());

}

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

var entity = entities[i];

var sitelinks = entity.extensions().sitelinks();

if (sitelinks.get().hasNext()) {

didComplete = didComplete &&

checkUrlsBySelector(checkedUrls, urlChecks, sitelinks);

entity.applyLabel(CONFIG.LABEL);

checkTimeout();

}

// True only if we did not breach an iterator limit.

didComplete = didComplete &&

entities.length == iterator.totalNumEntities();

};

var statuses = ['ENABLED'];

if (options.checkPausedSitelinks) {

statuses.push('PAUSED');

}

var predicate = ' IN [' + statuses.join(',') + ']';

checkSitelinkUrls(AdWordsApp.campaigns().

withCondition('Status' + predicate));

checkSitelinkUrls(AdWordsApp.adGroups().

withCondition('Status' + predicate).

withCondition('CampaignStatus' + predicate));

return didComplete;

}

/**

* Expands a URL that contains ValueTrack parameters such as {ifmobile:mobile}

* to all the combinations, and returns as an array. The following pairs of

* ValueTrack parameters are currently expanded:

* 1. {ifmobile:<...>} and {ifnotmobile:<...>} to produce URLs simulating

* clicks from either mobile or non-mobile devices.

* 2. {ifsearch:<...>} and {ifcontent:<...>} to produce URLs simulating

* clicks on either the search or display networks.

* Any other ValueTrack parameters or customer parameters are stripped out from

* the URL entirely.

* @param {string} url The URL which may contain ValueTrack parameters.

* @return {!Array.<string>} An array of one or more expanded URLs.

function expandUrlModifiers(url) {

var ifRegex = /({(if\w+):([^}]+)})/gi;

var modifiers = {};

var matches;

while (matches = ifRegex.exec(url)) {

// Tags are case-insensitive, e.g. IfMobile is valid.

modifiers[matches[2].toLowerCase()] = {

substitute: matches[0],

replacement: matches[3]

};

}

if (Object.keys(modifiers).length) {

if (modifiers.ifmobile || modifiers.ifnotmobile) {

var mobileCombinations =

pairedUrlModifierReplace(modifiers, 'ifmobile', 'ifnotmobile', url);

} else {

var mobileCombinations = [url];

}

// Store in a map on the offchance that there are duplicates.

var combinations = {};

mobileCombinations.forEach(function(url) {

if (modifiers.ifsearch || modifiers.ifcontent) {

pairedUrlModifierReplace(modifiers, 'ifsearch', 'ifcontent', url)

.forEach(function(modifiedUrl) {

combinations[modifiedUrl] = true;

});

} else {

combinations[url] = true;

}

});

var modifiedUrls = Object.keys(combinations);

} else {

var modifiedUrls = [url];

}

// Remove any custom parameters

return modifiedUrls.map(function(url) {

return url.replace(/{[0-9a-zA-Z\_\+\:]+}/g, '');

});

}

/**

* Return a pair of URLs, where each of the two modifiers is mutually exclusive,

* one for each combination. e.g. Evaluating ifmobile and ifnotmobile for a

* mobile and a non-mobile scenario.

* @param {Object} modifiers A map of ValueTrack modifiers.

* @param {string} modifier1 The modifier to honour in the URL.

* @param {string} modifier2 The modifier to remove from the URL.

* @param {string} url The URL potentially containing ValueTrack parameters.

* @return {Array.<string>} A pair of URLs, as a list.

function pairedUrlModifierReplace(modifiers, modifier1, modifier2, url) {

return [

urlModifierReplace(modifiers, modifier1, modifier2, url),

urlModifierReplace(modifiers, modifier2, modifier1, url)

];

}

/**

* Produces a URL where the first {if...} modifier is set, and the second is

* deleted.

* @param {Object} mods A map of ValueTrack modifiers.

* @param {string} mod1 The modifier to honour in the URL.

* @param {string} mod2 The modifier to remove from the URL.

* @param {string} url The URL potentially containing ValueTrack parameters.

* @return {string} The resulting URL with substitions.

function urlModifierReplace(mods, mod1, mod2, url) {

var modUrl = mods[mod1] ?

url.replace(mods[mod1].substitute, mods[mod1].replacement) :

url;

return mods[mod2] ? modUrl.replace(mods[mod2].substitute, '') : modUrl;

}

/**

* Requests a given URL. Retries if the UrlFetchApp QPS limit was reached,

* exponentially backing off on each retry. Throws an exception if it reaches

* the maximum number of retries. Throws an exception if the UrlFetchApp daily

* quota limit was reached.

* @param {string} url The URL to test.

* @return {number|string} The response code received when requesting the URL,

* or an error message.

function requestUrl(url) {

var responseCode;

var sleepTime = QUOTA_CONFIG.INIT_SLEEP_TIME;

var numTries = 0;

while (numTries < QUOTA_CONFIG.MAX_TRIES && !responseCode) {

try {

// If UrlFetchApp.fetch() throws an exception, responseCode will remain

// undefined.

responseCode =

UrlFetchApp.fetch(url, {muteHttpExceptions: true}).getResponseCode();

if (CONFIG.THROTTLE > 0) {

Utilities.sleep(CONFIG.THROTTLE);

}

} catch(e) {

if (e.message.indexOf('Service invoked too many times in a short time:')

!= -1) {

Utilities.sleep(sleepTime);

sleepTime *= QUOTA_CONFIG.BACKOFF_FACTOR;

} else if (e.message.indexOf('Service invoked too many times:') != -1) {

throw EXCEPTIONS.LIMIT;

} else {

return e.message;

}

numTries++;

}

if (!responseCode) {

throw EXCEPTIONS.QPS;

} else {

return responseCode;

}

/**

* Throws an exception if the script is close to timing out.

function checkTimeout() {

if (AdWordsApp.getExecutionInfo().getRemainingTime() <

CONFIG.TIMEOUT_BUFFER) {

throw EXCEPTIONS.TIMEOUT;

}

/**

* Returns the number of days between two dates.

* @param {Object} from The older Date object.

* @param {Object} to The newer (more recent) Date object.

* @return {number} The number of days between the given dates (possibly

* fractional).

function dayDifference(from, to) {

return (to.getTime() - from.getTime()) / (24 * 3600 * 1000);

}

/**

* Builds a string to be used for withCondition() filtering for whether the

* label is present or not.

* @param {boolean} hasLabel True if the label should be present, false if the

* label should not be present.

* @return {string} A condition that can be used in withCondition().

function labelCondition(hasLabel) {

return 'LabelNames ' + (hasLabel ? 'CONTAINS_ANY' : 'CONTAINS_NONE') +

' ["' + CONFIG.LABEL + '"]';

}

/**

* Retrieves an entity by name.

* @param {Object} selector A selector for an entity type with a Name field.

* @param {string} name The name to retrieve the entity by.

* @return {Object} The entity, if it exists, or null otherwise.

function getEntityByName(selector, name) {

var entities = selector.withCondition('Name = "' + name + '"').get();

if (entities.hasNext()) {

return entities.next();

} else {

return null;

}

/**

* Retrieves a Label object by name.

* @param {string} labelName The label name to retrieve.

* @return {Object} The Label object, if it exists, or null otherwise.

function getLabel(labelName) {

return getEntityByName(AdWordsApp.labels(), labelName);

}

/**

* Checks that the account has all provided labels and creates any that are

* missing. Since labels cannot be created in preview mode, throws an exception

* if a label is missing.

* @param {Array.<string>} labelNames An array of label names.

function ensureLabels(labelNames) {

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

var labelName = labelNames[i];

var label = getLabel(labelName);

if (!label) {

if (!AdWordsApp.getExecutionInfo().isPreview()) {

AdWordsApp.createLabel(labelName);

} else {

throw 'Label ' + labelName + ' is missing and cannot be created in ' +

'preview mode. Please run the script or create the label manually.';

}

/**

* Removes all provided labels from the account. Since labels cannot be removed

* in preview mode, throws an exception in preview mode.

* @param {Array.<string>} labelNames An array of label names.

function removeLabels(labelNames) {

if (AdWordsApp.getExecutionInfo().isPreview()) {

throw 'Cannot remove labels in preview mode. Please run the script or ' +

'remove the labels manually.';

}

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

var label = getLabel(labelNames[i]);

if (label) {

label.remove();

}

/**

* Validates the provided spreadsheet URL to make sure that it's set up

* properly. Throws a descriptive error message if validation fails.

* @param {string} spreadsheeturl The URL of the spreadsheet to open.

* @return {Spreadsheet} The spreadsheet object itself, fetched from the URL.

* @throws {Error} If the spreadsheet URL hasn't been set

function validateAndGetSpreadsheet(spreadsheeturl) {

if (spreadsheeturl == 'YOUR_SPREADSHEET_URL') {

throw new Error('Please specify a valid Spreadsheet URL. You can find' +

' a link to a template in the associated guide for this script.');

}

return SpreadsheetApp.openByUrl(spreadsheeturl);

}

/**

* Validates the provided email addresses to make sure it's not the default.

* Throws a descriptive error message if validation fails.

* @param {Array.<string>} recipientEmails The list of email adresses.

* @throws {Error} If the list of email addresses is still the default

function validateEmailAddresses(recipientEmails) {

if (recipientEmails &&

recipientEmails[0] == 'YOUR_EMAIL_HERE') {

throw new Error('Please either specify a valid email address or clear' +

' the RECIPIENT_EMAILS field.');

}

Tiếp theo là bạn xác thực quyền cho phép script bắt đầu chạy

Bước 3: chỉnh sửa lại lịch chạy script, bây giờ bạn có thể cho chạy script và vào file sheet để xem kết quả.

Vậy là xong, có gì thắc mắc các bạn để lại dưới comment nhé!

5/5 - (1 vote)

Script báo link không hoạt động trong Google Adwrods

Bước 1: Tạo một file Google Sheet để hệ thống ghi dữ liệu những link không hoạt động

Bước 2: Cài đặt Script kiểm tra link không hoạt động quảng cáo trong tài khoản Adwords

Bước 3: chỉnh sửa lại lịch chạy script, bây giờ bạn có thể cho chạy script và vào file sheet để xem kết quả.

Bài viết nổi bật

Hướng dẫn thêm quyền quản trị Google Analytics

Hướng dẫn thay đổi ngôn ngữ ở Google Analytics

👍 Trọn bộ Icon Facebook 2020 mới nhất

Hướng dẫn thêm quyền quản trị Google Adwords

Hướng dẫn cài đặt Google Adwords Remarketng

Bài viết nổi bật

Hướng dẫn thêm quyền quản trị Google Analytics

Hướng dẫn thay đổi ngôn ngữ ở Google Analytics

Chuyên mục nổi bật