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

Example 1 with Size

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

the class CreateLineItems method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param orderId the ID of the order that the line items will belong to.
 * @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 orderId) throws RemoteException {
    // Get the LineItemService.
    LineItemServiceInterface lineItemService = adManagerServices.get(session, LineItemServiceInterface.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 geographical targeting.
    GeoTargeting geoTargeting = new GeoTargeting();
    // Include the US, Quebec, Canada, and the B3P Canada postal code.
    // To determine what other geographic criteria exists,
    // run GetGeoTargets.java.
    Location countryLocation = new Location();
    countryLocation.setId(2840L);
    Location regionLocation = new Location();
    regionLocation.setId(20133L);
    Location postalCodeLocation = new Location();
    postalCodeLocation.setId(9000093L);
    geoTargeting.setTargetedLocations(new Location[] { countryLocation, regionLocation, postalCodeLocation });
    // Exclude Chicago and the New York metro area.
    // To determine what other geographic criteria exists, run
    // GetGeoTargets.java.
    Location cityLocation = new Location();
    cityLocation.setId(1016367L);
    Location metroLocation = new Location();
    metroLocation.setId(200501L);
    geoTargeting.setExcludedLocations(new Location[] { cityLocation, metroLocation });
    // Exclude domains that are not under the network's control.
    UserDomainTargeting userDomainTargeting = new UserDomainTargeting();
    userDomainTargeting.setDomains(new String[] { "usa.gov" });
    userDomainTargeting.setTargeted(false);
    // Create day-part targeting.
    DayPartTargeting dayPartTargeting = new DayPartTargeting();
    dayPartTargeting.setTimeZone(DeliveryTimeZone.BROWSER);
    // Target only the weekend in the browser's timezone.
    DayPart saturdayDayPart = new DayPart();
    saturdayDayPart.setDayOfWeek(DayOfWeek.SATURDAY);
    saturdayDayPart.setStartTime(new TimeOfDay(0, MinuteOfHour.ZERO));
    saturdayDayPart.setEndTime(new TimeOfDay(24, MinuteOfHour.ZERO));
    DayPart sundayDayPart = new DayPart();
    sundayDayPart.setDayOfWeek(DayOfWeek.SUNDAY);
    sundayDayPart.setStartTime(new TimeOfDay(0, MinuteOfHour.ZERO));
    sundayDayPart.setEndTime(new TimeOfDay(24, MinuteOfHour.ZERO));
    dayPartTargeting.setDayParts(new DayPart[] { saturdayDayPart, sundayDayPart });
    // Create technology targeting.
    TechnologyTargeting technologyTargeting = new TechnologyTargeting();
    // Create browser targeting.
    BrowserTargeting browserTargeting = new BrowserTargeting();
    browserTargeting.setIsTargeted(true);
    // Target just the Chrome browser.
    // To determine what other technology criteria exists, run
    // GetAllBrowsers.java.
    Technology browserTechnology = new Technology();
    browserTechnology.setId(500072L);
    browserTargeting.setBrowsers(new Technology[] { browserTechnology });
    technologyTargeting.setBrowserTargeting(browserTargeting);
    // Create targeting.
    Targeting targeting = new Targeting();
    targeting.setGeoTargeting(geoTargeting);
    targeting.setInventoryTargeting(inventoryTargeting);
    targeting.setUserDomainTargeting(userDomainTargeting);
    targeting.setDayPartTargeting(dayPartTargeting);
    targeting.setTechnologyTargeting(technologyTargeting);
    // Create a line item.
    LineItem lineItem = new LineItem();
    lineItem.setName("Line item #" + new Random().nextInt(Integer.MAX_VALUE));
    lineItem.setOrderId(orderId);
    lineItem.setTargeting(targeting);
    // Allow the line item to be booked even if there is not enough inventory.
    lineItem.setAllowOverbook(true);
    // Set the line item type to STANDARD and priority to Normal. In this case,
    // 6 would be High, and 10 would be Low.
    lineItem.setLineItemType(LineItemType.STANDARD);
    lineItem.setPriority(8);
    // Set the creative rotation type to even.
    lineItem.setCreativeRotationType(CreativeRotationType.EVEN);
    // 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 per unit to $2.
    lineItem.setCostType(CostType.CPM);
    lineItem.setCostPerUnit(new Money("USD", 2000000L));
    // Set the number of units bought to 500,000 so that the budget is
    // $1,000.
    Goal goal = new Goal();
    goal.setGoalType(GoalType.LIFETIME);
    goal.setUnits(500000L);
    goal.setUnitType(UnitType.IMPRESSIONS);
    lineItem.setPrimaryGoal(goal);
    // Create the line item on the server.
    LineItem[] lineItems = lineItemService.createLineItems(new LineItem[] { lineItem });
    for (LineItem createdLineItem : lineItems) {
        System.out.printf("A line item with ID %d and name '%s' was created.%n", createdLineItem.getId(), createdLineItem.getName());
    }
}

Example 2 with Size

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

the class CreateLineItemsWithCustomCriteria method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param orderId the ID of the order that the line items will belong to.
 * @param customTargetingKeyId1 the key ID for the equality comparison in the first expression
 *     group.
 * @param customTargetingKeyId2 the key ID for the equality comparison in the second expression
 *     group.
 * @param customTargetingKeyId3 the key ID for the equality comparison in the third expression
 *     group.
 * @param customTargetingValueId1 the value ID that must match the first key ID in the first
 *     expression group.
 * @param customTargetingValueIds2 the value ID that must match the second key ID in the first
 *     expression group.
 * @param customTargetingValueId3 he value ID that must match the key ID in the second expression
 *     group.
 * @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 orderId, long customTargetingKeyId1, long customTargetingKeyId2, long customTargetingKeyId3, long customTargetingValueId1, List<Long> customTargetingValueIds2, long customTargetingValueId3) throws RemoteException {
    // Get the LineItemService.
    LineItemServiceInterface lineItemService = adManagerServices.get(session, LineItemServiceInterface.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 targeting.
    Targeting targeting = new Targeting();
    targeting.setInventoryTargeting(inventoryTargeting);
    // Create the expression:
    // 
    // TARGETING_KEY_ID_1 == TARGETING_VALUE_ID_1
    CustomCriteria customCriteria1 = new CustomCriteria();
    customCriteria1.setKeyId(customTargetingKeyId1);
    customCriteria1.setOperator(CustomCriteriaComparisonOperator.IS);
    customCriteria1.setValueIds(new long[] { customTargetingValueId1 });
    // Create the expression:
    // 
    // TARGETING_KEY_ID_2 !=
    // (TARGETING_VALUE_IDS_2[0] OR TARGETING_VALUE_IDS_2[1] ...))
    CustomCriteria customCriteria2 = new CustomCriteria();
    customCriteria2.setKeyId(customTargetingKeyId2);
    customCriteria2.setOperator(CustomCriteriaComparisonOperator.IS_NOT);
    customCriteria2.setValueIds(Longs.toArray(customTargetingValueIds2));
    // Create the expression:
    // 
    // TARGETING_KEY_ID_3 = TARGETING_VALUE_ID_3
    CustomCriteria customCriteria3 = new CustomCriteria();
    customCriteria3.setKeyId(customTargetingKeyId3);
    customCriteria3.setOperator(CustomCriteriaComparisonOperator.IS);
    customCriteria3.setValueIds(new long[] { customTargetingValueId3 });
    // Create the custom criteria set that will resemble:
    // 
    // (TARGETING_KEY_ID_1 == TARGETING_VALUE_ID_1 AND
    // (TARGETING_KEY_ID_2 !=
    // (TARGETING_VALUE_IDS_2[0] OR TARGETING_VALUE_IDS_2[1] ...))
    // OR
    // (TARGETING_KEY_ID_3 = TARGETING_VALUE_ID_3)
    CustomCriteriaSet topCustomCriteriaSet = new CustomCriteriaSet();
    topCustomCriteriaSet.setLogicalOperator(CustomCriteriaSetLogicalOperator.OR);
    // Create the sub expression:
    // 
    // (TARGETING_KEY_ID_1 == TARGETING_VALUE_ID_1 AND
    // (TARGETING_KEY_ID_2 !=
    // (TARGETING_VALUE_IDS_2[0] OR TARGETING_VALUE_IDS_2[1] ...))
    CustomCriteriaSet subCustomCriteriaSet = new CustomCriteriaSet();
    subCustomCriteriaSet.setLogicalOperator(CustomCriteriaSetLogicalOperator.AND);
    subCustomCriteriaSet.setChildren(new CustomCriteriaNode[] { customCriteria1, customCriteria2 });
    // Combine the expression
    // (TARGETING_KEY_ID_3 = TARGETING_VALUE_ID_3) with
    // subCustomCriteriaSet.
    topCustomCriteriaSet.setChildren(new CustomCriteriaNode[] { subCustomCriteriaSet, customCriteria3 });
    // Set the custom targeting.
    targeting.setCustomTargeting(topCustomCriteriaSet);
    // Create a line item.
    LineItem lineItem = new LineItem();
    lineItem.setName("Line item #" + new Random().nextInt(Integer.MAX_VALUE));
    lineItem.setOrderId(orderId);
    lineItem.setTargeting(targeting);
    // Allow the line item to be booked even if there is not enough inventory.
    lineItem.setAllowOverbook(true);
    // Set the line item type to STANDARD and priority to High. In this case,
    // 8 would be Normal, and 10 would be Low.
    lineItem.setLineItemType(LineItemType.STANDARD);
    lineItem.setPriority(6);
    // Set the creative rotation type to even.
    lineItem.setCreativeRotationType(CreativeRotationType.EVEN);
    // 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 per unit to $2.
    lineItem.setCostType(CostType.CPM);
    lineItem.setCostPerUnit(new Money("USD", 2000000L));
    // Set the number of units bought to 500,000 so that the budget is
    // $1,000.
    Goal goal = new Goal();
    goal.setUnits(500000L);
    goal.setUnitType(UnitType.IMPRESSIONS);
    goal.setGoalType(GoalType.LIFETIME);
    lineItem.setPrimaryGoal(goal);
    // Create the line item on the server.
    LineItem[] lineItems = lineItemService.createLineItems(new LineItem[] { lineItem });
    for (LineItem createdLineItem : lineItems) {
        System.out.printf("A line item with ID %d and name '%s' was created.%n", createdLineItem.getId(), createdLineItem.getName());
    }
}

Example 3 with Size

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

the class CreatePlacements 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 PlacementService.
    PlacementServiceInterface placementService = adManagerServices.get(session, PlacementServiceInterface.class);
    // Get all ad units.
    List<AdUnit> adUnits = getAllAdUnits(adManagerServices, session);
    // Partition ad units by their size.
    Set<String> mediumSquareAdUnitIds = Sets.newHashSet();
    Set<String> skyscraperAdUnitIds = Sets.newHashSet();
    Set<String> bannerAdUnitIds = Sets.newHashSet();
    for (AdUnit adUnit : adUnits) {
        if (adUnit.getParentId() != null && adUnit.getAdUnitSizes() != null) {
            for (AdUnitSize adUnitSize : adUnit.getAdUnitSizes()) {
                Size size = adUnitSize.getSize();
                if (size.getWidth() == 300 && size.getHeight() == 250) {
                    mediumSquareAdUnitIds.add(adUnit.getId());
                } else if (size.getWidth() == 120 && size.getHeight() == 600) {
                    skyscraperAdUnitIds.add(adUnit.getId());
                } else if (size.getWidth() == 468 && size.getHeight() == 60) {
                    bannerAdUnitIds.add(adUnit.getId());
                }
            }
        }
    }
    List<Placement> placementsToCreate = new ArrayList<>();
    // Only create placements with one or more ad unit.
    if (!mediumSquareAdUnitIds.isEmpty()) {
        // Create medium square placement.
        Placement mediumSquareAdUnitPlacement = new Placement();
        mediumSquareAdUnitPlacement.setName("Medium Square AdUnit Placement #" + new Random().nextInt(Integer.MAX_VALUE));
        mediumSquareAdUnitPlacement.setDescription("Contains ad units that can hold creatives of size 300x250");
        mediumSquareAdUnitPlacement.setTargetedAdUnitIds(mediumSquareAdUnitIds.toArray(new String[] {}));
        placementsToCreate.add(mediumSquareAdUnitPlacement);
    }
    if (!skyscraperAdUnitIds.isEmpty()) {
        // Create skyscraper placement.
        Placement skyscraperAdUnitPlacement = new Placement();
        skyscraperAdUnitPlacement.setName("Skyscraper AdUnit Placement #" + new Random().nextInt(Integer.MAX_VALUE));
        skyscraperAdUnitPlacement.setDescription("Contains ad units that can hold creatives of size 120x600");
        skyscraperAdUnitPlacement.setTargetedAdUnitIds(skyscraperAdUnitIds.toArray(new String[] {}));
        placementsToCreate.add(skyscraperAdUnitPlacement);
    }
    if (!bannerAdUnitIds.isEmpty()) {
        // Create banner placement.
        Placement bannerAdUnitPlacement = new Placement();
        bannerAdUnitPlacement.setName("Banner AdUnit Placement #" + new Random().nextInt(Integer.MAX_VALUE));
        bannerAdUnitPlacement.setDescription("Contains ad units that can hold creatives of size 468x60");
        bannerAdUnitPlacement.setTargetedAdUnitIds(bannerAdUnitIds.toArray(new String[] {}));
        placementsToCreate.add(bannerAdUnitPlacement);
    }
    if (!placementsToCreate.isEmpty()) {
        // Create the placements on the server.
        Placement[] placements = placementService.createPlacements(placementsToCreate.toArray(new Placement[] {}));
        for (Placement createdPlacement : placements) {
            System.out.printf("A placement with ID %d, name '%s', and containing ad units [%s] was created.%n", createdPlacement.getId(), createdPlacement.getName(), Joiner.on(", ").join(createdPlacement.getTargetedAdUnitIds()));
        }
    } else {
        System.out.println("No placements were created.");
    }
}

Example 4 with Size

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

the class CopyImageCreatives method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param creativeId the ID of the image creative to copy.
 * @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 creativeId) throws RemoteException {
    // Get the CreativeService.
    CreativeServiceInterface creativeService = adManagerServices.get(session, CreativeServiceInterface.class);
    // Create a statement to get the image creative.
    StatementBuilder statementBuilder = new StatementBuilder().where("id = :id").orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("id", creativeId);
    // Get the creative.
    ImageCreative imageCreative = (ImageCreative) creativeService.getCreativesByStatement(statementBuilder.toStatement()).getResults()[0];
    // Fetch the image asset.
    CreativeAsset assetToCopy = imageCreative.getPrimaryImageAsset();
    Size aspectRatioSize = imageCreative.getSize();
    aspectRatioSize.setIsAspectRatio(true);
    AspectRatioImageCreative newImageCreative = new AspectRatioImageCreative();
    newImageCreative.setName("Copy of original image creative");
    newImageCreative.setSize(aspectRatioSize);
    newImageCreative.setAdvertiserId(imageCreative.getAdvertiserId());
    newImageCreative.setImageAssets(new CreativeAsset[] { assetToCopy });
    newImageCreative.setDestinationUrl(imageCreative.getDestinationUrl());
    // Create the creative on the server.
    Creative[] creatives = creativeService.createCreatives(new Creative[] { newImageCreative });
    for (Creative createdCreative : creatives) {
        System.out.printf("A creative with ID %d, name '%s', and type '%s'" + " was created and can be previewed at: %s%n", createdCreative.getId(), createdCreative.getName(), createdCreative.getClass().getSimpleName(), createdCreative.getPreviewUrl());
    }
}

Example 5 with Size

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

the class CreateCreativesFromTemplates method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param advertiserId the ID of the advertiser (company) that all creatives will be assigned to.
 * @throws ApiException if the API request failed with one or more service errors.
 * @throws RemoteException if the API request failed due to other errors.
 * @throws IOException if unable to get media data from the URL.
 */
public static void runExample(AdManagerServices adManagerServices, AdManagerSession session, long advertiserId) throws IOException {
    // Get the CreativeService.
    CreativeServiceInterface creativeService = adManagerServices.get(session, CreativeServiceInterface.class);
    // Create creative size.
    Size size = new Size();
    size.setWidth(600);
    size.setHeight(315);
    size.setIsAspectRatio(false);
    // Use the image banner with optional third party tracking template.
    // To determine what other creative templates exist,
    // run GetAllCreativeTemplates.java.
    long creativeTemplateId = 10000680L;
    // Create a template creative.
    TemplateCreative templateCreative = new TemplateCreative();
    templateCreative.setName("Template creative #" + new Random().nextInt(Integer.MAX_VALUE));
    templateCreative.setAdvertiserId(advertiserId);
    templateCreative.setCreativeTemplateId(creativeTemplateId);
    templateCreative.setSize(size);
    // Create the asset variable value.
    AssetCreativeTemplateVariableValue assetVariableValue = new AssetCreativeTemplateVariableValue();
    assetVariableValue.setUniqueName("Imagefile");
    CreativeAsset asset = new CreativeAsset();
    asset.setAssetByteArray(Media.getMediaDataFromUrl("https://goo.gl/3b9Wfh"));
    // Filenames must be unique.
    asset.setFileName(String.format("image%s.jpg", new Random().nextInt(Integer.MAX_VALUE)));
    assetVariableValue.setAsset(asset);
    // Create the image width variable value.
    LongCreativeTemplateVariableValue imageWidthVariableValue = new LongCreativeTemplateVariableValue();
    imageWidthVariableValue.setUniqueName("Imagewidth");
    imageWidthVariableValue.setValue(300L);
    // Create the image height variable value.
    LongCreativeTemplateVariableValue imageHeightVariableValue = new LongCreativeTemplateVariableValue();
    imageHeightVariableValue.setUniqueName("Imageheight");
    imageHeightVariableValue.setValue(250L);
    // Create the URL variable value.
    UrlCreativeTemplateVariableValue urlVariableValue = new UrlCreativeTemplateVariableValue();
    urlVariableValue.setUniqueName("ClickthroughURL");
    urlVariableValue.setValue("www.google.com");
    // Create the target window variable value.
    StringCreativeTemplateVariableValue targetWindowVariableValue = new StringCreativeTemplateVariableValue();
    targetWindowVariableValue.setUniqueName("Targetwindow");
    targetWindowVariableValue.setValue("__blank");
    // Set the creative template variables.
    templateCreative.setCreativeTemplateVariableValues(new BaseCreativeTemplateVariableValue[] { assetVariableValue, imageWidthVariableValue, imageHeightVariableValue, urlVariableValue, targetWindowVariableValue });
    // Create the creative on the server.
    Creative[] creatives = creativeService.createCreatives(new Creative[] { templateCreative });
    for (Creative createdCreative : creatives) {
        System.out.printf("A creative with ID %d, name '%s', and type '%s'" + " was created and can be previewed at: %s%n", createdCreative.getId(), createdCreative.getName(), createdCreative.getClass().getSimpleName(), createdCreative.getPreviewUrl());
    }
}