/// <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.v201311.LineItemService);
// Set the ID of the order to get line items from.
long orderId = long.Parse(_T("INSERT_ORDER_ID_HERE"));
// Create a Statement to get line items with even delivery rates.
Statement statement = new StatementBuilder("WHERE deliveryRateType = :deliveryRateType and " +
"orderId = :orderId LIMIT 500").AddValue("deliveryRateType",
DeliveryRateType.EVENLY.ToString()).AddValue("orderId", orderId).ToStatement();
try {
// Get line items by Statement.
LineItemPage page = lineItemService.getLineItemsByStatement(statement);
if (page.results != null && page.results.Length > 0)
{
LineItem[] lineItems = page.results;
List <LineItem> lineItemsToUpdate = new List <LineItem>();
// Update each local line item object by changing its delivery rate.
foreach (LineItem lineItem in lineItems)
{
// Archived line items cannot be updated.
if (!lineItem.isArchived)
{
lineItem.deliveryRateType = DeliveryRateType.AS_FAST_AS_POSSIBLE;
lineItemsToUpdate.Add(lineItem);
}
}
// Update the line items on the server.
lineItems = lineItemService.updateLineItems(lineItemsToUpdate.ToArray());
if (lineItems != null)
{
foreach (LineItem lineItem in lineItems)
{
Console.WriteLine("A line item with ID = '{0}', belonging to order ID = '{1}', " +
"named '{2}', and having delivery rate = '{3}' was updated.",
lineItem.id, lineItem.orderId, lineItem.name, lineItem.deliveryRateType);
}
}
else
{
Console.WriteLine("No line items updated.");
}
}
else
{
Console.WriteLine("No line items found to update.");
}
} catch (Exception ex) {
Console.WriteLine("Failed to update line items. Exception says \"{0}\"",
ex.Message);
}
}
/// <summary>
/// Run the code example.
/// </summary>
public void Run(DfpUser user)
{
using (LineItemService lineItemService =
(LineItemService)user.GetService(DfpService.v201802.LineItemService))
{
// Set the ID of the line item.
long lineItemId = long.Parse(_T("INSERT_LINE_ITEM_ID_HERE"));
// Create a statement to get the line item.
StatementBuilder statementBuilder = new StatementBuilder()
.Where("id = :lineItemId")
.OrderBy("id ASC")
.Limit(1)
.AddValue("lineItemId", lineItemId);
try
{
// Get line items by statement.
LineItemPage page =
lineItemService.getLineItemsByStatement(statementBuilder.ToStatement());
LineItem lineItem = page.results[0];
// Update line item object by changing its delivery rate.
lineItem.deliveryRateType = DeliveryRateType.AS_FAST_AS_POSSIBLE;
// Update the line item on the server.
LineItem[] lineItems = lineItemService.updateLineItems(new LineItem[]
{
lineItem
});
if (lineItems != null)
{
foreach (LineItem updatedLineItem in lineItems)
{
Console.WriteLine(
"A line item with ID = '{0}', belonging to order ID = '{1}', " +
"named '{2}', and having delivery rate = '{3}' was updated.",
updatedLineItem.id, updatedLineItem.orderId, updatedLineItem.name,
updatedLineItem.deliveryRateType);
}
}
else
{
Console.WriteLine("No line items updated.");
}
}
catch (Exception e)
{
Console.WriteLine("Failed to update line items. Exception says \"{0}\"",
e.Message);
}
}
}
public void TestUpdateLineItems()
{
lineItem1.costPerUnit.microAmount = 3500000;
lineItem2.costPerUnit.microAmount = 3500000;
LineItem[] localLineItems = null;
Assert.DoesNotThrow(delegate() {
localLineItems = lineItemService.updateLineItems(new LineItem[] { lineItem1, lineItem2 });
});
Assert.NotNull(localLineItems);
Assert.AreEqual(localLineItems.Length, 2);
Assert.AreEqual(localLineItems[0].id, lineItem1.id);
Assert.AreEqual(localLineItems[0].name, lineItem1.name);
Assert.AreEqual(localLineItems[0].orderId, lineItem1.orderId);
Assert.AreEqual(localLineItems[0].costPerUnit.microAmount, lineItem1.costPerUnit.microAmount);
Assert.AreEqual(localLineItems[1].id, lineItem2.id);
Assert.AreEqual(localLineItems[1].name, lineItem2.name);
Assert.AreEqual(localLineItems[1].orderId, lineItem2.orderId);
Assert.AreEqual(localLineItems[1].costPerUnit.microAmount, lineItem2.costPerUnit.microAmount);
}
/// <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.v201408.LineItemService);
long lineItemId = long.Parse(_T("INSERT_LINE_ITEM_ID_HERE"));
long[] customCriteriaIds1 =
new long[] { long.Parse(_T("INSERT_CUSTOM_TARGETING_KEY_ID_HERE")),
long.Parse(_T("INSERT_CUSTOM_TARGETING_VALUE_ID_HERE")) };
long[] customCriteriaIds2 =
new long[] { long.Parse(_T("INSERT_CUSTOM_TARGETING_KEY_ID_HERE")),
long.Parse(_T("INSERT_CUSTOM_TARGETING_VALUE_ID_HERE")) };
long[] customCriteriaIds3 =
new long[] { long.Parse(_T("INSERT_CUSTOM_TARGETING_KEY_ID_HERE")),
long.Parse(_T("INSERT_CUSTOM_TARGETING_VALUE_ID_HERE")) };
// Create custom criteria.
CustomCriteria customCriteria1 = new CustomCriteria();
customCriteria1.keyId = customCriteriaIds1[0];
customCriteria1.valueIds = new long[] { customCriteriaIds1[1] };
customCriteria1.@operator = CustomCriteriaComparisonOperator.IS;
CustomCriteria customCriteria2 = new CustomCriteria();
customCriteria2.keyId = customCriteriaIds2[0];
customCriteria2.valueIds = new long[] { customCriteriaIds2[1] };
customCriteria2.@operator = CustomCriteriaComparisonOperator.IS_NOT;
CustomCriteria customCriteria3 = new CustomCriteria();
customCriteria3.keyId = customCriteriaIds3[0];
customCriteria3.valueIds = new long[] { customCriteriaIds3[1] };
customCriteria3.@operator = CustomCriteriaComparisonOperator.IS;
// Create the custom criteria set that will resemble:
//
// (customCriteria1.key == customCriteria1.value OR
// (customCriteria2.key != customCriteria2.value AND
// customCriteria3.key == customCriteria3.value))
CustomCriteriaSet topCustomCriteriaSet = new CustomCriteriaSet();
topCustomCriteriaSet.logicalOperator = CustomCriteriaSetLogicalOperator.OR;
CustomCriteriaSet subCustomCriteriaSet = new CustomCriteriaSet();
subCustomCriteriaSet.logicalOperator = CustomCriteriaSetLogicalOperator.AND;
subCustomCriteriaSet.children =
new CustomCriteriaNode[] { customCriteria2, customCriteria3 };
topCustomCriteriaSet.children =
new CustomCriteriaNode[] { customCriteria1, subCustomCriteriaSet };
try {
StatementBuilder statementBuilder = new StatementBuilder()
.Where("id = :id")
.OrderBy("id ASC")
.Limit(1)
.AddValue("id", lineItemId);
// Set the custom criteria targeting on the line item.
LineItemPage page = lineItemService.getLineItemsByStatement(statementBuilder.ToStatement());
LineItem lineItem = page.results[0];
lineItem.targeting.customTargeting = topCustomCriteriaSet;
// Update the line items on the server.
LineItem[] updatedLineItems = lineItemService.updateLineItems(new LineItem[] { lineItem });
foreach (LineItem updatedLineItem in updatedLineItems)
{
// Display the updated line item.
Console.WriteLine("Line item with ID {0} updated with custom criteria targeting \n{1}\n",
updatedLineItem.id,
getCustomCriteriaSetString(updatedLineItem.targeting.customTargeting, 0));
}
} catch (Exception ex) {
Console.WriteLine("Failed to add custom target criteria. Exception says \"{0}\"",
ex.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 CustomFieldService.
CustomFieldService customFieldService = (CustomFieldService)user.GetService(
DfpService.v201502.CustomFieldService);
// Get the LineItemService.
LineItemService lineItemService = (LineItemService)user.GetService(
DfpService.v201502.LineItemService);
// Set the IDs of the custom fields, custom field option, and line item.
long customFieldId = long.Parse(_T("INSERT_STRING_CUSTOM_FIELD_ID_HERE"));
long customFieldOptionId = long.Parse(_T("INSERT_CUSTOM_FIELD_OPTION_ID_HERE"));
long lineItemId = long.Parse(_T("INSERT_LINE_ITEM_ID_HERE"));
try {
// Get the drop-down custom field id.
long dropDownCustomFieldId =
customFieldService.getCustomFieldOption(customFieldOptionId).customFieldId;
StatementBuilder statementBuilder = new StatementBuilder()
.Where("id = :id")
.OrderBy("id ASC")
.Limit(1)
.AddValue("id", lineItemId);
// Get the line item.
LineItemPage lineItemPage = lineItemService.getLineItemsByStatement(
statementBuilder.ToStatement());
LineItem lineItem = lineItemPage.results[0];
// Create custom field values.
List <BaseCustomFieldValue> customFieldValues = new List <BaseCustomFieldValue>();
TextValue textValue = new TextValue();
textValue.value = "Custom field value";
CustomFieldValue customFieldValue = new CustomFieldValue();
customFieldValue.customFieldId = customFieldId;
customFieldValue.value = textValue;
customFieldValues.Add(customFieldValue);
DropDownCustomFieldValue dropDownCustomFieldValue = new DropDownCustomFieldValue();
dropDownCustomFieldValue.customFieldId = dropDownCustomFieldId;
dropDownCustomFieldValue.customFieldOptionId = customFieldOptionId;
customFieldValues.Add(dropDownCustomFieldValue);
// Only add existing custom field values for different custom fields than
// the ones you are setting.
if (lineItem.customFieldValues != null)
{
foreach (BaseCustomFieldValue oldCustomFieldValue in lineItem.customFieldValues)
{
if (!(oldCustomFieldValue.customFieldId == customFieldId) &&
!(oldCustomFieldValue.customFieldId == dropDownCustomFieldId))
{
customFieldValues.Add(oldCustomFieldValue);
}
}
}
lineItem.customFieldValues = customFieldValues.ToArray();
// Update the line item on the server.
LineItem[] lineItems = lineItemService.updateLineItems(new LineItem[] { lineItem });
if (lineItems != null)
{
foreach (LineItem updatedLineItem in lineItems)
{
List <String> customFieldValueStrings = new List <String>();
foreach (BaseCustomFieldValue baseCustomFieldValue in lineItem.customFieldValues)
{
if (baseCustomFieldValue is CustomFieldValue &&
((CustomFieldValue)baseCustomFieldValue).value is TextValue)
{
customFieldValueStrings.Add("{ID: '" + baseCustomFieldValue.customFieldId
+ "', value: '"
+ ((TextValue)((CustomFieldValue)baseCustomFieldValue).value).value
+ "'}");
}
else if (baseCustomFieldValue is DropDownCustomFieldValue)
{
customFieldValueStrings.Add("{ID: '" + baseCustomFieldValue.customFieldId
+ "', custom field option ID: '"
+ ((DropDownCustomFieldValue)baseCustomFieldValue).customFieldOptionId
+ "'}");
}
}
Console.WriteLine("A line item with ID \"{0}\" set with custom field values \"{1}\".",
updatedLineItem.id, string.Join(", ", customFieldValueStrings.ToArray()));
}
}
else
{
Console.WriteLine("No line items were updated.");
}
} catch (Exception ex) {
Console.WriteLine("Failed to update line items. Exception says \"{0}\"", ex.Message);
}
}