Search in sources :

Example 1 with NetworkServiceInterface

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

the class CreateSites method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param childNetworkCode the child network code of the site.
 * @param url the URL of the site.
 * @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 childNetworkCode, String url) throws RemoteException {
    // Get the SiteService.
    SiteServiceInterface siteService = adManagerServices.get(session, SiteServiceInterface.class);
    // Get the NetworkService.
    NetworkServiceInterface networkService = adManagerServices.get(session, NetworkServiceInterface.class);
    // Validate that the site can be created.
    Network currentNetwork = networkService.getCurrentNetwork();
    ChildPublisher childNetwork = null;
    for (ChildPublisher child : currentNetwork.getChildPublishers()) {
        if (childNetworkCode.equals(child.getChildNetworkCode())) {
            childNetwork = child;
            break;
        }
    }
    if (childNetwork == null) {
        throw new IllegalStateException(String.format("Child network %s not found on the current network (%s). Cannot create site.", childNetworkCode, currentNetwork.getNetworkCode()));
    }
    if (!DelegationType.MANAGE_INVENTORY.equals(childNetwork.getApprovedDelegationType())) {
        throw new IllegalStateException(String.format("Child network %s has not approved the current network (%s) to manage its inventory." + " Cannot create site.", childNetworkCode, currentNetwork.getNetworkCode()));
    }
    // Create a site.
    Site site = new Site();
    site.setChildNetworkCode(childNetworkCode);
    site.setUrl(url);
    // Create the site on the server.
    Site[] sites = siteService.createSites(new Site[] { site });
    for (Site createdSite : sites) {
        System.out.printf("A site with ID %d and URL '%s' was created.%n", createdSite.getId(), createdSite.getUrl());
    }
}
Also used : Site(com.google.api.ads.admanager.axis.v202111.Site) NetworkServiceInterface(com.google.api.ads.admanager.axis.v202111.NetworkServiceInterface) SiteServiceInterface(com.google.api.ads.admanager.axis.v202111.SiteServiceInterface) ChildPublisher(com.google.api.ads.admanager.axis.v202111.ChildPublisher) Network(com.google.api.ads.admanager.axis.v202111.Network)

Example 2 with NetworkServiceInterface

use of com.google.api.ads.admanager.axis.v202108.NetworkServiceInterface 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());
    }
}
Also used : NetworkServiceInterface(com.google.api.ads.admanager.axis.v202108.NetworkServiceInterface) Targeting(com.google.api.ads.admanager.axis.v202108.Targeting) AdUnitTargeting(com.google.api.ads.admanager.axis.v202108.AdUnitTargeting) InventoryTargeting(com.google.api.ads.admanager.axis.v202108.InventoryTargeting) LineItemServiceInterface(com.google.api.ads.admanager.axis.v202108.LineItemServiceInterface) Size(com.google.api.ads.admanager.axis.v202108.Size) LineItem(com.google.api.ads.admanager.axis.v202108.LineItem) InventoryTargeting(com.google.api.ads.admanager.axis.v202108.InventoryTargeting) CustomCriteriaSet(com.google.api.ads.admanager.axis.v202108.CustomCriteriaSet) CreativePlaceholder(com.google.api.ads.admanager.axis.v202108.CreativePlaceholder) Money(com.google.api.ads.admanager.axis.v202108.Money) Goal(com.google.api.ads.admanager.axis.v202108.Goal) AdUnitTargeting(com.google.api.ads.admanager.axis.v202108.AdUnitTargeting) Random(java.util.Random) CustomCriteria(com.google.api.ads.admanager.axis.v202108.CustomCriteria)

Example 3 with NetworkServiceInterface

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

the class GetCurrentNetwork 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 NetworkService.
    NetworkServiceInterface networkService = adManagerServices.get(session, NetworkServiceInterface.class);
    // Get the current network.
    Network network = networkService.getCurrentNetwork();
    System.out.printf("Current network has network code '%s' and display name '%s'.%n", network.getNetworkCode(), network.getDisplayName());
}
Also used : NetworkServiceInterface(com.google.api.ads.admanager.axis.v202108.NetworkServiceInterface) Network(com.google.api.ads.admanager.axis.v202108.Network)

Example 4 with NetworkServiceInterface

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

the class GetTopLevelAdUnits 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 InventoryService.
    InventoryServiceInterface inventoryService = adManagerServices.get(session, InventoryServiceInterface.class);
    // Get the NetworkService.
    NetworkServiceInterface networkService = adManagerServices.get(session, NetworkServiceInterface.class);
    // Set the parent ad unit's ID for all children ad units to be fetched from.
    String parentAdUnitId = networkService.getCurrentNetwork().getEffectiveRootAdUnitId();
    // Create a statement to select ad units under the parent ad unit.
    StatementBuilder statementBuilder = new StatementBuilder().where("parentId = :parentId").orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("parentId", parentAdUnitId);
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get ad units by statement.
        AdUnitPage page = inventoryService.getAdUnitsByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (AdUnit adUnit : page.getResults()) {
                System.out.printf("%d) Ad unit with ID '%s' and name '%s' was found.%n", i++, adUnit.getId(), adUnit.getName());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    System.out.printf("Number of results found: %d%n", totalResultSetSize);
}
Also used : NetworkServiceInterface(com.google.api.ads.admanager.axis.v202108.NetworkServiceInterface) AdUnitPage(com.google.api.ads.admanager.axis.v202108.AdUnitPage) AdUnit(com.google.api.ads.admanager.axis.v202108.AdUnit) InventoryServiceInterface(com.google.api.ads.admanager.axis.v202108.InventoryServiceInterface) StatementBuilder(com.google.api.ads.admanager.axis.utils.v202108.StatementBuilder)

Example 5 with NetworkServiceInterface

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

the class GetAllNetworks 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 NetworkService.
    NetworkServiceInterface networkService = adManagerServices.get(session, NetworkServiceInterface.class);
    // Get all networks that you have access to with the current authentication
    // credentials.
    Network[] networks = networkService.getAllNetworks();
    int i = 0;
    for (Network network : networks) {
        System.out.printf("%d) Network with network code '%s' and display name '%s' was found.%n", i++, network.getNetworkCode(), network.getDisplayName());
    }
    System.out.printf("Number of networks found: %d%n", networks.length);
}
Also used : NetworkServiceInterface(com.google.api.ads.admanager.axis.v202108.NetworkServiceInterface) Network(com.google.api.ads.admanager.axis.v202108.Network)

Aggregations

Random (java.util.Random)18 NetworkServiceInterface (com.google.api.ads.admanager.axis.v202202.NetworkServiceInterface)17 NetworkServiceInterface (com.google.api.ads.admanager.axis.v202108.NetworkServiceInterface)15 NetworkServiceInterface (com.google.api.ads.admanager.axis.v202111.NetworkServiceInterface)15 AdUnitTargeting (com.google.api.ads.admanager.axis.v202108.AdUnitTargeting)7 InventoryTargeting (com.google.api.ads.admanager.axis.v202108.InventoryTargeting)7 AdUnitTargeting (com.google.api.ads.admanager.axis.v202111.AdUnitTargeting)7 InventoryTargeting (com.google.api.ads.admanager.axis.v202111.InventoryTargeting)7 AdUnitTargeting (com.google.api.ads.admanager.axis.v202202.AdUnitTargeting)7 InventoryTargeting (com.google.api.ads.admanager.axis.v202202.InventoryTargeting)7 Targeting (com.google.api.ads.admanager.axis.v202108.Targeting)6 Targeting (com.google.api.ads.admanager.axis.v202111.Targeting)6 Network (com.google.api.ads.admanager.axis.v202202.Network)6 Targeting (com.google.api.ads.admanager.axis.v202202.Targeting)6 Size (com.google.api.ads.admanager.axis.v202108.Size)5 Size (com.google.api.ads.admanager.axis.v202202.Size)5 CreativePlaceholder (com.google.api.ads.admanager.axis.v202108.CreativePlaceholder)4 Goal (com.google.api.ads.admanager.axis.v202108.Goal)4 Network (com.google.api.ads.admanager.axis.v202111.Network)4 Size (com.google.api.ads.admanager.axis.v202111.Size)4