// Copyright 2012 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 v201311.lineitemservice;
import com.google.api.ads.dfp.lib.DfpService;
import com.google.api.ads.dfp.lib.DfpServiceLogger;
import com.google.api.ads.dfp.lib.DfpUser;
import com.google.api.ads.dfp.lib.utils.v201311.StatementBuilder;
import com.google.api.ads.dfp.v201311.ComputedStatus;
import com.google.api.ads.dfp.v201311.LineItem;
import com.google.api.ads.dfp.v201311.LineItemPage;
import com.google.api.ads.dfp.v201311.LineItemServiceInterface;
import com.google.api.ads.dfp.v201311.Statement;
/**
* This example gets all line items that need creatives for the given order.
* The statement retrieves up to the maximum page size limit of 500. To create
* line items, run CreateLineItemsExample.java. To determine which orders exist,
* run GetAllOrdersExample.java.
*
* Tags: LineItemService.getLineItemsByStatement
*
* @author api.arogal@gmail.com (Adam Rogal)
*/
public class GetLineItemsByStatementExample {
public static void main(String[] args) {
try {
// Log SOAP XML request and response.
DfpServiceLogger.log();
// Get DfpUser from "~/dfp.properties".
DfpUser user = new DfpUser();
// Get the LineItemService.
LineItemServiceInterface lineItemService =
user.getService(DfpService.V201311.LINEITEM_SERVICE);
// Set the ID of the order to get line items from.
Long orderId = Long.parseLong("INSERT_ORDER_ID_HERE");
// Create a statement to only select line items that need creatives from a
// given order.
Statement filterStatement =
new StatementBuilder("WHERE orderId = :orderId AND status = :status LIMIT 500")
.putValue("orderId", orderId)
.putValue("status", ComputedStatus.NEEDS_CREATIVES.toString())
.toStatement();
// Get line items by statement.
LineItemPage page = lineItemService.getLineItemsByStatement(filterStatement);
if (page.getResults() != null) {
int i = page.getStartIndex();
for (LineItem lineItem : page.getResults()) {
System.out.println(i + ") Line item with ID \""
+ lineItem.getId() + "\", belonging to order ID \""
+ lineItem.getOrderId() + "\", and named \"" + lineItem.getName()
+ "\" was found.");
i++;
}
}
System.out.println("Number of results found: " + page.getTotalResultSetSize());
} catch (Exception e) {
e.printStackTrace();
}
}
}