use of com.google.api.ads.admanager.axis.v202205.Order in project googleads-java-lib by googleads.
the class GetAllOrders 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 OrderService.
OrderServiceInterface orderService = adManagerServices.get(session, OrderServiceInterface.class);
// Create a statement to select all orders.
StatementBuilder statementBuilder = new StatementBuilder().orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT);
// Default for total result set size.
int totalResultSetSize = 0;
do {
// Get orders by statement.
OrderPage page = orderService.getOrdersByStatement(statementBuilder.toStatement());
if (page.getResults() != null) {
totalResultSetSize = page.getTotalResultSetSize();
int i = page.getStartIndex();
for (Order order : page.getResults()) {
System.out.printf("%d) Order with ID %d and name '%s' was found.%n", i++, order.getId(), order.getName());
}
}
statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
} while (statementBuilder.getOffset() < totalResultSetSize);
System.out.printf("Number of results found: %d%n", totalResultSetSize);
}
use of com.google.api.ads.admanager.axis.v202205.Order in project googleads-java-lib by googleads.
the class ApproveOrders method runExample.
/**
* Runs the example.
*
* @param adManagerServices the services factory.
* @param session the session.
* @param orderId the ID of the order to approve.
* @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 OrderService.
OrderServiceInterface orderService = adManagerServices.get(session, OrderServiceInterface.class);
// Create a statement to select an order.
StatementBuilder statementBuilder = new StatementBuilder().where("WHERE id = :id").orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("id", orderId);
// Default for total result set size.
int totalResultSetSize = 0;
do {
// Get orders by statement.
OrderPage page = orderService.getOrdersByStatement(statementBuilder.toStatement());
if (page.getResults() != null) {
totalResultSetSize = page.getTotalResultSetSize();
int i = page.getStartIndex();
for (Order order : page.getResults()) {
System.out.printf("%d) Order with ID %d will be approved.%n", i++, order.getId());
}
}
statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
} while (statementBuilder.getOffset() < totalResultSetSize);
System.out.printf("Number of orders to be approved: %d%n", totalResultSetSize);
if (totalResultSetSize > 0) {
// Remove limit and offset from statement.
statementBuilder.removeLimitAndOffset();
// Create action.
com.google.api.ads.admanager.axis.v202111.ApproveOrders action = new com.google.api.ads.admanager.axis.v202111.ApproveOrders();
// Perform action.
UpdateResult result = orderService.performOrderAction(action, statementBuilder.toStatement());
if (result != null && result.getNumChanges() > 0) {
System.out.printf("Number of orders approved: %d%n", result.getNumChanges());
} else {
System.out.println("No orders were approved.");
}
}
}
use of com.google.api.ads.admanager.axis.v202205.Order in project googleads-java-lib by googleads.
the class CreateOrders 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.
* @param traffickerId the ID of the trafficker (user) associated with this order.
* @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, long traffickerId) throws RemoteException {
// Get the OrderService.
OrderServiceInterface orderService = adManagerServices.get(session, OrderServiceInterface.class);
// Create an order.
Order order = new Order();
order.setName("Order #" + new Random().nextInt(Integer.MAX_VALUE));
order.setAdvertiserId(advertiserId);
order.setTraffickerId(traffickerId);
// Create the order on the server.
Order[] orders = orderService.createOrders(new Order[] { order });
for (Order createdOrder : orders) {
System.out.printf("An order with ID %d and name '%s' was created.%n", createdOrder.getId(), createdOrder.getName());
}
}
use of com.google.api.ads.admanager.axis.v202205.Order in project googleads-java-lib by googleads.
the class GetAllOrders 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 OrderService.
OrderServiceInterface orderService = adManagerServices.get(session, OrderServiceInterface.class);
// Create a statement to select all orders.
StatementBuilder statementBuilder = new StatementBuilder().orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT);
// Default for total result set size.
int totalResultSetSize = 0;
do {
// Get orders by statement.
OrderPage page = orderService.getOrdersByStatement(statementBuilder.toStatement());
if (page.getResults() != null) {
totalResultSetSize = page.getTotalResultSetSize();
int i = page.getStartIndex();
for (Order order : page.getResults()) {
System.out.printf("%d) Order with ID %d and name '%s' was found.%n", i++, order.getId(), order.getName());
}
}
statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
} while (statementBuilder.getOffset() < totalResultSetSize);
System.out.printf("Number of results found: %d%n", totalResultSetSize);
}
use of com.google.api.ads.admanager.axis.v202205.Order 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());
}
}
Aggregations