Examples with CmsMetadataValue com.google.api.ads.admanager.axis.v202205.CmsMetadataValue used on opensource projects

Example 6 with CmsMetadataValue

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

the class ActivateCmsMetadataValues method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param cmsMetadataKeyId the ID of the CMS Metadata Key to activate values for.
 * @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 cmsMetadataKeyId) throws RemoteException {
    // Get the CmsMetadataService.
    CmsMetadataServiceInterface cmsMetadataService = adManagerServices.get(session, CmsMetadataServiceInterface.class);
    // Create a statement to select CMS Metadata Values.
    StatementBuilder statementBuilder = new StatementBuilder().where("cmsKeyId = :cmsKeyId AND status = :status").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("cmsKeyId", cmsMetadataKeyId).withBindVariableValue("status", CmsMetadataKeyStatus.INACTIVE.toString());
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get CMS Metadata Values by statement.
        CmsMetadataValuePage page = cmsMetadataService.getCmsMetadataValuesByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (CmsMetadataValue cmsMetadataValue : page.getResults()) {
                System.out.printf("%d) CMS Metadata Value with ID %d will be activated.%n", i++, cmsMetadataValue.getCmsMetadataValueId());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    System.out.printf("Number of CMS Metadata Values to be activated: %d%n", totalResultSetSize);
    if (totalResultSetSize > 0) {
        // Remove limit and offset from statement to activate all matching values.
        statementBuilder.removeLimitAndOffset();
        // Create action.
        com.google.api.ads.admanager.axis.v202108.ActivateCmsMetadataValues action = new com.google.api.ads.admanager.axis.v202108.ActivateCmsMetadataValues();
        // Perform action.
        UpdateResult result = cmsMetadataService.performCmsMetadataValueAction(action, statementBuilder.toStatement());
        if (result != null && result.getNumChanges() > 0) {
            System.out.printf("Number of items activated: %d%n", result.getNumChanges());
        } else {
            System.out.println("No CMS Metadata Values were activated.");
        }
    }
}

Example 7 with CmsMetadataValue

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

the class GetAllCmsMetadataValues method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices 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(AdManagerServices adManagerServices, AdManagerSession session) throws RemoteException {
    // Get the CmsMetadataService.
    CmsMetadataServiceInterface cmsMetadataService = adManagerServices.get(session, CmsMetadataServiceInterface.class);
    // Create a statement to select all CMS metadata values.
    StatementBuilder statementBuilder = new StatementBuilder().orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get CMS metadata values by statement.
        CmsMetadataValuePage page = cmsMetadataService.getCmsMetadataValuesByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (CmsMetadataValue cmsMetadataValue : page.getResults()) {
                System.out.printf("%d) CMS metadata value with ID %d and name '%s' associated with the " + "CmsMetadataKey with ID %d and name '%s' was found.%n", i++, cmsMetadataValue.getCmsMetadataValueId(), cmsMetadataValue.getValueName(), cmsMetadataValue.getKey().getId(), cmsMetadataValue.getKey().getName());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    System.out.printf("Number of results found: %d%n", totalResultSetSize);
}

Example 8 with CmsMetadataValue

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

the class GetCmsMetadataValuesForKey method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices 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(AdManagerServices adManagerServices, AdManagerSession session, String cmsMetadataKeyName) throws RemoteException {
    // Get the CmsMetadataService.
    CmsMetadataServiceInterface cmsMetadataService = adManagerServices.get(session, CmsMetadataServiceInterface.class);
    // Create a statement to select all CMS metadata values.
    StatementBuilder statementBuilder = new StatementBuilder().where("cmsKey = :cmsMetadataKeyName").orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("cmsMetadataKeyName", cmsMetadataKeyName);
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get CMS metadata values by statement.
        CmsMetadataValuePage page = cmsMetadataService.getCmsMetadataValuesByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (CmsMetadataValue cmsMetadataValue : page.getResults()) {
                System.out.printf("%d) CMS metadata value with ID %d and name '%s' associated with the " + "CmsMetadataKey with ID %d and name '%s' was found.%n", i++, cmsMetadataValue.getCmsMetadataValueId(), cmsMetadataValue.getValueName(), cmsMetadataValue.getKey().getId(), cmsMetadataValue.getKey().getName());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    System.out.printf("Number of results found: %d%n", totalResultSetSize);
}

Example 9 with CmsMetadataValue

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

the class ActivateCmsMetadataValues method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param cmsMetadataKeyId the ID of the CMS Metadata Key to activate values for.
 * @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 cmsMetadataKeyId) throws RemoteException {
    // Get the CmsMetadataService.
    CmsMetadataServiceInterface cmsMetadataService = adManagerServices.get(session, CmsMetadataServiceInterface.class);
    // Create a statement to select CMS Metadata Values.
    StatementBuilder statementBuilder = new StatementBuilder().where("cmsKeyId = :cmsKeyId AND status = :status").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("cmsKeyId", cmsMetadataKeyId).withBindVariableValue("status", CmsMetadataKeyStatus.INACTIVE.toString());
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get CMS Metadata Values by statement.
        CmsMetadataValuePage page = cmsMetadataService.getCmsMetadataValuesByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (CmsMetadataValue cmsMetadataValue : page.getResults()) {
                System.out.printf("%d) CMS Metadata Value with ID %d will be activated.%n", i++, cmsMetadataValue.getCmsMetadataValueId());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    System.out.printf("Number of CMS Metadata Values to be activated: %d%n", totalResultSetSize);
    if (totalResultSetSize > 0) {
        // Remove limit and offset from statement to activate all matching values.
        statementBuilder.removeLimitAndOffset();
        // Create action.
        com.google.api.ads.admanager.axis.v202111.ActivateCmsMetadataValues action = new com.google.api.ads.admanager.axis.v202111.ActivateCmsMetadataValues();
        // Perform action.
        UpdateResult result = cmsMetadataService.performCmsMetadataValueAction(action, statementBuilder.toStatement());
        if (result != null && result.getNumChanges() > 0) {
            System.out.printf("Number of items activated: %d%n", result.getNumChanges());
        } else {
            System.out.println("No CMS Metadata Values were activated.");
        }
    }
}

Example 10 with CmsMetadataValue

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

the class ActivateCmsMetadataValues method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param cmsMetadataKeyId the ID of the CMS Metadata Key to activate values for.
 * @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 cmsMetadataKeyId) throws RemoteException {
    // Get the CmsMetadataService.
    CmsMetadataServiceInterface cmsMetadataService = adManagerServices.get(session, CmsMetadataServiceInterface.class);
    // Create a statement to select CMS Metadata Values.
    StatementBuilder statementBuilder = new StatementBuilder().where("cmsKeyId = :cmsKeyId AND status = :status").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("cmsKeyId", cmsMetadataKeyId).withBindVariableValue("status", CmsMetadataKeyStatus.INACTIVE.toString());
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get CMS Metadata Values by statement.
        CmsMetadataValuePage page = cmsMetadataService.getCmsMetadataValuesByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (CmsMetadataValue cmsMetadataValue : page.getResults()) {
                System.out.printf("%d) CMS Metadata Value with ID %d will be activated.%n", i++, cmsMetadataValue.getCmsMetadataValueId());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    System.out.printf("Number of CMS Metadata Values to be activated: %d%n", totalResultSetSize);
    if (totalResultSetSize > 0) {
        // Remove limit and offset from statement to activate all matching values.
        statementBuilder.removeLimitAndOffset();
        // Create action.
        com.google.api.ads.admanager.axis.v202202.ActivateCmsMetadataValues action = new com.google.api.ads.admanager.axis.v202202.ActivateCmsMetadataValues();
        // Perform action.
        UpdateResult result = cmsMetadataService.performCmsMetadataValueAction(action, statementBuilder.toStatement());
        if (result != null && result.getNumChanges() > 0) {
            System.out.printf("Number of items activated: %d%n", result.getNumChanges());
        } else {
            System.out.println("No CMS Metadata Values were activated.");
        }
    }
}