Examples with CustomTargetingKey com.google.api.ads.admanager.axis.v202202.CustomTargetingKey used on opensource projects

Example 11 with CustomTargetingKey

use of com.google.api.ads.admanager.axis.v202202.CustomTargetingKey in project googleads-java-lib by googleads.

the class UpdateCustomTargetingKeys method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param customTargetingKeyId the ID of the custom targeting key to update.
 * @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(AdManagerServices adManagerServices, AdManagerSession session, long customTargetingKeyId) throws RemoteException {
    // Get the CustomTargetingService.
    CustomTargetingServiceInterface customTargetingService = adManagerServices.get(session, CustomTargetingServiceInterface.class);
    // Create a statement to get custom targeting keys.
    StatementBuilder statementBuilder = new StatementBuilder().where("WHERE id = :id").orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("id", customTargetingKeyId);
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get custom targeting keys by statement.
        CustomTargetingKeyPage page = customTargetingService.getCustomTargetingKeysByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            CustomTargetingKey[] customTargetingKeys = page.getResults();
            totalResultSetSize = page.getTotalResultSetSize();
            // name.
            for (CustomTargetingKey customTargetingKey : customTargetingKeys) {
                if (customTargetingKey.getDisplayName() == null) {
                    customTargetingKey.setDisplayName(customTargetingKey.getName());
                }
                customTargetingKey.setDisplayName(customTargetingKey.getDisplayName() + " (Deprecated)");
            }
            // Update the custom targeting keys on the server.
            customTargetingKeys = customTargetingService.updateCustomTargetingKeys(customTargetingKeys);
            for (CustomTargetingKey updatedCustomTargetingKey : customTargetingKeys) {
                System.out.printf("Custom targeting key with ID %d, name '%s', and display name " + "'%s' was updated.%n", updatedCustomTargetingKey.getId(), updatedCustomTargetingKey.getName(), updatedCustomTargetingKey.getDisplayName());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
}

Example 12 with CustomTargetingKey

use of com.google.api.ads.admanager.axis.v202202.CustomTargetingKey in project googleads-java-lib by googleads.

the class DeleteCustomTargetingKeys method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param customTargetingKeyId the ID of the custom targeting key.
 * @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(AdManagerServices adManagerServices, AdManagerSession session, long customTargetingKeyId) throws RemoteException {
    // Get the CustomTargetingService.
    CustomTargetingServiceInterface customTargetingService = adManagerServices.get(session, CustomTargetingServiceInterface.class);
    // Create a statement to select a custom targeting key.
    StatementBuilder statementBuilder = new StatementBuilder().where("WHERE id = :id").orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("id", customTargetingKeyId);
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get custom targeting keys by statement.
        CustomTargetingKeyPage page = customTargetingService.getCustomTargetingKeysByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (CustomTargetingKey customTargetingKey : page.getResults()) {
                System.out.printf("%d) Custom targeting key with ID %d" + " will be deleted.%n", i++, customTargetingKey.getId());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    System.out.printf("Number of custom targeting keys to be deleted: %d%n", totalResultSetSize);
    if (totalResultSetSize > 0) {
        // Remove limit and offset from statement.
        statementBuilder.removeLimitAndOffset();
        // Create action.
        com.google.api.ads.admanager.axis.v202108.DeleteCustomTargetingKeys action = new com.google.api.ads.admanager.axis.v202108.DeleteCustomTargetingKeys();
        // Perform action.
        UpdateResult result = customTargetingService.performCustomTargetingKeyAction(action, statementBuilder.toStatement());
        if (result != null && result.getNumChanges() > 0) {
            System.out.printf("Number of custom targeting keys deleted: %d%n", result.getNumChanges());
        } else {
            System.out.println("No custom targeting keys were deleted.");
        }
    }
}

Example 13 with CustomTargetingKey

use of com.google.api.ads.admanager.axis.v202202.CustomTargetingKey in project googleads-java-lib by googleads.

the class UpdateCustomTargetingKeys method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param customTargetingKeyId the ID of the custom targeting key to update.
 * @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(AdManagerServices adManagerServices, AdManagerSession session, long customTargetingKeyId) throws RemoteException {
    // Get the CustomTargetingService.
    CustomTargetingServiceInterface customTargetingService = adManagerServices.get(session, CustomTargetingServiceInterface.class);
    // Create a statement to get custom targeting keys.
    StatementBuilder statementBuilder = new StatementBuilder().where("WHERE id = :id").orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("id", customTargetingKeyId);
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get custom targeting keys by statement.
        CustomTargetingKeyPage page = customTargetingService.getCustomTargetingKeysByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            CustomTargetingKey[] customTargetingKeys = page.getResults();
            totalResultSetSize = page.getTotalResultSetSize();
            // name.
            for (CustomTargetingKey customTargetingKey : customTargetingKeys) {
                if (customTargetingKey.getDisplayName() == null) {
                    customTargetingKey.setDisplayName(customTargetingKey.getName());
                }
                customTargetingKey.setDisplayName(customTargetingKey.getDisplayName() + " (Deprecated)");
            }
            // Update the custom targeting keys on the server.
            customTargetingKeys = customTargetingService.updateCustomTargetingKeys(customTargetingKeys);
            for (CustomTargetingKey updatedCustomTargetingKey : customTargetingKeys) {
                System.out.printf("Custom targeting key with ID %d, name '%s', and display name " + "'%s' was updated.%n", updatedCustomTargetingKey.getId(), updatedCustomTargetingKey.getName(), updatedCustomTargetingKey.getDisplayName());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
}

Example 14 with CustomTargetingKey

use of com.google.api.ads.admanager.axis.v202202.CustomTargetingKey in project googleads-java-lib by googleads.

the class GetPredefinedCustomTargetingKeysAndValues method getPredefinedCustomTargetingKeyIds.

public static List<Long> getPredefinedCustomTargetingKeyIds(AdManagerServices adManagerServices, AdManagerSession session) throws RemoteException {
    List<Long> customTargetingKeyIds = new ArrayList<>();
    CustomTargetingServiceInterface customTargetingService = adManagerServices.get(session, CustomTargetingServiceInterface.class);
    // Create a statement to get predefined custom targeting keys.
    StatementBuilder statementBuilder = new StatementBuilder().where("type = :type").orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("type", CustomTargetingKeyType.PREDEFINED.toString());
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get custom targeting keys by statement.
        CustomTargetingKeyPage page = customTargetingService.getCustomTargetingKeysByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (CustomTargetingKey customTargetingKey : page.getResults()) {
                System.out.printf("%d) Custom targeting key with ID %d, name '%s', and " + "display name '%s' was found.%n", i++, customTargetingKey.getId(), customTargetingKey.getName(), customTargetingKey.getDisplayName());
                customTargetingKeyIds.add(customTargetingKey.getId());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    return customTargetingKeyIds;
}

Example 15 with CustomTargetingKey

use of com.google.api.ads.admanager.axis.v202202.CustomTargetingKey in project googleads-java-lib by googleads.

the class DeleteCustomTargetingKeys method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param customTargetingKeyId the ID of the custom targeting key.
 * @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(AdManagerServices adManagerServices, AdManagerSession session, long customTargetingKeyId) throws RemoteException {
    // Get the CustomTargetingService.
    CustomTargetingServiceInterface customTargetingService = adManagerServices.get(session, CustomTargetingServiceInterface.class);
    // Create a statement to select a custom targeting key.
    StatementBuilder statementBuilder = new StatementBuilder().where("WHERE id = :id").orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("id", customTargetingKeyId);
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get custom targeting keys by statement.
        CustomTargetingKeyPage page = customTargetingService.getCustomTargetingKeysByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (CustomTargetingKey customTargetingKey : page.getResults()) {
                System.out.printf("%d) Custom targeting key with ID %d" + " will be deleted.%n", i++, customTargetingKey.getId());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    System.out.printf("Number of custom targeting keys to be deleted: %d%n", totalResultSetSize);
    if (totalResultSetSize > 0) {
        // Remove limit and offset from statement.
        statementBuilder.removeLimitAndOffset();
        // Create action.
        com.google.api.ads.admanager.axis.v202111.DeleteCustomTargetingKeys action = new com.google.api.ads.admanager.axis.v202111.DeleteCustomTargetingKeys();
        // Perform action.
        UpdateResult result = customTargetingService.performCustomTargetingKeyAction(action, statementBuilder.toStatement());
        if (result != null && result.getNumChanges() > 0) {
            System.out.printf("Number of custom targeting keys deleted: %d%n", result.getNumChanges());
        } else {
            System.out.println("No custom targeting keys were deleted.");
        }
    }
}