Code.js

/***********************************************************************
Copyright 2018 Google Inc.

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.

Note that these code samples being shared are not official Google
products and are not formally supported.
************************************************************************/

// Sheet Names
var CONFIG_SHEET_NAME = 'Config';
var ORIGIN_SHEET_NAME = 'OriginLI';
var DESTINATION_SHEET_NAME = 'DestinationLIs';

// Constants with references to specific cells in the Config sheet
// (update these values if for any reason you're editing the sheet)
var ROW_GENERAL_HEADER = 1;
var ROW_SDF_VERSION = 2;
var ROW_SETTING = 3;
var ROW_ORIGIN_HEADER = 4;
var ROW_ORIGIN_LI_ID = 5;
var ROW_ORIGIN_LI_NAME = 6;
var ROW_ORIGIN_LI_VALUE = 7;
var ROW_DESTINATION_HEADER = 8;
var ROW_DESTINATION_COLUMNS = 9;
var ROW_DESTINATION_LI = 10;
var NUM_COLUMNS = 4;
var CONFIG_HEADERS_COLOR = '#93C47D';
var CONFIG_NAMES_COLOR = '#A4C2F4';
var CONFIG_EDITABLE_VALUES_COLOR = 'cyan';
var CONFIG_AUTOMATIC_VALUES_COLOR = '#EFEFEF';
var CONFIG_DESCRIPTIONS_COLOR = '#D9EAD3';

// Constants from the SDF request filter and response headers
var FILTER_LI = 'LINE_ITEM_ID';
var SDF_ID = 'Line Item Id';
var SDF_NAME = 'Name';

var doc, configSheet, originLiSheet, destinationLisSheet, selectedSetting,
    originLiId;
var originLiObject = {};
var destinationLiObject = {};


/**
 * Creates the "Custom Functions" menu.
 */
function onOpen() {
  var ui = SpreadsheetApp.getUi();
  ui.createMenu('Custom Functions')
      .addItem('Retrieve ORIGIN Line Item info', 'getOrigin_')
      .addItem('Retrieve DESTINATION Line Items info', 'getDestination_')
      .addSeparator()
      .addItem('Copy Line Item setting', 'copyLiSetting_')
      .addSeparator()
      .addItem('Reset', 'reset_')
      .addToUi();
  // Resets the flag to track changes made by the user.
  userProperties.setProperty('haschanges', 'false');
}


/**
 * Function triggered on edit to clear some fields when the user manually
 * updates some specific cells.
 * @param (Object) e The event object from the onEdit trigger.
 */
function customOnEdit(e){
  try {
    doc = SpreadsheetApp.getActiveSpreadsheet();
  } catch (e) {
    // Silent fail.
    return;
  }
  configSheet = doc.getSheetByName(CONFIG_SHEET_NAME);
  var range = e.range;
  if (range.getRow() == ROW_SETTING && range.getColumn() == 2) {
    // The selected setting has changed, we clear the corresponding retrieved
    // value for origin/destination LIs.
    clearOriginInfo_();
    clearDestinationInfo_(false);
  } else if (range.getRow() == ROW_ORIGIN_LI_ID && range.getColumn() == 2){
    // The origin Line Item ID has been changed, let's clear the corresponding
    // retrieved values.
    clearOriginInfo_();
  } else if (range.getRow() >= ROW_DESTINATION_LI && range.getColumn() == 1) {
    // One (or more) destination LI IDs have been changed, let's clear the
    // corresponding retrieved values.
    for (var row = range.getRow(); row<= range.getLastRow(); row++) {
      clearDestinationInfo_(true, row);
    }
  }
}


/**
 * Initialization function to save the API credentials, retrieve the current
 * selected setting and create the "on edit" trigger if doesn't exist already.
 * @private
 */
function init_() {
  doc = SpreadsheetApp.getActiveSpreadsheet();
  configSheet = doc.getSheetByName(CONFIG_SHEET_NAME);
  originLiSheet = doc.getSheetByName(ORIGIN_SHEET_NAME);
  destinationLisSheet = doc.getSheetByName(DESTINATION_SHEET_NAME);
  if (!(configSheet & originLiSheet & destinationLisSheet)) {
    // We need setup and format the spreadsheet
    initSpreadsheet_();
  }
  selectedSetting = configSheet.getRange(ROW_SETTING,2).getValue();
  var allTriggers = ScriptApp.getProjectTriggers();
  if (allTriggers.length == 0) {
    // Let's add the trigger to track edited cells
    ScriptApp.newTrigger('customOnEdit')
      .forSpreadsheet(doc)
      .onEdit()
      .create();
  }
  doc.setActiveSheet(configSheet);
}


/**
 * Sets up and formats the needed sheets in the Spreadsheet: "Config" with the
 * configuration settings, "OriginLI" to host the origin Line Item info,
 * "Destination LIs" to host the destination Line Items info.
 * @private
 */
function initSpreadsheet_() {
  if (!originLiSheet) {
    doc.insertSheet(ORIGIN_SHEET_NAME,0);
    originLiSheet = doc.getSheetByName(ORIGIN_SHEET_NAME);
    originLiSheet.setTabColor("yellow");
    originLiSheet.getRange(1,1,1,100).setBackground("yellow");
    originLiSheet.getRange(1,1,originLiSheet.getMaxRows(),
        originLiSheet.getMaxColumns()).setFontFamily('Roboto Slab');
  }
  if (!destinationLisSheet) {
    doc.insertSheet(DESTINATION_SHEET_NAME,1);
    destinationLisSheet = doc.getSheetByName(DESTINATION_SHEET_NAME);
    destinationLisSheet.setTabColor("green");
    destinationLisSheet.getRange(1,1,1,100).setBackground("green");
    destinationLisSheet.getRange(1,1,destinationLisSheet.getMaxRows(),
        destinationLisSheet.getMaxColumns()).setFontFamily('Roboto Slab');
  }
  if (!configSheet) {
    doc.insertSheet(CONFIG_SHEET_NAME,0);
    configSheet = doc.getSheetByName(CONFIG_SHEET_NAME);
    configSheet.setTabColor('red');
    // Sets default column widths.
    configSheet.setColumnWidth(1, 260);
    configSheet.setColumnWidth(2, 280);
    configSheet.setColumnWidth(3, 360);
    configSheet.setColumnWidth(4, 360);
    // General settings section.
    configSheet.getRange(ROW_GENERAL_HEADER,1,1,NUM_COLUMNS)
        .setBackground(CONFIG_HEADERS_COLOR).setFontWeight('bold');
    configSheet.setRowHeight(ROW_GENERAL_HEADER, 40);
    configSheet.getRange(ROW_GENERAL_HEADER,1).setValue('General settings');
    configSheet.getRange(ROW_SDF_VERSION,1,2,1)
        .setBackground(CONFIG_NAMES_COLOR).setFontWeight('bold');
    configSheet.getRange(ROW_SDF_VERSION,1).setValue('SDF Version');
    configSheet.getRange(ROW_SETTING,1).setValue('Line Item setting to copy');
    configSheet.getRange(ROW_SDF_VERSION,2,2,1)
        .setBackground(CONFIG_EDITABLE_VALUES_COLOR).setFontWeight('bold')
        .setHorizontalAlignment('center');
    var rule = SpreadsheetApp.newDataValidation()
        .requireValueInList(['3.1', '4']).build();
    configSheet.getRange(ROW_SDF_VERSION,2).setDataValidation(rule)
        .setValue('4');
    var range = originLiSheet.getRange('1:1');
    rule = SpreadsheetApp.newDataValidation().requireValueInRange(range)
        .build();
    configSheet.getRange(ROW_SETTING,2).setDataValidation(rule)
      .setValue('Geography Targeting - Include');
    configSheet.getRange(ROW_SDF_VERSION,3,2,2)
        .setBackground(CONFIG_DESCRIPTIONS_COLOR);
    configSheet.getRange(ROW_SDF_VERSION,3)
        .setValue('Check your advertiser/partner supported SDF version ' +
        'directly in DV360');
    configSheet.getRange(ROW_SETTING,3).setValue('<-- if this menu is empty, ' +
        'select an ORIGIN line item below and run "Custom Functions > ' +
        'Retrieve ORIGIN Line Item Info"');
    // Origin Line Item section.
    configSheet.getRange(ROW_ORIGIN_HEADER,1,1,NUM_COLUMNS)
        .setBackground(CONFIG_HEADERS_COLOR).setFontWeight('bold');
    configSheet.setRowHeight(ROW_ORIGIN_HEADER, 40);
    configSheet.getRange(ROW_ORIGIN_HEADER,1)
        .setFormula('=CONCATENATE("ORIGIN Line Item - the Line Item to copy ' +
        'the selected setting ("; $B$3; ") from")');
    configSheet.getRange(ROW_ORIGIN_LI_ID,1,3,1)
        .setBackground(CONFIG_NAMES_COLOR).setFontWeight('bold');
    configSheet.setRowHeight(ROW_ORIGIN_LI_ID, 40);
    configSheet.setRowHeight(ROW_ORIGIN_LI_NAME, 40);
    configSheet.setRowHeight(ROW_ORIGIN_LI_VALUE, 40);
    configSheet.getRange(ROW_ORIGIN_LI_ID,1).setValue('Line Item ID');
    configSheet.getRange(ROW_ORIGIN_LI_NAME,1).setValue('Line Item Name');
    configSheet.getRange(ROW_ORIGIN_LI_VALUE,1)
        .setFormula('= CONCATENATE("Value for: "; $B$3)');
    configSheet.getRange(ROW_ORIGIN_LI_ID,2)
        .setBackground(CONFIG_EDITABLE_VALUES_COLOR).setFontWeight('bold')
        .setHorizontalAlignment('center');
    configSheet.getRange(ROW_ORIGIN_LI_NAME,2,2,1)
        .setBackground(CONFIG_AUTOMATIC_VALUES_COLOR).setFontWeight('bold')
        .setHorizontalAlignment('center');
    configSheet.getRange(ROW_ORIGIN_LI_ID,3,3,2)
        .setBackground(CONFIG_DESCRIPTIONS_COLOR);
    configSheet.getRange(ROW_ORIGIN_LI_ID,3,1,2).merge().setWrap(true)
        .setValue('The ID of the Line Item you want to copy the setting FROM');
    configSheet.getRange(ROW_ORIGIN_LI_NAME,3,1,2).merge().setWrap(true)
        .setValue('Run "Custom Functions > Retrieve ORIGIN Line Item Info" ' +
        'to load the LI Name and the current value for the selected setting ' +
        '(Keyword Targeting - Include)');
    configSheet.getRange(ROW_ORIGIN_LI_VALUE,3,1,2).merge().setWrap(true)
        .setFormula('=CONCATENATE("This is the value for "; $B$3; " which is ' +
        'gonna be copied into the DESTINATION Line Items below")');
    // Destination Line Items section.
    configSheet.getRange(ROW_DESTINATION_HEADER,1,1,NUM_COLUMNS)
        .setBackground(CONFIG_HEADERS_COLOR).setFontWeight('bold');
    configSheet.setRowHeight(ROW_DESTINATION_HEADER, 40);
    configSheet.getRange(ROW_DESTINATION_HEADER,1,1,4).merge().setWrap(true)
        .setValue('DESTINATION Line Items - the Line Item(s) you want to ' +
        'copy the selected setting TO.');
    configSheet.getRange(ROW_DESTINATION_COLUMNS,1,1,NUM_COLUMNS)
        .setBackground(CONFIG_NAMES_COLOR).setFontWeight('bold');
    configSheet.getRange(ROW_DESTINATION_COLUMNS,1)
        .setValue('Destination Line Item IDs');
    configSheet.getRange(ROW_DESTINATION_COLUMNS,2).setValue('Line Item Name');
    configSheet.getRange(ROW_DESTINATION_COLUMNS,3)
        .setFormula('= CONCATENATE("Current value for: "; $B$3)');
    configSheet.getRange(ROW_DESTINATION_COLUMNS,4)
        .setFormula('= CONCATENATE("New value applied for: "; $B$3)');
    configSheet.getRange(ROW_DESTINATION_LI,1,100,1).setFontWeight('bold')
        .setBackground(CONFIG_EDITABLE_VALUES_COLOR)
        .setHorizontalAlignment('center');
    configSheet.getRange(ROW_DESTINATION_LI,2,100,3).setFontWeight('bold')
        .setBackground(CONFIG_AUTOMATIC_VALUES_COLOR);
    configSheet.getRange(1,1,configSheet.getMaxRows(),
        configSheet.getMaxColumns()).setFontFamily('Roboto Slab')
        .setVerticalAlignment("middle");
  }
}


/**
 * Retrieves ORIGIN Line Item information, loading the SDF file via DV360 API.
 * @return {string} Value of the selected setting in the ORIGIN Line Item.
 * @private
 */
function retrieveOriginLi_() {
  originLiId = configSheet.getRange(ROW_ORIGIN_LI_ID,2).getValue();
  if (!originLiId) {
    throw new Error('You need to specify an origin Line Item ID');
  }
  var sdfVersion = configSheet.getRange(ROW_SDF_VERSION,2).getValue();
  var sdfResponse = getSdf_(FILTER_LI, [originLiId], ["LINE_ITEM"], sdfVersion);
  var originLiData = Utilities.parseCsv(sdfResponse['lineItems']);
  originLiSheet.clearContents();
  originLiSheet.getRange(1,1, originLiData.length, originLiData[0].length)
      .setValues(originLiData);
  originLiObject = populateObject_(originLiSheet);
  configSheet.getRange(ROW_ORIGIN_LI_NAME,2)
      .setValue(originLiObject[SDF_NAME][0]);
  configSheet.getRange(ROW_ORIGIN_LI_VALUE,2)
      .setValue(originLiObject[selectedSetting][0]);
  return originLiObject[selectedSetting][0];
}


/**
 * Retrieves DESTINATION Line Items information, loading the SDF file via the
 * DV360 API. If the user has already made some changes, has the options to
 * abort the operation to avoid overwriting uncommitted updates.
 * @return {string=} 'abort' if the user aborts the operation.
 * @private
 */
function retrieveDestinationLis_() {
  var ui = SpreadsheetApp.getUi();
  // Checks if the user has made changes so far, and eventually shows a warning.
  var hasChanges = userProperties.getProperty('haschanges');
  if (hasChanges == 'true') {
    var response = ui.alert('You are about to download the current DV360 ' +
        'settings values for the destination Line Items. They will overwrite ' +
        'any change you have already made, unless you have already uploaded ' +
        'the resulting SDF file to DV360. Do you wish to continue?',
        ui.ButtonSet.YES_NO);
    if (response == ui.Button.NO) {
     return 'abort';
    }
  }
  var liIds = [];
  for (var row=ROW_DESTINATION_LI;
       row <configSheet.getDataRange().getNumRows() +1;
       row++) {
    var liId = configSheet.getRange(row, 1).getValue();
    configSheet.getRange(row, 2,1,3).clearContent();
    liIds.push(liId);
  }
  var sdfVersion = configSheet.getRange(ROW_SDF_VERSION,2).getValue();
  var sdfResponse = getSdf_(FILTER_LI, liIds, ["LINE_ITEM"], sdfVersion);
  var destinationLiData = Utilities.parseCsv(sdfResponse['lineItems']);
  destinationLisSheet.clearContents();
  destinationLisSheet.getRange(1,1, destinationLiData.length,
      destinationLiData[0].length).setValues(destinationLiData);
  destinationLiObject = populateObject_(destinationLisSheet);
  for (var row=ROW_DESTINATION_LI;
       row < configSheet.getDataRange().getNumRows() +1; row++) {
    // Log the current value of the destination LIs setting
    configSheet.getRange(row,1)
        .setValue(destinationLiObject[SDF_ID][row -ROW_DESTINATION_LI]);
    configSheet.getRange(row,2)
        .setValue(destinationLiObject[SDF_NAME][row - ROW_DESTINATION_LI]);
    configSheet.getRange(row,3)
        .setValue(destinationLiObject[selectedSetting][row -
                                                       ROW_DESTINATION_LI]);

  }
  return;
}


/**
 * Updates the "new value" of the selected setting for the DESTINATION Line
 * Items in the Config sheet, using the corresponding value from the ORIGIN Line
 * Item.
 * @param {string} settingValue Value of the origin Line Item setting to use.
 * @private
 */
function updateDestinationLis_(settingValue) {
  var headers = destinationLisSheet.getRange(1,1,1,destinationLisSheet
      .getDataRange().getNumColumns()+1).getValues()[0];
  var indexOfSetting = headers.indexOf(selectedSetting);
  for (var row=2; row < destinationLisSheet.getDataRange().getNumRows() +1;
       row++) {
    destinationLisSheet.getRange(row,indexOfSetting + 1).setValue(settingValue);
    configSheet.getRange(row + ROW_DESTINATION_LI - 2,4).setValue(settingValue);
  }
}


/**
 * Clears the information (name and current setting value) of the ORIGIN Line
 * Item in the Config Sheet.
 * @private
 */
function clearOriginInfo_() {
  configSheet.getRange(ROW_ORIGIN_LI_NAME,2,
      ROW_ORIGIN_LI_VALUE - ROW_ORIGIN_LI_NAME + 1, 1).clearContent();
}


/**
 * Clears the information of the DESTINATION Line Items in the Config Sheet.
 * @param {Boolean} clearName Whether to clear the column containing the name.
 * @param {Number=} row Row to clear (all if not specified)
 * @private
 */
function clearDestinationInfo_(clearName, row) {
  var startingColumn = clearName ? 2 : 3;
  var columnsToClear = clearName ? 3 : 2;
  if (row) {
    configSheet.getRange(row,startingColumn, 1, columnsToClear).clearContent();
  } else {
    configSheet.getRange(ROW_DESTINATION_LI,startingColumn,
        configSheet.getDataRange().getNumRows() - ROW_DESTINATION_LI + 2,
        columnsToClear).clearContent();
  }
}


/**
 * Checks if the DESTINATION Line Items information has already been loaded,
 * checking if the "Name" column is populated for all the rows.
 * @return {Boolean} Whether the information has already been loaded.
 * @private
 */
function isDestinationInfoLoaded_() {
  var liNames = configSheet.getRange(ROW_DESTINATION_LI,2,
      configSheet.getDataRange().getNumRows() - ROW_DESTINATION_LI + 1, 1)
      .getValues();
  for (var i=0; i<liNames.length; i++) {
    if (liNames[i][0].length < 1) {
      return false;
    }
  }
  return true;
}


/**
 * Inits the tool and and calls the function to retrieve ORIGIN Line Item
 * settings.
 * @private
 */
function getOrigin_() {
  init_();
  retrieveOriginLi_();
}


/**
 * Inits the tool and calls the function to retrieve DESTINATION Line Items
 * settings.
 * @private
 */
 function getDestination_() {
  init_();
  retrieveDestinationLis_();
}


/**
 * Copies the value of the ORIGIN Line Item setting to the DESTINATION Line
 * Items settings.
 * @private
 * @return {string=} 'abort' if the copy has been aborted by the user
 */
function copyLiSetting_() {
  init_();
  // Retrieves Origin Line Item info and setting value.
  var settingValue = retrieveOriginLi_();
  if (!isDestinationInfoLoaded_()) {
    // Downloads current settings of Destination Line Items
    if (retrieveDestinationLis_() == 'abort') {
      return 'abort';
    }
  }
  updateDestinationLis_(settingValue);
  userProperties.setProperty('haschanges', 'true');
  return;
}


/**
 * Resets all user-inserted values.
 * @private
 */
function reset_() {
  init_();
  configSheet.getRange(ROW_ORIGIN_LI_ID,2).clearContent();
  configSheet.getRange(ROW_DESTINATION_LI,1,
      configSheet.getDataRange().getNumRows() - ROW_DESTINATION_LI + 1,1)
      .clearContent();
  clearOriginInfo_();
  clearDestinationInfo_(true);
  userProperties.setProperty('haschanges', 'false');
}