// Copyright 2013 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package dfp.axis.v201308.audiencesegmentservice;
import com.google.api.ads.common.lib.auth.OfflineCredentials;
import com.google.api.ads.common.lib.auth.OfflineCredentials.Api;
import com.google.api.ads.dfp.axis.factory.DfpServices;
import com.google.api.ads.dfp.axis.v201308.AdUnitTargeting;
import com.google.api.ads.dfp.axis.v201308.AudienceSegment;
import com.google.api.ads.dfp.axis.v201308.AudienceSegmentServiceInterface;
import com.google.api.ads.dfp.axis.v201308.CustomCriteria;
import com.google.api.ads.dfp.axis.v201308.CustomCriteriaComparisonOperator;
import com.google.api.ads.dfp.axis.v201308.CustomCriteriaNode;
import com.google.api.ads.dfp.axis.v201308.CustomCriteriaSet;
import com.google.api.ads.dfp.axis.v201308.CustomCriteriaSetLogicalOperator;
import com.google.api.ads.dfp.axis.v201308.FirstPartyAudienceSegment;
import com.google.api.ads.dfp.axis.v201308.FirstPartyAudienceSegmentRule;
import com.google.api.ads.dfp.axis.v201308.InventoryTargeting;
import com.google.api.ads.dfp.axis.v201308.NetworkServiceInterface;
import com.google.api.ads.dfp.axis.v201308.RuleBasedFirstPartyAudienceSegment;
import com.google.api.ads.dfp.lib.client.DfpSession;
import com.google.api.client.auth.oauth2.Credential;
import java.util.Random;
/**
* This example creates new rule based first party audience segments. To
* determine which audience segments exist, run GetAllAudienceSegments.java.
*
* Credentials and properties in {@code fromFile()} are pulled from the
* "ads.properties" file. See README for more info.
*
* Tags: AudienceSegmentService.createAudienceSegments
*
* @author Adam Rogal
*/
public class CreateAudienceSegments {
// Set the IDs of the custom criteria to be used in the segment rule.
private static final String CUSTOM_TARGETING_KEY_ID =
"INSERT_CUSTOM_TARGETING_KEY_ID_HERE";
private static final String CUSTOM_TARGETING_VALUE_ID =
"INSERT_CUSTOM_TARGETING_VALUE_ID_HERE";
public static void runExample(DfpServices dfpServices, DfpSession session,
long customTargetingKeyId, long customTargetingValueId) throws Exception {
// Get the AudienceSegmentService.
AudienceSegmentServiceInterface audienceSegmentService =
dfpServices.get(session, AudienceSegmentServiceInterface.class);
// Get the NetworkService.
NetworkServiceInterface networkService =
dfpServices.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 the custom criteria to be used in the segment rule.
// CUSTOM_TARGETING_KEY_ID == CUSTOM_TARGETING_VALUE_ID
CustomCriteria customCriteria = new CustomCriteria();
customCriteria.setKeyId(customTargetingKeyId);
customCriteria.setOperator(CustomCriteriaComparisonOperator.IS);
customCriteria.setValueIds(new long[] {customTargetingValueId});
// Create the custom criteria expression.
CustomCriteriaSet topCustomCriteriaSet = new CustomCriteriaSet();
topCustomCriteriaSet.setLogicalOperator(CustomCriteriaSetLogicalOperator.AND);
topCustomCriteriaSet.setChildren(new CustomCriteriaNode[] {customCriteria});
// Create the audience segment rule.
FirstPartyAudienceSegmentRule rule = new FirstPartyAudienceSegmentRule();
rule.setInventoryRule(inventoryTargeting);
rule.setCustomCriteriaRule(topCustomCriteriaSet);
// Create an audience segment.
RuleBasedFirstPartyAudienceSegment audienceSegment = new RuleBasedFirstPartyAudienceSegment();
audienceSegment.setName(
"Sports enthusiasts audience segment #" + new Random().nextInt(Integer.MAX_VALUE));
audienceSegment.setDescription("Sports enthusiasts between the ages of 20 and 30.");
audienceSegment.setPageViews(6);
audienceSegment.setRecencyDays(6);
audienceSegment.setMembershipExpirationDays(88);
audienceSegment.setRule(rule);
// Create the audience segment on the server.
AudienceSegment[] audienceSegments = audienceSegmentService.createAudienceSegments(
new FirstPartyAudienceSegment[] {audienceSegment});
for (AudienceSegment createdAudienceSegment : audienceSegments) {
System.out.printf(
"An audience segment with ID \"%d\", name \"%s\", and type \"%s\" was created.\n",
createdAudienceSegment.getId(), createdAudienceSegment.getName(),
createdAudienceSegment.getType());
}
}
public static void main(String[] args) throws Exception {
// Generate a refreshable OAuth2 credential similar to a ClientLogin token
// and can be used in place of a service account.
Credential oAuth2Credential = new OfflineCredentials.Builder()
.forApi(Api.DFP)
.fromFile()
.build()
.generateCredential();
// Construct a DfpSession.
DfpSession session = new DfpSession.Builder()
.fromFile()
.withOAuth2Credential(oAuth2Credential)
.build();
DfpServices dfpServices = new DfpServices();
runExample(dfpServices, session, Long.parseLong(CUSTOM_TARGETING_KEY_ID),
Long.parseLong(CUSTOM_TARGETING_VALUE_ID));
}
}