Examples with ManagedCustomer com.google.api.ads.adwords.axis.v201809.mcm.ManagedCustomer used on opensource projects

Example 1 with ManagedCustomer

use of com.google.api.ads.adwords.axis.v201809.mcm.ManagedCustomer in project googleads-java-lib by googleads.

the class ParallelReportDownload method runExample.

/**
 * Runs the example.
 *
 * @param adWordsServices the services factory.
 * @param session the session.
 * @param numberOfThreads number of threads to use for concurrent report requests.
 * @param maxElapsedSecondsPerCustomer the maximum number of seconds to wait for each report
 *     request to complete.
 * @throws ApiException if the API request to retrieve managed customers failed with one or more
 *     service errors.
 * @throws RemoteException if the API request to retrieve managed customers failed due to other
 *     errors.
 * @throws DetailedReportDownloadResponseException if the report request failed with a detailed
 *     error from the reporting service.
 * @throws ReportDownloadResponseException if the report request failed with a general error from
 *     the reporting service.
 * @throws ReportException if the report request failed due to a transport layer error.
 * @throws IOException if the report's contents could not be read from the response.
 * @throws ValidationException if creation of an ImmutableAdWordsSession for a customer failed due
 *     to validation issues.
 * @throws InterruptedException if the thread was interrupted while waiting for all report
 *     downloads to complete.
 */
public static void runExample(AdWordsServicesInterface adWordsServices, ImmutableAdWordsSession session, int numberOfThreads, int maxElapsedSecondsPerCustomer) throws ReportDownloadResponseException, ReportException, IOException, ValidationException, InterruptedException {
    // Retrieve all accounts under the manager account.
    Map<Long, ManagedCustomer> managedCustomers = getAllManagedCustomers(adWordsServices, session);
    System.out.printf("Downloading report for %d managed customers.%n", managedCustomers.size());
    // Create selector for the report definition.
    Selector selector = new Selector();
    selector.getFields().addAll(Arrays.asList("CampaignId", "AdGroupId", "Impressions", "Clicks", "Cost"));
    // Create report definition.
    ReportDefinition reportDefinition = new ReportDefinition();
    reportDefinition.setReportName("Custom ADGROUP_PERFORMANCE_REPORT");
    reportDefinition.setDateRangeType(ReportDefinitionDateRangeType.LAST_7_DAYS);
    reportDefinition.setReportType(ReportDefinitionReportType.ADGROUP_PERFORMANCE_REPORT);
    reportDefinition.setDownloadFormat(DownloadFormat.CSV);
    reportDefinition.setSelector(selector);
    // Optional: Set the reporting configuration of the session to suppress header, column name, or
    // summary rows in the report output. You can also configure this via your ads.properties
    // configuration file. See AdWordsSession.Builder.from(Configuration) for details.
    // In addition, you can set whether you want to explicitly include or exclude zero impression
    // rows.
    ReportingConfiguration reportingConfiguration = new ReportingConfiguration.Builder().skipReportHeader(false).skipColumnHeader(false).skipReportSummary(false).includeZeroImpressions(false).build();
    // Create a thread pool for submitting report requests.
    ExecutorService threadPool = Executors.newFixedThreadPool(numberOfThreads);
    // Customize this builder if you want to change the backoff policy on retryable report
    // failures.
    ExponentialBackOff.Builder backOffBuilder = new ExponentialBackOff.Builder().setMaxElapsedTimeMillis(maxElapsedSecondsPerCustomer * 1000);
    File reportDirectory = Files.createTempDir();
    // List to keep track of the progress of each customer's report download task.
    List<ReportDownloadFutureTask> reportDownloadFutureTasks = new ArrayList<>();
    for (ManagedCustomer managedCustomer : managedCustomers.values()) {
        File outputFile = new File(reportDirectory, String.format("adgroup_%010d.csv", managedCustomer.getCustomerId()));
        ImmutableAdWordsSession sessionForCustomer = session.newBuilder().withClientCustomerId(Long.toString(managedCustomer.getCustomerId())).withReportingConfiguration(reportingConfiguration).buildImmutable();
        ReportDownloadFutureTask reportDownloadFutureTask = new ReportDownloadFutureTask(new ReportDownloadCallable(sessionForCustomer, adWordsServices, reportDefinition, outputFile, backOffBuilder.build()));
        // Use execute instead of submit since there is no need to get a Future for a FutureTask.
        // Instead, store this ReportDownloadFutureTask in the list so that it can be used later
        // to check the result and determine the task context (client customer ID).
        threadPool.execute(reportDownloadFutureTask);
        reportDownloadFutureTasks.add(reportDownloadFutureTask);
    }
    // All callables have been submitted. Shut down the thread pool.
    threadPool.shutdown();
    // Wait for the thread pool to terminate.
    threadPool.awaitTermination(Long.MAX_VALUE, TimeUnit.MILLISECONDS);
    System.out.println();
    System.out.println("All downloads completed. Results:");
    Map<String, File> successfulReports = Maps.newHashMap();
    Map<String, Exception> failedReports = Maps.newHashMap();
    for (ReportDownloadFutureTask reportDownloadFutureTask : reportDownloadFutureTasks) {
        String clientCustomerId = reportDownloadFutureTask.getClientCustomerId();
        try {
            File reportFile = reportDownloadFutureTask.get();
            successfulReports.put(clientCustomerId, reportFile);
        } catch (CancellationException | InterruptedException | ExecutionException e) {
            failedReports.put(clientCustomerId, e);
        }
    }
    System.out.println("Successful reports:");
    successfulReports.forEach((clientCustomerId, reportFile) -> System.out.printf("\tClient ID %s => '%s'%n", clientCustomerId, reportFile));
    System.out.println("Failed reports:");
    failedReports.forEach((clientCustomerId, exception) -> System.out.printf("\tClient ID %s => Exception: %s%n", clientCustomerId, exception));
    System.out.println("End of results.");
}

Example 2 with ManagedCustomer

use of com.google.api.ads.adwords.axis.v201809.mcm.ManagedCustomer in project googleads-java-lib by googleads.

the class GetAccountHierarchy method runExample.

/**
 * Runs the example.
 *
 * @param adWordsServices the services factory.
 * @param session the session.
 * @throws ApiException if the API request failed with one or more service errors.
 * @throws RemoteException if the API request failed due to other errors.
 */
public static void runExample(AdWordsServicesInterface adWordsServices, AdWordsSession session) throws RemoteException {
    // Get the ServicedAccountService.
    ManagedCustomerServiceInterface managedCustomerService = adWordsServices.get(session, ManagedCustomerServiceInterface.class);
    // Create selector builder.
    int offset = 0;
    SelectorBuilder selectorBuilder = new SelectorBuilder().fields(ManagedCustomerField.CustomerId, ManagedCustomerField.Name).offset(offset).limit(PAGE_SIZE);
    // Get results.
    ManagedCustomerPage page;
    // Map from customerId to customer node.
    Map<Long, ManagedCustomerTreeNode> customerIdToCustomerNode = Maps.newHashMap();
    // Map from each parent customer ID to its set of linked child customer IDs.
    SortedSetMultimap<Long, Long> parentIdToChildIds = TreeMultimap.create();
    do {
        page = managedCustomerService.get(selectorBuilder.build());
        if (page.getEntries() != null) {
            // Create account tree nodes for each customer.
            for (ManagedCustomer customer : page.getEntries()) {
                ManagedCustomerTreeNode node = new ManagedCustomerTreeNode();
                node.account = customer;
                customerIdToCustomerNode.put(customer.getCustomerId(), node);
            }
            // Update the map of parent customer ID to child customer IDs.
            if (page.getLinks() != null) {
                for (ManagedCustomerLink link : page.getLinks()) {
                    parentIdToChildIds.put(link.getManagerCustomerId(), link.getClientCustomerId());
                }
            }
        }
        offset += PAGE_SIZE;
        selectorBuilder.increaseOffsetBy(PAGE_SIZE);
    } while (offset < page.getTotalNumEntries());
    // of its parentNode.
    for (Entry<Long, Long> parentIdEntry : parentIdToChildIds.entries()) {
        ManagedCustomerTreeNode parentNode = customerIdToCustomerNode.get(parentIdEntry.getKey());
        ManagedCustomerTreeNode childNode = customerIdToCustomerNode.get(parentIdEntry.getValue());
        childNode.parentNode = parentNode;
        parentNode.childAccounts.add(childNode);
    }
    // Find the root account node in the tree.
    ManagedCustomerTreeNode rootNode = customerIdToCustomerNode.values().stream().filter(node -> node.parentNode == null).findFirst().orElse(null);
    // Display serviced account graph.
    if (rootNode != null) {
        // Display account tree.
        System.out.println("CustomerId, Name");
        System.out.println(rootNode.toTreeString(0, new StringBuffer()));
    } else {
        System.out.println("No serviced accounts were found.");
    }
}

Example 3 with ManagedCustomer

use of com.google.api.ads.adwords.axis.v201809.mcm.ManagedCustomer in project googleads-java-lib by googleads.

the class ParallelReportDownload method getAllManagedCustomers.

/**
 * Retrieves all managed customers under the manager account identified by
 * {@link AdWordsSession#getClientCustomerId()}.
 */
private static Map<Long, ManagedCustomer> getAllManagedCustomers(AdWordsServicesInterface adWordsServices, ImmutableAdWordsSession session) throws RemoteException {
    // Get the ManagedCustomerService.
    ManagedCustomerServiceInterface managedCustomerService = adWordsServices.get(session, ManagedCustomerServiceInterface.class);
    SelectorBuilder selectorBuilder = new SelectorBuilder().fields(ManagedCustomerField.CustomerId).equals(ManagedCustomerField.CanManageClients, "false").limit(PAGE_SIZE).offset(0);
    ManagedCustomerPage managedCustomerPage;
    int offset = 0;
    Map<Long, ManagedCustomer> managedCustomers = Maps.newHashMap();
    do {
        selectorBuilder.offset(offset);
        managedCustomerPage = managedCustomerService.get(selectorBuilder.build());
        if (managedCustomerPage.getEntries() != null) {
            for (ManagedCustomer managedCustomer : managedCustomerPage.getEntries()) {
                managedCustomers.put(managedCustomer.getCustomerId(), managedCustomer);
            }
        }
        offset += PAGE_SIZE;
    } while (offset < managedCustomerPage.getTotalNumEntries());
    return managedCustomers;
}

Example 4 with ManagedCustomer

use of com.google.api.ads.adwords.axis.v201809.mcm.ManagedCustomer in project googleads-java-lib by googleads.

the class CreateAccount method runExample.

/**
 * Runs the example.
 *
 * @param adWordsServices the services factory.
 * @param session the session.
 * @throws ApiException if the API request failed with one or more service errors.
 * @throws RemoteException if the API request failed due to other errors.
 */
public static void runExample(AdWordsServicesInterface adWordsServices, AdWordsSession session) throws RemoteException {
    // Get the CampaignService.
    ManagedCustomerServiceInterface managedCustomerService = adWordsServices.get(session, ManagedCustomerServiceInterface.class);
    // Create account.
    ManagedCustomer customer = new ManagedCustomer();
    customer.setName("Customer created with ManagedCustomerService on " + DateTime.now());
    customer.setCurrencyCode("EUR");
    customer.setDateTimeZone("Europe/London");
    // Create operations.
    ManagedCustomerOperation operation = new ManagedCustomerOperation();
    operation.setOperand(customer);
    operation.setOperator(Operator.ADD);
    ManagedCustomerOperation[] operations = new ManagedCustomerOperation[] { operation };
    // Add account.
    ManagedCustomerReturnValue result = managedCustomerService.mutate(operations);
    // Display accounts.
    for (ManagedCustomer customerResult : result.getValue()) {
        System.out.printf("Account with customer ID %d was created.%n", customerResult.getCustomerId());
    }
}