Package v201306

Source Code of v201306.PerformMutateJob

// Copyright 2013 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 v201306;

import com.google.api.adwords.lib.AdWordsService;
import com.google.api.adwords.lib.AdWordsServiceLogger;
import com.google.api.adwords.lib.AdWordsUser;
import com.google.api.adwords.v201306.cm.AdGroupCriterionOperation;
import com.google.api.adwords.v201306.cm.ApiError;
import com.google.api.adwords.v201306.cm.BasicJobStatus;
import com.google.api.adwords.v201306.cm.BiddableAdGroupCriterion;
import com.google.api.adwords.v201306.cm.BulkMutateJobPolicy;
import com.google.api.adwords.v201306.cm.BulkMutateJobSelector;
import com.google.api.adwords.v201306.cm.Job;
import com.google.api.adwords.v201306.cm.JobResult;
import com.google.api.adwords.v201306.cm.Keyword;
import com.google.api.adwords.v201306.cm.KeywordMatchType;
import com.google.api.adwords.v201306.cm.MutateJobServiceInterface;
import com.google.api.adwords.v201306.cm.Operand;
import com.google.api.adwords.v201306.cm.Operation;
import com.google.api.adwords.v201306.cm.Operator;
import com.google.api.adwords.v201306.cm.SimpleMutateJob;

import java.util.ArrayList;
import java.util.List;
import java.util.Random;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
* This code sample illustrates how to perform asynchronous requests using the
* MutateJobService.
*
* Tags: MutateJobService.mutate, MutateJobService.get,
* MutateJobService.getResult
*
* @author api.kwinter@gmail.com (Kevin Winter)
*/
public class PerformMutateJob {
  private static final long RETRY_INTERVAL = 5;
  private static final long RETRIES_COUNT = 12;
  private static final long KEYWORD_NUMBER = 100;
  private static final Pattern INDEX_REGEX = Pattern.compile("operations\\[(\\d+)\\].*");

  private static int getOperationIndex(String fieldPath) {
    Matcher m = INDEX_REGEX.matcher(fieldPath);
    if (!m.matches()) {
      throw new IllegalArgumentException("Invalid fieldPath: " + fieldPath);
    }
    return Integer.valueOf(m.group(1));
  }

  public static void main(String[] args) {
    try {
      // Log SOAP XML request and response.
      AdWordsServiceLogger.log();

      // Get AdWordsUser from "~/adwords.properties".
      AdWordsUser user = new AdWordsUser();

      // Get the MutateJobService.
      MutateJobServiceInterface mutateJobService =
          user.getService(AdWordsService.V201306.MUTATE_JOB_SERVICE);

      long adGroupId = Long.parseLong("INSERT_AD_GROUP_ID_HERE");

      Random r = new Random();
      List<AdGroupCriterionOperation> operations = new ArrayList<AdGroupCriterionOperation>();

      // Create AdGroupCriterionOperations to add keywords.
      for (int i = 0; i < KEYWORD_NUMBER; i++) {
        // Create Keyword.
        String text = String.format("mars%d", i);
        if (r.nextInt() % 10 == 0) {
          text = text + "!!!";
        }
        Keyword keyword = new Keyword();
        keyword.setText(text);
        keyword.setMatchType(KeywordMatchType.BROAD);
        // Create BiddableAdGroupCriterion.
        BiddableAdGroupCriterion bagc = new BiddableAdGroupCriterion();
        bagc.setAdGroupId(adGroupId);
        bagc.setCriterion(keyword);
        // Create AdGroupCriterionOperation.
        AdGroupCriterionOperation agco = new AdGroupCriterionOperation();
        agco.setOperand(bagc);
        agco.setOperator(Operator.ADD);
        // Add to list.
        operations.add(agco);
      }

      // You can specify up to 3 job IDs that must successfully complete before
      // this job can be processed.
      BulkMutateJobPolicy policy = new BulkMutateJobPolicy();
      policy.setPrerequisiteJobIds(new long[] {});

      // Call mutate to create a new job.
      SimpleMutateJob response =
          mutateJobService.mutate(operations.toArray(new Operation[operations.size()]), policy);

      long jobId = response.getId();
      System.out.printf("Job with ID %d was successfully created.\n", jobId);

      // Create selector to retrieve job status and wait for it to complete.
      BulkMutateJobSelector selector = new BulkMutateJobSelector();
      selector.setJobIds(new long[] {jobId});

      // Poll for job status until it's finished.
      System.out.println("Retrieving job status...");
      SimpleMutateJob jobStatusResponse = null;
      BasicJobStatus status = null;
      for (int i = 0; i < RETRIES_COUNT; i++) {
        Job[] jobs = mutateJobService.get(selector);
        jobStatusResponse = (SimpleMutateJob) jobs[0];
        status = jobStatusResponse.getStatus();
        if (status == BasicJobStatus.COMPLETED || status == BasicJobStatus.FAILED) {
          break;
        }
        System.out.printf("[%d] Current status is '%s', waiting %d seconds to retry...\n", i,
            status.toString(), RETRY_INTERVAL);
        Thread.sleep(RETRY_INTERVAL * 1000);
      }

      // Handle unsuccessful results.
      if (status == BasicJobStatus.FAILED) {
        throw new IllegalStateException("Job failed with reason: "
            + jobStatusResponse.getFailureReason());
      }
      if (status == BasicJobStatus.PENDING || status == BasicJobStatus.PROCESSING) {
        throw new IllegalAccessException("Job did not complete within "
            + ((RETRIES_COUNT - 1) * RETRY_INTERVAL) + " seconds.");
      }

      // Status must be COMPLETED.
      // Get the job result. Here we re-use the same selector.
      JobResult result = mutateJobService.getResult(selector);

      // Output results.
      int i = 0;
      for (Operand operand : result.getSimpleMutateResult().getResults()) {
        String outcome = operand.getPlaceHolder() == null ? "SUCCESS" : "FAILED";
        System.out.printf("Operation [%d] - %s\n", i++, outcome);
      }

      // Output errors.
      if (result.getSimpleMutateResult().getErrors() != null) {
        for (ApiError error : result.getSimpleMutateResult().getErrors()) {
          int index = getOperationIndex(error.getFieldPath());
          String reason = error.getErrorString();
          System.out.printf("ERROR - keyword '%s' failed due to '%s'\n",
              ((Keyword) operations.get(index).getOperand().getCriterion()).getText(), reason);
        }
      } else {
        System.out.printf("Job with ID %d succeeded with no errors.\n", jobId);
      }
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}
TOP

Related Classes of v201306.PerformMutateJob

TOP
Copyright © 2018 www.massapi.com. All rights reserved.
All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.