com.google.api.ads.admanager.axis.v202002

Class StreamActivityMonitorServiceSoapBindingStub

java.lang.Object

org.apache.axis.client.Stub

com.google.api.ads.admanager.axis.v202002.StreamActivityMonitorServiceSoapBindingStub

All Implemented Interfaces:

StreamActivityMonitorServiceInterface, Remote, javax.xml.rpc.Stub

public class StreamActivityMonitorServiceSoapBindingStub
extends org.apache.axis.client.Stub
implements StreamActivityMonitorServiceInterface

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
StreamActivityMonitorServiceSoapBindingStub()
StreamActivityMonitorServiceSoapBindingStub(javax.xml.rpc.Service service)
StreamActivityMonitorServiceSoapBindingStub(URL endpointURL, javax.xml.rpc.Service service)

Method Summary

Modifier and Type	Method and Description
protected org.apache.axis.client.Call	createCall()
SamSession[]	getSamSessionsByStatement(Statement statement) Returns the logging information for a DAI session.
String[]	registerSessionsForMonitoring(String[] sessionIds) Registers the specified list of sessionIds for monitoring.

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

StreamActivityMonitorServiceSoapBindingStub

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

Throws:

org.apache.axis.AxisFault

StreamActivityMonitorServiceSoapBindingStub

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

Throws:

org.apache.axis.AxisFault

StreamActivityMonitorServiceSoapBindingStub

public StreamActivityMonitorServiceSoapBindingStub(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

getSamSessionsByStatement

public SamSession[] getSamSessionsByStatement(Statement statement)
                                       throws RemoteException,
                                              ApiException

Description copied from interface: StreamActivityMonitorServiceInterface

Returns the logging information for a DAI session. A DAI session can be identified by it's session id or debug key. The session ID must be registered via the registerSessionsForMonitoring method before it can be accessed. There may be some delay before the session is available.

The number of sessions requested is limited to 25. The following fields are supported for filtering:

Entity property	PQL filter
Session id	'sessionId'
Debug key	'debugKey"

Specified by:

getSamSessionsByStatement in interface StreamActivityMonitorServiceInterface

Parameters:

statement - PQL specifying the sessionId or debugKey to fetch logging information for. Only '=' and 'IN' expressions are supported.

Throws:

ApiException - if there is an error while fetching the logging information or if there is no SAM session is associated with any of the sessionIds.

RemoteException

registerSessionsForMonitoring

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

Description copied from interface: StreamActivityMonitorServiceInterface

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 StreamActivityMonitorServiceInterface

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