use of com.google.api.ads.admanager.axis.v202205.NetworkServiceInterface in project googleads-java-lib by googleads.
the class CreateProposalLineItems method runExample.
/**
* Runs the example.
*
* @param adManagerServices the services factory.
* @param session the session.
* @param proposalId the ID of the proposal that the proposal 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 proposalId) throws RemoteException {
ProposalLineItemServiceInterface proposalLineItemService = adManagerServices.get(session, ProposalLineItemServiceInterface.class);
NetworkServiceInterface networkService = adManagerServices.get(session, NetworkServiceInterface.class);
ProposalLineItem proposalLineItem = new ProposalLineItem();
// Set common required fields for a proposal line item.
proposalLineItem.setName("Proposal line item #" + new Random().nextInt(Integer.MAX_VALUE));
proposalLineItem.setProposalId(proposalId);
proposalLineItem.setLineItemType(LineItemType.STANDARD);
// 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 });
// Target display environment
RequestPlatformTargeting requestPlatformTargeting = new RequestPlatformTargeting();
requestPlatformTargeting.setTargetedRequestPlatforms(new RequestPlatform[] { RequestPlatform.BROWSER });
// Target Display environment by excluding Mobile Apps.
// DeviceCapabilities can be obtained though the Device_Capability PQL table:
// https://developers.google.com/ad-manager/api/reference/latest/PublisherQueryLanguageService
DeviceCapability mobileApps = new DeviceCapability();
mobileApps.setId(5005L);
DeviceCapabilityTargeting deviceCapabilityTargeting = new DeviceCapabilityTargeting();
deviceCapabilityTargeting.setExcludedDeviceCapabilities(new DeviceCapability[] { mobileApps });
TechnologyTargeting technologyTargeting = new TechnologyTargeting();
technologyTargeting.setDeviceCapabilityTargeting(deviceCapabilityTargeting);
// Create targeting.
Targeting targeting = new Targeting();
targeting.setInventoryTargeting(inventoryTargeting);
targeting.setRequestPlatformTargeting(requestPlatformTargeting);
targeting.setTechnologyTargeting(technologyTargeting);
proposalLineItem.setTargeting(targeting);
// 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 proposal line item.
proposalLineItem.setCreativePlaceholders(new CreativePlaceholder[] { creativePlaceholder });
// Set the length of the proposal line item to run.
proposalLineItem.setStartDateTime(DateTimes.toDateTime(Instant.now(), "America/New_York"));
proposalLineItem.setEndDateTime(DateTimes.toDateTime(Instant.now().plus(Duration.standardDays(30L)), "America/New_York"));
// Set delivery specifications for the proposal line item.
proposalLineItem.setDeliveryRateType(DeliveryRateType.EVENLY);
// Set pricing for the proposal line item for 1000 impressions at a CPM of $2
// for a total value of $2.
Goal goal = new Goal();
goal.setUnits(1000L);
goal.setUnitType(UnitType.IMPRESSIONS);
proposalLineItem.setGoal(goal);
proposalLineItem.setNetRate(new Money("USD", 2000000L));
proposalLineItem.setRateType(RateType.CPM);
ProposalLineItem[] proposalLineItems = proposalLineItemService.createProposalLineItems(new ProposalLineItem[] { proposalLineItem });
for (ProposalLineItem createdProposalLineItem : proposalLineItems) {
System.out.printf("A proposal line item with ID %d and name '%s' was created.%n", createdProposalLineItem.getId(), createdProposalLineItem.getName());
}
}
use of com.google.api.ads.admanager.axis.v202205.NetworkServiceInterface in project googleads-java-lib by googleads.
the class MakeTestNetwork 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);
// Make the test network.
Network network = networkService.makeTestNetwork();
System.out.printf("Test network with network code '%s' and display name '%s' created.%n" + "You may now sign in at https://admanager.google.com/%s%n", network.getNetworkCode(), network.getDisplayName(), network.getNetworkCode());
}
use of com.google.api.ads.admanager.axis.v202205.NetworkServiceInterface 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.v202205.NetworkServiceInterface 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.v202205.NetworkServiceInterface 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