Search in sources :

Example 21 with Size

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

the class UpdateAdUnits method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param adUnitId the ID of the ad unit 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, String adUnitId) throws RemoteException {
    // Get the InventoryService.
    InventoryServiceInterface inventoryService = adManagerServices.get(session, InventoryServiceInterface.class);
    // Create a statement to only select a single ad unit by ID.
    StatementBuilder statementBuilder = new StatementBuilder().where("id = :id").orderBy("id ASC").limit(1).withBindVariableValue("id", adUnitId);
    // Get the ad unit.
    AdUnitPage page = inventoryService.getAdUnitsByStatement(statementBuilder.toStatement());
    AdUnit adUnit = Iterables.getOnlyElement(Arrays.asList(page.getResults()));
    List<AdUnitSize> adUnitSizes = new ArrayList<>(Arrays.asList(adUnit.getAdUnitSizes()));
    // Create a 480x60 web ad unit size.
    Size size = new Size();
    size.setWidth(468);
    size.setHeight(60);
    AdUnitSize adUnitSize = new AdUnitSize();
    adUnitSize.setSize(size);
    adUnitSize.setEnvironmentType(EnvironmentType.BROWSER);
    adUnitSizes.add(adUnitSize);
    // Update the ad unit sizes.
    adUnit.setAdUnitSizes(adUnitSizes.toArray(new AdUnitSize[] {}));
    // Update the ad unit on the server.
    AdUnit[] adUnits = inventoryService.updateAdUnits(new AdUnit[] { adUnit });
    for (AdUnit updatedAdUnit : adUnits) {
        List<String> adUnitSizeStrings = new ArrayList<>();
        for (AdUnitSize updatedAdUnitSize : updatedAdUnit.getAdUnitSizes()) {
            adUnitSizeStrings.add(String.format("%dx%d", updatedAdUnitSize.getSize().getWidth(), updatedAdUnitSize.getSize().getHeight()));
        }
        System.out.printf("Ad unit with ID '%s', name '%s', and sizes [%s] was updated.%n", updatedAdUnit.getId(), updatedAdUnit.getName(), Joiner.on(", ").join(adUnitSizeStrings));
    }
}
Also used : AdUnitPage(com.google.api.ads.admanager.axis.v202111.AdUnitPage) AdUnitSize(com.google.api.ads.admanager.axis.v202111.AdUnitSize) AdUnit(com.google.api.ads.admanager.axis.v202111.AdUnit) InventoryServiceInterface(com.google.api.ads.admanager.axis.v202111.InventoryServiceInterface) Size(com.google.api.ads.admanager.axis.v202111.Size) AdUnitSize(com.google.api.ads.admanager.axis.v202111.AdUnitSize) StatementBuilder(com.google.api.ads.admanager.axis.utils.v202111.StatementBuilder) ArrayList(java.util.ArrayList)

Example 22 with Size

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

the class GetAllLabels 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 LabelService.
    LabelServiceInterface labelService = adManagerServices.get(session, LabelServiceInterface.class);
    // Create a statement to select all labels.
    StatementBuilder statementBuilder = new StatementBuilder().orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get labels by statement.
        LabelPage page = labelService.getLabelsByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (Label label : page.getResults()) {
                System.out.printf("%d) Label with ID %d and name '%s' was found.%n", i++, label.getId(), label.getName());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    System.out.printf("Number of results found: %d%n", totalResultSetSize);
}
Also used : LabelPage(com.google.api.ads.admanager.axis.v202205.LabelPage) StatementBuilder(com.google.api.ads.admanager.axis.utils.v202205.StatementBuilder) LabelServiceInterface(com.google.api.ads.admanager.axis.v202205.LabelServiceInterface) Label(com.google.api.ads.admanager.axis.v202205.Label)

Example 23 with Size

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

the class DeactivateLicas method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param lineItemId the ID of the line item to deactivate LICAs 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 lineItemId) throws RemoteException {
    // Get the LineItemCreativeAssociationService.
    LineItemCreativeAssociationServiceInterface licaService = adManagerServices.get(session, LineItemCreativeAssociationServiceInterface.class);
    // Create a statement to select all LICAs for a line item.
    StatementBuilder statementBuilder = new StatementBuilder().where("WHERE lineItemId = :lineItemId").orderBy("lineItemId ASC, creativeId ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("lineItemId", lineItemId);
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get LICAs by statement.
        LineItemCreativeAssociationPage page = licaService.getLineItemCreativeAssociationsByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (LineItemCreativeAssociation lica : page.getResults()) {
                if (lica.getCreativeSetId() != null) {
                    System.out.printf("%d) LICA with line item ID %d and creative " + "set ID %d will be deactivated.%n", i++, lica.getLineItemId(), lica.getCreativeSetId());
                } else {
                    System.out.printf("%d) LICA with line item ID %d and creative ID %d will be deactivated.%n", i++, lica.getLineItemId(), lica.getCreativeId());
                }
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    System.out.printf("Number of LICAs to be deactivated: %d%n", totalResultSetSize);
    if (totalResultSetSize > 0) {
        // Remove limit and offset from statement.
        statementBuilder.removeLimitAndOffset();
        // Create action.
        DeactivateLineItemCreativeAssociations action = new DeactivateLineItemCreativeAssociations();
        // Perform action.
        UpdateResult result = licaService.performLineItemCreativeAssociationAction(action, statementBuilder.toStatement());
        if (result != null && result.getNumChanges() > 0) {
            System.out.printf("Number of LICAs deactivated: %d%n", result.getNumChanges());
        } else {
            System.out.println("No LICAs were deactivated.");
        }
    }
}
Also used : LineItemCreativeAssociation(com.google.api.ads.admanager.axis.v202205.LineItemCreativeAssociation) StatementBuilder(com.google.api.ads.admanager.axis.utils.v202205.StatementBuilder) LineItemCreativeAssociationPage(com.google.api.ads.admanager.axis.v202205.LineItemCreativeAssociationPage) DeactivateLineItemCreativeAssociations(com.google.api.ads.admanager.axis.v202205.DeactivateLineItemCreativeAssociations) LineItemCreativeAssociationServiceInterface(com.google.api.ads.admanager.axis.v202205.LineItemCreativeAssociationServiceInterface) UpdateResult(com.google.api.ads.admanager.axis.v202205.UpdateResult)

Example 24 with Size

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

the class GetAllLicas 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 LineItemCreativeAssociationService.
    LineItemCreativeAssociationServiceInterface licaService = adManagerServices.get(session, LineItemCreativeAssociationServiceInterface.class);
    // Create a statement to get all LICAs.
    StatementBuilder statementBuilder = new StatementBuilder().orderBy("lineItemId ASC, creativeId ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get LICAs by statement.
        LineItemCreativeAssociationPage page = licaService.getLineItemCreativeAssociationsByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (LineItemCreativeAssociation lica : page.getResults()) {
                if (lica.getCreativeSetId() != null) {
                    System.out.printf("%d) LICA with line item ID %d and creative set ID %d was found.%n", i++, lica.getLineItemId(), lica.getCreativeSetId());
                } else {
                    System.out.printf("%d) LICA with line item ID %d and creative ID %d was found.%n", i++, lica.getLineItemId(), lica.getCreativeId());
                }
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    System.out.printf("Number of results found: %d%n", totalResultSetSize);
}
Also used : LineItemCreativeAssociation(com.google.api.ads.admanager.axis.v202205.LineItemCreativeAssociation) StatementBuilder(com.google.api.ads.admanager.axis.utils.v202205.StatementBuilder) LineItemCreativeAssociationPage(com.google.api.ads.admanager.axis.v202205.LineItemCreativeAssociationPage) LineItemCreativeAssociationServiceInterface(com.google.api.ads.admanager.axis.v202205.LineItemCreativeAssociationServiceInterface)

Example 25 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());
    }
}
Also used : NetworkServiceInterface(com.google.api.ads.admanager.axis.v202205.NetworkServiceInterface) TimeOfDay(com.google.api.ads.admanager.axis.v202205.TimeOfDay) UserDomainTargeting(com.google.api.ads.admanager.axis.v202205.UserDomainTargeting) AdUnitTargeting(com.google.api.ads.admanager.axis.v202205.AdUnitTargeting) Targeting(com.google.api.ads.admanager.axis.v202205.Targeting) GeoTargeting(com.google.api.ads.admanager.axis.v202205.GeoTargeting) InventoryTargeting(com.google.api.ads.admanager.axis.v202205.InventoryTargeting) TechnologyTargeting(com.google.api.ads.admanager.axis.v202205.TechnologyTargeting) BrowserTargeting(com.google.api.ads.admanager.axis.v202205.BrowserTargeting) DayPartTargeting(com.google.api.ads.admanager.axis.v202205.DayPartTargeting) LineItemServiceInterface(com.google.api.ads.admanager.axis.v202205.LineItemServiceInterface) Size(com.google.api.ads.admanager.axis.v202205.Size) LineItem(com.google.api.ads.admanager.axis.v202205.LineItem) InventoryTargeting(com.google.api.ads.admanager.axis.v202205.InventoryTargeting) GeoTargeting(com.google.api.ads.admanager.axis.v202205.GeoTargeting) CreativePlaceholder(com.google.api.ads.admanager.axis.v202205.CreativePlaceholder) DayPartTargeting(com.google.api.ads.admanager.axis.v202205.DayPartTargeting) Money(com.google.api.ads.admanager.axis.v202205.Money) Goal(com.google.api.ads.admanager.axis.v202205.Goal) AdUnitTargeting(com.google.api.ads.admanager.axis.v202205.AdUnitTargeting) UserDomainTargeting(com.google.api.ads.admanager.axis.v202205.UserDomainTargeting) DayPart(com.google.api.ads.admanager.axis.v202205.DayPart) Random(java.util.Random) Technology(com.google.api.ads.admanager.axis.v202205.Technology) TechnologyTargeting(com.google.api.ads.admanager.axis.v202205.TechnologyTargeting) BrowserTargeting(com.google.api.ads.admanager.axis.v202205.BrowserTargeting) Location(com.google.api.ads.admanager.axis.v202205.Location)

Aggregations

StatementBuilder (com.google.api.ads.admanager.axis.utils.v202205.StatementBuilder)62 Random (java.util.Random)46 UpdateResult (com.google.api.ads.admanager.axis.v202205.UpdateResult)16 ArrayList (java.util.ArrayList)16 Size (com.google.api.ads.admanager.axis.v202202.Size)15 Size (com.google.api.ads.admanager.axis.v202205.Size)15 Size (com.google.api.ads.admanager.axis.v202108.Size)14 Size (com.google.api.ads.admanager.axis.v202111.Size)14 CustomTargetingServiceInterface (com.google.api.ads.admanager.axis.v202205.CustomTargetingServiceInterface)7 Creative (com.google.api.ads.admanager.axis.v202202.Creative)6 CreativeServiceInterface (com.google.api.ads.admanager.axis.v202202.CreativeServiceInterface)6 AdUnit (com.google.api.ads.admanager.axis.v202205.AdUnit)6 Creative (com.google.api.ads.admanager.axis.v202205.Creative)6 CreativeServiceInterface (com.google.api.ads.admanager.axis.v202205.CreativeServiceInterface)6 InventoryServiceInterface (com.google.api.ads.admanager.axis.v202205.InventoryServiceInterface)6 LineItem (com.google.api.ads.admanager.axis.v202205.LineItem)6 NetworkServiceInterface (com.google.api.ads.admanager.axis.v202205.NetworkServiceInterface)6 AdUnitTargeting (com.google.api.ads.admanager.axis.v202108.AdUnitTargeting)5 CreativePlaceholder (com.google.api.ads.admanager.axis.v202108.CreativePlaceholder)5 Goal (com.google.api.ads.admanager.axis.v202108.Goal)5