StreamActivityMonitorService (v202505)

AI-generated Key Takeaways

• The Stream Activity Monitor Service provides operations to retrieve and register DAI session logging information.

• The getSamSessionsByStatement operation returns logging information for registered DAI sessions, filterable by session ID or debug key with a limit of 25 sessions.

• The registerSessionsForMonitoring operation allows you to register a list of session IDs to persist and view their logged information in the Ad Manager UI.

• The service defines a comprehensive list of potential errors including issues with authentication, permissions, quotas, and specific session errors.

---

Production WSDL

https://ads.google.com/apis/ads/publisher/v202505/StreamActivityMonitorService?wsdl

Namespace

https://www.google.com/apis/ads/publisher/v202505

Operations

• getSamSessionsByStatement
• registerSessionsForMonitoring

Errors

• ApiVersionError
• AuthenticationError
• CollectionSizeError
• CommonError
• FeatureError
• InternalApiError
• NotNullError
• ParseError
• PermissionError
• PublisherQueryLanguageContextError
• PublisherQueryLanguageSyntaxError
• QuotaError
• RequiredCollectionError
• RequiredError
• SamSessionError
• ServerError
• StatementError
• StringFormatError
• 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	Statement

Response

Field	Type	Description
rval	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	Enumerations UPDATE_TO_NEWER_VERSION UNKNOWN
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	Enumerations TOO_LARGE UNKNOWN
CommonError	Enumerations NOT_FOUND ALREADY_EXISTS NOT_APPLICABLE DUPLICATE_OBJECT CANNOT_UPDATE UNSUPPORTED_OPERATION CONCURRENT_MODIFICATION UNKNOWN
FeatureError	Enumerations MISSING_FEATURE UNKNOWN
InternalApiError	Enumerations UNEXPECTED_INTERNAL_API_ERROR TRANSIENT_ERROR UNKNOWN DOWNTIME ERROR_GENERATING_RESPONSE
NotNullError	Enumerations ARG1_NULL ARG2_NULL ARG3_NULL NULL UNKNOWN
ParseError	Enumerations UNPARSABLE UNKNOWN
PermissionError	Enumerations PERMISSION_DENIED UNKNOWN
PublisherQueryLanguageContextError	Enumerations UNEXECUTABLE UNKNOWN
PublisherQueryLanguageSyntaxError	Enumerations UNPARSABLE UNKNOWN
QuotaError	Enumerations EXCEEDED_QUOTA UNKNOWN REPORT_JOB_LIMIT SEGMENT_POPULATION_LIMIT
RequiredCollectionError	Enumerations REQUIRED TOO_LARGE TOO_SMALL UNKNOWN
RequiredError	Enumerations REQUIRED
SamSessionError	Enumerations COULD_NOT_REGISTER_SESSION MALFORMED_SESSION_ID INVALID_SESSION_ID INVALID_DEBUG_KEY REQUEST_EXCEEDS_SESSION_LIMIT UNKNOWN
ServerError	Enumerations SERVER_ERROR SERVER_BUSY UNKNOWN
StatementError	Enumerations VARIABLE_NOT_BOUND_TO_VALUE UNKNOWN
StringFormatError	Enumerations UNKNOWN ILLEGAL_CHARS INVALID_FORMAT
StringLengthError	Enumerations TOO_LONG TOO_SHORT UNKNOWN