Search in sources :

Example 6 with AvailabilityForecastOptions

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

the class GetAvailabilityForecast method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param advertiserId the ID of the advertiser (company) to forecast for. Setting an advertiser
 *     will cause the forecast to apply the appropriate unified blocking rules.
 * @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 advertiserId) throws RemoteException {
    // Get the ForecastService.
    ForecastServiceInterface forecastService = adManagerServices.get(session, ForecastServiceInterface.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.
    AdUnitTargeting adUnitTargeting = new AdUnitTargeting();
    adUnitTargeting.setAdUnitId(rootAdUnitId);
    adUnitTargeting.setIncludeDescendants(true);
    inventoryTargeting.setTargetedAdUnits(new AdUnitTargeting[] { adUnitTargeting });
    // Create targeting.
    Targeting targeting = new Targeting();
    targeting.setInventoryTargeting(inventoryTargeting);
    // Create a line item.
    LineItem lineItem = new LineItem();
    lineItem.setTargeting(targeting);
    lineItem.setLineItemType(LineItemType.SPONSORSHIP);
    // Set the roadblocking type.
    lineItem.setRoadblockingType(RoadblockingType.ONE_OR_MORE);
    // Set the creative rotation type.
    lineItem.setCreativeRotationType(CreativeRotationType.OPTIMIZED);
    // Create creative placeholder size.
    Size size = new Size();
    size.setWidth(300);
    size.setHeight(250);
    size.setIsAspectRatio(false);
    // Create the creative placeholder.
    CreativePlaceholder creativePlaceholder = new CreativePlaceholder();
    creativePlaceholder.setSize(size);
    // Set the size of creatives that can be associated with this line item.
    lineItem.setCreativePlaceholders(new CreativePlaceholder[] { creativePlaceholder });
    // Set the length of the line item to run.
    lineItem.setStartDateTimeType(StartDateTimeType.IMMEDIATELY);
    lineItem.setEndDateTime(DateTimes.toDateTime(Instant.now().plus(Duration.standardDays(30L)), "America/New_York"));
    // Set the cost type.
    lineItem.setCostType(CostType.CPM);
    // Set the line item to use 50% of the impressions.
    Goal goal = new Goal();
    goal.setGoalType(GoalType.DAILY);
    goal.setUnitType(UnitType.IMPRESSIONS);
    goal.setUnits(50L);
    lineItem.setPrimaryGoal(goal);
    // Get forecast for prospective line item.
    ProspectiveLineItem prospectiveLineItem = new ProspectiveLineItem();
    prospectiveLineItem.setAdvertiserId(advertiserId);
    prospectiveLineItem.setLineItem(lineItem);
    AvailabilityForecastOptions options = new AvailabilityForecastOptions();
    options.setIncludeContendingLineItems(true);
    options.setIncludeTargetingCriteriaBreakdown(true);
    AvailabilityForecast forecast = forecastService.getAvailabilityForecast(prospectiveLineItem, options);
    long matched = forecast.getMatchedUnits();
    double availablePercent = (forecast.getAvailableUnits() / (matched * 1.0)) * 100;
    String unitType = forecast.getUnitType().toString().toLowerCase();
    System.out.printf("%d %s matched.%n", matched, unitType);
    System.out.printf("%.2f%% %s available.%n", availablePercent, unitType);
    if (forecast.getPossibleUnits() != null) {
        double possiblePercent = (forecast.getPossibleUnits() / (matched * 1.0)) * 100;
        System.out.printf("%.2f%% %s possible.%n", possiblePercent, unitType);
    }
    System.out.printf("%d contending line items.%n", forecast.getContendingLineItems() == null ? 0 : forecast.getContendingLineItems().length);
}
Also used : NetworkServiceInterface(com.google.api.ads.admanager.axis.v202111.NetworkServiceInterface) Targeting(com.google.api.ads.admanager.axis.v202111.Targeting) InventoryTargeting(com.google.api.ads.admanager.axis.v202111.InventoryTargeting) AdUnitTargeting(com.google.api.ads.admanager.axis.v202111.AdUnitTargeting) Size(com.google.api.ads.admanager.axis.v202111.Size) ProspectiveLineItem(com.google.api.ads.admanager.axis.v202111.ProspectiveLineItem) LineItem(com.google.api.ads.admanager.axis.v202111.LineItem) InventoryTargeting(com.google.api.ads.admanager.axis.v202111.InventoryTargeting) CreativePlaceholder(com.google.api.ads.admanager.axis.v202111.CreativePlaceholder) ForecastServiceInterface(com.google.api.ads.admanager.axis.v202111.ForecastServiceInterface) ProspectiveLineItem(com.google.api.ads.admanager.axis.v202111.ProspectiveLineItem) Goal(com.google.api.ads.admanager.axis.v202111.Goal) AdUnitTargeting(com.google.api.ads.admanager.axis.v202111.AdUnitTargeting) AvailabilityForecastOptions(com.google.api.ads.admanager.axis.v202111.AvailabilityForecastOptions) AvailabilityForecast(com.google.api.ads.admanager.axis.v202111.AvailabilityForecast)

Aggregations

AvailabilityForecast (com.google.api.ads.admanager.axis.v202108.AvailabilityForecast)2 AvailabilityForecastOptions (com.google.api.ads.admanager.axis.v202108.AvailabilityForecastOptions)2 ForecastServiceInterface (com.google.api.ads.admanager.axis.v202108.ForecastServiceInterface)2 AvailabilityForecast (com.google.api.ads.admanager.axis.v202111.AvailabilityForecast)2 AvailabilityForecastOptions (com.google.api.ads.admanager.axis.v202111.AvailabilityForecastOptions)2 ForecastServiceInterface (com.google.api.ads.admanager.axis.v202111.ForecastServiceInterface)2 AvailabilityForecast (com.google.api.ads.admanager.axis.v202202.AvailabilityForecast)2 AvailabilityForecastOptions (com.google.api.ads.admanager.axis.v202202.AvailabilityForecastOptions)2 ForecastServiceInterface (com.google.api.ads.admanager.axis.v202202.ForecastServiceInterface)2 AdUnitTargeting (com.google.api.ads.admanager.axis.v202108.AdUnitTargeting)1 CreativePlaceholder (com.google.api.ads.admanager.axis.v202108.CreativePlaceholder)1 Goal (com.google.api.ads.admanager.axis.v202108.Goal)1 InventoryTargeting (com.google.api.ads.admanager.axis.v202108.InventoryTargeting)1 LineItem (com.google.api.ads.admanager.axis.v202108.LineItem)1 NetworkServiceInterface (com.google.api.ads.admanager.axis.v202108.NetworkServiceInterface)1 ProspectiveLineItem (com.google.api.ads.admanager.axis.v202108.ProspectiveLineItem)1 Size (com.google.api.ads.admanager.axis.v202108.Size)1 Targeting (com.google.api.ads.admanager.axis.v202108.Targeting)1 AdUnitTargeting (com.google.api.ads.admanager.axis.v202111.AdUnitTargeting)1 CreativePlaceholder (com.google.api.ads.admanager.axis.v202111.CreativePlaceholder)1