use of com.google.api.ads.admanager.axis.v202111.AdUnit 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.");
}
}
use of com.google.api.ads.admanager.axis.v202111.AdUnit in project googleads-java-lib by googleads.
the class CreateAdUnits 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 ad units to be created under.
String parentAdUnitId = networkService.getCurrentNetwork().getEffectiveRootAdUnitId();
// Create a 300x250 web ad unit size.
Size webSize = new Size();
webSize.setWidth(300);
webSize.setHeight(250);
webSize.setIsAspectRatio(false);
AdUnitSize webAdUnitSize = new AdUnitSize();
webAdUnitSize.setSize(webSize);
webAdUnitSize.setEnvironmentType(EnvironmentType.BROWSER);
// Create a 640x360v video ad unit size with a companion.
Size videoSize = new Size();
videoSize.setWidth(640);
videoSize.setHeight(360);
videoSize.setIsAspectRatio(false);
AdUnitSize videoAdUnitSize = new AdUnitSize();
videoAdUnitSize.setSize(videoSize);
videoAdUnitSize.setCompanions(new AdUnitSize[] { webAdUnitSize });
videoAdUnitSize.setEnvironmentType(EnvironmentType.VIDEO_PLAYER);
// Create a web ad unit.
AdUnit webAdUnit = new AdUnit();
webAdUnit.setName("web_ad_unit_" + new Random().nextInt(Integer.MAX_VALUE));
webAdUnit.setDescription(webAdUnit.getName());
webAdUnit.setParentId(parentAdUnitId);
webAdUnit.setTargetWindow(AdUnitTargetWindow.BLANK);
webAdUnit.setAdUnitSizes(new AdUnitSize[] { webAdUnitSize });
// Create a video ad unit.
AdUnit videoAdUnit = new AdUnit();
videoAdUnit.setName("video_ad_unit_" + new Random().nextInt(Integer.MAX_VALUE));
videoAdUnit.setDescription(videoAdUnit.getName());
videoAdUnit.setParentId(parentAdUnitId);
videoAdUnit.setTargetWindow(AdUnitTargetWindow.BLANK);
videoAdUnit.setAdUnitSizes(new AdUnitSize[] { videoAdUnitSize });
// Create the ad units on the server.
AdUnit[] adUnits = inventoryService.createAdUnits(new AdUnit[] { webAdUnit, videoAdUnit });
for (AdUnit adUnit : adUnits) {
System.out.printf("An ad unit with ID '%s', name '%s' was created.%n", adUnit.getId(), adUnit.getName());
}
}
use of com.google.api.ads.admanager.axis.v202111.AdUnit in project googleads-java-lib by googleads.
the class ArchiveAdUnits method runExample.
/**
* Runs the example.
*
* @param adManagerServices the services factory.
* @param session the session.
* @param parentAdUnitId the ad unit ID to archive underneath.
* @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 parentAdUnitId) throws RemoteException {
// Get the InventoryService.
InventoryServiceInterface inventoryService = adManagerServices.get(session, InventoryServiceInterface.class);
// Create a statement to select ad units under the parent ad unit and the
// parent ad unit.
StatementBuilder statementBuilder = new StatementBuilder().where("parentId = :parentId or id = :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' will be archived.%n", i++, adUnit.getId(), adUnit.getName());
}
}
statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
} while (statementBuilder.getOffset() < totalResultSetSize);
System.out.printf("Number of ad units to be archived: %d%n", totalResultSetSize);
if (totalResultSetSize > 0) {
// Remove limit and offset from statement.
statementBuilder.removeLimitAndOffset();
// Create action.
com.google.api.ads.admanager.axis.v202111.ArchiveAdUnits action = new com.google.api.ads.admanager.axis.v202111.ArchiveAdUnits();
// Perform action.
UpdateResult result = inventoryService.performAdUnitAction(action, statementBuilder.toStatement());
if (result != null && result.getNumChanges() > 0) {
System.out.printf("Number of ad units archived: %d%n", result.getNumChanges());
} else {
System.out.println("No ad units were archived.");
}
}
}
use of com.google.api.ads.admanager.axis.v202111.AdUnit in project googleads-java-lib by googleads.
the class GetAdUnitHierarchy method getAllAdUnits.
/**
* Get all ad units.
*/
private static List<AdUnit> getAllAdUnits(AdManagerServices adManagerServices, AdManagerSession session) throws RemoteException {
List<AdUnit> adUnits = new ArrayList<>();
// Get the InventoryService.
InventoryServiceInterface inventoryService = adManagerServices.get(session, InventoryServiceInterface.class);
// Create a statement to select all ad units.
StatementBuilder statementBuilder = new StatementBuilder().orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT);
// 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();
Collections.addAll(adUnits, page.getResults());
}
statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
} while (statementBuilder.getOffset() < totalResultSetSize);
return adUnits;
}
use of com.google.api.ads.admanager.axis.v202111.AdUnit 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());
}
}
Aggregations