com.google.api.ads.dfp.axis.v201708

Interface LiveStreamEventServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

LiveStreamEventServiceSoapBindingStub

public interface LiveStreamEventServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
LiveStreamEvent[]	createLiveStreamEvents(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.
String[]	registerSessionsForMonitoring(String[] sessionIds) Registers the specified list of sessionIds for monitoring.
LiveStreamEvent[]	updateLiveStreamEvents(LiveStreamEvent[] liveStreamEvents) Updates the specified LiveStreamEvent objects.

Method Detail

createLiveStreamEvents

LiveStreamEvent[] createLiveStreamEvents(LiveStreamEvent[] liveStreamEvents)
                                  throws RemoteException,
                                         ApiException

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

Returns:

the created live stream events with their IDs filled in

Throws:

RemoteException

ApiException

getLiveStreamEventsByStatement

LiveStreamEventPage getLiveStreamEventsByStatement(Statement filterStatement)
                                            throws RemoteException,
                                                   ApiException

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

Returns:

the live stream events that match the filter

Throws:

RemoteException

ApiException

performLiveStreamEventAction

UpdateResult performLiveStreamEventAction(LiveStreamEventAction liveStreamEventAction,
                                          Statement filterStatement)
                                   throws RemoteException,
                                          ApiException

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

registerSessionsForMonitoring

String[] registerSessionsForMonitoring(String[] sessionIds)
                                throws RemoteException,
                                       ApiException

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

Returns:

the list of session IDs that were registered for monitoring

Throws:

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

RemoteException

updateLiveStreamEvents

LiveStreamEvent[] updateLiveStreamEvents(LiveStreamEvent[] liveStreamEvents)
                                  throws RemoteException,
                                         ApiException

Updates the specified LiveStreamEvent objects.

Parameters:

liveStreamEvents - the live stream events to update

Returns:

the updated live stream events

Throws:

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

RemoteException