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

Class PlacementService

java.lang.Object

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

public class PlacementService
extends Object

Service containing Placement helper methods.

Constructor Summary

Constructors

Constructor and Description
PlacementService()

Method Summary

Modifier and Type	Method and Description
List<Long>	createPlacements(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.Placement> placementsToCreate) Creates the specified placements.
protected com.google.api.ads.admanager.axis.v201902.PlacementServiceInterface	createPlacementService(com.google.api.ads.admanager.lib.client.AdManagerSession session)
List<com.google.api.ads.admanager.axis.v201902.Placement>	getPlacements(com.google.api.ads.admanager.lib.client.AdManagerSession session, String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieves a filtered list of Placements.
Integer	performPlacements(com.google.api.ads.admanager.lib.client.AdManagerSession session, String placementActionString, String queryString, Map<String,Object> queryParams) Perform the selected Placement action.
List<Long>	updatePlacements(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.Placement> placementsToUpdate) Updates the specified placements.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlacementService

public PlacementService()

Method Detail

createPlacementService

protected com.google.api.ads.admanager.axis.v201902.PlacementServiceInterface createPlacementService(com.google.api.ads.admanager.lib.client.AdManagerSession session)

createPlacements

public List<Long> createPlacements(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                   List<com.google.api.ads.admanager.axis.v201902.Placement> placementsToCreate)
                            throws AdManagerApiException,
                                   AdManagerCommunicationException

Creates the specified placements.

Parameters:

session - an API session

placementsToCreate - list of placements to create

Returns:

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

updatePlacements

public List<Long> updatePlacements(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                   List<com.google.api.ads.admanager.axis.v201902.Placement> placementsToUpdate)
                            throws AdManagerApiException,
                                   AdManagerCommunicationException

Updates the specified placements.

Parameters:

session - the API session

placementsToUpdate - list of placements to update

Returns:

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

performPlacements

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

Perform the selected Placement action.

Parameters:

session - the API session

placementActionString - the action

queryString - the query

queryParams - the query parameters

Returns:

Integer the number of affected rows

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

getPlacements

public List<com.google.api.ads.admanager.axis.v201902.Placement> getPlacements(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 Placements.

Parameters:

session - the API session

queryString - the query

queryParams - the query parameters

queryOrder - the order

queryOffset - the offset

Returns:

List<Placement> list of placements

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