Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdManager.v202111.StreamActivityMonitorService Class Reference
Inheritance diagram for Google.Api.Ads.AdManager.v202111.StreamActivityMonitorService:
Google.Api.Ads.AdManager.v202111.IStreamActivityMonitorService Google.Api.Ads.AdManager.v202111.StreamActivityMonitorServiceInterface

Public Member Functions

 StreamActivityMonitorService ()
 Creates a new instance of the StreamActivityMonitorService class. More...
 
 StreamActivityMonitorService (string endpointConfigurationName)
 Creates a new instance of the StreamActivityMonitorService class. More...
 
 StreamActivityMonitorService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the StreamActivityMonitorService class. More...
 
 StreamActivityMonitorService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the StreamActivityMonitorService class. More...
 
 StreamActivityMonitorService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the StreamActivityMonitorService class. More...
 
virtual
Google.Api.Ads.AdManager.v202111.SamSession[] 
getSamSessionsByStatement (Google.Api.Ads.AdManager.v202111.Statement statement)
 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 More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202111.SamSession[]> 
getSamSessionsByStatementAsync (Google.Api.Ads.AdManager.v202111.Statement statement)
 
virtual string[] registerSessionsForMonitoring (string[] sessionIds)
 Registers the specified list of More...
 
virtual
System.Threading.Tasks.Task
< string[]> 
registerSessionsForMonitoringAsync (string[] sessionIds)
 

Constructor & Destructor Documentation

Google.Api.Ads.AdManager.v202111.StreamActivityMonitorService.StreamActivityMonitorService ( )
inline

Creates a new instance of the StreamActivityMonitorService class.

Google.Api.Ads.AdManager.v202111.StreamActivityMonitorService.StreamActivityMonitorService ( string  endpointConfigurationName)
inline

Creates a new instance of the StreamActivityMonitorService class.

Google.Api.Ads.AdManager.v202111.StreamActivityMonitorService.StreamActivityMonitorService ( string  endpointConfigurationName,
string  remoteAddress 
)
inline

Creates a new instance of the StreamActivityMonitorService class.

Google.Api.Ads.AdManager.v202111.StreamActivityMonitorService.StreamActivityMonitorService ( string  endpointConfigurationName,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the StreamActivityMonitorService class.

Google.Api.Ads.AdManager.v202111.StreamActivityMonitorService.StreamActivityMonitorService ( System.ServiceModel.Channels.Binding  binding,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the StreamActivityMonitorService class.

Member Function Documentation

virtual Google.Api.Ads.AdManager.v202111.SamSession [] Google.Api.Ads.AdManager.v202111.StreamActivityMonitorService.getSamSessionsByStatement ( Google.Api.Ads.AdManager.v202111.Statement  statement)
inlinevirtual

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" </tbody>

Parameters
statementPQL specifying the sessionId or debugKey to fetch logging information for. Only '=' and 'IN' expressions are supported.
Exceptions
ApiExceptionif there is an error while fetching the logging information or if there is no SAM session is associated with any of the sessionIds.

Implements Google.Api.Ads.AdManager.v202111.IStreamActivityMonitorService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202111.SamSession[]> Google.Api.Ads.AdManager.v202111.StreamActivityMonitorService.getSamSessionsByStatementAsync ( Google.Api.Ads.AdManager.v202111.Statement  statement)
inlinevirtual
virtual string [] Google.Api.Ads.AdManager.v202111.StreamActivityMonitorService.registerSessionsForMonitoring ( string[]  sessionIds)
inlinevirtual

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
sessionIdsa list of session IDs to register for monitoring
Returns
the list of session IDs that were registered for monitoring
Exceptions
ApiExceptionif there is an error registering any of the session IDs

Implements Google.Api.Ads.AdManager.v202111.IStreamActivityMonitorService.

virtual System.Threading.Tasks.Task<string[]> Google.Api.Ads.AdManager.v202111.StreamActivityMonitorService.registerSessionsForMonitoringAsync ( string[]  sessionIds)
inlinevirtual

The documentation for this class was generated from the following file: