Account Auditor: Einzelnes Konto

This script is for a single account. For operating on multiple accounts in a Manager Account, use the Manager Account version of the script.

Viele Werbetreibende strukturieren ihre Konten am liebsten konsistent. Manche Werbetreibende strukturieren beispielsweise jede Kampagne so, dass sie eine feste Anzahl von Anzeigengruppen enthält, und jede Anzeigengruppe so, dass sie eine feste Anzahl von Anzeigen und Keywords beinhaltet. Andere Werbetreibende verwenden Labels, um ihre Konten zu organisieren, und kennzeichnen jede Kampagne oder Anzeigengruppe mit mindestens einem Label aus einer kurzen Liste. Wieder andere organisieren ihre Anzeigengruppen oder Anzeigen so, dass zu einem bestimmten Zeitpunkt nur eine Anzeigengruppe oder Anzeige aktiviert ist. Damit Ihr Konto die gewünschte konsistente Struktur aufweist, müssen Sie häufig viel Zeit für die manuelle Bearbeitung aufwenden.

Mit dem Account Auditor können Sie die Struktur Ihrer Kampagnen, Anzeigengruppen, Anzeigen und Keywords leichter organisieren. Sie definieren die gewünschte Struktur mithilfe flexibler "Regeln" in einer Tabelle. Das Skript analysiert Ihr Konto und führt alle Entitäten, die Ihren Regeln nicht entsprechen, auf einem separaten Tab der Tabelle auf.

Der Account Auditor funktioniert ähnlich wie die automatisierten Regeln in AdWords, eine leistungsstarke Funktion, mit der Werbetreibende mithilfe von Regeln Änderungen an ihrem Konto vornehmen oder E-Mail-Benachrichtigungen senden können. Der Hauptunterschied besteht darin, dass Sie mit dem Account Auditor die strukturellen Bedingungen Ihrer Konten überprüfen können, beispielsweise, dass jede aktive Kampagne eine Mindestanzahl von Anzeigengruppen beinhaltet. Automatisierte Regeln konzentrieren sich hingegen vorwiegend auf Leistungsmesswerte.

Konfiguration

Grundlagen

Sie konfigurieren den Account Auditor, indem Sie Regeln in einer Tabelle festlegen. Erstellen Sie eine Kopie dieser Tabellenvorlage und ersetzen Sie die Beispielregeln durch Ihre eigenen oder bearbeiten bzw. erweitern diese.

Das obige Beispiel zeigt verschiedene wichtige Funktionen:

  • Jede Zeile enthält eine einzelne Regel. Eine Regel besteht aus drei Teilen: einer eindeutigen ID (erforderlich), einem Trigger (optional) und einem Test (erforderlich).
  • Ein Trigger oder Test beinhaltet einen Entitätstyp (erforderlich) und Bedingungen (optional). Ein Test umfasst außerdem die erwartete Anzahl der Testentitäten, die den Testbedingungen entsprechen müssen (erforderlich).
  • Ein Trigger oder Test kann mehrere Bedingungen beinhalten. Jede Bedingung muss in eine Zeile derselben Zelle eingefügt werden (nicht in eine separate Zeile).
  • In einem Test kann festgelegt werden, dass alle Entitäten den Bedingungen entsprechen müssen oder dass eine numerische Bedingung erfüllt werden muss, z. B. >5 Entitäten.

Regeln

Im Allgemeinen kann eine Zeile folgendermaßen interpretiert werden: "Für jeden Triggerentitätstyp der den Triggerbedingungen entspricht, muss die erwartete Anzahl der zugehörigen Entitäten des Testentitätstyps den Testbedingungen entsprechen". Sie können sich den Trigger wie einen Filter vorstellen, der bestimmt, für welche Entitäten der Test gilt. Die im obigen Beispiel definierten Regeln sind unten aufgelistet.

  • IDs 1, 2, 3: Jede aktivierte Kampagne muss mindestens zwei aktivierte Anzeigengruppen beinhalten. Jede aktivierte Anzeigengruppe muss mindestens fünf aktivierte Anzeigen enthalten. Und schließlich muss jede aktivierte Anzeigengruppe mindestens zehn aktivierte Keywords umfassen.
  • ID 4: Das Budget jeder aktivierten Kampagne darf nicht null sein.
  • ID 5: Jede aktivierte Anzeigengruppe mit dem Label "Immer ausliefern" muss Teil einer aktivierten Kampagne sein.
  • ID 6: Jede aktivierte Textanzeige, deren Anzeigentitel "schuhe" beinhaltet, muss mit allen aktivierten Keywords verknüpft sein (d. h. Teil der selben Anzeigengruppe sein), die "schuhe" enthalten.
  • ID 7: Jedes Keyword mit einem niedrigeren Qualitätsfaktor als 3 muss deaktiviert sein (d. h. die Anzahl der aktivierten Keywords ist null).
  • ID 8: Alle Anzeigen müssen Textanzeigen sein.

Der Trigger ist optional. Wenn er wie in Regel-ID 8 ausgelassen wird, wird der Test auf alle Entitäten des Testentitätstyps angewendet.

Formatierung

Für die Bedingungen eines Triggers oder Tests muss wie in der folgenden Tabelle das Format der Methode withCondition(condition) des entsprechenden Entitätstyps verwendet werden:

Entitätstyp Format der Bedingung
Kampagne CampaignSelector.withCondition(Bedingung)
Anzeigengruppe AdGroupSelector.withCondition(Bedingung)
Anzeige AdSelector.withCondition(Bedingung)
Keyword KeywordSelector.withCondition(Bedingung)

Bedingungen werden nur für Entitätsattribute unterstützt. Bedingungen für Statistikspalten werden nicht unterstützt.

Sie können mehrere Bedingungen festlegen, indem Sie jede Bedingung in eine Zeile derselben Zelle einfügen (nicht in eine separate Zeile). Mehrere Bedingungen werden mit UND verknüpft.

Drücken Sie Strg + Enter oder Alt + Enter, um innerhalb einer Zelle eine neue Zeile einzufügen, während Sie die Zelleninhalte bearbeiten.

Die erwartete Anzahl der Testentitäten, die die Testbedingungen erfüllen, muss in einem einfachen Format vorliegen:

  • Das Wort All bedeutet, dass alle Testentitäten die Testbedingungen erfüllen müssen.
  • Eine Zahl bedeutet, dass genau so viele Testentitäten die Testbedingungen erfüllen müssen. Die Zahl muss eine Ganzzahl größer als oder gleich null sein.
  • Einfach Ausdrücke in der Form Operator Number wie >= 3 oder != 0 können verwendet werden. Zulässige Operatoren sind =, !=, <, >, <= und >=. Hinweis: Die Verwendung des Operators = entspricht dem Auslassen des Operators.

Wenn der Triggerentitätstyp dem Testentitätstyp entspricht oder spezifischer ist als dieser, muss die im Test festgelegte erwartete Anzahl All sein.

Planung

Planen Sie das Skript so, dass es so oft ausgeführt wird, wie Sie wesentliche strukturelle Änderungen an Ihrem Konto bzw. speziell organisierten Entitäten vornehmen, wie das Erstellen, Entfernen, Aktivieren oder Pausieren von Kampagnen, Anzeigengruppen, Anzeigen und Keywords. Wenn Sie nur unregelmäßig strukturelle Änderungen an Ihrem Konto vornehmen, reicht es vermutlich aus, das Skript wöchentlich zu planen. Wenn Sie häufig entweder selbst oder mithilfe anderer Skripts strukturelle Änderungen vornehmen, sollten Sie das Skript täglich oder sogar stündlich planen.

Funktionsweise

Das Skript lädt und parst nacheinander jede Regel in der Tabelle und stoppt bei der ersten Zeile, in der keine ID eingetragen ist. Daraufhin überprüft es jede Regel, indem es die relevanten Entitäten abruft und untersucht. Der Triggerentitätstyp kann umfangreicher oder weniger umfangreich als der Testentitätstyp sein, ihm ähnlich sein oder ihm entsprechen. Das Skript kennt die Hierarchie der AdWords-Entitäten und wendet jede Regel entsprechend an.

Das Skript verwendet die assoziative Indexierung, um die benötigten Methoden für AdWords-Entitäten flexibel zu ermitteln. Ein Beispiel: Der Ausdruck im Skript trigger[testInfo.selector](), in dem trigger eine Entität des AdWords-Skripts und testInfo.selector der Name einer Methode ist, um einen Selektor wie campaigns oder adGroups zu erhalten, entspricht den bekannteren Varianten trigger.campaigns() oder trigger.adGroups(). Dies macht sich die Tatsache zunutze, dass Methoden für alle Entitätstypen in AdWords-Skripts konsistent bezeichnet werden.

Wenn das Skript einen Regelverstoß entdeckt, gibt es die Details auf dem Tab Berichte der Tabelle aus und sendet eine E-Mail-Benachrichtigung an eine Empfängerliste. Auf dem Tab Berichte wird die Entität angezeigt, die die Regel ausgelöst hat, und der Grund, aus dem der Test fehlgeschlagen ist. Der Grund ist entweder eine bestimmte Entität, die die Testbedingungen nicht erfüllt hat (wenn für die erwartete Anzahl der Testentitäten, die die Testbedingungen erfüllen, All angegeben wurde), oder die Anzahl der Entitäten, die die Testbedingungen erfüllen (wenn die erwartete Anzahl ein Ausdruck ist).

Einrichtung

  • Erstellen Sie ein Skript mit dem unten stehenden Quellcode. Verwenden Sie dazu eine Kopie dieser Tabellenvorlage.
  • Fügen Sie der Tabelle Regeln hinzu, wie es unter Konfiguration beschrieben wurde.
  • Passen Sie die Variablen SPREADSHEET_URL und RECIPIENT_EMAILS im Skript an.
  • Planen Sie das Skript.

Quellcode

// 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 Account Auditor
 *
 * @overview The Account Auditor script helps you keep your accounts
 *     organized as you intend by automatically checking many types of
 *     structural conditions on your campaigns, ad groups, ads, and keywords.
 *     You define your intended structure using flexible "rules" in a
 *     spreadsheet, and the script analyzes your account and reports any
 *     entities that failed to satisfy your rules on a separate tab of the
 *     spreadsheet. See
 *     https://developers.google.com/adwords/scripts/docs/solutions/account-auditor
 *     for more details.
 *
 * @author AdWords Scripts Team [adwords-scripts@googlegroups.com]
 *
 * @version 1.1.1
 *
 * @changelog
 * - version 1.1.1
 *   - Added validation for external spreadsheet setup.
 * - version 1.1
 *   - Added support for different ad types, including expanded text ads.
 * - version 1.0.1
 *   - Improvements to time zone handling. Minor bug fixes.
 * - version 1.0
 *   - Released initial version.
 */

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

  // Whether to output results to a copy of the above spreadsheet (true) or to
  // the spreadsheet directly, overwriting previous results (false).
  COPY_SPREADSHEET: false,

  // Array of addresses to be alerted via email if rule failures are found.
  RECIPIENT_EMAILS: [
    'YOUR_EMAIL_HERE'
  ]
};

// See applyRule() below for examples of each type.
var RULE_TYPES = {
  NO_TRIGGER: 'Rule applies to all entities of test entity type',
  BROAD_TRIGGER: 'Trigger entity type is broader than test entity type',
  NARROW_TRIGGER: 'Test entity type is broader than trigger entity type',
  SAME_TYPE: 'Trigger and test entity types are the same',
  SIBLING_TYPE: 'Trigger and test entity types are different but the same level'
};

// Static information for each type of entity.
// The keys in this table match the drop-down values in the spreadsheet and the
// values returned by getEntityType().
// selector: Name of the method used by a higher-level entity to retrieve a
//     selector for its descendant entities of this type.
// getter: Name of the method used by a lower-level entity to retrieve its
//     ancestor entity of this type.
// asText: Either:
//     (a) A string representing the method for this entity which returns a text
//         representation, OR
//     (b) A function, which when passed the entity as a single argument,
//         returns a text representation.
// level: Where the entity falls in the entity hierarchy. Lower numbers
//     represent broader entity types.
// parentType: The type of the entity's parent.
var ENTITY_TYPE_INFO = {
  Campaign: {
    selector: 'campaigns',
    getter: 'getCampaign',
    asText: 'getName',
    level: 1
  },
  AdGroup: {
    selector: 'adGroups',
    getter: 'getAdGroup',
    asText: 'getName',
    level: 2,
    parentType: 'Campaign'
  },
  Ad: {
    selector: 'ads',
    // For ads, asText references a specific function, not a method name. For
    // details refer to the above JSDoc or @see getEntityDetails definition.
    asText: getAdAsText,
    level: 3,
    parentType: 'AdGroup'
  },
  Keyword: {
    selector: 'keywords',
    asText: 'getText',
    level: 3,
    parentType: 'AdGroup'
  }
};

function main() {
  var failures = findFailures();

  var spreadsheet = validateAndGetSpreadsheet(CONFIG.SPREADSHEET_URL);
  if (CONFIG.COPY_SPREADSHEET) {
    spreadsheet = spreadsheet.copy('Account Auditor');
  }
  initializeSpreadsheet(spreadsheet);

  var hasFailures = outputFailures(spreadsheet,
    AdWordsApp.currentAccount().getCustomerId(), failures);

  if (hasFailures) {
    validateEmailAddresses();
    sendEmail(spreadsheet);
  }
}

/**
 * Checks the account against all of the rules in the spreadsheet.
 *
 * @return {Array.<Object>} A list of failures found.
 */
function findFailures() {
  var rules = loadRules();
  var failures = [];

  for (var i = 0; i < rules.length; i++) {
    failures = failures.concat(applyRule(rules[i]));
  }

  return failures;
}

/**
 * Saves failures to a spreadsheet if present.
 *
 * @param {Object} spreadsheet The spreadsheet object.
 * @param {string} customerId The account the failures are for.
 * @param {Array.<Object>} failures A list of failures.
 * @return {boolean} True if there were failures and false otherwise.
 */
function outputFailures(spreadsheet, customerId, failures) {
  if (failures.length > 0) {
    saveFailuresToSpreadsheet(spreadsheet, customerId, failures);
    Logger.log('Rule failures were found for ' + customerId +
               '. See ' + spreadsheet.getUrl());
    return true;
  } else {
    Logger.log('No rule failures were found for ' + customerId + '.');
    return false;
  }
}

/**
 * Sets up the spreadsheet to receive output.
 *
 * @param {Object} spreadsheet The spreadsheet object.
 */
function initializeSpreadsheet(spreadsheet) {
  // Make sure the spreadsheet is using the account's timezone.
  spreadsheet.setSpreadsheetTimeZone(AdWordsApp.currentAccount().getTimeZone());

  // Clear the last run date on the spreadsheet.
  spreadsheet.getRangeByName('RunDate').clearContent();

  // Clear all rows in the Report tab of the spreadsheet below the header row.
  var outputRange = spreadsheet.getRangeByName('ReportHeaders')
    .offset(1, 0, spreadsheet.getSheetByName('Report')
        .getDataRange().getLastRow())
    .clearContent();
}

/**
 * Saves failures for a particular account to the spreadsheet starting at the
 * first unused row.
 *
 * @param {Object} spreadsheet The spreadsheet object.
 * @param {string} customerId The account that the failures are for.
 * @param {Array.<Object>} failures A list of failure objects.
 */
function saveFailuresToSpreadsheet(spreadsheet, customerId, failures) {
  // Find the first open row on the Report tab below the headers and create a
  // range large enough to hold all of the failures, one per row.
  var lastRow = spreadsheet.getSheetByName('Report')
    .getDataRange().getLastRow();
  var headers = spreadsheet.getRangeByName('ReportHeaders');
  var outputRange = headers
    .offset(lastRow - headers.getRow() + 1, 0, failures.length);

  // Build each row of output values in the order of the Report tab columns.
  var outputValues = [];
  for (var i = 0; i < failures.length; i++) {
    var failure = failures[i];
    outputValues.push([
      customerId,
      failure.ruleId,
      '',                               // blank column
      failure.trigger.entityType,
      failure.trigger.entityId,
      failure.trigger.entityText,
      '',                               // blank column
      failure.test.entityType,
      failure.test.entityId || '',
      failure.test.entityText || '',

      // Include a leading apostrophe to ensure test expressions like "= 0" are
      // not mistakenly treated as formulas.
      failure.test.expected && ('\'' + failure.test.op + ' ' +
                                failure.test.expected) || '',
      failure.test.actual || ''
    ]);
  }
  outputRange.setValues(outputValues);

  spreadsheet.getRangeByName('RunDate').setValue(new Date());

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

/**
 * Sends an email alert that failures were found.
 *
 * @param {Object} spreadsheet The spreadsheet object.
 */
function sendEmail(spreadsheet) {
  MailApp.sendEmail(CONFIG.RECIPIENT_EMAILS.join(','),
      'Account Auditor Script: Rule Failures Were Found',
      'The Account Auditor Script found cases where the entities in your ' +
      'AdWords account(s) did not meet your rules. ' +
      'See the Report tab of ' + spreadsheet.getUrl() + ' for details.');
}

/**
 * Loads the rules from the spreadsheet.
 *
 * @return {Array.<Object>} A list of rule objects.
 */
function loadRules() {
  var rules = [];
  var spreadsheet = validateAndGetSpreadsheet(CONFIG.SPREADSHEET_URL);
  var lastRow = spreadsheet.getSheetByName('Rules').getDataRange().getLastRow();

  // Get all of the rows below the header row.
  var ruleData = spreadsheet.getRange('RuleHeaders')
      .offset(1, 0, lastRow).getValues();

  var ruleIds = {};
  var i = 0;

  while (ruleData[i][0]) {
    var rule = parseRule(ruleData[i]);
    rules.push(rule);

    // Rule IDs must be unique.
    if (!ruleIds[rule.id]) {
      ruleIds[rule.id] = true;
    } else {
      throw 'Multiple rules with ID ' + rule.id + '. Check the spreadsheet ' +
        'to make sure every rule has a unique ID.';
    }

    Logger.log('Loaded rule ' + rule.id + '.');
    i++;
  }

  Logger.log('Total number of rules: ' + i + '.');
  return rules;
}

/**
 * Parses a row from the spreadsheet into a rule object.
 *
 * @param {Array} ruleData A row from the spreadsheet.
 * @return {Object} A rule object.
 */
function parseRule(ruleData) {
  var rule = {
    id: ruleData[0].toString()
  };

  if (!rule.id) {
    throw 'Rule missing ID. Check the spreadsheet to make sure every rule ' +
        'has a unique ID.';
  }

  // Tests are required.
  if (!ruleData[5]) {
    throw 'Rule ' + rule.id + ' test is missing entity type.';
  } else {
    rule.test = {
      entityType: ruleData[5],
      conditions: ruleData[6] && ruleData[6].split('\n')
    };
  }

  // Triggers are optional, but it is invalid to have a condition without an
  // entity type.
  if (ruleData[3] && !ruleData[2]) {
    throw 'Rule ' + rule.id + ' trigger has conditions without an entity type.';
  } else if (ruleData[2]) {
    rule.trigger = {
      entityType: ruleData[2],
      conditions: ruleData[3] && ruleData[3].split('\n')
    };
  }

  // Count expressions are required.
  parsedExpr = parseCountExpr(ruleData[7]);
  if (!parsedExpr) {
    throw 'Rule ' + rule.id + ' has invalid expression for expected number.';
  }
  rule.test.op = parsedExpr.op;
  rule.test.num = parsedExpr.num;

  rule.type = getRuleType(rule);

  // Certain rule types can only use 'All'.
  if ((rule.type == RULE_TYPES.NARROW_TRIGGER ||
       rule.type == RULE_TYPES.SAME_TYPE) &&
      rule.test.op != 'All') {
    throw 'Rule ' + rule.id + ' must use "All" for the expected number.';
  }

  return rule;
}

/**
 * Parses a simple relational expression.
 *
 * @param {string} expr An expression of the form 'Op Num', where Op is one
 *     of '=', '!=', '<', '>', '<=', or '>=' and Num is a non-negative integer
 *     or the special expression 'All'. If Op is omitted it is assumed to be
 *     '='.
 * @return {Object} The parsed Op and Num, or undefined if the parse failed.
 */
function parseCountExpr(expr) {
  expr = expr.toString();

  // Check for the special expression 'All'.
  if (expr.match(/^\s*All\s*$/i)) {
    return {
      op: 'All'
    };
  }

  // If the operator is missing, prepend '=' as the default operator.
  if (expr.match(/^\s*\d*\s*$/)) {
    expr = '=' + expr;
  }

  var regex = /^\s*(\!?\=|\<\=?|\>\=?)\s*(\d*)\s*$/;
  var result = regex.exec(expr);

  if (result) {
    return {
      op: result[1],
      num: result[2]
    };
  }
}

/**
 * Determines the type of rule evaluation strategy to apply.
 *
 * @param {Object} rule A rule object.
 * @return {string} The type of rule evaluation strategy to apply.
 */
function getRuleType(rule) {
  if (!rule.trigger) {
    return RULE_TYPES.NO_TRIGGER;
  } else if (ENTITY_TYPE_INFO[rule.test.entityType].level >
      ENTITY_TYPE_INFO[rule.trigger.entityType].level) {
    return RULE_TYPES.BROAD_TRIGGER;
  } else if (ENTITY_TYPE_INFO[rule.test.entityType].level <
      ENTITY_TYPE_INFO[rule.trigger.entityType].level) {
    return RULE_TYPES.NARROW_TRIGGER;
  } else if (rule.test.entityType == rule.trigger.entityType) {
    return RULE_TYPES.SAME_TYPE;
  } else {
    return RULE_TYPES.SIBLING_TYPE;
  }
}

/**
 * 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';
}

/**
 * Finds all cases where entities in the account fail to match a rule.
 *
 * @param {Object} rule A rule object.
 * @return {Array.<Object>} A list of failure objects, each describing a case
 *     where the rule was not met.
 */
function applyRule(rule) {
  Logger.log('Applying rule ' + rule.id + '.');

  var failures = [];

  var testInfo = ENTITY_TYPE_INFO[rule.test.entityType];

  // Get the trigger entities.
  if (rule.type != RULE_TYPES.NO_TRIGGER) {
    var triggerInfo = ENTITY_TYPE_INFO[rule.trigger.entityType];
    var triggerSelector = AdWordsApp[triggerInfo.selector]();
    addConditions(triggerSelector, rule.trigger.conditions);
    var triggers = triggerSelector.get();
  }

  // Helper method to get details about the entity associated with a failure.
  var getEntityDetails = function(entity) {
    var entityType = entity && entity.getEntityType();

    if (entityType) {
      var text = 'N/A';
      var fn = ENTITY_TYPE_INFO[entityType].asText;

      if (typeof fn === 'string') {
        // Specified as a string method name to get a text representation.
        text = entity[fn]();
      } else if (typeof fn === 'function') {
        // Specified as a function, to which the entity is passed to extract a
        // text representation. Used in the case of Ads, which can have a number
        // of underlying types.
        text = fn(entity);
      }
    }

    return {
      entityId: entity ? entity.getId() : 'N/A',
      entityType: entity ? entityType : 'N/A',
      entityText: text ? text : 'N/A'
    };
  };

  // Helper method to build failures for each entity in a selector that does
  // not match the test conditions.
  var checkAll = function(params) {
    var entities = findMissingEntities(params.selector, rule.test.conditions);

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

      // The trigger is either provided as a map, indicated to be the entity
      // itself, or provided directly (possibly null if there is no trigger).
      var trigger = params.triggerMap && params.triggerMap[entity.getId()] ||
        (params.trigger == 'entity' && entity || params.trigger);

      failures.push({
        ruleId: rule.id,
        trigger: getEntityDetails(trigger),
        test: getEntityDetails(entity)
      });
    }
  };

  // Helper method to build failures where the number of entities in a
  // selector does not match the test's expected number.
  var checkCount = function(params) {
    addConditions(params.selector, rule.test.conditions);
    var expected = rule.test.num;
    var actual = params.selector.get().totalNumEntities();
    var op = rule.test.op || '=';

    if (!compare(actual, expected, op)) {
      failures.push({
        ruleId: rule.id,
        trigger: getEntityDetails(params.trigger),
        test: {
          entityType: rule.test.entityType,
          expected: expected,
          op: op,
          actual: actual
        }
      });
    }
  };

  // Helper method to use the appropriate checker depending on the operator.
  var checkRule = function(params) {
    if (rule.test.op == 'All') {
      checkAll(params);
    } else {
      checkCount(params);
    }
  };

  switch (rule.type) {
    case RULE_TYPES.NO_TRIGGER:
      // Example: All campaigns are enabled (test).
      // Example: There are X enabled campaigns (test).
      checkRule({selector: AdWordsApp[testInfo.selector]()});
      break;

    case RULE_TYPES.NARROW_TRIGGER:
      // Example: For each enabled ad group (trigger), its campaign is enabled
      // (test).
      var testIds = [];
      var triggerMap = {};

      while (triggers.hasNext()) {
        var trigger = triggers.next();
        var testId = trigger[testInfo.getter]().getId();
        testIds.push(testId);
        triggerMap[testId] = trigger;
      }

      checkAll({
        triggerMap: triggerMap,
        selector: AdWordsApp[testInfo.selector]().withIds(testIds)
      });
      break;

    case RULE_TYPES.BROAD_TRIGGER:
      // Example: For each enabled campaign (trigger), all of its ad groups are
      // enabled (test).
      // Example: For each enabled campaign (trigger), it has at least X enabled
      // ad groups (test).
      while (triggers.hasNext()) {
        var trigger = triggers.next();
        var testSelector = trigger[testInfo.selector]();
        checkRule({trigger: trigger, selector: testSelector});
      }
      break;

    case RULE_TYPES.SAME_TYPE:
      // Example: For each ad group with label X (trigger), it is enabled
      // (test).
      checkAll({trigger: 'entity', selector: triggerSelector});
      break;

    case RULE_TYPES.SIBLING_TYPE:
      // Example: For each enabled ad (trigger), it is associated with at least
      // X approved keywords (test).
      var parentIds = {};

      while (triggers.hasNext()) {
        var trigger = triggers.next();
        var parent = trigger[ENTITY_TYPE_INFO[triggerInfo.parentType].getter]();
        var parentId = parent.getId();

        // If we have seen the parent already, it is unnecessary and inefficient
        // to check again since the siblings are the same. This means only the
        // first sibling will be listed as the trigger for any failures.
        if (!parentIds[parentId]) {
          parentIds[parentId] = true;
          var testSelector = parent[testInfo.selector]();
          checkRule({trigger: trigger, selector: testSelector});
        }
      }
      break;
  }

  return failures;
}

/**
 * Adds a set of conditions to a selector. The provided selector is modified.
 *
 * @param {Object} selector An AdWords scripts selector.
 * @param {Array.<string>} conditions An array of conditions to be applied to
 *     the selector using withCondition().
 */
function addConditions(selector, conditions) {
  if (conditions) {
    for (var i = 0; i < conditions.length; i++) {
      selector = selector.withCondition(conditions[i]);
    }
  }
}

/**
 * Retrieves the IDs of a set of AdWords scripts entities.
 *
 * @param {Object} iterator An iterator over an AdWords scripts entity that
 *     has a getId() method.
 * @return {Array.<number>} An array of IDs of the entities.
 */
function getEntityIds(iterator) {
  var ids = [];

  while (iterator.hasNext()) {
    ids.push(iterator.next().getId());
  }

  return ids;
}

/**
 * Identifies entities in a selector that do not match a set of conditions.
 * Modifies the given selector.
 *
 * @param {Object} selector An AdWords scripts selector for an entity type.
 *     that has a getId() method.
 * @param {Array.<string>} conditions An array of conditions to be applied to
 *     the selector using withCondition().
 * @return {Array.<Object>} A list of AdWords objects that did not meet the
 *     conditions.
 */
function findMissingEntities(selector, conditions) {
  var missing = [];

  // Get an iterator *before* applying the conditions.
  var entities = selector.get();

  // Get the IDs of the entities matching the conditions.
  addConditions(selector, conditions);
  var ids = getEntityIds(selector.get());

  while (entities.hasNext()) {
    var entity = entities.next();
    if (ids.indexOf(entity.getId()) == -1) {
      missing.push(entity);
    }
  }

  return missing;
}

/**
 * Compares two numbers using a given operator.
 *
 * @param {number} val1 The first number in the comparison.
 * @param {number} val2 The second number in the comparison.
 * @param {string} op The operator for the comparison.
 * @return {boolean} The result of the comparison 'val1 op val2'.
 */
function compare(val1, val2, op) {
  switch (op) {
    case '=':
      return val1 == val2;
    case '!=':
      return val1 != val2;
    case '<':
      return val1 < val2;
    case '>':
      return val1 > val2;
    case '<=':
      return val1 <= val2;
    case '>=':
      return val1 >= val2;
  }
}

/**
 * DO NOT EDIT ANYTHING BELOW THIS LINE.
 * Please modify your spreadsheet URL and email addresses at the top of the file
 * only.
 */

/**
 * Validates the provided spreadsheet URL and email address
 * to make sure that they're 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 or email 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.');
  }
  var spreadsheet = SpreadsheetApp.openByUrl(spreadsheeturl);
  return spreadsheet;
}

/**
 * Validates the provided email address to make sure it's not the default.
 * Throws a descriptive error message if validation fails.
 *
 * @throws {Error} If the list of email addresses is still the default
 */
function validateEmailAddresses() {
  if (CONFIG.RECIPIENT_EMAILS &&
      CONFIG.RECIPIENT_EMAILS[0] == 'YOUR_EMAIL_HERE') {
    throw new Error('Please specify a valid email address.');
  }
}

    

Feedback geben zu...

AdWords Scripts
AdWords Scripts