/// <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.v201302.LineItemService);
// Sets defaults for page and Statement.
LineItemPage page = new LineItemPage();
Statement statement = new Statement();
int offset = 0;
try {
do {
// Create a Statement to get all line items.
statement.query = string.Format("LIMIT 500 OFFSET {0}", offset);
// Get line items by Statement.
page = lineItemService.getLineItemsByStatement(statement);
if (page.results != null && page.results.Length > 0) {
int i = page.startIndex;
foreach (LineItemSummary lineItem in page.results) {
Console.WriteLine("{0}) Line item with ID = '{1}', belonging to order ID ='{2}'" +
" , and named '{3}' was found.", i, lineItem.id, lineItem.orderId,
lineItem.name);
i++;
}
}
offset += 500;
} while (offset < page.totalResultSetSize);
Console.WriteLine("Number of results found: {0}", page.totalResultSetSize);
} catch (Exception ex) {
Console.WriteLine("Failed to get line items. 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 LineItemService.
LineItemService lineItemService =
(LineItemService) user.GetService(DfpService.v201302.LineItemService);
// Get the ReportService.
ReportService reportService =
(ReportService) user.GetService(DfpService.v201302.ReportService);
try {
// Set the ID of the order to get line items from.
long orderId = long.Parse(_T("INSERT_ORDER_ID_HERE"));
// Sets defaults for page and filterStatement.
LineItemPage page = new LineItemPage();
int offset = 0;
// Create a statement to only select line items from a given order.
String filterText = "WHERE orderId = :orderId LIMIT 500";
Statement filterStatement =
new StatementBuilder(filterText).AddValue("orderId", orderId).ToStatement();
// Collect all line item custom field IDs for an order.
List<long> customFieldIds = new List<long>();
do {
filterStatement.query = filterText + " OFFSET " + offset;
// Get line items by statement.
page = lineItemService.getLineItemsByStatement(filterStatement);
// Get custom field IDs from the line items of an order.
if (page.results != null) {
foreach (LineItem lineItem in page.results) {
if (lineItem.customFieldValues != null) {
foreach (BaseCustomFieldValue customFieldValue in lineItem.customFieldValues) {
if (!customFieldIds.Contains(customFieldValue.customFieldId)) {
customFieldIds.Add(customFieldValue.customFieldId);
}
}
}
}
}
offset += 500;
} while (offset < page.totalResultSetSize);
// Create statement to filter for an order.
filterStatement =
new StatementBuilder("WHERE ORDER_ID = :orderId").AddValue("orderId", orderId)
.ToStatement();
// Create report job.
ReportJob reportJob = new ReportJob();
// Create report query.
ReportQuery reportQuery = new ReportQuery();
reportQuery.dateRangeType = DateRangeType.LAST_MONTH;
reportQuery.dimensions = new Dimension[] {Dimension.LINE_ITEM_ID, Dimension.LINE_ITEM_NAME};
reportQuery.statement = filterStatement;
reportQuery.customFieldIds = customFieldIds.ToArray();
reportQuery.columns = new Column[] {Column.AD_SERVER_IMPRESSIONS};
reportJob.reportQuery = reportQuery;
// Run report job.
reportJob = reportService.runReportJob(reportJob);
do {
Console.WriteLine("Report with ID '{0}' is still running.", reportJob.id);
Thread.Sleep(30000);
// Get report job.
reportJob = reportService.getReportJob(reportJob.id);
} while (reportJob.reportJobStatus == ReportJobStatus.IN_PROGRESS);
if (reportJob.reportJobStatus == ReportJobStatus.FAILED) {
Console.WriteLine("Report job with ID '{0}' failed to finish successfully.",
reportJob.id);
} else {
Console.WriteLine("Report job with ID '{0}' completed successfully.", reportJob.id);
}
} catch (Exception ex) {
Console.WriteLine("Failed to run cusom fields report. 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 LineItemService.
LineItemService lineItemService =
(LineItemService) user.GetService(DfpService.v201302.LineItemService);
// Set the ID of the order to get line items from.
long orderId = long.Parse(_T("INSERT_ORDER_ID_HERE"));
// Create Statement text to select approved line items from a given order.
string statementText = "WHERE orderId = :orderId and status = :status LIMIT 500";
Statement statement = new StatementBuilder("").AddValue("orderId", orderId).
AddValue("status", ComputedStatus.NEEDS_CREATIVES.ToString()).ToStatement();
// Set defaults for page and offset.
LineItemPage page = new LineItemPage();
int offset = 0;
int i = 0;
List<string> lineItemIds = new List<string>();
try {
do {
// Create a Statement to page through approved line items.
statement.query = string.Format("{0} OFFSET {1}", statementText, offset);
// Get line items by Statement.
page = lineItemService.getLineItemsByStatement(statement);
if (page.results != null && page.results.Length > 0) {
foreach (LineItemSummary lineItem in page.results) {
// Archived line items cannot be activated.
if (!lineItem.isArchived) {
Console.WriteLine("{0}) Line item with ID ='{1}', belonging to order ID ='{2}' " +
"and name ='{2}' will be activated.", i, lineItem.id, lineItem.orderId,
lineItem.name);
lineItemIds.Add(lineItem.id.ToString());
i++;
}
}
}
offset += 500;
} while (offset < page.totalResultSetSize);
Console.WriteLine("Number of line items to be activated: {0}", lineItemIds.Count);
if (lineItemIds.Count > 0) {
// Create action Statement.
statement = new StatementBuilder(
string.Format("WHERE id IN ({0})", string.Join(",", lineItemIds.ToArray()))).
ToStatement();
// Create action.
ActivateLineItems action = new ActivateLineItems();
// Perform action.
UpdateResult result = lineItemService.performLineItemAction(action, statement);
// Display results.
if (result != null && result.numChanges > 0) {
Console.WriteLine("Number of line items activated: {0}", result.numChanges);
} else {
Console.WriteLine("No line items were activated.");
}
}
} catch (Exception ex) {
Console.WriteLine("Failed to activate line items. Exception says \"{0}\"",
ex.Message);
}
}