/// <summary>
/// Run the code example.
/// </summary>
/// <param name="user">The DFP user object running the code example.</param>
public override void Run(DfpUser user) {
// Get the AudienceSegmentService.
AudienceSegmentService audienceSegmentService = (AudienceSegmentService) user.GetService(
DfpService.v201505.AudienceSegmentService);
// Get the NetworkService.
NetworkService networkService = (NetworkService) user.GetService(
DfpService.v201505.NetworkService);
long customTargetingKeyId = long.Parse(_T("INSERT_CUSTOM_TARGETING_KEY_ID_HERE"));
long customTargetingValueId = long.Parse(_T("INSERT_CUSTOM_TARGETING_VALUE_ID_HERE"));
try {
// Get the root ad unit ID used to target the whole site.
String rootAdUnitId = networkService.getCurrentNetwork().effectiveRootAdUnitId;
// 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.adUnitId = rootAdUnitId;
adUnitTargeting.includeDescendants = true;
inventoryTargeting.targetedAdUnits = 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.keyId = customTargetingKeyId;
customCriteria.@operator = CustomCriteriaComparisonOperator.IS;
customCriteria.valueIds = new long[] {customTargetingValueId};
// Create the custom criteria expression.
CustomCriteriaSet topCustomCriteriaSet = new CustomCriteriaSet();
topCustomCriteriaSet.logicalOperator = CustomCriteriaSetLogicalOperator.AND;
topCustomCriteriaSet.children = new CustomCriteriaNode[] {customCriteria};
// Create the audience segment rule.
FirstPartyAudienceSegmentRule rule = new FirstPartyAudienceSegmentRule();
rule.inventoryRule = inventoryTargeting;
rule.customCriteriaRule = topCustomCriteriaSet;
// Create an audience segment.
RuleBasedFirstPartyAudienceSegment audienceSegment =
new RuleBasedFirstPartyAudienceSegment();
audienceSegment.name = "Sports enthusiasts audience segment #" + this.GetTimeStamp();
audienceSegment.description = "Sports enthusiasts between the ages of 20 and 30.";
audienceSegment.pageViews = 6;
audienceSegment.recencyDays = 6;
audienceSegment.membershipExpirationDays = 88;
audienceSegment.rule = rule;
// Create the audience segment on the server.
AudienceSegment[] audienceSegments = audienceSegmentService.createAudienceSegments(
new FirstPartyAudienceSegment[] {audienceSegment});
foreach (AudienceSegment createdAudienceSegment in audienceSegments) {
Console.WriteLine("An audience segment with ID \"{0}\", name \"{1}\", and type \"{2}\" " +
"was created.", createdAudienceSegment.id, createdAudienceSegment.name,
createdAudienceSegment.type);
}
} catch (Exception e) {
Console.WriteLine("Failed to get audience segment. Exception says \"{0}\"", e.Message);
}
}
/// <summary>
/// Run the code example.
/// </summary>
/// <param name="user">The DFP user object running the code example.</param>
public override void Run(DfpUser user) {
// Get the LineItemService.
LineItemService lineItemService =
(LineItemService) user.GetService(DfpService.v201505.LineItemService);
// Set the order that all created line items will belong to and the
// video ad unit ID to target.
long orderId = long.Parse(_T("INSERT_ORDER_ID_HERE"));
string targetedVideoAdUnitId = _T("INSERT_TARGETED_VIDEO_AD_UNIT_ID_HERE");
// Set the custom targeting value ID representing the metadata
// on the content to target. This would typically be from a key representing
// a "genre" and a value representing something like "comedy". The value must
// be from a key in a content metadata key hierarchy.
long contentCustomTargetingValueId =
long.Parse(_T("INSERT_CONTENT_CUSTOM_TARGETING_VALUE_ID_HERE"));
// Create content targeting.
ContentMetadataKeyHierarchyTargeting contentMetadataTargeting =
new ContentMetadataKeyHierarchyTargeting();
contentMetadataTargeting.customTargetingValueIds =
new long[] {contentCustomTargetingValueId};
ContentTargeting contentTargeting = new ContentTargeting();
contentTargeting.targetedContentMetadata =
new ContentMetadataKeyHierarchyTargeting[] {contentMetadataTargeting};
// Create inventory targeting.
InventoryTargeting inventoryTargeting = new InventoryTargeting();
AdUnitTargeting adUnitTargeting = new AdUnitTargeting();
adUnitTargeting.adUnitId = targetedVideoAdUnitId;
adUnitTargeting.includeDescendants = true;
inventoryTargeting.targetedAdUnits = new AdUnitTargeting[] {adUnitTargeting};
// Create video position targeting.
VideoPosition videoPosition = new VideoPosition();
videoPosition.positionType = VideoPositionType.PREROLL;
VideoPositionTarget videoPositionTarget = new VideoPositionTarget();
videoPositionTarget.videoPosition = videoPosition;
VideoPositionTargeting videoPositionTargeting = new VideoPositionTargeting();
videoPositionTargeting.targetedPositions = new VideoPositionTarget[] {videoPositionTarget};
// Create targeting.
Targeting targeting = new Targeting();
targeting.contentTargeting = contentTargeting;
targeting.inventoryTargeting = inventoryTargeting;
targeting.videoPositionTargeting = videoPositionTargeting;
// Create local line item object.
LineItem lineItem = new LineItem();
lineItem.name = "Video line item - " + this.GetTimeStamp();
lineItem.orderId = orderId;
lineItem.targeting = targeting;
lineItem.lineItemType = LineItemType.SPONSORSHIP;
lineItem.allowOverbook = true;
// Set the environment type to video.
lineItem.environmentType = EnvironmentType.VIDEO_PLAYER;
// Set the creative rotation type to optimized.
lineItem.creativeRotationType = CreativeRotationType.OPTIMIZED;
// Create the master creative placeholder.
CreativePlaceholder creativeMasterPlaceholder = new CreativePlaceholder();
Size size1 = new Size();
size1.width = 400;
size1.height = 300;
size1.isAspectRatio = false;
creativeMasterPlaceholder.size = size1;
// Create companion creative placeholders.
CreativePlaceholder companionCreativePlaceholder1 = new CreativePlaceholder();
Size size2 = new Size();
size2.width = 300;
size2.height = 250;
size2.isAspectRatio = false;
companionCreativePlaceholder1.size = size2;
CreativePlaceholder companionCreativePlaceholder2 = new CreativePlaceholder();
Size size3 = new Size();
size3.width = 728;
size3.height = 90;
size3.isAspectRatio = false;
companionCreativePlaceholder2.size = size3;
// Set companion creative placeholders.
creativeMasterPlaceholder.companions = new CreativePlaceholder[] {
companionCreativePlaceholder1, companionCreativePlaceholder2};
// Set the size of creatives that can be associated with this line item.
lineItem.creativePlaceholders = new CreativePlaceholder[] {creativeMasterPlaceholder};
// Set delivery of video companions to optional.
lineItem.companionDeliveryOption = CompanionDeliveryOption.OPTIONAL;
// Set the line item to run for one month.
lineItem.startDateTimeType = StartDateTimeType.IMMEDIATELY;
lineItem.endDateTime =
DateTimeUtilities.FromDateTime(System.DateTime.Now.AddMonths(1), "America/New_York");
// Set the cost per day to $1.
lineItem.costType = CostType.CPD;
Money money = new Money();
money.currencyCode = "USD";
money.microAmount = 1000000L;
lineItem.costPerUnit = money;
// Set the percentage to be 100%.
Goal goal = new Goal();
goal.goalType = GoalType.DAILY;
goal.unitType = UnitType.IMPRESSIONS;
goal.units = 100;
lineItem.primaryGoal = goal;
try {
// Create the line item on the server.
LineItem[] createdLineItems = lineItemService.createLineItems(new LineItem[] {lineItem});
foreach (LineItem createdLineItem in createdLineItems) {
Console.WriteLine("A line item with ID \"{0}\", belonging to order ID \"{1}\", and " +
"named \"{2}\" was created.", createdLineItem.id, createdLineItem.orderId,
createdLineItem.name);
}
} catch (Exception ex) {
Console.WriteLine("Failed to create line items. Exception says \"{0}\"",
ex.Message);
}
}
/// <summary>
/// Run the code examples.
/// </summary>
/// <param name="user">The DFP user object running the code examples.</param>
public override void Run(DfpUser user) {
// Get the ProposalLineItemService.
ProposalLineItemService proposalLineItemService =
(ProposalLineItemService) user.GetService(DfpService.v201505.ProposalLineItemService);
// Get the NetworkService.
NetworkService networkService =
(NetworkService) user.GetService(DfpService.v201505.NetworkService);
long proposalId = long.Parse(_T("INSERT_PROPOSAL_ID_HERE"));
long rateCardId = long.Parse(_T("INSERT_RATE_CARD_ID_HERE"));
long productId = long.Parse(_T("INSERT_PRODUCT_ID_HERE"));
// Get the root ad unit ID used to target the whole site.
String rootAdUnitId = networkService.getCurrentNetwork().effectiveRootAdUnitId;
// 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.adUnitId = rootAdUnitId;
adUnitTargeting.includeDescendants = true;
inventoryTargeting.targetedAdUnits = new AdUnitTargeting[] {adUnitTargeting};
// Create targeting.
Targeting targeting = new Targeting();
targeting.inventoryTargeting = inventoryTargeting;
// Create a proposal line item.
ProposalLineItem proposalLineItem = new ProposalLineItem();
proposalLineItem.name = "Proposal line item #" + new Random().Next(int.MaxValue);
proposalLineItem.proposalId = proposalId;
proposalLineItem.rateCardId = rateCardId;
proposalLineItem.productId = productId;
proposalLineItem.targeting = targeting;
// Set the length of the proposal line item to run.
proposalLineItem.startDateTime =
DateTimeUtilities.FromDateTime(System.DateTime.Now.AddDays(7), "America/New_York");
proposalLineItem.endDateTime =
DateTimeUtilities.FromDateTime(System.DateTime.Now.AddDays(30), "America/New_York");
// Set delivery specifications for the proposal line item.
proposalLineItem.deliveryRateType = DeliveryRateType.EVENLY;
proposalLineItem.creativeRotationType = CreativeRotationType.OPTIMIZED;
// Set billing specifications for the proposal line item.
proposalLineItem.billingCap = BillingCap.CAPPED_CUMULATIVE;
proposalLineItem.billingSource = BillingSource.THIRD_PARTY_VOLUME;
// Set pricing for the proposal line item for 1000 impressions at a CPM of $2
// for a total value of $2.
proposalLineItem.goal = new Goal() {unitType = UnitType.IMPRESSIONS, units = 1000L};
proposalLineItem.cost = new Money() {currencyCode = "USD", microAmount = 2000000L};
proposalLineItem.costPerUnit = new Money() {currencyCode = "USD", microAmount = 2000000L};
proposalLineItem.rateType = RateType.CPM;
try {
// Create the proposal line item on the server.
ProposalLineItem[] proposalLineItems = proposalLineItemService.createProposalLineItems(
new ProposalLineItem[] {proposalLineItem});
foreach (ProposalLineItem createdProposalLineItem in proposalLineItems) {
Console.WriteLine("A proposal line item with ID \"{0}\" and name \"{1}\" was created.",
createdProposalLineItem.id, createdProposalLineItem.name);
}
} catch (Exception e) {
Console.WriteLine("Failed to create proposal line items. Exception says \"{0}\"",
e.Message);
}
}
public LineItem CreateLineItem(DfpUser user, long orderId, string adUnitId) {
LineItemService lineItemService =
(LineItemService) user.GetService(DfpService.v201505.LineItemService);
long placementId = CreatePlacement(user, new string[] {adUnitId}).id;
// Create inventory targeting.
InventoryTargeting inventoryTargeting = new InventoryTargeting();
inventoryTargeting.targetedPlacementIds = new long[] {placementId};
// Create geographical targeting.
GeoTargeting geoTargeting = new GeoTargeting();
// Include the US and Quebec, Canada.
Location countryLocation = new Location();
countryLocation.id = 2840L;
Location regionLocation = new Location();
regionLocation.id = 20123L;
geoTargeting.targetedLocations = new Location[] {countryLocation, regionLocation};
// Exclude Chicago and the New York metro area.
Location cityLocation = new Location();
cityLocation.id = 1016367L;
Location metroLocation = new Location();
metroLocation.id = 200501L;
geoTargeting.excludedLocations = new Location[] {cityLocation, metroLocation};
// Exclude domains that are not under the network's control.
UserDomainTargeting userDomainTargeting = new UserDomainTargeting();
userDomainTargeting.domains = new String[] {"usa.gov"};
userDomainTargeting.targeted = false;
// Create day-part targeting.
DayPartTargeting dayPartTargeting = new DayPartTargeting();
dayPartTargeting.timeZone = DeliveryTimeZone.BROWSER;
// Target only the weekend in the browser's timezone.
DayPart saturdayDayPart = new DayPart();
saturdayDayPart.dayOfWeek = Google.Api.Ads.Dfp.v201505.DayOfWeek.SATURDAY;
saturdayDayPart.startTime = new TimeOfDay();
saturdayDayPart.startTime.hour = 0;
saturdayDayPart.startTime.minute = MinuteOfHour.ZERO;
saturdayDayPart.endTime = new TimeOfDay();
saturdayDayPart.endTime.hour = 24;
saturdayDayPart.endTime.minute = MinuteOfHour.ZERO;
DayPart sundayDayPart = new DayPart();
sundayDayPart.dayOfWeek = Google.Api.Ads.Dfp.v201505.DayOfWeek.SUNDAY;
sundayDayPart.startTime = new TimeOfDay();
sundayDayPart.startTime.hour = 0;
sundayDayPart.startTime.minute = MinuteOfHour.ZERO;
sundayDayPart.endTime = new TimeOfDay();
sundayDayPart.endTime.hour = 24;
sundayDayPart.endTime.minute = MinuteOfHour.ZERO;
dayPartTargeting.dayParts = new DayPart[] {saturdayDayPart, sundayDayPart};
// Create technology targeting.
TechnologyTargeting technologyTargeting = new TechnologyTargeting();
// Create browser targeting.
BrowserTargeting browserTargeting = new BrowserTargeting();
browserTargeting.isTargeted = true;
// Target just the Chrome browser.
Technology browserTechnology = new Technology();
browserTechnology.id = 500072L;
browserTargeting.browsers = new Technology[] {browserTechnology};
technologyTargeting.browserTargeting = browserTargeting;
LineItem lineItem = new LineItem();
lineItem.name = "Line item #" + new TestUtils().GetTimeStamp();
lineItem.orderId = orderId;
lineItem.targeting = new Targeting();
lineItem.targeting.inventoryTargeting = inventoryTargeting;
lineItem.targeting.geoTargeting = geoTargeting;
lineItem.targeting.userDomainTargeting = userDomainTargeting;
lineItem.targeting.dayPartTargeting = dayPartTargeting;
lineItem.targeting.technologyTargeting = technologyTargeting;
lineItem.lineItemType = LineItemType.STANDARD;
lineItem.allowOverbook = true;
// Set the creative rotation type to even.
lineItem.creativeRotationType = CreativeRotationType.EVEN;
// Set the size of creatives that can be associated with this line item.
Size size = new Size();
size.width = 300;
size.height = 250;
size.isAspectRatio = false;
// Create the creative placeholder.
CreativePlaceholder creativePlaceholder = new CreativePlaceholder();
creativePlaceholder.size = size;
lineItem.creativePlaceholders = new CreativePlaceholder[] {creativePlaceholder};
// Set the line item to run for one month.
lineItem.startDateTimeType = StartDateTimeType.IMMEDIATELY;
lineItem.endDateTime =
DateTimeUtilities.FromDateTime(System.DateTime.Today.AddMonths(1), "America/New_York");
// Set the cost per unit to $2.
lineItem.costType = CostType.CPM;
lineItem.costPerUnit = new Money();
lineItem.costPerUnit.currencyCode = "USD";
lineItem.costPerUnit.microAmount = 2000000L;
// Set the number of units bought to 500,000 so that the budget is
// $1,000.
Goal goal = new Goal();
goal.units = 500000L;
goal.unitType = UnitType.IMPRESSIONS;
lineItem.primaryGoal = goal;
return lineItemService.createLineItems(new LineItem[] {lineItem})[0];
}
/// <summary>
/// Run the code examples.
/// </summary>
/// <param name="user">The DFP user object running the code examples.</param>
public override void Run(DfpUser user) {
// Get the LineItemService.
LineItemService lineItemService =
(LineItemService) user.GetService(DfpService.v201505.LineItemService);
// Set the order that all created line items will belong to and the
// placement ID to target.
long orderId = long.Parse(_T("INSERT_ORDER_ID_HERE"));
long[] targetPlacementIds = new long[] {long.Parse(_T("INSERT_PLACEMENT_ID_HERE"))};
// Create inventory targeting.
InventoryTargeting inventoryTargeting = new InventoryTargeting();
inventoryTargeting.targetedPlacementIds = targetPlacementIds;
// Create geographical targeting.
GeoTargeting geoTargeting = new GeoTargeting();
// Include the US and Quebec, Canada.
Location countryLocation = new Location();
countryLocation.id = 2840L;
Location regionLocation = new Location();
regionLocation.id = 20123L;
geoTargeting.targetedLocations = new Location[] {countryLocation, regionLocation};
Location postalCodeLocation = new Location();
postalCodeLocation.id = 9000093;
// Exclude Chicago and the New York metro area.
Location cityLocation = new Location();
cityLocation.id = 1016367L;
Location metroLocation = new Location();
metroLocation.id = 200501L;
geoTargeting.excludedLocations = new Location[] {cityLocation, metroLocation};
// Exclude domains that are not under the network's control.
UserDomainTargeting userDomainTargeting = new UserDomainTargeting();
userDomainTargeting.domains = new String[] {"usa.gov"};
userDomainTargeting.targeted = false;
// Create day-part targeting.
DayPartTargeting dayPartTargeting = new DayPartTargeting();
dayPartTargeting.timeZone = DeliveryTimeZone.BROWSER;
// Target only the weekend in the browser's timezone.
DayPart saturdayDayPart = new DayPart();
saturdayDayPart.dayOfWeek = Google.Api.Ads.Dfp.v201505.DayOfWeek.SATURDAY;
saturdayDayPart.startTime = new TimeOfDay();
saturdayDayPart.startTime.hour = 0;
saturdayDayPart.startTime.minute = MinuteOfHour.ZERO;
saturdayDayPart.endTime = new TimeOfDay();
saturdayDayPart.endTime.hour = 24;
saturdayDayPart.endTime.minute = MinuteOfHour.ZERO;
DayPart sundayDayPart = new DayPart();
sundayDayPart.dayOfWeek = Google.Api.Ads.Dfp.v201505.DayOfWeek.SUNDAY;
sundayDayPart.startTime = new TimeOfDay();
sundayDayPart.startTime.hour = 0;
sundayDayPart.startTime.minute = MinuteOfHour.ZERO;
sundayDayPart.endTime = new TimeOfDay();
sundayDayPart.endTime.hour = 24;
sundayDayPart.endTime.minute = MinuteOfHour.ZERO;
dayPartTargeting.dayParts = new DayPart[] {saturdayDayPart, sundayDayPart};
// Create technology targeting.
TechnologyTargeting technologyTargeting = new TechnologyTargeting();
// Create browser targeting.
BrowserTargeting browserTargeting = new BrowserTargeting();
browserTargeting.isTargeted = true;
// Target just the Chrome browser.
Technology browserTechnology = new Technology();
browserTechnology.id = 500072L;
browserTargeting.browsers = new Technology[] {browserTechnology};
technologyTargeting.browserTargeting = browserTargeting;
// Create an array to store local line item objects.
LineItem[] lineItems = new LineItem[5];
for (int i = 0; i < 5; i++) {
LineItem lineItem = new LineItem();
lineItem.name = "Line item #" + i;
lineItem.orderId = orderId;
lineItem.targeting = new Targeting();
lineItem.targeting.inventoryTargeting = inventoryTargeting;
lineItem.targeting.geoTargeting = geoTargeting;
lineItem.targeting.userDomainTargeting = userDomainTargeting;
lineItem.targeting.dayPartTargeting = dayPartTargeting;
lineItem.targeting.technologyTargeting = technologyTargeting;
lineItem.lineItemType = LineItemType.STANDARD;
lineItem.allowOverbook = true;
// Set the creative rotation type to even.
lineItem.creativeRotationType = CreativeRotationType.EVEN;
// Set the size of creatives that can be associated with this line item.
Size size = new Size();
size.width = 300;
size.height = 250;
size.isAspectRatio = false;
// Create the creative placeholder.
CreativePlaceholder creativePlaceholder = new CreativePlaceholder();
creativePlaceholder.size = size;
lineItem.creativePlaceholders = new CreativePlaceholder[] {creativePlaceholder};
// Set the line item to run for one month.
lineItem.startDateTimeType = StartDateTimeType.IMMEDIATELY;
lineItem.endDateTime =
DateTimeUtilities.FromDateTime(System.DateTime.Today.AddMonths(1), "America/New_York");
// Set the cost per unit to $2.
lineItem.costType = CostType.CPM;
lineItem.costPerUnit = new Money();
lineItem.costPerUnit.currencyCode = "USD";
lineItem.costPerUnit.microAmount = 2000000L;
// Set the number of units bought to 500,000 so that the budget is
// $1,000.
Goal goal = new Goal();
goal.goalType = GoalType.LIFETIME;
goal.unitType = UnitType.IMPRESSIONS;
goal.units = 500000L;
lineItem.primaryGoal = goal;
lineItems[i] = lineItem;
}
try {
// Create the line items on the server.
lineItems = lineItemService.createLineItems(lineItems);
if (lineItems != null) {
foreach (LineItem lineItem in lineItems) {
Console.WriteLine("A line item with ID \"{0}\", belonging to order ID \"{1}\", and" +
" named \"{2}\" was created.", lineItem.id, lineItem.orderId, lineItem.name);
}
} else {
Console.WriteLine("No line items created.");
}
} catch (Exception e) {
Console.WriteLine("Failed to create line items. Exception says \"{0}\"",
e.Message);
}
}