Bidadjustments for devices

// Copyright 2019. Increase BV. All Rights Reserved.
//
// Created By: Tibbe van Asten
// for Increase B.V.
// 
// Created: 01-03-2018
// Last update: 17-09-2019
//
// ABOUT THE SCRIPT
// With this script we adjust the biddings for devices for
// all active campaigns in the account. Change will be based
// on the device statistics vs campaign statistics.
//
////////////////////////////////////////////////////////////////////

var config = {
  
    LOG : true,
    DATE_RANGE : "LAST_30_DAYS",

    // Set these to true if you want to include them.
    INCLUDE_SEARCH : true,		
    INCLUDE_DISPLAY : false,
    INCLUDE_SHOPPING : true,	
  
    // Optional: Use minimum conversions and/or cost to select devices.
    // Cost is in account currency. Leave empty to skip.
    MINIMUM_CONVERIONS : "2",
    MINIMUM_CLICKS : "100",
    MINIMUM_COST : "10",
  
    // Bidadjustments won't be higher then MAX_BID and not lower then MIN_BID.
    // Examples: 1.2 = +20%, 0.8 = -20%, 2 = +100%.
    MAX_BID : 1,
    MIN_BID : 0.5,
	
    // Optional: Use a label to make a selection of campaigns.
    // Leave empty to skip.
    LABEL : ""

}

////////////////////////////////////////////////////////////////////

function main() {  

  // Starting with selecting Search campaigns, if included in the config.
  if(config.INCLUDE_SEARCH === true) {
    if(config.LABEL != ""){
      if(config.INCLUDE_DISPLAY === true) {      
        var campaignIterator = AdsApp
        .campaigns()
        .withCondition("Status = ENABLED")
        .withCondition("LabelNames CONTAINS_ANY ['" + config.LABEL + "']")
        .get();
      } else {
        var campaignIterator = AdsApp
        .campaigns()
        .withCondition("Status = ENABLED")
        .withCondition("LabelNames CONTAINS_ANY ['" + config.LABEL + "']")
        .withCondition("AdvertisingChannelType != DISPLAY") 
        .get();        
      }
    } else{
      if(config.INCLUDE_DISPLAY === true) {  
        var campaignIterator = AdsApp
        .campaigns()
        .withCondition("Status = ENABLED")
        .get();
      } else {
        var campaignIterator = AdsApp
        .campaigns()
        .withCondition("Status = ENABLED")
        .withCondition("AdvertisingChannelType != DISPLAY") 
        .get();
      }
    }

    // With campaigns selected, the bidadjustments will be set.
    bidAdjustments(campaignIterator);
  }

  // Select Shopping campaigns, if included in the config.
  if(config.INCLUDE_SHOPPING === true) {
    if(config.LABEL != ""){
      var campaignIterator = AdsApp
      .shoppingCampaigns()
      .withCondition("Status = ENABLED")
      .withCondition("LabelNames CONTAINS_ANY ['" + config.LABEL + "']")
      .get();
    } else{
      var campaignIterator = AdsApp
      .shoppingCampaigns()
      .withCondition("Status = ENABLED")
      .get();
    }

    // With campaigns selected, the bidadjustments will be set.
    bidAdjustments(campaignIterator);
  }    
  
  Logger.log("Thanks for using this custom script by Tibbe van Asten. Winning!")
  
} // function main()

////////////////////////////////////////////////////////////////////

function bidAdjustments(iterator) {
  
   while (iterator.hasNext()) {
    var campaign = iterator.next();
    
    // We only want to alter the campaigns and adgroups with manual bidding strategies.
    if(campaign.bidding().getStrategyType() == "MANUAL_CPC" || campaign.bidding().getStrategyType() == "MANUAL_CPM" || campaign.bidding().getStrategyType() == "MANUAL_CPV"){
      
      var campaignCpa = campaign.getStatsFor(config.DATE_RANGE).getCost() / campaign.getStatsFor(config.DATE_RANGE).getConversions();

      	if(config.LOG === true){
          Logger.log("Checking " + campaign.getName());
          Logger.log("-----");
        }
      
      // Within the campaign, we will check for devices.
      var deviceIterator = campaign
        .targeting()
        .platforms()
        .get();

      while(deviceIterator.hasNext()){
        var device = deviceIterator.next();
        
        var deviceConversions = device.getStatsFor(config.DATE_RANGE).getConversions();
        var deviceCost = device.getStatsFor(config.DATE_RANGE).getCost();
        var deviceClicks = device.getStatsFor(config.DATE_RANGE).getClicks();
        
          if(config.LOG === true){
            Logger.log("Device: " + device.getName());
            Logger.log("Conversions: " + deviceConversions);
            Logger.log("Cost: " + deviceCost);
            Logger.log("Clicks: " + deviceClicks);
          }
        
        // Only change devices that have the required conversions, cost or clicks
        if(config.MINIMUM_CONVERIONS != "" || config.MINIMUM_COST != "" || config.MINIMUM_CLICKS != ""){
          
          if(deviceConversions < config.MINIMUM_CONVERIONS && deviceCost < config.MINIMUM_COST && deviceClicks < config.MINIMUM_CLICKS) continue;
          
        } // check minimums        
        
        var deviceCpa = deviceCost / deviceConversions;
        var newDeviceBid = campaignCpa / deviceCpa;

        // If there is an audience CPA, we will place a bidadjustment.
        if(isNaN(newDeviceBid) === false && isFinite(deviceCpa) === true && device.getBidModifier() !== newDeviceBid) {
          if(newDeviceBid < config.MIN_BID) { newDeviceBid = config.MIN_BID; }
          if(newDeviceBid > config.MAX_BID) { newDeviceBid = config.MAX_BID; }

          device.setBidModifier(newDeviceBid);  

          if(config.LOG === true){
            Logger.log("Bidadjustment " + device.getName() + " changed to " + device.getBidModifier());
          }
        }        

        // Negative bidadjustment when conversions = 0.
        if(deviceConversions == 0 && deviceCost > config.MINIMUM_COST && isNaN(newDeviceBid) == false){
          device.setBidModifier(config.MIN_BID);

          if(config.LOG === true){
            Logger.log("Bidadjustment " + device.getName() + " changed to " + device.getBidModifier());
          }
        }
        
        if(config.LOG === true){
          Logger.log(" ");
        }

      } // deviceIterator   
      
      if(config.LOG === true){
        Logger.log(" ");
      }
            
    } // manual bidding
    
  } // campaignIterator
  
} // function bidAdjustments()