Examples with BatchJobMutateResponse com.google.api.ads.adwords.axis.utils.v201809.batchjob.BatchJobMutateResponse used on opensource projects

Example 1 with BatchJobMutateResponse

use of com.google.api.ads.adwords.axis.utils.v201809.batchjob.BatchJobMutateResponse in project googleads-java-lib by googleads.

the class AddCompleteCampaignsUsingBatchJob method runExample.

/**
 * Runs the example.
 *
 * @param adWordsServices the services factory.
 * @param session the session.
 * @throws BatchJobException if uploading operations or downloading results failed.
 * @throws ApiException if the API request failed with one or more service errors.
 * @throws RemoteException if the API request failed due to other errors.
 * @throws InterruptedException if the thread was interrupted while sleeping between retries.
 * @throws TimeoutException if the job did not complete after job status was polled {@link
 *     #MAX_POLL_ATTEMPTS} times.
 */
public static void runExample(AdWordsServicesInterface adWordsServices, AdWordsSession session) throws RemoteException, BatchJobException, InterruptedException, TimeoutException {
    // Get the MutateJobService.
    BatchJobServiceInterface batchJobService = adWordsServices.get(session, BatchJobServiceInterface.class);
    // Create a BatchJob.
    BatchJobOperation addOp = new BatchJobOperation();
    addOp.setOperator(Operator.ADD);
    addOp.setOperand(new BatchJob());
    BatchJob batchJob = batchJobService.mutate(new BatchJobOperation[] { addOp }).getValue(0);
    // Get the upload URL from the new job.
    String uploadUrl = batchJob.getUploadUrl().getUrl();
    System.out.printf("Created BatchJob with ID %d, status '%s' and upload URL %s.%n", batchJob.getId(), batchJob.getStatus(), uploadUrl);
    // Create a temporary ID generator that will produce a sequence of descending negative numbers.
    Iterator<Long> tempIdGenerator = new AbstractSequentialIterator<Long>(-1L) {

        @Override
        protected Long computeNext(Long previous) {
            return Long.MIN_VALUE == previous ? null : previous - 1;
        }
    };
    // Use a random UUID name prefix to avoid name collisions.
    String namePrefix = UUID.randomUUID().toString();
    // Create the mutate request that will be sent to the upload URL.
    List<Operation> operations = new ArrayList<>();
    // Create and add an operation to create a new budget.
    BudgetOperation budgetOperation = buildBudgetOperation(tempIdGenerator, namePrefix);
    operations.add(budgetOperation);
    // Create and add operations to create new campaigns.
    List<CampaignOperation> campaignOperations = buildCampaignOperations(tempIdGenerator, namePrefix, budgetOperation);
    operations.addAll(campaignOperations);
    // Create and add operations to create new negative keyword criteria for each campaign.
    operations.addAll(buildCampaignCriterionOperations(campaignOperations));
    // Create and add operations to create new ad groups.
    List<AdGroupOperation> adGroupOperations = new ArrayList<>(buildAdGroupOperations(tempIdGenerator, namePrefix, campaignOperations));
    operations.addAll(adGroupOperations);
    // Create and add operations to create new ad group criteria (keywords).
    operations.addAll(buildAdGroupCriterionOperations(adGroupOperations));
    // Create and add operations to create new ad group ads (text ads).
    operations.addAll(buildAdGroupAdOperations(adGroupOperations));
    // Use a BatchJobHelper to upload all operations.
    BatchJobHelper batchJobHelper = adWordsServices.getUtility(session, BatchJobHelper.class);
    batchJobHelper.uploadBatchJobOperations(operations, uploadUrl);
    System.out.printf("Uploaded %d operations for batch job with ID %d.%n", operations.size(), batchJob.getId());
    // Poll for completion of the batch job using an exponential back off.
    int pollAttempts = 0;
    boolean isPending;
    Selector selector = new SelectorBuilder().fields(BatchJobField.Id, BatchJobField.Status, BatchJobField.DownloadUrl, BatchJobField.ProcessingErrors, BatchJobField.ProgressStats).equalsId(batchJob.getId()).build();
    do {
        long sleepSeconds = (long) Math.scalb(30, pollAttempts);
        System.out.printf("Sleeping %d seconds...%n", sleepSeconds);
        Thread.sleep(sleepSeconds * 1000);
        batchJob = batchJobService.get(selector).getEntries(0);
        System.out.printf("Batch job ID %d has status '%s'.%n", batchJob.getId(), batchJob.getStatus());
        pollAttempts++;
        isPending = PENDING_STATUSES.contains(batchJob.getStatus());
    } while (isPending && pollAttempts < MAX_POLL_ATTEMPTS);
    if (isPending) {
        throw new TimeoutException("Job is still in pending state after polling " + MAX_POLL_ATTEMPTS + " times.");
    }
    if (batchJob.getProcessingErrors() != null) {
        int i = 0;
        for (BatchJobProcessingError processingError : batchJob.getProcessingErrors()) {
            System.out.printf("  Processing error [%d]: errorType=%s, trigger=%s, errorString=%s, fieldPath=%s" + ", reason=%s%n", i++, processingError.getApiErrorType(), processingError.getTrigger(), processingError.getErrorString(), processingError.getFieldPath(), processingError.getReason());
        }
    } else {
        System.out.println("No processing errors found.");
    }
    if (batchJob.getDownloadUrl() != null && batchJob.getDownloadUrl().getUrl() != null) {
        BatchJobMutateResponse mutateResponse = batchJobHelper.downloadBatchJobMutateResponse(batchJob.getDownloadUrl().getUrl());
        System.out.printf("Downloaded results from %s:%n", batchJob.getDownloadUrl().getUrl());
        for (MutateResult mutateResult : mutateResponse.getMutateResults()) {
            String outcome = mutateResult.getErrorList() == null ? "SUCCESS" : "FAILURE";
            System.out.printf("  Operation [%d] - %s%n", mutateResult.getIndex(), outcome);
        }
    } else {
        System.out.println("No results available for download.");
    }
}

Example 2 with BatchJobMutateResponse

use of com.google.api.ads.adwords.axis.utils.v201809.batchjob.BatchJobMutateResponse in project googleads-java-lib by googleads.

the class AddKeywordsUsingIncrementalBatchJob method runExample.

/**
 * Runs the example.
 *
 * @param adWordsServices the services factory.
 * @param session the session.
 * @param adGroupId the ID of the ad group where keywords will be added.
 * @throws BatchJobException if uploading operations or downloading results failed.
 * @throws ApiException if the API request failed with one or more service errors.
 * @throws RemoteException if the API request failed due to other errors.
 * @throws InterruptedException if the thread was interrupted while sleeping between retries.
 * @throws TimeoutException if the job did not complete after job status was polled {@link
 *     #MAX_POLL_ATTEMPTS} times.
 */
public static void runExample(AdWordsServicesInterface adWordsServices, AdWordsSession session, Long adGroupId) throws RemoteException, BatchJobException, InterruptedException, TimeoutException {
    // Get the BatchJobService.
    BatchJobServiceInterface batchJobService = adWordsServices.get(session, BatchJobServiceInterface.class);
    BatchJobOperation addOp = new BatchJobOperation();
    addOp.setOperator(Operator.ADD);
    addOp.setOperand(new BatchJob());
    BatchJob batchJob = batchJobService.mutate(new BatchJobOperation[] { addOp }).getValue(0);
    System.out.printf("Created BatchJob with ID %d, status '%s' and upload URL %s.%n", batchJob.getId(), batchJob.getStatus(), batchJob.getUploadUrl().getUrl());
    // Create a BatchJobHelper for uploading operations.
    BatchJobHelper batchJobHelper = adWordsServices.getUtility(session, BatchJobHelper.class);
    BatchJobUploadStatus batchJobUploadStatus = new BatchJobUploadStatus(0, URI.create(batchJob.getUploadUrl().getUrl()));
    List<AdGroupCriterionOperation> operations = new ArrayList<>();
    // incrementally.
    for (int i = 0; i < NUMBER_OF_KEYWORDS_TO_ADD; i++) {
        // Create Keyword.
        String text = String.format("mars%d", i);
        // Make 10% of keywords invalid to demonstrate error handling.
        if (i % 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 the list of operations.
        operations.add(agco);
        // If the current list of operations has reached KEYWORDS_PER_UPLOAD or this is the last
        // operation, upload the current list of operations.
        boolean isLastOperation = i == NUMBER_OF_KEYWORDS_TO_ADD - 1;
        if (operations.size() == KEYWORDS_PER_UPLOAD || isLastOperation) {
            BatchJobUploadResponse uploadResponse = batchJobHelper.uploadIncrementalBatchJobOperations(operations, isLastOperation, batchJobUploadStatus);
            System.out.printf("Uploaded %d operations for batch job with ID %d.%n", operations.size(), batchJob.getId());
            // Set the batch job upload status and clear the operations list in preparation for the
            // next upload.
            batchJobUploadStatus = uploadResponse.getBatchJobUploadStatus();
            operations.clear();
        }
    }
    // Poll for completion of the batch job using an exponential back off.
    int pollAttempts = 0;
    boolean isPending;
    boolean wasCancelRequested = false;
    Selector selector = new SelectorBuilder().fields(BatchJobField.Id, BatchJobField.Status, BatchJobField.DownloadUrl, BatchJobField.ProcessingErrors, BatchJobField.ProgressStats).equalsId(batchJob.getId()).build();
    do {
        long sleepSeconds = (long) Math.scalb(30, pollAttempts);
        System.out.printf("Sleeping %d seconds...%n", sleepSeconds);
        Thread.sleep(sleepSeconds * 1000);
        batchJob = batchJobService.get(selector).getEntries(0);
        System.out.printf("Batch job ID %d has status '%s'.%n", batchJob.getId(), batchJob.getStatus());
        pollAttempts++;
        isPending = PENDING_STATUSES.contains(batchJob.getStatus());
        // times.
        if (isPending && !wasCancelRequested && pollAttempts == MAX_POLL_ATTEMPTS) {
            batchJob.setStatus(BatchJobStatus.CANCELING);
            BatchJobOperation batchJobSetOperation = new BatchJobOperation();
            batchJobSetOperation.setOperand(batchJob);
            batchJobSetOperation.setOperator(Operator.SET);
            // Only request cancellation once per job.
            wasCancelRequested = true;
            try {
                batchJob = batchJobService.mutate(new BatchJobOperation[] { batchJobSetOperation }).getValue(0);
                System.out.printf("Requested cancellation of batch job with ID %d.%n", batchJob.getId());
            } catch (ApiException e) {
                if (e.getErrors() != null && e.getErrors().length > 0 && e.getErrors(0) instanceof BatchJobError) {
                    BatchJobError batchJobError = (BatchJobError) e.getErrors(0);
                    if (BatchJobErrorReason.INVALID_STATE_CHANGE.equals(batchJobError.getReason())) {
                        System.out.printf("Attempt to cancel batch job with ID %d was rejected because the job already " + "completed or was canceled.", batchJob.getId());
                        continue;
                    }
                }
                throw e;
            } finally {
                // Reset the poll attempt counter to wait for cancellation.
                pollAttempts = 0;
            }
        }
    } while (isPending && pollAttempts < MAX_POLL_ATTEMPTS);
    if (isPending) {
        throw new TimeoutException("Job is still in pending state after polling " + MAX_POLL_ATTEMPTS + " times.");
    }
    if (batchJob.getProcessingErrors() != null) {
        int errorIndex = 0;
        for (BatchJobProcessingError processingError : batchJob.getProcessingErrors()) {
            System.out.printf("  Processing error [%d]: errorType=%s, trigger=%s, errorString=%s, fieldPath=%s" + ", reason=%s%n", errorIndex++, processingError.getApiErrorType(), processingError.getTrigger(), processingError.getErrorString(), processingError.getFieldPath(), processingError.getReason());
        }
    } else {
        System.out.println("No processing errors found.");
    }
    if (batchJob.getDownloadUrl() != null && batchJob.getDownloadUrl().getUrl() != null) {
        BatchJobMutateResponse mutateResponse = batchJobHelper.downloadBatchJobMutateResponse(batchJob.getDownloadUrl().getUrl());
        System.out.printf("Downloaded results from %s:%n", batchJob.getDownloadUrl().getUrl());
        for (MutateResult mutateResult : mutateResponse.getMutateResults()) {
            String outcome = mutateResult.getErrorList() == null ? "SUCCESS" : "FAILURE";
            System.out.printf("  Operation [%d] - %s%n", mutateResult.getIndex(), outcome);
        }
    } else {
        System.out.println("No results available for download.");
    }
}

Example 3 with BatchJobMutateResponse

use of com.google.api.ads.adwords.axis.utils.v201809.batchjob.BatchJobMutateResponse in project googleads-java-lib by googleads.

the class JaxWsBatchJobResponseDeserializerTest method testDeserializeBatchJobResponseWithoutErrors.

/**
 * Tests that a response without errors will be properly deserialized.
 */
@Test
public void testDeserializeBatchJobResponseWithoutErrors() throws Exception {
    BatchJobMutateResponse response = deserializer.deserializeBatchJobMutateResults(BatchJobMutateResponse.class, JaxWsBatchJobResponseDeserializerTest.class.getResource("resources/BatchJobMutate.responseWithoutErrors.xml"));
    assertNotNull(response);
    // Expect: Campaign, AdGroup, BiddableAdGroupCriterion, BiddableAdGroupCriterion
    assertEquals(4, response.getMutateResults().length);
    assertNotNull(response.getMutateResults()[0].getOperand().getCampaign());
    assertNotNull(response.getMutateResults()[1].getOperand().getAdGroup());
    assertNotNull(response.getMutateResults()[2].getOperand().getAdGroupCriterion());
    assertThat(response.getMutateResults()[3].getOperand().getAdGroupCriterion(), Matchers.instanceOf(BiddableAdGroupCriterion.class));
    assertNotNull(response.getMutateResults()[3].getOperand().getAdGroupCriterion());
    assertThat(response.getMutateResults()[3].getOperand().getAdGroupCriterion(), Matchers.instanceOf(BiddableAdGroupCriterion.class));
}

Example 4 with BatchJobMutateResponse

use of com.google.api.ads.adwords.axis.utils.v201809.batchjob.BatchJobMutateResponse in project googleads-java-lib by googleads.

the class JaxWsBatchJobResponseDeserializerTest method testDeserializeBatchJobMutateResponseWithErrors.

@Test
public void testDeserializeBatchJobMutateResponseWithErrors() throws Exception {
    BatchJobMutateResponse response = deserializer.deserializeBatchJobMutateResults(BatchJobMutateResponse.class, JaxWsBatchJobResponseDeserializerTest.class.getResource("resources/BatchJobMutate.responseWithErrors.xml"));
    assertNotNull("Null deserialized request returned", response);
    // Expect: Campaign, AdGroup, BiddableAdGroupCriterion, BiddableAdGroupCriterion,
    // CriterionError, CriterionError, CriterionError
    assertEquals(7, response.getMutateResults().length);
    assertNotNull(response.getMutateResults()[0].getOperand().getCampaign());
    assertNotNull(response.getMutateResults()[1].getOperand().getAdGroup());
    assertNotNull(response.getMutateResults()[2].getOperand().getAdGroupCriterion());
    assertThat(response.getMutateResults()[2].getOperand().getAdGroupCriterion(), Matchers.instanceOf(BiddableAdGroupCriterion.class));
    assertNotNull(response.getMutateResults()[3].getOperand().getAdGroupCriterion());
    assertThat(response.getMutateResults()[3].getOperand().getAdGroupCriterion(), Matchers.instanceOf(BiddableAdGroupCriterion.class));
    assertThat(response.getMutateResults()[4].getErrorList().getErrors()[0], Matchers.instanceOf(CriterionError.class));
    assertThat(response.getMutateResults()[5].getErrorList().getErrors()[0], Matchers.instanceOf(CriterionError.class));
    assertThat(response.getMutateResults()[6].getErrorList().getErrors()[0], Matchers.instanceOf(CriterionError.class));
}

Example 5 with BatchJobMutateResponse

use of com.google.api.ads.adwords.axis.utils.v201809.batchjob.BatchJobMutateResponse in project googleads-java-lib by googleads.

the class JaxWsDeserializationTest method testDeserializeBatchJobMutateRequest.

@Test
public void testDeserializeBatchJobMutateRequest() {
    Source source = new StreamSource(JaxWsDeserializationTest.class.getResourceAsStream("resources/BatchJobMutate.responseWithErrors.xml"));
    BatchJobMutateResponse response = deserializer.deserialize(source);
    assertNotNull("Null deserialized request returned", response);
    // Expect: Campaign, AdGroup, BiddableAdGroupCriterion, BiddableAdGroupCriterion,
    // CriterionError, CriterionError, CriterionError
    assertEquals(7, response.getMutateResults().length);
    assertNotNull(response.getMutateResults()[0].getOperand().getCampaign());
    assertNotNull(response.getMutateResults()[1].getOperand().getAdGroup());
    assertNotNull(response.getMutateResults()[2].getOperand().getAdGroupCriterion());
    assertThat(response.getMutateResults()[2].getOperand().getAdGroupCriterion(), Matchers.instanceOf(BiddableAdGroupCriterion.class));
    assertNotNull(response.getMutateResults()[3].getOperand().getAdGroupCriterion());
    assertThat(response.getMutateResults()[3].getOperand().getAdGroupCriterion(), Matchers.instanceOf(BiddableAdGroupCriterion.class));
    assertThat(response.getMutateResults()[4].getErrorList().getErrors()[0], Matchers.instanceOf(CriterionError.class));
    assertThat(response.getMutateResults()[5].getErrorList().getErrors()[0], Matchers.instanceOf(CriterionError.class));
    assertThat(response.getMutateResults()[6].getErrorList().getErrors()[0], Matchers.instanceOf(CriterionError.class));
}