Web Service: StreamActivityMonitorService

Port type StreamActivityMonitorServiceInterfaceSource code

1. getSamSessionsByStatement
   Source code
   Description:
   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 {@code 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"

   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getSamSessionsByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type 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 {@code 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"

   • statement - optional; type Statement
     • query - optional; type string
     • values - optional, unbounded; type String_ValueMapEntry
       This represents an entry in a map with a key of type String and value of type Value.
       • key - optional; type string
       • value - optional; type Value
   Output:
   getSamSessionsByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getSamSessionsByStatementResponse

   • rval - optional, unbounded; type SamSession
     • sessionId - optional; type string
     • isVodSession - optional; type boolean
     • streamCreateRequest - optional; type StreamCreateRequest
       • url - optional; type string
       • userAgent - optional; type string
       • reportingType - optional; type ReportingType - type string with restriction - enum { 'DISABLED', 'CLIENT', 'SERVER', 'AD_MEDIA', 'UNKNOWN' }
     • adBreaks - optional, unbounded; type AdBreak
       • rootAdResponses - optional, unbounded; type AdResponse
         • requestUrl - optional; type string
         • isVmapRequest - optional; type boolean
         • responseBody - optional; type string
         • redirectResponses - optional, unbounded; type AdResponse
           • requestUrl - optional; type string
           • isVmapRequest - optional; type boolean
           • responseBody - optional; type string
           • redirectResponses - optional, unbounded; type AdResponse
             • requestUrl - optional; type string
             • isVmapRequest - optional; type boolean
             • responseBody - optional; type string
             • redirectResponses - optional, unbounded; type AdResponse... is recursive
             • samError - optional; type SamError
               • samErrorType - optional; type SamErrorType - type string with restriction - enum { 'INTERNAL_ERROR', 'AD_REQUEST_ERROR', 'VAST_PARSE_ERROR', 'UNSUPPORTED_AD_SYSTEM', 'CANNOT_FIND_UNIQUE_TRANSCODE_ID', 'CANNOT_FIND_MEDIA_FILE_PATH', 'MISSING_INLINE_ELEMENTS', 'MAX_WRAPPER_DEPTH_REACHED', 'INVALID_AD_SEQUENCE_NUMBER', 'FAILED_PING', 'AD_TAG_PARSE_ERROR', 'VMAP_PARSE_ERROR', 'INVALID_VMAP_RESPONSE', 'NO_AD_BREAKS_IN_VMAP', 'CUSTOM_AD_SOURCE_IN_VMAP', 'AD_BREAK_TYPE_NOT_SUPPORTED', 'NEITHER_AD_SOURCE_NOR_TRACKING', 'UNKNOWN_ERROR', 'AD_POD_DROPPED_TO_MANY_AD_PODS', 'AD_POD_DROPPED_EMPTY_ADS', 'AD_BREAK_WITHOUT_AD_POD', 'TRANSCODING_IN_PROGRESS', 'UNSUPPORTED_VAST_VERSION', 'AD_POD_DROPPED_BUMPER_ERROR', 'NO_VALID_MEDIAFILES_FOUND', 'EXCEEDS_MAX_FILLER', 'SKIPPABLE_AD_NOT_SUPPORTED', 'AD_REQUEST_TIMEOUT', 'AD_POD_DROPPED_UNSUPPORTED_TYPE', 'DUPLICATE_AD_TAG', 'FOLLOW_REDIRECTS_IS_FALSE', 'AD_POD_DROPPED_INCOMPATIBLE_TIMEOFFSET', 'UNKNOWN' }
               • errorDetails - optional; type string
             • adErrors - optional, unbounded; type SamError
               • samErrorType - optional; type SamErrorType - type string with restriction - enum { 'INTERNAL_ERROR', 'AD_REQUEST_ERROR', 'VAST_PARSE_ERROR', 'UNSUPPORTED_AD_SYSTEM', 'CANNOT_FIND_UNIQUE_TRANSCODE_ID', 'CANNOT_FIND_MEDIA_FILE_PATH', 'MISSING_INLINE_ELEMENTS', 'MAX_WRAPPER_DEPTH_REACHED', 'INVALID_AD_SEQUENCE_NUMBER', 'FAILED_PING', 'AD_TAG_PARSE_ERROR', 'VMAP_PARSE_ERROR', 'INVALID_VMAP_RESPONSE', 'NO_AD_BREAKS_IN_VMAP', 'CUSTOM_AD_SOURCE_IN_VMAP', 'AD_BREAK_TYPE_NOT_SUPPORTED', 'NEITHER_AD_SOURCE_NOR_TRACKING', 'UNKNOWN_ERROR', 'AD_POD_DROPPED_TO_MANY_AD_PODS', 'AD_POD_DROPPED_EMPTY_ADS', 'AD_BREAK_WITHOUT_AD_POD', 'TRANSCODING_IN_PROGRESS', 'UNSUPPORTED_VAST_VERSION', 'AD_POD_DROPPED_BUMPER_ERROR', 'NO_VALID_MEDIAFILES_FOUND', 'EXCEEDS_MAX_FILLER', 'SKIPPABLE_AD_NOT_SUPPORTED', 'AD_REQUEST_TIMEOUT', 'AD_POD_DROPPED_UNSUPPORTED_TYPE', 'DUPLICATE_AD_TAG', 'FOLLOW_REDIRECTS_IS_FALSE', 'AD_POD_DROPPED_INCOMPATIBLE_TIMEOFFSET', 'UNKNOWN' }
               • errorDetails - optional; type string
           • samError - optional; type SamError
             • samErrorType - optional; type SamErrorType - type string with restriction - enum { 'INTERNAL_ERROR', 'AD_REQUEST_ERROR', 'VAST_PARSE_ERROR', 'UNSUPPORTED_AD_SYSTEM', 'CANNOT_FIND_UNIQUE_TRANSCODE_ID', 'CANNOT_FIND_MEDIA_FILE_PATH', 'MISSING_INLINE_ELEMENTS', 'MAX_WRAPPER_DEPTH_REACHED', 'INVALID_AD_SEQUENCE_NUMBER', 'FAILED_PING', 'AD_TAG_PARSE_ERROR', 'VMAP_PARSE_ERROR', 'INVALID_VMAP_RESPONSE', 'NO_AD_BREAKS_IN_VMAP', 'CUSTOM_AD_SOURCE_IN_VMAP', 'AD_BREAK_TYPE_NOT_SUPPORTED', 'NEITHER_AD_SOURCE_NOR_TRACKING', 'UNKNOWN_ERROR', 'AD_POD_DROPPED_TO_MANY_AD_PODS', 'AD_POD_DROPPED_EMPTY_ADS', 'AD_BREAK_WITHOUT_AD_POD', 'TRANSCODING_IN_PROGRESS', 'UNSUPPORTED_VAST_VERSION', 'AD_POD_DROPPED_BUMPER_ERROR', 'NO_VALID_MEDIAFILES_FOUND', 'EXCEEDS_MAX_FILLER', 'SKIPPABLE_AD_NOT_SUPPORTED', 'AD_REQUEST_TIMEOUT', 'AD_POD_DROPPED_UNSUPPORTED_TYPE', 'DUPLICATE_AD_TAG', 'FOLLOW_REDIRECTS_IS_FALSE', 'AD_POD_DROPPED_INCOMPATIBLE_TIMEOFFSET', 'UNKNOWN' }
             • errorDetails - optional; type string
           • adErrors - optional, unbounded; type SamError
             • samErrorType - optional; type SamErrorType - type string with restriction - enum { 'INTERNAL_ERROR', 'AD_REQUEST_ERROR', 'VAST_PARSE_ERROR', 'UNSUPPORTED_AD_SYSTEM', 'CANNOT_FIND_UNIQUE_TRANSCODE_ID', 'CANNOT_FIND_MEDIA_FILE_PATH', 'MISSING_INLINE_ELEMENTS', 'MAX_WRAPPER_DEPTH_REACHED', 'INVALID_AD_SEQUENCE_NUMBER', 'FAILED_PING', 'AD_TAG_PARSE_ERROR', 'VMAP_PARSE_ERROR', 'INVALID_VMAP_RESPONSE', 'NO_AD_BREAKS_IN_VMAP', 'CUSTOM_AD_SOURCE_IN_VMAP', 'AD_BREAK_TYPE_NOT_SUPPORTED', 'NEITHER_AD_SOURCE_NOR_TRACKING', 'UNKNOWN_ERROR', 'AD_POD_DROPPED_TO_MANY_AD_PODS', 'AD_POD_DROPPED_EMPTY_ADS', 'AD_BREAK_WITHOUT_AD_POD', 'TRANSCODING_IN_PROGRESS', 'UNSUPPORTED_VAST_VERSION', 'AD_POD_DROPPED_BUMPER_ERROR', 'NO_VALID_MEDIAFILES_FOUND', 'EXCEEDS_MAX_FILLER', 'SKIPPABLE_AD_NOT_SUPPORTED', 'AD_REQUEST_TIMEOUT', 'AD_POD_DROPPED_UNSUPPORTED_TYPE', 'DUPLICATE_AD_TAG', 'FOLLOW_REDIRECTS_IS_FALSE', 'AD_POD_DROPPED_INCOMPATIBLE_TIMEOFFSET', 'UNKNOWN' }
             • errorDetails - optional; type string
         • samError - optional; type SamError
           • samErrorType - optional; type SamErrorType - type string with restriction - enum { 'INTERNAL_ERROR', 'AD_REQUEST_ERROR', 'VAST_PARSE_ERROR', 'UNSUPPORTED_AD_SYSTEM', 'CANNOT_FIND_UNIQUE_TRANSCODE_ID', 'CANNOT_FIND_MEDIA_FILE_PATH', 'MISSING_INLINE_ELEMENTS', 'MAX_WRAPPER_DEPTH_REACHED', 'INVALID_AD_SEQUENCE_NUMBER', 'FAILED_PING', 'AD_TAG_PARSE_ERROR', 'VMAP_PARSE_ERROR', 'INVALID_VMAP_RESPONSE', 'NO_AD_BREAKS_IN_VMAP', 'CUSTOM_AD_SOURCE_IN_VMAP', 'AD_BREAK_TYPE_NOT_SUPPORTED', 'NEITHER_AD_SOURCE_NOR_TRACKING', 'UNKNOWN_ERROR', 'AD_POD_DROPPED_TO_MANY_AD_PODS', 'AD_POD_DROPPED_EMPTY_ADS', 'AD_BREAK_WITHOUT_AD_POD', 'TRANSCODING_IN_PROGRESS', 'UNSUPPORTED_VAST_VERSION', 'AD_POD_DROPPED_BUMPER_ERROR', 'NO_VALID_MEDIAFILES_FOUND', 'EXCEEDS_MAX_FILLER', 'SKIPPABLE_AD_NOT_SUPPORTED', 'AD_REQUEST_TIMEOUT', 'AD_POD_DROPPED_UNSUPPORTED_TYPE', 'DUPLICATE_AD_TAG', 'FOLLOW_REDIRECTS_IS_FALSE', 'AD_POD_DROPPED_INCOMPATIBLE_TIMEOFFSET', 'UNKNOWN' }
           • errorDetails - optional; type string
         • adErrors - optional, unbounded; type SamError
           • samErrorType - optional; type SamErrorType - type string with restriction - enum { 'INTERNAL_ERROR', 'AD_REQUEST_ERROR', 'VAST_PARSE_ERROR', 'UNSUPPORTED_AD_SYSTEM', 'CANNOT_FIND_UNIQUE_TRANSCODE_ID', 'CANNOT_FIND_MEDIA_FILE_PATH', 'MISSING_INLINE_ELEMENTS', 'MAX_WRAPPER_DEPTH_REACHED', 'INVALID_AD_SEQUENCE_NUMBER', 'FAILED_PING', 'AD_TAG_PARSE_ERROR', 'VMAP_PARSE_ERROR', 'INVALID_VMAP_RESPONSE', 'NO_AD_BREAKS_IN_VMAP', 'CUSTOM_AD_SOURCE_IN_VMAP', 'AD_BREAK_TYPE_NOT_SUPPORTED', 'NEITHER_AD_SOURCE_NOR_TRACKING', 'UNKNOWN_ERROR', 'AD_POD_DROPPED_TO_MANY_AD_PODS', 'AD_POD_DROPPED_EMPTY_ADS', 'AD_BREAK_WITHOUT_AD_POD', 'TRANSCODING_IN_PROGRESS', 'UNSUPPORTED_VAST_VERSION', 'AD_POD_DROPPED_BUMPER_ERROR', 'NO_VALID_MEDIAFILES_FOUND', 'EXCEEDS_MAX_FILLER', 'SKIPPABLE_AD_NOT_SUPPORTED', 'AD_REQUEST_TIMEOUT', 'AD_POD_DROPPED_UNSUPPORTED_TYPE', 'DUPLICATE_AD_TAG', 'FOLLOW_REDIRECTS_IS_FALSE', 'AD_POD_DROPPED_INCOMPATIBLE_TIMEOFFSET', 'UNKNOWN' }
           • errorDetails - optional; type string
       • adDecisionCreatives - optional, unbounded; type AdDecisionCreative
         • sequence - optional; type int
         • slateDurationMills - optional; type long
         • creativeDurationMills - optional; type long
         • creativeTranscode - optional; type CreativeTranscode
           • adServer - optional; type string
           • creativeIdType - optional; type CreativeTranscode.IdType - type string with restriction - enum { 'AD_ID', 'CREATIVE_ID', 'CREATIVE_ADID', 'UNIVERSAL_AD_ID', 'MEDIA_URI', 'MEDIA_URI_PATH', 'CREATIVE_ADID_WITH_FALLBACK', 'CANONICALIZED_MEDIA_URI', 'GV_REGISTRY_ID', 'UNKNOWN_ID_TYPE', 'MEDIA_URI_HASH', 'UNKNOWN' }
           • creativeId - optional; type string
         • googleVideoId - optional; type string
         • samError - optional; type SamError
           • samErrorType - optional; type SamErrorType - type string with restriction - enum { 'INTERNAL_ERROR', 'AD_REQUEST_ERROR', 'VAST_PARSE_ERROR', 'UNSUPPORTED_AD_SYSTEM', 'CANNOT_FIND_UNIQUE_TRANSCODE_ID', 'CANNOT_FIND_MEDIA_FILE_PATH', 'MISSING_INLINE_ELEMENTS', 'MAX_WRAPPER_DEPTH_REACHED', 'INVALID_AD_SEQUENCE_NUMBER', 'FAILED_PING', 'AD_TAG_PARSE_ERROR', 'VMAP_PARSE_ERROR', 'INVALID_VMAP_RESPONSE', 'NO_AD_BREAKS_IN_VMAP', 'CUSTOM_AD_SOURCE_IN_VMAP', 'AD_BREAK_TYPE_NOT_SUPPORTED', 'NEITHER_AD_SOURCE_NOR_TRACKING', 'UNKNOWN_ERROR', 'AD_POD_DROPPED_TO_MANY_AD_PODS', 'AD_POD_DROPPED_EMPTY_ADS', 'AD_BREAK_WITHOUT_AD_POD', 'TRANSCODING_IN_PROGRESS', 'UNSUPPORTED_VAST_VERSION', 'AD_POD_DROPPED_BUMPER_ERROR', 'NO_VALID_MEDIAFILES_FOUND', 'EXCEEDS_MAX_FILLER', 'SKIPPABLE_AD_NOT_SUPPORTED', 'AD_REQUEST_TIMEOUT', 'AD_POD_DROPPED_UNSUPPORTED_TYPE', 'DUPLICATE_AD_TAG', 'FOLLOW_REDIRECTS_IS_FALSE', 'AD_POD_DROPPED_INCOMPATIBLE_TIMEOFFSET', 'UNKNOWN' }
           • errorDetails - optional; type string
         • isTranscoded - optional; type boolean
         • isDropped - optional; type boolean
       • podNum - optional; type int
       • linearAbsolutePodNum - optional; type int
       • adBreakDurationMillis - optional; type long
       • filledDurationMillis - optional; type long
       • servedDurationMillis - optional; type long
       • startDateTime - optional; type DateTime
         • date - optional; type Date
           • year - optional; type int
           • month - optional; type int
           • day - optional; type int
         • hour - optional; type int
         • minute - optional; type int
         • second - optional; type int
         • timeZoneId - optional; type string
       • startTimeOffsetMillis - optional; type long
       • samError - optional; type SamError
         • samErrorType - optional; type SamErrorType - type string with restriction - enum { 'INTERNAL_ERROR', 'AD_REQUEST_ERROR', 'VAST_PARSE_ERROR', 'UNSUPPORTED_AD_SYSTEM', 'CANNOT_FIND_UNIQUE_TRANSCODE_ID', 'CANNOT_FIND_MEDIA_FILE_PATH', 'MISSING_INLINE_ELEMENTS', 'MAX_WRAPPER_DEPTH_REACHED', 'INVALID_AD_SEQUENCE_NUMBER', 'FAILED_PING', 'AD_TAG_PARSE_ERROR', 'VMAP_PARSE_ERROR', 'INVALID_VMAP_RESPONSE', 'NO_AD_BREAKS_IN_VMAP', 'CUSTOM_AD_SOURCE_IN_VMAP', 'AD_BREAK_TYPE_NOT_SUPPORTED', 'NEITHER_AD_SOURCE_NOR_TRACKING', 'UNKNOWN_ERROR', 'AD_POD_DROPPED_TO_MANY_AD_PODS', 'AD_POD_DROPPED_EMPTY_ADS', 'AD_BREAK_WITHOUT_AD_POD', 'TRANSCODING_IN_PROGRESS', 'UNSUPPORTED_VAST_VERSION', 'AD_POD_DROPPED_BUMPER_ERROR', 'NO_VALID_MEDIAFILES_FOUND', 'EXCEEDS_MAX_FILLER', 'SKIPPABLE_AD_NOT_SUPPORTED', 'AD_REQUEST_TIMEOUT', 'AD_POD_DROPPED_UNSUPPORTED_TYPE', 'DUPLICATE_AD_TAG', 'FOLLOW_REDIRECTS_IS_FALSE', 'AD_POD_DROPPED_INCOMPATIBLE_TIMEOFFSET', 'UNKNOWN' }
         • errorDetails - optional; type string
       • midrollIndex - optional; type int
       • decisionedAds - optional; type boolean
       • trackingEvents - optional, unbounded; type TrackingEvent
         • pings - optional, unbounded; type TrackingEvent.Ping
           • uri - optional; type string
           • hasError - optional; type boolean
     • startDateTime - optional; type DateTime
       • date - optional; type Date
         • year - optional; type int
         • month - optional; type int
         • day - optional; type int
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • sessionDurationMillis - optional; type long
     • contentDurationMillis - optional; type long
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   • message - optional; type string

   • errors - optional, unbounded; type ApiError
     • fieldPath - optional; type string
     • fieldPathElements - optional, unbounded; type FieldPathElement
       • field - optional; type string
       • index - optional; type int
     • trigger - optional; type string
     • errorString - optional; type string

   A fault element of type ApiException.
2. registerSessionsForMonitoring
   Source code
   Description:
   Registers the specified list of {@code 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.

   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   registerSessionsForMonitoringRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type registerSessionsForMonitoring

   Registers the specified list of {@code 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.

   • sessionIds - optional, unbounded; type string
   Output:
   registerSessionsForMonitoringResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type registerSessionsForMonitoringResponse

   • rval - optional, unbounded; type string
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   • message - optional; type string

   • errors - optional, unbounded; type ApiError
     • fieldPath - optional; type string
     • fieldPathElements - optional, unbounded; type FieldPathElement
       • field - optional; type string
       • index - optional; type int
     • trigger - optional; type string
     • errorString - optional; type string

   A fault element of type ApiException.