org.mule.modules.google.dfp.premium.services

Class LineItemService

java.lang.Object

org.mule.modules.google.dfp.premium.services.LineItemService

public class LineItemService
extends Object

Service containing Line Item helper methods.

Constructor Summary

Constructors

Constructor and Description
LineItemService()

Method Summary

Modifier and Type	Method and Description
List<Long>	createLineItems(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.LineItem> lineItemsToCreate) Creates the specified Line Items.
protected com.google.api.ads.admanager.axis.v201902.LineItemServiceInterface	createLineItemService(com.google.api.ads.admanager.lib.client.AdManagerSession session)
List<com.google.api.ads.admanager.axis.v201902.LineItem>	getLineItems(com.google.api.ads.admanager.lib.client.AdManagerSession session, String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieves a filtered list of Line Items.
Integer	performLineItemsAction(com.google.api.ads.admanager.lib.client.AdManagerSession session, String lineItemActionString, String queryString, Map<String,Object> queryParams) Performs the specified Line Item action.
List<Long>	updateLineItems(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.LineItem> lineItemsToUpdate) Update the specified Line Items.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LineItemService

public LineItemService()

Method Detail

createLineItemService

protected com.google.api.ads.admanager.axis.v201902.LineItemServiceInterface createLineItemService(com.google.api.ads.admanager.lib.client.AdManagerSession session)

getLineItems

public List<com.google.api.ads.admanager.axis.v201902.LineItem> getLineItems(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                                                             String queryString,
                                                                             Map<String,Object> queryParams,
                                                                             String queryOrder,
                                                                             Integer queryOffset)
                                                                      throws AdManagerApiException,
                                                                             AdManagerCommunicationException

Retrieves a filtered list of Line Items.

Parameters:

session - the API session

queryString - the query

queryParams - the query parameters

queryOrder - the order

queryOffset - the offset

Returns:

List<LineItem> list of line items

Throws:

AdManagerApiException - if there is a problem with the request made to the API.

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)

performLineItemsAction

public Integer performLineItemsAction(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                      String lineItemActionString,
                                      String queryString,
                                      Map<String,Object> queryParams)
                               throws AdManagerException

Performs the specified Line Item action.

Parameters:

session - the API session

lineItemActionString - the action

queryString - the query

queryParams - the query parameters

Returns:

Integer the number of affected records

Throws:

AdManagerException - AdManagerApiException if there is a problem with the request made to the API. AdManagerCommunicationException if there is a communication problem with the API (such as timeouts etc.)

createLineItems

public List<Long> createLineItems(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                  List<com.google.api.ads.admanager.axis.v201902.LineItem> lineItemsToCreate)
                           throws AdManagerApiException,
                                  AdManagerCommunicationException

Creates the specified Line Items.

Parameters:

session - the API session

lineItemsToCreate - list of LineItems to create

Returns:

List<Long> list of created LineItems IDs

Throws:

AdManagerApiException - if there is a problem with the request made to the API.

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)

updateLineItems

public List<Long> updateLineItems(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                  List<com.google.api.ads.admanager.axis.v201902.LineItem> lineItemsToUpdate)
                           throws AdManagerApiException,
                                  AdManagerCommunicationException

Update the specified Line Items.

Parameters:

session - the API session

lineItemsToUpdate - the LineItems to update

Returns:

List<Long> the updated LineItems IDs

Throws:

AdManagerApiException - if there is a problem with the request made to the API.

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)