use of com.google.api.ads.admanager.jaxws.v202205.AdUnitTargeting in project googleads-java-lib by googleads.
the class CreateVideoLineItems method runExample.
/**
* Runs the example.
*
* @param adManagerServices the services factory.
* @param session the session.
* @param orderId the ID of the order that the line item will belong to.
* @param targetedVideoAdUnitId the ID of the d unit that the line item will target.
* @param contentId the ID of the video content that the line item will target.
* @param contentBundleId the ID of the video content bundle that the line item will target.
* @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, String targetedVideoAdUnitId, long contentId, long contentBundleId, long cmsMetadataValueId) throws RemoteException {
// Get the LineItemService.
LineItemServiceInterface lineItemService = adManagerServices.get(session, LineItemServiceInterface.class);
// Create content targeting.
ContentTargeting contentTargeting = new ContentTargeting();
contentTargeting.setTargetedContentIds(new long[] { contentId });
contentTargeting.setTargetedVideoContentBundleIds(new long[] { contentBundleId });
// Target only video players
RequestPlatformTargeting requestPlatformTargeting = new RequestPlatformTargeting();
requestPlatformTargeting.setTargetedRequestPlatforms(new RequestPlatform[] { RequestPlatform.VIDEO_PLAYER });
// Create inventory targeting.
InventoryTargeting inventoryTargeting = new InventoryTargeting();
inventoryTargeting.setTargetedAdUnits(new AdUnitTargeting[] { new AdUnitTargeting(targetedVideoAdUnitId, true) });
// Create video position targeting.
VideoPosition videoPosition = new VideoPosition();
videoPosition.setPositionType(VideoPositionType.PREROLL);
VideoPositionTarget videoPositionTarget = new VideoPositionTarget();
videoPositionTarget.setVideoPosition(videoPosition);
VideoPositionTargeting videoPositionTargeting = new VideoPositionTargeting();
videoPositionTargeting.setTargetedPositions(new VideoPositionTarget[] { videoPositionTarget });
// Create custom targeting for CmsMetadataValues.
CmsMetadataCriteria contentCustomCriteria = new CmsMetadataCriteria();
contentCustomCriteria.setCmsMetadataValueIds(new long[] { cmsMetadataValueId });
contentCustomCriteria.setOperator(CmsMetadataCriteriaComparisonOperator.EQUALS);
CustomCriteriaSet customCriteriaSet = new CustomCriteriaSet();
customCriteriaSet.setChildren(new CustomCriteriaNode[] { contentCustomCriteria });
customCriteriaSet.setLogicalOperator(CustomCriteriaSetLogicalOperator.AND);
// Create targeting.
Targeting targeting = new Targeting();
targeting.setContentTargeting(contentTargeting);
targeting.setInventoryTargeting(inventoryTargeting);
targeting.setVideoPositionTargeting(videoPositionTargeting);
targeting.setRequestPlatformTargeting(requestPlatformTargeting);
targeting.setCustomTargeting(customCriteriaSet);
// Create local line item object.
LineItem lineItem = new LineItem();
lineItem.setName("Video 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 SPONSORSHIP.
lineItem.setLineItemType(LineItemType.SPONSORSHIP);
// Set the environment type to video.
lineItem.setEnvironmentType(EnvironmentType.VIDEO_PLAYER);
// Set the creative rotation type to optimized.
lineItem.setCreativeRotationType(CreativeRotationType.OPTIMIZED);
// Create the master creative placeholder.
CreativePlaceholder creativeMasterPlaceholder = new CreativePlaceholder();
creativeMasterPlaceholder.setSize(new Size(640, 360, false));
// Create companion creative placeholders.
CreativePlaceholder companionCreativePlaceholder = new CreativePlaceholder();
companionCreativePlaceholder.setSize(new Size(300, 250, false));
// Set companion creative placeholders.
creativeMasterPlaceholder.setCompanions(new CreativePlaceholder[] { companionCreativePlaceholder });
// Set the size of creatives that can be associated with this line item.
lineItem.setCreativePlaceholders(new CreativePlaceholder[] { creativeMasterPlaceholder });
// Set delivery of video companions to optional.
lineItem.setCompanionDeliveryOption(CompanionDeliveryOption.OPTIONAL);
// Set the maximum video creative length for this line item to 15 seconds.
lineItem.setVideoMaxDuration(15000L);
// 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 day to $1.
lineItem.setCostType(CostType.CPD);
lineItem.setCostPerUnit(new Money("USD", 1000000L));
// Set the percentage to be 100%.
Goal goal = new Goal();
goal.setGoalType(GoalType.DAILY);
goal.setUnits(100L);
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 video line item with ID %d and name '%s' was created.%n", createdLineItem.getId(), createdLineItem.getName());
}
}
use of com.google.api.ads.admanager.jaxws.v202205.AdUnitTargeting in project googleads-java-lib by googleads.
the class PqlTest method setUp.
@Before
public void setUp() throws Exception {
column1 = new ColumnType();
column1.setLabelName("column1");
column2 = new ColumnType();
column2.setLabelName("column2");
column3 = new ColumnType();
column3.setLabelName("column3");
textValue1 = new TextValue();
textValue1.setValue("value1");
textValue2 = new TextValue();
textValue2.setValue("value2");
textValue3 = new TextValue();
textValue3.setValue("value3");
textValue4 = new TextValue();
textValue4.setValue("comma,separated");
booleanValue1 = new BooleanValue();
booleanValue1.setValue(false);
booleanValue2 = new BooleanValue();
booleanValue2.setValue(true);
booleanValue3 = new BooleanValue();
booleanValue3.setValue(false);
numberValue1 = new NumberValue();
numberValue1.setValue("1");
numberValue2 = new NumberValue();
numberValue2.setValue("1.02");
numberValue3 = new NumberValue();
numberValue3.setValue("-1");
dateTime1 = new DateTime();
date1 = new Date();
date1.setYear(2012);
date1.setMonth(12);
date1.setDay(2);
dateTime1.setDate(date1);
dateTime1.setHour(12);
dateTime1.setMinute(45);
dateTime1.setSecond(0);
dateTime1.setTimeZoneId(TIME_ZONE_ID1);
dateTimeValue1 = new DateTimeValue();
dateTimeValue1.setValue(dateTime1);
dateValue1 = new DateValue();
dateValue1.setValue(date1);
AdUnitTargeting adUnitTargeting = new AdUnitTargeting();
adUnitTargeting.setAdUnitId("100");
InventoryTargeting inventoryTargeting = new InventoryTargeting();
inventoryTargeting.getTargetedAdUnits().add(adUnitTargeting);
targeting1 = new Targeting();
targeting1.setInventoryTargeting(inventoryTargeting);
targetingValue1 = new TargetingValue();
targetingValue1.setValue(targeting1);
numberSetValue = new SetValue();
numberSetValue.getValues().add(numberValue1);
numberSetValue.getValues().add(numberValue3);
textSetValue = new SetValue();
textSetValue.getValues().add(textValue1);
textSetValue.getValues().add(textValue2);
dateSetValue = new SetValue();
dateSetValue.getValues().add(dateValue1);
dateTimeSetValue = new SetValue();
dateTimeSetValue.getValues().add(dateTimeValue1);
mixedSetValue = new SetValue();
mixedSetValue.getValues().add(textValue1);
mixedSetValue.getValues().add(dateTimeValue1);
commaTextSetValue = new SetValue();
commaTextSetValue.getValues().add(textValue1);
commaTextSetValue.getValues().add(textValue4);
}
use of com.google.api.ads.admanager.jaxws.v202205.AdUnitTargeting in project googleads-java-lib by googleads.
the class PqlTest method setUp.
@Before
public void setUp() throws Exception {
column1 = new ColumnType();
column1.setLabelName("column1");
column2 = new ColumnType();
column2.setLabelName("column2");
column3 = new ColumnType();
column3.setLabelName("column3");
textValue1 = new TextValue();
textValue1.setValue("value1");
textValue2 = new TextValue();
textValue2.setValue("value2");
textValue3 = new TextValue();
textValue3.setValue("value3");
textValue4 = new TextValue();
textValue4.setValue("comma,separated");
booleanValue1 = new BooleanValue();
booleanValue1.setValue(false);
booleanValue2 = new BooleanValue();
booleanValue2.setValue(true);
booleanValue3 = new BooleanValue();
booleanValue3.setValue(false);
numberValue1 = new NumberValue();
numberValue1.setValue("1");
numberValue2 = new NumberValue();
numberValue2.setValue("1.02");
numberValue3 = new NumberValue();
numberValue3.setValue("-1");
dateTime1 = new DateTime();
date1 = new Date();
date1.setYear(2012);
date1.setMonth(12);
date1.setDay(2);
dateTime1.setDate(date1);
dateTime1.setHour(12);
dateTime1.setMinute(45);
dateTime1.setSecond(0);
dateTime1.setTimeZoneId(TIME_ZONE_ID1);
dateTimeValue1 = new DateTimeValue();
dateTimeValue1.setValue(dateTime1);
dateValue1 = new DateValue();
dateValue1.setValue(date1);
AdUnitTargeting adUnitTargeting = new AdUnitTargeting();
adUnitTargeting.setAdUnitId("100");
InventoryTargeting inventoryTargeting = new InventoryTargeting();
inventoryTargeting.getTargetedAdUnits().add(adUnitTargeting);
targeting1 = new Targeting();
targeting1.setInventoryTargeting(inventoryTargeting);
targetingValue1 = new TargetingValue();
targetingValue1.setValue(targeting1);
numberSetValue = new SetValue();
numberSetValue.getValues().add(numberValue1);
numberSetValue.getValues().add(numberValue3);
textSetValue = new SetValue();
textSetValue.getValues().add(textValue1);
textSetValue.getValues().add(textValue2);
dateSetValue = new SetValue();
dateSetValue.getValues().add(dateValue1);
dateTimeSetValue = new SetValue();
dateTimeSetValue.getValues().add(dateTimeValue1);
mixedSetValue = new SetValue();
mixedSetValue.getValues().add(textValue1);
mixedSetValue.getValues().add(dateTimeValue1);
commaTextSetValue = new SetValue();
commaTextSetValue.getValues().add(textValue1);
commaTextSetValue.getValues().add(textValue4);
}
use of com.google.api.ads.admanager.jaxws.v202205.AdUnitTargeting 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.jaxws.v202205.AdUnitTargeting 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());
}
}
Aggregations