com.google.api.ads.admanager.axis.v202005

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.
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
slateCreativeId	LiveStreamEvent.slateCreativeId
assetKey	LiveStreamEvent.assetKey
streamCreateDaiAuthenticationKeyIds	LiveStreamEvent#streamCreateDaiAuthenticationKeyIds
dynamicAdInsertionType	LiveStreamEvent#dynamicAdInsertionType
streamingFormat	LiveStreamEvent.streamingFormat
customAssetKey	LiveStreamEvent#customAssetKey
daiEncodingProfileIds	LiveStreamEvent#daiEncodingProfileIds
segmentUrlAuthenticationKeyIds	LiveStreamEvent#segmentUrlAuthenticationKeyIds

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

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