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

Class InventoryService

java.lang.Object

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

public class InventoryService
extends Object

Service containing Inventory helper methods.

Constructor Summary

Constructors

Constructor and Description
InventoryService()

Method Summary

Modifier and Type	Method and Description
List<String>	createAdUnits(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.AdUnit> adUnitsToCreate) Creates the specified Ad Units.
protected com.google.api.ads.admanager.axis.v201902.InventoryServiceInterface	createInventoryService(com.google.api.ads.admanager.lib.client.AdManagerSession session)
List<com.google.api.ads.admanager.axis.v201902.AdUnit>	getAdUnits(com.google.api.ads.admanager.lib.client.AdManagerSession session, String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieves a filtered list of Ad Units.
List<com.google.api.ads.admanager.axis.v201902.AdUnitSize>	getAdUnitSizes(com.google.api.ads.admanager.lib.client.AdManagerSession session, String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieves a filtered list of Ad Unit Sizes.
Integer	performAdUnitsAction(com.google.api.ads.admanager.lib.client.AdManagerSession session, String adUnitActionString, String queryString, Map<String,Object> queryParams) Perform the specified Ad Unit action.
List<String>	updateAdUnits(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.AdUnit> adUnitsToUpdate) Updates the specified Ad Units.

Methods inherited from class java.lang.Object

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

Constructor Detail

InventoryService

public InventoryService()

Method Detail

createInventoryService

protected com.google.api.ads.admanager.axis.v201902.InventoryServiceInterface createInventoryService(com.google.api.ads.admanager.lib.client.AdManagerSession session)

createAdUnits

public List<String> createAdUnits(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                  List<com.google.api.ads.admanager.axis.v201902.AdUnit> adUnitsToCreate)
                           throws AdManagerApiException,
                                  AdManagerCommunicationException

Creates the specified Ad Units.

Parameters:

session - the API session

adUnitsToCreate - the Ad Units to create

Returns:

List<String> list of created Ad Units 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.)

updateAdUnits

public List<String> updateAdUnits(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                  List<com.google.api.ads.admanager.axis.v201902.AdUnit> adUnitsToUpdate)
                           throws AdManagerApiException,
                                  AdManagerCommunicationException

Updates the specified Ad Units.

Parameters:

session - the API session

adUnitsToUpdate - list of Ad Units to update

Returns:

List<String> list of updated Ad Units

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

performAdUnitsAction

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

Perform the specified Ad Unit action.

Parameters:

session - the API session

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

getAdUnits

public List<com.google.api.ads.admanager.axis.v201902.AdUnit> getAdUnits(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 Ad Units.

Parameters:

session - the API session

queryString - the query

queryParams - the query parameters

queryOrder - the order

queryOffset - the offset

Returns:

List<AdUnit> a list of retrieved Ad Units

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

getAdUnitSizes

public List<com.google.api.ads.admanager.axis.v201902.AdUnitSize> getAdUnitSizes(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 Ad Unit Sizes.

Parameters:

session - the API session

queryString - the query

queryParams - the query parameters

queryOrder - the order

queryOffset - the offset

Returns:

List<AdUnitSize> list of Ad Unit Sizes

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