UpdateProductTemplates.java

// Copyright 2015 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.

package dfp.axis.v201608.producttemplateservice;

import com.google.api.ads.common.lib.auth.OfflineCredentials;
import com.google.api.ads.common.lib.auth.OfflineCredentials.Api;
import com.google.api.ads.dfp.axis.factory.DfpServices;
import com.google.api.ads.dfp.axis.utils.v201608.StatementBuilder;
import com.google.api.ads.dfp.axis.v201608.GeoTargeting;
import com.google.api.ads.dfp.axis.v201608.Location;
import com.google.api.ads.dfp.axis.v201608.ProductTemplate;
import com.google.api.ads.dfp.axis.v201608.ProductTemplatePage;
import com.google.api.ads.dfp.axis.v201608.ProductTemplateServiceInterface;
import com.google.api.ads.dfp.axis.v201608.Targeting;
import com.google.api.ads.dfp.lib.client.DfpSession;
import com.google.api.client.auth.oauth2.Credential;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import java.util.Arrays;
import java.util.List;

/**
 * This example updates a product template's targeting to include a new GeoTarget.
 * To determine which product templates exist, run GetAllProductTemplates.java.
 *
 * Credentials and properties in {@code fromFile()} are pulled from the
 * "ads.properties" file. See README for more info.
 */
public class UpdateProductTemplates {
  
  // Set the ID of the product template to update.
  private static final String PRODUCT_TEMPLATE_ID = "INSERT_PRODUCT_TEMPLATE_ID_HERE";

  public static void runExample(DfpServices dfpServices, DfpSession session,
      long productTemplateId) throws Exception {
    // Get the ProductTemplateService.
    ProductTemplateServiceInterface productTemplateService =
        dfpServices.get(session, ProductTemplateServiceInterface.class);

    // Create a statement to select a product template by ID.
    StatementBuilder statementBuilder = new StatementBuilder()
        .where("id = :id")
        .orderBy("id ASC")
        .limit(1)
        .withBindVariableValue("id", productTemplateId);

    // Get the product template.
    ProductTemplatePage page =
        productTemplateService.getProductTemplatesByStatement(statementBuilder.toStatement());

    ProductTemplate productTemplate = Iterables.getOnlyElement(Arrays.asList(page.getResults()));
    
    // Add geo targeting for Canada to the product template.
    Location countryLocation = new Location();
    countryLocation.setId(2124L);
    
    Targeting productTemplateTargeting = productTemplate.getBuiltInTargeting();
    GeoTargeting geoTargeting = productTemplateTargeting.getGeoTargeting();
    
    List<Location> existingTargetedLocations = Lists.newArrayList();
    
    if (geoTargeting != null) {
      if (geoTargeting.getTargetedLocations() != null) {
        existingTargetedLocations = Lists.newArrayList(geoTargeting.getTargetedLocations());
      }
    } else {
      geoTargeting = new GeoTargeting();
    }

    existingTargetedLocations.add(countryLocation); 
    geoTargeting.setTargetedLocations(existingTargetedLocations.toArray(new Location[] {}));
    
    productTemplateTargeting.setGeoTargeting(geoTargeting);
    productTemplate.setBuiltInTargeting(productTemplateTargeting);

    // Update the product template on the server.
    ProductTemplate[] productTemplates =
        productTemplateService.updateProductTemplates(new ProductTemplate[] {productTemplate});

    for (ProductTemplate updatedProductTemplate : productTemplates) {
      System.out.printf("Product template with ID %d and name '%s' was updated.%n",
          updatedProductTemplate.getId(),
          updatedProductTemplate.getName());
    }
  }

  public static void main(String[] args) throws Exception {
    // Generate a refreshable OAuth2 credential.
    Credential oAuth2Credential = new OfflineCredentials.Builder()
        .forApi(Api.DFP)
        .fromFile()
        .build()
        .generateCredential();

    // Construct a DfpSession.
    DfpSession session = new DfpSession.Builder()
        .fromFile()
        .withOAuth2Credential(oAuth2Credential)
        .build();

    DfpServices dfpServices = new DfpServices();

    runExample(dfpServices, session, Long.parseLong(PRODUCT_TEMPLATE_ID));
  }
}