com.google.api.ads.dfp.jaxws.v201802

Interface LiveStreamEventServiceInterface

public interface LiveStreamEventServiceInterface

Provides methods for creating, updating and retrieving LiveStreamEvent objects.

This feature is not yet openly available for DFP Video publishers. Publishers will need to apply for access for this feature through their account managers. This class was generated by the JAX-WS RI. JAX-WS RI 2.2.9-b130926.1035 Generated source version: 2.1

Method Summary

Modifier and Type	Method and Description
List<LiveStreamEvent>	createLiveStreamEvents(List<LiveStreamEvent> liveStreamEvents) Creates new LiveStreamEvent objects.
LiveStreamEventPage	getLiveStreamEventsByStatement(Statement filterStatement) Gets a LiveStreamEventPage of LiveStreamEvent objects that satisfy the given Statement.query.
UpdateResult	performLiveStreamEventAction(LiveStreamEventAction liveStreamEventAction, Statement filterStatement) Performs actions on LiveStreamEvent objects that match the given Statement.query.
List<String>	registerSessionsForMonitoring(List<String> sessionIds) Registers the specified list of sessionIds for monitoring.
List<LiveStreamEvent>	updateLiveStreamEvents(List<LiveStreamEvent> liveStreamEvents) Updates the specified LiveStreamEvent objects.

Method Detail

createLiveStreamEvents

@RequestWrapper(localName="createLiveStreamEvents",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.LiveStreamEventServiceInterfacecreateLiveStreamEvents")
 @ResponseWrapper(localName="createLiveStreamEventsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.LiveStreamEventServiceInterfacecreateLiveStreamEventsResponse")
List<LiveStreamEvent> createLiveStreamEvents(List<LiveStreamEvent> liveStreamEvents)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Creates new LiveStreamEvent objects. The following fields are required:

• LiveStreamEvent.name
• LiveStreamEvent.startDateTime
• LiveStreamEvent.endDateTime
• LiveStreamEvent.contentUrls
• LiveStreamEvent.adTags

Parameters:

liveStreamEvents - the live stream events to create

liveStreamEvents -

Returns:

the created live stream events with their IDs filled in

Throws:

ApiException_Exception

getLiveStreamEventsByStatement

@RequestWrapper(localName="getLiveStreamEventsByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.LiveStreamEventServiceInterfacegetLiveStreamEventsByStatement")
 @ResponseWrapper(localName="getLiveStreamEventsByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.LiveStreamEventServiceInterfacegetLiveStreamEventsByStatementResponse")
LiveStreamEventPage getLiveStreamEventsByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException_Exception

Gets a LiveStreamEventPage of LiveStreamEvent objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
id	LiveStreamEvent.id

Parameters:

filterStatement - a Publisher Query Language statement to filter a list of live stream events

filterStatement -

Returns:

the live stream events that match the filter

Throws:

ApiException_Exception

performLiveStreamEventAction

@RequestWrapper(localName="performLiveStreamEventAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.LiveStreamEventServiceInterfaceperformLiveStreamEventAction")
 @ResponseWrapper(localName="performLiveStreamEventActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.LiveStreamEventServiceInterfaceperformLiveStreamEventActionResponse")
UpdateResult performLiveStreamEventAction(LiveStreamEventAction liveStreamEventAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 throws ApiException_Exception

Performs actions on LiveStreamEvent objects that match the given Statement.query.

Parameters:

liveStreamEventAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of live stream events

liveStreamEventAction -

filterStatement -

Returns:

the result of the action performed

Throws:

ApiException_Exception

registerSessionsForMonitoring

@RequestWrapper(localName="registerSessionsForMonitoring",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.LiveStreamEventServiceInterfaceregisterSessionsForMonitoring")
 @ResponseWrapper(localName="registerSessionsForMonitoringResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.LiveStreamEventServiceInterfaceregisterSessionsForMonitoringResponse")
List<String> registerSessionsForMonitoring(List<String> sessionIds)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      throws ApiException_Exception

Registers the specified list of sessionIds for monitoring. Once the session IDs have been registered, all logged information about the sessions will be persisted and can be viewed via the DFP UI.

A session ID is a unique identifier of a single user watching a live stream event.

Parameters:

sessionIds - a list of session IDs to register for monitoring

sessionIds -

Returns:

the list of session IDs that were registered for monitoring

Throws:

ApiException - if there is an error registering any of the session IDs

ApiException_Exception

updateLiveStreamEvents

@RequestWrapper(localName="updateLiveStreamEvents",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.LiveStreamEventServiceInterfaceupdateLiveStreamEvents")
 @ResponseWrapper(localName="updateLiveStreamEventsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.LiveStreamEventServiceInterfaceupdateLiveStreamEventsResponse")
List<LiveStreamEvent> updateLiveStreamEvents(List<LiveStreamEvent> liveStreamEvents)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Updates the specified LiveStreamEvent objects.

Parameters:

liveStreamEvents - the live stream events to update

liveStreamEvents -

Returns:

the updated live stream events

Throws:

ApiException - if there is an error updating the live stream events

ApiException_Exception