Examples with AudienceSegment com.google.api.ads.admanager.axis.v202108.AudienceSegment used on opensource projects

Example 1 with AudienceSegment

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

the class PopulateFirstPartyAudienceSegments method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param audienceSegmentId the ID of the first party audience segment to populate.
 * @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 audienceSegmentId) throws RemoteException {
    // Get the AudienceSegmentService.
    AudienceSegmentServiceInterface audienceSegmentService = adManagerServices.get(session, AudienceSegmentServiceInterface.class);
    // Create a statement to only select a specified first party audience
    // segment.
    StatementBuilder statementBuilder = new StatementBuilder().where("WHERE id = :audienceSegmentId and type = :type").orderBy("id ASC").limit(1).withBindVariableValue("audienceSegmentId", audienceSegmentId).withBindVariableValue("type", "FIRST_PARTY");
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get audience segments by statement.
        AudienceSegmentPage page = audienceSegmentService.getAudienceSegmentsByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (AudienceSegment audienceSegment : page.getResults()) {
                System.out.printf("%d) Audience segment with ID %d and name '%s' will be populated.%n", i++, audienceSegment.getId(), audienceSegment.getName());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    System.out.printf("Number of audience segments to be populated: %d%n", totalResultSetSize);
    if (totalResultSetSize > 0) {
        // Remove limit and offset from statement.
        statementBuilder.removeLimitAndOffset();
        // Create action.
        PopulateAudienceSegments action = new PopulateAudienceSegments();
        // Perform action.
        UpdateResult result = audienceSegmentService.performAudienceSegmentAction(action, statementBuilder.toStatement());
        if (result != null && result.getNumChanges() > 0) {
            System.out.printf("Number of audience segments populated: %d%n", result.getNumChanges());
        } else {
            System.out.println("No audience segments were populated.");
        }
    }
}

Example 2 with AudienceSegment

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

the class CreateAudienceSegments method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param customTargetingKeyId the ID of the custom criteria to be used in the segment rule.
 * @param customTargetingValueId the custom targeting value ID.
 * @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, long customTargetingValueId) throws RemoteException {
    // Get the AudienceSegmentService.
    AudienceSegmentServiceInterface audienceSegmentService = adManagerServices.get(session, AudienceSegmentServiceInterface.class);
    // Get the NetworkService.
    NetworkServiceInterface networkService = adManagerServices.get(session, NetworkServiceInterface.class);
    // Get the root ad unit ID used to target the whole site.
    String rootAdUnitId = networkService.getCurrentNetwork().getEffectiveRootAdUnitId();
    // Create inventory targeting.
    InventoryTargeting inventoryTargeting = new InventoryTargeting();
    // Create ad unit targeting for the root ad unit (i.e. the whole network).
    AdUnitTargeting adUnitTargeting = new AdUnitTargeting();
    adUnitTargeting.setAdUnitId(rootAdUnitId);
    adUnitTargeting.setIncludeDescendants(true);
    inventoryTargeting.setTargetedAdUnits(new AdUnitTargeting[] { adUnitTargeting });
    // Create the custom criteria to be used in the segment rule.
    // TARGETING_KEY_ID == TARGETING_VALUE_ID
    CustomCriteria customCriteria = new CustomCriteria();
    customCriteria.setKeyId(customTargetingKeyId);
    customCriteria.setOperator(CustomCriteriaComparisonOperator.IS);
    customCriteria.setValueIds(new long[] { customTargetingValueId });
    // Create the custom criteria expression.
    CustomCriteriaSet topCustomCriteriaSet = new CustomCriteriaSet();
    topCustomCriteriaSet.setLogicalOperator(CustomCriteriaSetLogicalOperator.AND);
    topCustomCriteriaSet.setChildren(new CustomCriteriaNode[] { customCriteria });
    // Create the audience segment rule.
    FirstPartyAudienceSegmentRule rule = new FirstPartyAudienceSegmentRule();
    rule.setInventoryRule(inventoryTargeting);
    rule.setCustomCriteriaRule(topCustomCriteriaSet);
    // Create an audience segment.
    RuleBasedFirstPartyAudienceSegment audienceSegment = new RuleBasedFirstPartyAudienceSegment();
    audienceSegment.setName("Sports enthusiasts audience segment #" + new Random().nextInt(Integer.MAX_VALUE));
    audienceSegment.setDescription("Sports enthusiasts between the ages of 20 and 30.");
    audienceSegment.setPageViews(6);
    audienceSegment.setRecencyDays(6);
    audienceSegment.setMembershipExpirationDays(88);
    audienceSegment.setRule(rule);
    // Create the audience segment on the server.
    AudienceSegment[] audienceSegments = audienceSegmentService.createAudienceSegments(new FirstPartyAudienceSegment[] { audienceSegment });
    for (AudienceSegment createdAudienceSegment : audienceSegments) {
        System.out.printf("An audience segment with ID %d, name '%s', and type '%s' was created.%n", createdAudienceSegment.getId(), createdAudienceSegment.getName(), createdAudienceSegment.getType());
    }
}

Example 3 with AudienceSegment

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

the class GetFirstPartyAudienceSegments 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 {
    AudienceSegmentServiceInterface audienceSegmentService = adManagerServices.get(session, AudienceSegmentServiceInterface.class);
    // Create a statement to select audience segments.
    StatementBuilder statementBuilder = new StatementBuilder().where("type = :type").orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("type", AudienceSegmentType.FIRST_PARTY.toString());
    // Retrieve a small amount of audience segments at a time, paging through
    // until all audience segments have been retrieved.
    int totalResultSetSize = 0;
    do {
        AudienceSegmentPage page = audienceSegmentService.getAudienceSegmentsByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            // Print out some information for each audience segment.
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (AudienceSegment audienceSegment : page.getResults()) {
                System.out.printf("%d) Audience segment with ID %d, name '%s', and size %d was found.%n", i++, audienceSegment.getId(), audienceSegment.getName(), audienceSegment.getSize());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    System.out.printf("Number of results found: %d%n", totalResultSetSize);
}

Example 4 with AudienceSegment

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

the class UpdateAudienceSegments method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param audienceSegmentId the ID of the first party audience segment 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 audienceSegmentId) throws RemoteException {
    // Get the AudienceSegmentService.
    AudienceSegmentServiceInterface audienceSegmentService = adManagerServices.get(session, AudienceSegmentServiceInterface.class);
    // Create a statement to only select a specified first party audience
    // segment.
    StatementBuilder statementBuilder = new StatementBuilder().where("WHERE id = :audienceSegmentId and type = :type").orderBy("id ASC").limit(1).withBindVariableValue("audienceSegmentId", audienceSegmentId).withBindVariableValue("type", "FIRST_PARTY");
    // Get the audience segment.
    RuleBasedFirstPartyAudienceSegment audienceSegment = (RuleBasedFirstPartyAudienceSegment) audienceSegmentService.getAudienceSegmentsByStatement(statementBuilder.toStatement()).getResults()[0];
    // Update the member expiration days.
    audienceSegment.setMembershipExpirationDays(180);
    // Update the audience segment on the server.
    AudienceSegment[] audienceSegments = audienceSegmentService.updateAudienceSegments(new FirstPartyAudienceSegment[] { audienceSegment });
    for (AudienceSegment updatedAudienceSegment : audienceSegments) {
        System.out.printf("Audience segment with ID %d and name '%s' was updated.%n", updatedAudienceSegment.getId(), updatedAudienceSegment.getName());
    }
}

Example 5 with AudienceSegment

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

the class GetAllAudienceSegments 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 AudienceSegmentService.
    AudienceSegmentServiceInterface audienceSegmentService = adManagerServices.get(session, AudienceSegmentServiceInterface.class);
    // Create a statement to select all audience segments.
    StatementBuilder statementBuilder = new StatementBuilder().orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get audience segments by statement.
        AudienceSegmentPage page = audienceSegmentService.getAudienceSegmentsByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (AudienceSegment audienceSegment : page.getResults()) {
                System.out.printf("%d) Audience segment with ID %d and name '%s' of size %d was found.%n", i++, audienceSegment.getId(), audienceSegment.getName(), audienceSegment.getSize());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    System.out.printf("Number of results found: %d%n", totalResultSetSize);
}