Bouw en onderhoud Google Shopping campagnes

// Copyright 2021. Increase BV. All Rights Reserved.
//
// Created By: Tibbe van Asten
// for Increase B.V.
//
// Created 15-04-2019
// Last update: 23-07-2021 Filter country & language improved
//
// ABOUT THE SCRIPT
// All products in Google Merchant Center are checked for existance
// in the Google Shopping campaigns. Based on your input, products
// will be put in the right campaign and adgroup.
// The script also checks all active productgroups in your campaigns
// and removes productgroups that are not in GMC anymore.
//
////////////////////////////////////////////////////////////////////

var config = {

  LOG : true,

  // Connect Merchant Center. Add user to GMC that runs this script.
  // Also enable Advanced API 'Shopping content'.
  MERCHANT_ID : "123456789",
  DEFAULT_BID : 0.3,

  TARGET_COUNTRY : "BE",
  TARGET_LANGUAGE : "nl",

  // To select a (set of) Shopping campaign(s), all names must contain the following
  // Leave empty when you only want to use a field from GMC to select a campaign.
  CAMPAIGN_SELECTOR : "[B] Shopping",

  // To specify the corresponding campaign and adgroup for each product,
  // we'll use fields from GMC. Define which field contains (part of) the
  // campaign- and adgroupname.
  // Available fieldnames: https://developers.google.com/shopping-content/reference/rest/v2/products

  // Leave empty when you only want to use the CAMPAIGN_SELECTOR to select a campaign.
  CAMPAIGNNAME_FIELD : "",

  // use productTypes, customLabel0 (or 1,2,3,4) or brand
  ADGROUPNAME_FIELD : "productTypes"

}

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

function main(){

  // Connect Merchant Center and collect active brands and products
  var merchantCenter = connectMerchant();
  var products = merchantCenter["products"];
  var productsIds = merchantCenter["productsIds"];

  var productGroups = activeProductGroups();
  var activeProducts = productGroups["activeProducts"];
  var activeProductsIds = productGroups["activeProductsIds"];

  var activeSubcategories = activeAdGroups();
  var addProducts = {};
  var removeProducts = [];

  // Check which products need to be added
  // Loop through all products from Merchant Center
  for (var i = 0; i < products.length; i++) {

    // If product is in stock and not in any campaign, we'll add it
    if(products[i]["availability"] == "in stock" && activeProductsIds.indexOf(products[i]["offerId"]) < 0 && activeProductsIds.indexOf(products[i]["offerId"].toLowerCase())  < 0){

      // Make sure addProducts isn't empty
      if (addProducts[products[i]["offerId"]] == null) {
        addProducts[products[i]["offerId"]] = [];
      }
      if(config.ADGROUPNAME_FIELD == "productTypes"){
        addProducts[products[i]["offerId"]].push([products[i]["offerId"], products[i][config.ADGROUPNAME_FIELD][0], products[i][config.CAMPAIGNNAME_FIELD]]);
      } else {
        addProducts[products[i]["offerId"]].push([products[i]["offerId"], products[i][config.ADGROUPNAME_FIELD], products[i][config.CAMPAIGNNAME_FIELD]]);
      }
    }

  } // merchantCenterIterator

  if(config.LOG === true){
    Logger.log("Found " + Object.keys(addProducts).length + " to be added");
    Logger.log(" ");
  }

  // Check which products need to be removed
  // Loop through all products from the campaigns
  for (var i = 0; i < activeProducts.length; i++) {
    
    // If product is not in Merchant Center, we'll remove it
    if(productsIds.indexOf(activeProducts[i].getValue()) < 0 && productsIds.indexOf(activeProducts[i].getValue().toUpperCase()) < 0 && activeProducts[i].getDimension() == "ITEM_ID"){
        if(config.LOG === true){
          Logger.log("Removed " + activeProducts[i].getValue());
        }

      activeProducts[i].remove();

    }

  } // activeProductsIterator

  // Add products
  for (var key in addProducts) {

     // Skip product if adgroupname field is undefined
    if(typeof addProducts[key][0][1] == "undefined") continue;
    
    var shoppingAdGroups = AdsApp.shoppingAdGroups().withCondition("CampaignName CONTAINS '"+config.CAMPAIGN_SELECTOR+"'");

      // If a field is defined to select the campaignname
      if(config.CAMPAIGNNAME_FIELD != ""){
        shoppingAdGroups = shoppingAdGroups.withCondition("CampaignName CONTAINS '"+addProducts[key][0][2]+"'");
      }

    shoppingAdGroups = shoppingAdGroups.withCondition("Name = '"+addProducts[key][0][1]+"'").get();

    if(!shoppingAdGroups.hasNext()){
      var campaign = AdsApp.shoppingCampaigns().withCondition("Name CONTAINS '"+config.CAMPAIGN_SELECTOR+"'");

        // If a field is defined to select the campaignname
        if(config.CAMPAIGNNAME_FIELD != ""){
          campaign = campaign.withCondition("Name CONTAINS '"+addProducts[key][0][2]+"'");
        }

      campaign = campaign.get().next();

      // Adding adgroup to Shopping campaign
      var shoppingAdGroup = campaign
        .newAdGroupBuilder()
        .withName(addProducts[key][0][1])
        .withCpc(config.DEFAULT_BID)
        .withStatus("ENABLED")
        .build()
        .getResult();

      if(config.LOG === true){
        Logger.log(shoppingAdGroup.getName() + " added to " + campaign.getName());
      }

      // Adding an ad to the new adgroup
      var ad = shoppingAdGroup
        .newAdBuilder()
        .build()
        .getResult();

      // Creating the root productgroup 'All Products' and select it
      shoppingAdGroup.createRootProductGroup();
      var root = shoppingAdGroup.rootProductGroup();

      // Creating a productgroup for this product
        if(config.ADGROUPNAME_FIELD == "productTypes"){
          var child = root.newChild().productTypeBuilder()
            .withBid(config.DEFAULT_BID)
            .withValue(addProducts[key][0][1])
            .build();
        }

        if(config.ADGROUPNAME_FIELD.indexOf("customLabel") > -1){
          var type = "CUSTOM_LABEL_" + config.ADGROUPNAME_FIELD.slice(-1);
          var child = root.newChild().customLabelBuilder()
            .withBid(config.DEFAULT_BID)
            .withType(type)
            .withValue(addProducts[key][0][1])
            .build();
        }

        if(config.ADGROUPNAME_FIELD == "brand"){
          var child = root.newChild().brandBuilder()
            .withBid(config.DEFAULT_BID)
            .withValue(addProducts[key][0][1])
            .build();
        }

      // Putting item right under productType
      child.getResult().newChild().itemIdBuilder()
        .withBid(config.DEFAULT_BID)
        .withValue(addProducts[key][0][0])
        .build();

      // Making sure all other products in this adgroup are excluded
      var children = root.children().get();
      while (children.hasNext()) {
        var child = children.next();
        if (child.isOtherCase()) {
          child.exclude();
        }
      } // childrenIterator
    }

    // If adgroup already exists, we'll add the product
    while(shoppingAdGroups.hasNext()){
      var shoppingAdGroup = shoppingAdGroups.next();

      var type = shoppingAdGroup.rootProductGroup().children().withCondition("ProductGroup CONTAINS '"+addProducts[key][0][1].toLowerCase()+"'").get().next().asProductType();

      // Creating a productgroup for this product
      type.newChild().itemIdBuilder()
        .withBid(config.DEFAULT_BID)
        .withValue(addProducts[key][0][0])
        .build();

        if(config.LOG === true){
          Logger.log("Added " + addProducts[key][0][0] + " to " + shoppingAdGroup.getName());
        }
    } // shoppingAdGroupsIterator

  } // addProductsIterator

}

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

function connectMerchant(){

  	if(config.MERCHANT == "123456789"){
      throw Error("Change the Merchant ID in the settings");
    }

  var pageToken;
  var pageNum = 1;
  var maxResults = 250;
  var products = [];
  var productsIds = [];

  do {
    var productList = ShoppingContent.Products.list(config.MERCHANT_ID, {
      pageToken: pageToken,
      maxResults: maxResults
    });

    if (productList.resources) {
      for (var i = 0; i < productList.resources.length; i++) {

        // If targetcountry and language are set, only corresponding products will be selected
        if(config.TARGET_COUNTRY != ""){
          if(config.TARGET_LANGUAGE != ""){
            if(productList.resources[i]["targetCountry"] == config.TARGET_COUNTRY && productList.resources[i]["contentLanguage"] == config.TARGET_LANGUAGE){
              products.push(productList.resources[i]);
              productsIds.push(productList.resources[i]["offerId"].toLowerCase());
            }
          } else {
            if(productList.resources[i]["targetCountry"] == config.TARGET_COUNTRY){
              products.push(productList.resources[i]);
              productsIds.push(productList.resources[i]["offerId"].toLowerCase());
            }
          }
        } else {
          products.push(productList.resources[i]);
          productsIds.push(productList.resources[i]["offerId"].toLowerCase());
        }
      }
    }

    pageToken = productList.nextPageToken;
    pageNum++;
  } while (pageToken);

  return {products : products, productsIds : productsIds};

} // function connectMerchant

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

function activeProductGroups(){

  var activeProducts = [];
  var activeProductsIds = [];

  // We collect all active productGroups
  var productGroupIterator = AdsApp
    .productGroups()
    .withCondition("CampaignName CONTAINS '"+config.CAMPAIGN_SELECTOR+"'")
    .withCondition("AdGroupStatus != REMOVED")
    .withCondition("ProductGroup DOES_NOT_CONTAIN ' OtherCase'")
    .get();

  while(productGroupIterator.hasNext()){
    var productGroup = productGroupIterator.next();

    // Only add a product if it's an active, actual product
    if(productGroup.isOtherCase() === false && productGroup.getValue() != null){
      activeProducts.push(productGroup);
      activeProductsIds.push(productGroup.getValue());
    }
  } // productGroupIterator

  return {activeProducts : activeProducts, activeProductsIds : activeProductsIds};

} // activeProducts

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

function activeAdGroups(){

  var activeSubcategories = [];

  var adGroupIterator = AdsApp
    .shoppingAdGroups()
    .withCondition("CampaignName = '"+config.CAMPAIGN_SELECTOR+"'")
    .withCondition("Status != REMOVED")
    .get()

  while(adGroupIterator.hasNext()){
    var adGroup = adGroupIterator.next();

    // Add adgroupname as subcategory
    if(activeSubcategories.indexOf(adGroup.getName()) <0){
      activeSubcategories.push(adGroup.getName());
    }

  } // adGroupIterator

  return activeSubcategories;

} // activeAdGroups