com.google.api.ads.admanager.axis.v201808

Class LiveStreamEventServiceSoapBindingStub

java.lang.Object

org.apache.axis.client.Stub

com.google.api.ads.admanager.axis.v201808.LiveStreamEventServiceSoapBindingStub

All Implemented Interfaces:

LiveStreamEventServiceInterface, Remote, javax.xml.rpc.Stub

public class LiveStreamEventServiceSoapBindingStub
extends org.apache.axis.client.Stub
implements LiveStreamEventServiceInterface

Field Summary

Fields inherited from class org.apache.axis.client.Stub

_call, cachedEndpoint, cachedPassword, cachedPortName, cachedProperties, cachedTimeout, cachedUsername, maintainSession, maintainSessionSet, service

Fields inherited from interface javax.xml.rpc.Stub

ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
LiveStreamEventServiceSoapBindingStub()
LiveStreamEventServiceSoapBindingStub(javax.xml.rpc.Service service)
LiveStreamEventServiceSoapBindingStub(URL endpointURL, javax.xml.rpc.Service service)

Method Summary

Modifier and Type	Method and Description
protected org.apache.axis.client.Call	createCall()
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.

Methods inherited from class org.apache.axis.client.Stub

_createCall, _getCall, _getProperty, _getPropertyNames, _getService, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, firstCall, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeader, getResponseHeaders, getResponseHeaders, getTimeout, getUsername, removeProperty, setAttachments, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setRequestHeaders, setTimeout, setUsername

Methods inherited from class java.lang.Object

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

Constructor Detail

LiveStreamEventServiceSoapBindingStub

public LiveStreamEventServiceSoapBindingStub()
                                      throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

LiveStreamEventServiceSoapBindingStub

public LiveStreamEventServiceSoapBindingStub(URL endpointURL,
                                             javax.xml.rpc.Service service)
                                      throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

LiveStreamEventServiceSoapBindingStub

public LiveStreamEventServiceSoapBindingStub(javax.xml.rpc.Service service)
                                      throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

Method Detail

createCall

protected org.apache.axis.client.Call createCall()
                                          throws RemoteException

Throws:

RemoteException

createLiveStreamEvents

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

Description copied from interface: LiveStreamEventServiceInterface

Creates new LiveStreamEvent objects. The following fields are required:

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

Specified by:

createLiveStreamEvents in interface LiveStreamEventServiceInterface

Parameters:

liveStreamEvents - the live stream events to create

Returns:

the created live stream events with their IDs filled in

Throws:

RemoteException

ApiException

getLiveStreamEventsByStatement

public LiveStreamEventPage getLiveStreamEventsByStatement(Statement filterStatement)
                                                   throws RemoteException,
                                                          ApiException

Description copied from interface: LiveStreamEventServiceInterface

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

Specified by:

getLiveStreamEventsByStatement in interface LiveStreamEventServiceInterface

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

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

Description copied from interface: LiveStreamEventServiceInterface

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

Specified by:

performLiveStreamEventAction in interface LiveStreamEventServiceInterface

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

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

Description copied from interface: LiveStreamEventServiceInterface

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 Ad Manager UI.

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

Specified by:

registerSessionsForMonitoring in interface LiveStreamEventServiceInterface

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

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

Description copied from interface: LiveStreamEventServiceInterface

Updates the specified LiveStreamEvent objects.

Specified by:

updateLiveStreamEvents in interface LiveStreamEventServiceInterface

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