use of com.google.api.ads.admanager.axis.v202202.Size in project googleads-java-lib by googleads.
the class CreateCreativesFromTemplates 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.
* @throws ApiException if the API request failed with one or more service errors.
* @throws RemoteException if the API request failed due to other errors.
* @throws IOException if unable to get media data from the URL.
*/
public static void runExample(AdManagerServices adManagerServices, AdManagerSession session, long advertiserId) throws IOException {
// Get the CreativeService.
CreativeServiceInterface creativeService = adManagerServices.get(session, CreativeServiceInterface.class);
// Create creative size.
Size size = new Size();
size.setWidth(600);
size.setHeight(315);
size.setIsAspectRatio(false);
// Use the image banner with optional third party tracking template.
// To determine what other creative templates exist,
// run GetAllCreativeTemplates.java.
long creativeTemplateId = 10000680L;
// Create a template creative.
TemplateCreative templateCreative = new TemplateCreative();
templateCreative.setName("Template creative #" + new Random().nextInt(Integer.MAX_VALUE));
templateCreative.setAdvertiserId(advertiserId);
templateCreative.setCreativeTemplateId(creativeTemplateId);
templateCreative.setSize(size);
// Create the asset variable value.
AssetCreativeTemplateVariableValue assetVariableValue = new AssetCreativeTemplateVariableValue();
assetVariableValue.setUniqueName("Imagefile");
CreativeAsset asset = new CreativeAsset();
asset.setAssetByteArray(Media.getMediaDataFromUrl("https://goo.gl/3b9Wfh"));
// Filenames must be unique.
asset.setFileName(String.format("image%s.jpg", new Random().nextInt(Integer.MAX_VALUE)));
assetVariableValue.setAsset(asset);
// Create the image width variable value.
LongCreativeTemplateVariableValue imageWidthVariableValue = new LongCreativeTemplateVariableValue();
imageWidthVariableValue.setUniqueName("Imagewidth");
imageWidthVariableValue.setValue(300L);
// Create the image height variable value.
LongCreativeTemplateVariableValue imageHeightVariableValue = new LongCreativeTemplateVariableValue();
imageHeightVariableValue.setUniqueName("Imageheight");
imageHeightVariableValue.setValue(250L);
// Create the URL variable value.
UrlCreativeTemplateVariableValue urlVariableValue = new UrlCreativeTemplateVariableValue();
urlVariableValue.setUniqueName("ClickthroughURL");
urlVariableValue.setValue("www.google.com");
// Create the target window variable value.
StringCreativeTemplateVariableValue targetWindowVariableValue = new StringCreativeTemplateVariableValue();
targetWindowVariableValue.setUniqueName("Targetwindow");
targetWindowVariableValue.setValue("__blank");
// Set the creative template variables.
templateCreative.setCreativeTemplateVariableValues(new BaseCreativeTemplateVariableValue[] { assetVariableValue, imageWidthVariableValue, imageHeightVariableValue, urlVariableValue, targetWindowVariableValue });
// Create the creative on the server.
Creative[] creatives = creativeService.createCreatives(new Creative[] { templateCreative });
for (Creative createdCreative : creatives) {
System.out.printf("A creative with ID %d, name '%s', and type '%s'" + " was created and can be previewed at: %s%n", createdCreative.getId(), createdCreative.getName(), createdCreative.getClass().getSimpleName(), createdCreative.getPreviewUrl());
}
}
use of com.google.api.ads.admanager.axis.v202202.Size in project googleads-java-lib by googleads.
the class CreateNativeCreatives 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.
* @throws ApiException if the API request failed with one or more service errors.
* @throws RemoteException if the API request failed due to other errors.
* @throws IOException if unable to get media data from the URL.
*/
public static void runExample(AdManagerServices adManagerServices, AdManagerSession session, long advertiserId) throws IOException {
// Get the CreativeService.
CreativeServiceInterface creativeService = adManagerServices.get(session, CreativeServiceInterface.class);
// Use the system defined native app install creative template.
long nativeAppInstallTemplateId = 10004400L;
// Use 1x1 as the size for native creatives.
Size size = new Size();
size.setWidth(1);
size.setHeight(1);
size.setIsAspectRatio(false);
// Create a native app install creative for the Pie Noon app.
TemplateCreative nativeAppInstallCreative = new TemplateCreative();
nativeAppInstallCreative.setName("Native creative #" + new Random().nextInt(Integer.MAX_VALUE));
nativeAppInstallCreative.setAdvertiserId(advertiserId);
nativeAppInstallCreative.setDestinationUrl("https://play.google.com/store/apps/details?id=com.google.fpl.pie_noon");
nativeAppInstallCreative.setCreativeTemplateId(nativeAppInstallTemplateId);
nativeAppInstallCreative.setSize(size);
List<BaseCreativeTemplateVariableValue> templateVariables = new ArrayList<>();
// Set the headline.
StringCreativeTemplateVariableValue headlineVariableValue = new StringCreativeTemplateVariableValue();
headlineVariableValue.setUniqueName("Headline");
headlineVariableValue.setValue("Pie Noon");
templateVariables.add(headlineVariableValue);
// Set the body text.
StringCreativeTemplateVariableValue bodyVariableValue = new StringCreativeTemplateVariableValue();
bodyVariableValue.setUniqueName("Body");
bodyVariableValue.setValue("Try multi-screen mode!");
templateVariables.add(bodyVariableValue);
// Set the image asset.
AssetCreativeTemplateVariableValue imageVariableValue = new AssetCreativeTemplateVariableValue();
imageVariableValue.setUniqueName("Image");
CreativeAsset imageAsset = new CreativeAsset();
imageAsset.setFileName("image" + new Random().nextInt(Integer.MAX_VALUE) + ".png");
imageAsset.setAssetByteArray(Media.getMediaDataFromUrl("https://lh4.ggpht.com/" + "GIGNKdGHMEHFDw6TM2bgAUDKPQQRIReKZPqEpMeEhZOPYnTdOQGaSpGSEZflIFs0iw=h300"));
imageVariableValue.setAsset(imageAsset);
templateVariables.add(imageVariableValue);
// Set the price.
StringCreativeTemplateVariableValue priceVariableValue = new StringCreativeTemplateVariableValue();
priceVariableValue.setUniqueName("Price");
priceVariableValue.setValue("Free");
templateVariables.add(priceVariableValue);
// Set app icon image asset.
AssetCreativeTemplateVariableValue appIconVariableValue = new AssetCreativeTemplateVariableValue();
appIconVariableValue.setUniqueName("Appicon");
CreativeAsset appIconAsset = new CreativeAsset();
appIconAsset.setFileName("icon" + new Random().nextInt(Integer.MAX_VALUE) + ".png");
appIconAsset.setAssetByteArray(Media.getMediaDataFromUrl("https://lh6.ggpht.com/" + "Jzvjne5CLs6fJ1MHF-XeuUfpABzl0YNMlp4RpHnvPRCIj4--eTDwtyouwUDzVVekXw=w300"));
appIconVariableValue.setAsset(appIconAsset);
templateVariables.add(appIconVariableValue);
// Set the call to action text.
StringCreativeTemplateVariableValue callToActionVariableValue = new StringCreativeTemplateVariableValue();
callToActionVariableValue.setUniqueName("Calltoaction");
callToActionVariableValue.setValue("Install");
templateVariables.add(callToActionVariableValue);
// Set the star rating.
StringCreativeTemplateVariableValue starRatingVariableValue = new StringCreativeTemplateVariableValue();
starRatingVariableValue.setUniqueName("Starrating");
starRatingVariableValue.setValue("4");
templateVariables.add(starRatingVariableValue);
// Set the store type.
StringCreativeTemplateVariableValue storeVariableValue = new StringCreativeTemplateVariableValue();
storeVariableValue.setUniqueName("Store");
storeVariableValue.setValue("Google Play");
templateVariables.add(storeVariableValue);
// Set the deep link URL.
UrlCreativeTemplateVariableValue deepLinkVariableValue = new UrlCreativeTemplateVariableValue();
deepLinkVariableValue.setUniqueName("DeeplinkclickactionURL");
deepLinkVariableValue.setValue("market://details?id=com.google.fpl.pie_noon");
templateVariables.add(deepLinkVariableValue);
nativeAppInstallCreative.setCreativeTemplateVariableValues(templateVariables.toArray(new BaseCreativeTemplateVariableValue[templateVariables.size()]));
// Create the creative on the server.
Creative[] creatives = creativeService.createCreatives(new Creative[] { nativeAppInstallCreative });
for (Creative createdCreative : creatives) {
System.out.printf("A native creative with ID %d and name '%s' was" + " created and can be previewed at: %s%n", createdCreative.getId(), createdCreative.getName(), createdCreative.getPreviewUrl());
}
}
use of com.google.api.ads.admanager.axis.v202202.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());
}
}
use of com.google.api.ads.admanager.axis.v202202.Size in project googleads-java-lib by googleads.
the class GetSitesRequiringApproval 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 SiteService.
SiteServiceInterface siteService = adManagerServices.get(session, SiteServiceInterface.class);
// Create a statement to select sites needing approval.
StatementBuilder statementBuilder = new StatementBuilder().where("approvalStatus = :approvalStatus").orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("approvalStatus", ApprovalStatus.REQUIRES_REVIEW.toString());
// Default for total result set size.
int totalResultSetSize = 0;
do {
// Get sites by statement.
SitePage page = siteService.getSitesByStatement(statementBuilder.toStatement());
if (page.getResults() != null) {
totalResultSetSize = page.getTotalResultSetSize();
int i = page.getStartIndex();
for (Site site : page.getResults()) {
System.out.printf("%d) Site with ID %d and URL '%s' was found.%n", i++, site.getId(), site.getUrl());
}
}
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.v202202.Size in project googleads-java-lib by googleads.
the class ApproveSuggestedAdUnits method runExample.
/**
* Runs the example.
*
* @param adManagerServices the services factory.
* @param session the session.
* @param numRequests the number of requests for suggested ad units greater than which 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 numRequests) throws RemoteException {
// Get the SuggestedAdUnitService.
SuggestedAdUnitServiceInterface suggestedAdUnitService = adManagerServices.get(session, SuggestedAdUnitServiceInterface.class);
// Create a statement to only select suggested ad units that are highly
// requested.
StatementBuilder statementBuilder = new StatementBuilder().where("numRequests >= :numRequests").orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("numRequests", numRequests);
// Default for total result set size.
int totalResultSetSize = 0;
do {
// Get suggested ad units by statement.
SuggestedAdUnitPage page = suggestedAdUnitService.getSuggestedAdUnitsByStatement(statementBuilder.toStatement());
if (page.getResults() != null) {
totalResultSetSize = page.getTotalResultSetSize();
int i = page.getStartIndex();
for (SuggestedAdUnit suggestedAdUnit : page.getResults()) {
System.out.printf("%d) Suggested ad unit with ID '%s' will be approved.%n", i++, suggestedAdUnit.getId());
}
}
statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
} while (statementBuilder.getOffset() < totalResultSetSize);
System.out.printf("Number of suggested ad units 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.v202202.ApproveSuggestedAdUnits action = new com.google.api.ads.admanager.axis.v202202.ApproveSuggestedAdUnits();
// Perform action.
SuggestedAdUnitUpdateResult result = suggestedAdUnitService.performSuggestedAdUnitAction(action, statementBuilder.toStatement());
if (result != null && result.getNumChanges() > 0) {
System.out.printf("Number of new ad units created: %d%n", result.getNewAdUnitIds().length);
} else {
System.out.println("No suggested ad units were approved.");
}
}
}
Aggregations