use of com.google.api.ads.admanager.axis.v202202.Network 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());
}
}
use of com.google.api.ads.admanager.axis.v202202.Network in project googleads-java-lib by googleads.
the class CreateNativeStyles 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 NativeStyleService.
NativeStyleServiceInterface nativeStyleService = adManagerServices.get(session, NativeStyleServiceInterface.class);
String htmlSnippet = "<div id=\"adunit\" style=\"overflow: hidden;\">\n" + " <img src='[%Thirdpartyimpressiontracker%]' style='display:none'>\n" + " <div class='attribution'>Ad</div>\n" + " <div class='image'>\n" + " <a class='image-link' " + "href='%%CLICK_URL_UNESC%%[%Thirdpartyclicktracker%]%%DEST_URL%%' target='_top'>" + "<img src=\"[%Image%]\"></a>\n" + " </div>\n" + " <div class='app-icon'><img src=\"[%Appicon%]\"/></div>\n" + " <div class='title'>\n" + " <a class='title-link' " + "href='%%CLICK_URL_UNESC%%[%Thirdpartyclicktracker%]%%DEST_URL%%' " + "target='_top'>[%Headline%]</a>\n" + " </div>\n" + " <div class='reviews'></div>\n" + " <div class='body'>\n" + " <a class='body-link' " + "href='%%CLICK_URL_UNESC%%[%Thirdpartyclicktracker%]%%DEST_URL%%' " + "target='_top'>[%Body%]</a>\n" + " </div>\n" + " <div class='price'>[%Price%]</div>\n" + " <div class='button'>\n" + " <a class='button-link' " + "href='%%CLICK_URL_UNESC%%[%Thirdpartyclicktracker%]%%DEST_URL%%' " + "target='_top'>[%Calltoaction%]</a>\n" + " </div>\n" + "</div>\n";
String cssSnippet = "body {" + " background-color: rgba(255, 255, 255, 1);" + " font-family: \"Roboto-Regular\", sans-serif;" + " font-weight: normal;" + " font-size: 12px;" + " line-height: 14px;" + "}" + ".attribution {" + " background-color: rgba(236, 182, 0, 1);" + " color: rgba(255, 255, 255, 1);" + " font-size: 13px;" + " display: table;" + " margin: 4px 8px;" + " padding: 0 3px;" + " border-radius: 2px;" + "}" + ".image {" + " text-align: center;" + " margin: 8px;" + "}" + ".image img," + ".image-link {" + " width: 100%;" + "}" + ".app-icon {" + " float: left;" + " margin: 0 8px 4px 8px;" + " height: 40px;" + " width: 40px;" + " background-color: transparent;" + "}" + ".app-icon img {" + " height: 100%;" + " width: 100%;" + " border-radius: 20%;" + "}" + ".title {" + " font-weight: bold;" + " font-size: 14px;" + " line-height: 20px;" + " margin: 8px 8px 4px 8px;" + "}" + ".title a {" + " color: rgba(112, 112, 112, 1);" + " text-decoration: none;" + "}" + ".reviews {" + " float: left;" + "}" + ".reviews svg {" + " fill: rgba(0, 0, 0, 0.7);" + "}" + ".body {" + " clear: left;" + " margin: 8px;" + "}" + ".body a {" + " color: rgba(110, 110, 110, 1);" + " text-decoration: none;" + "}" + ".price {" + " display: none;" + "}" + ".button {" + " font-size: 14px;" + " font-weight: bold;" + " float: right;" + " margin: 0px 16px 16px 0px;" + " white-space: nowrap;" + "}" + ".button a {" + " color: #2196F3;" + " text-decoration: none;" + "}" + ".button svg {" + " display: none;" + "}";
// This is the creative template ID for the system-defined native app
// install ad format, which we will create the native style from. Use
// CreativeTemplateService.getCreativeTemplatesByStatement() and
// CreativeTemplate.isNativeEligible to get other native ad formats
// available in your network.
long nativeAppInstallTemplateId = 10004400L;
// Set the size for the native style.
Size size = new Size();
size.setWidth(300);
size.setHeight(250);
size.setIsAspectRatio(false);
// Create a style for native app install ads.
NativeStyle nativeStyle = new NativeStyle();
nativeStyle.setName("Native style #" + new Random().nextInt(Integer.MAX_VALUE));
nativeStyle.setCreativeTemplateId(nativeAppInstallTemplateId);
nativeStyle.setSize(size);
nativeStyle.setHtmlSnippet(htmlSnippet);
nativeStyle.setCssSnippet(cssSnippet);
// Create the native style on the server.
NativeStyle[] nativeStyles = nativeStyleService.createNativeStyles(new NativeStyle[] { nativeStyle });
for (NativeStyle createdNativeStyle : nativeStyles) {
System.out.printf("A native style with ID %d and name '%s' was created.%n", createdNativeStyle.getId(), createdNativeStyle.getName());
}
}
use of com.google.api.ads.admanager.axis.v202202.Network 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);
}
use of com.google.api.ads.admanager.axis.v202202.Network in project googleads-java-lib by googleads.
the class GetDefaultThirdPartyDataDeclaration 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 Exception {
// Get the NetworkService.
NetworkServiceInterface networkService = adManagerServices.get(session, NetworkServiceInterface.class);
// Get the PublisherQueryLanguageService.
PublisherQueryLanguageServiceInterface pqlService = adManagerServices.get(session, PublisherQueryLanguageServiceInterface.class);
// Get the current network's default third party data declaration.
ThirdPartyDataDeclaration declaration = networkService.getDefaultThirdPartyDataDeclaration();
if (declaration == null) {
System.out.println("No default ad technology partners have been set on this network.");
} else if (DeclarationType.NONE.equals(declaration.getDeclarationType()) || declaration.getThirdPartyCompanyIds().length == 0) {
System.out.println("This network has specified that there are no ad technology providers " + " associated with its reservation creatives by default.");
} else {
System.out.printf("This network has specified %d ad technology provider(s) associated with its reservation" + " creatives by default:%n", declaration.getThirdPartyCompanyIds().length);
ResultSet companies = pqlService.select(new StatementBuilder().select("name, id").from("rich_media_ad_company").where("id in (:ids)").withBindVariableValue("ids", ImmutableSet.copyOf(Longs.asList(declaration.getThirdPartyCompanyIds()))).toStatement());
System.out.println(Pql.resultSetToString(companies));
}
}
use of com.google.api.ads.admanager.axis.v202202.Network 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());
}
Aggregations