com.google.api.ads.admanager.axis.v202008

Interface StreamActivityMonitorServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

StreamActivityMonitorServiceSoapBindingStub

public interface StreamActivityMonitorServiceInterface
extends Remote

Method Summary

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

Method Detail

getSamSessionsByStatement

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

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"

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

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