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

Class OrderService

java.lang.Object

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

public class OrderService
extends Object

Service containing Order helper methods.

Constructor Summary

Constructors

Constructor and Description
OrderService()

Method Summary

Modifier and Type	Method and Description
List<Long>	createOrders(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.Order> ordersToCreate) Creates the specified orders.
protected com.google.api.ads.admanager.axis.v201902.OrderServiceInterface	createOrderService(com.google.api.ads.admanager.lib.client.AdManagerSession session)
List<com.google.api.ads.admanager.axis.v201902.Order>	getOrders(com.google.api.ads.admanager.lib.client.AdManagerSession session, String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieves a filtered list of Orders.
Integer	performOrdersAction(com.google.api.ads.admanager.lib.client.AdManagerSession session, String orderActionString, String queryString, Map<String,Object> queryParams) Performs the specified Order action.
List<Long>	updateOrders(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.Order> ordersToUpdate) Updates the specified orders.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderService

public OrderService()

Method Detail

createOrderService

protected com.google.api.ads.admanager.axis.v201902.OrderServiceInterface createOrderService(com.google.api.ads.admanager.lib.client.AdManagerSession session)

getOrders

public List<com.google.api.ads.admanager.axis.v201902.Order> getOrders(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 Orders.

Parameters:

session - an API session

queryString - the query string

queryParams - the query parameters

queryOrder - the order

queryOffset - the offset

Returns:

List<Order> the list of Orders

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.)

performOrdersAction

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

Performs the specified Order action.

Parameters:

session - the API session

orderActionString - 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.)

createOrders

public List<Long> createOrders(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                               List<com.google.api.ads.admanager.axis.v201902.Order> ordersToCreate)
                        throws AdManagerApiException,
                               AdManagerCommunicationException

Creates the specified orders.

Parameters:

session - the API session

ordersToCreate - list of orders to create

Returns:

List<Long> list of created Order 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.)

updateOrders

public List<Long> updateOrders(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                               List<com.google.api.ads.admanager.axis.v201902.Order> ordersToUpdate)
                        throws AdManagerApiException,
                               AdManagerCommunicationException

Updates the specified orders.

Parameters:

session - the API session

ordersToUpdate - list of orders to update

Returns:

List<Long> list of updated order 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.)