com.google.api.ads.admanager.axis.v202105

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.
Slate[]	createSlates(Slate[] slates) Create new slates.
LiveStreamEventPage	getLiveStreamEventsByStatement(Statement filterStatement) Gets a LiveStreamEventPage of LiveStreamEvent objects that satisfy the given Statement.query.
SlatePage	getSlatesByStatement(Statement statement) Gets a SlatePage of Slate objects that satisfy the given Statement.query.
UpdateResult	performLiveStreamEventAction(LiveStreamEventAction liveStreamEventAction, Statement filterStatement) Performs actions on LiveStreamEvent objects that match the given Statement.query.
UpdateResult	performSlateAction(SlateAction slateAction, Statement filterStatement) Performs actions on slates that match the given Statement.
LiveStreamEvent[]	updateLiveStreamEvents(LiveStreamEvent[] liveStreamEvents) Updates the specified LiveStreamEvent objects.
Slate[]	updateSlates(Slate[] slates) Update existing slates.

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

createSlates

Slate[] createSlates(Slate[] slates)
              throws RemoteException,
                     ApiException

Create new slates.

A slate creative is served as backup content in a live stream event when no other creatives are eligible to be served.

Parameters:

slates - list of slate objects to create.

Throws:

ApiException - if there is an error while fetching the logging information

RemoteException

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

getSlatesByStatement

SlatePage getSlatesByStatement(Statement statement)
                        throws RemoteException,
                               ApiException

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

PQL Property	Object Property
id	Slate.id
name	Slate.name
lastModifiedDateTime	Slate.lastModifiedDateTime

Parameters:

statement - a Publisher Query Language statement used to filter slates

Returns:

the slates that match the given 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

performSlateAction

UpdateResult performSlateAction(SlateAction slateAction,
                                Statement filterStatement)
                         throws RemoteException,
                                ApiException

Performs actions on slates that match the given Statement.

Parameters:

slateAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of slates

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

updateSlates

Slate[] updateSlates(Slate[] slates)
              throws RemoteException,
                     ApiException

Update existing slates.

Only the slateName is editable.

Parameters:

slates - list of slate objects to update.

Throws:

ApiException - if there is an error while fetching the logging information

RemoteException