# StreamActivityMonitorService (v202602)

Provides methods for registering and retrieving [SamSession](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.SamSession) objects.

*** ** * ** ***

Production WSDL
:
    `
    https://ads.google.com/apis/ads/publisher/v202602/StreamActivityMonitorService?wsdl
    `

Namespace
:
    `https://www.google.com/apis/ads/publisher/v202602`

Operations
:
    - [getSamSessionsByStatement](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#getSamSessionsByStatement)
    - [registerSessionsForMonitoring](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#registerSessionsForMonitoring)

Errors
:
    - [ApiVersionError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#ApiVersionError)
    - [AuthenticationError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#AuthenticationError)
    - [CollectionSizeError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#CollectionSizeError)
    - [CommonError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#CommonError)
    - [FeatureError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#FeatureError)
    - [InternalApiError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#InternalApiError)
    - [NotNullError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#NotNullError)
    - [ParseError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#ParseError)
    - [PermissionError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#PermissionError)
    - [PublisherQueryLanguageContextError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#PublisherQueryLanguageContextError)
    - [PublisherQueryLanguageSyntaxError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#PublisherQueryLanguageSyntaxError)
    - [QuotaError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#QuotaError)
    - [RequiredCollectionError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#RequiredCollectionError)
    - [RequiredError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#RequiredError)
    - [SamSessionError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#SamSessionError)
    - [ServerError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#ServerError)
    - [StatementError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#StatementError)
    - [StringFormatError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#StringFormatError)
    - [StringLengthError](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService#StringLengthError)

## getSamSessionsByStatement


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

| Field | Type | Description |
|---|---|---|
| `statement` | `` ` https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.Statement ` `` |   |

### Response

| Field | Type | Description |
|---|---|---|
| `rval` | `` ` https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.SamSession[]` `` |   |

## registerSessionsForMonitoring


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

| Field | Type | Description |
|---|---|---|
| `sessionIds` | `` ` xsd:string[]` `` |   |

### Response

| Field | Type | Description |
|---|---|---|
| `rval` | `` ` xsd:string[]` `` |   |

## Errors

| Error | Reasons |
|---|---|
| [`ApiVersionError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.ApiVersionError) | *** ** * ** *** **Enumerations** `UPDATE_TO_NEWER_VERSION` : `UNKNOWN` : |
| [`AuthenticationError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.AuthenticationError) | *** ** * ** *** **Enumerations** `AMBIGUOUS_SOAP_REQUEST_HEADER` : `INVALID_EMAIL` : `AUTHENTICATION_FAILED` : `INVALID_OAUTH_SIGNATURE` : `INVALID_SERVICE` : `MISSING_SOAP_REQUEST_HEADER` : `MISSING_AUTHENTICATION_HTTP_HEADER` : `MISSING_AUTHENTICATION` : `NETWORK_API_ACCESS_DISABLED` : `NO_NETWORKS_TO_ACCESS` : `NETWORK_NOT_FOUND` : `NETWORK_CODE_REQUIRED` : `CONNECTION_ERROR` : `GOOGLE_ACCOUNT_ALREADY_ASSOCIATED_WITH_NETWORK` : `UNDER_INVESTIGATION` : `UNKNOWN` : |
| [`CollectionSizeError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.CollectionSizeError) | *** ** * ** *** **Enumerations** `TOO_LARGE` : `UNKNOWN` : |
| [`CommonError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.CommonError) | *** ** * ** *** **Enumerations** `NOT_FOUND` : `ALREADY_EXISTS` : `NOT_APPLICABLE` : `DUPLICATE_OBJECT` : `CANNOT_UPDATE` : `UNSUPPORTED_OPERATION` : `CONCURRENT_MODIFICATION` : `REQUEST_TOO_LARGE` : `UNKNOWN` : |
| [`FeatureError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.FeatureError) | *** ** * ** *** **Enumerations** `MISSING_FEATURE` : `UNKNOWN` : |
| [`InternalApiError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.InternalApiError) | *** ** * ** *** **Enumerations** `UNEXPECTED_INTERNAL_API_ERROR` : `TRANSIENT_ERROR` : `UNKNOWN` : `DOWNTIME` : `ERROR_GENERATING_RESPONSE` : |
| [`NotNullError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.NotNullError) | *** ** * ** *** **Enumerations** `ARG1_NULL` : `ARG2_NULL` : `ARG3_NULL` : `NULL` : `UNKNOWN` : |
| [`ParseError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.ParseError) | *** ** * ** *** **Enumerations** `UNPARSABLE` : `UNKNOWN` : |
| [`PermissionError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.PermissionError) | *** ** * ** *** **Enumerations** `PERMISSION_DENIED` : `UNKNOWN` : |
| [`PublisherQueryLanguageContextError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.PublisherQueryLanguageContextError) | *** ** * ** *** **Enumerations** `UNEXECUTABLE` : `UNKNOWN` : |
| [`PublisherQueryLanguageSyntaxError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.PublisherQueryLanguageSyntaxError) | *** ** * ** *** **Enumerations** `UNPARSABLE` : `UNKNOWN` : |
| [`QuotaError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.QuotaError) | *** ** * ** *** **Enumerations** `EXCEEDED_QUOTA` : `UNKNOWN` : `REPORT_JOB_LIMIT` : `SEGMENT_POPULATION_LIMIT` : |
| [`RequiredCollectionError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.RequiredCollectionError) | *** ** * ** *** **Enumerations** `REQUIRED` : `TOO_LARGE` : `TOO_SMALL` : `UNKNOWN` : |
| [`RequiredError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.RequiredError) | *** ** * ** *** **Enumerations** `REQUIRED` : |
| [`SamSessionError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.SamSessionError) | *** ** * ** *** **Enumerations** `COULD_NOT_REGISTER_SESSION` : `MALFORMED_SESSION_ID` : `INVALID_SESSION_ID` : `INVALID_DEBUG_KEY` : `REQUEST_EXCEEDS_SESSION_LIMIT` : `UNKNOWN` : |
| [`ServerError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.ServerError) | *** ** * ** *** **Enumerations** `SERVER_ERROR` : `SERVER_BUSY` : `UNKNOWN` : |
| [`StatementError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.StatementError) | *** ** * ** *** **Enumerations** `VARIABLE_NOT_BOUND_TO_VALUE` : `UNKNOWN` : |
| [`StringFormatError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.StringFormatError) | *** ** * ** *** **Enumerations** `UNKNOWN` : `ILLEGAL_CHARS` : `INVALID_FORMAT` : |
| [`StringLengthError`](https://developers.google.com/ad-manager/api/reference/v202602/StreamActivityMonitorService.StringLengthError) | *** ** * ** *** **Enumerations** `TOO_LONG` : `TOO_SHORT` : `UNKNOWN` : |