Note: Reporting metrics for Programmatic Guaranteed and Preferred Deals will soon change from gross revenue to net revenue. See the Ad Manager Release notes for more information.

type SamSessionError (v202002)

Lists all errors associated with the Session Activity Monitor (SAM).


Namespace
https://www.google.com/apis/ads/publisher/v202002

Field

ApiError (inherited)

fieldPath

xsd:string

The OGNL field path to identify cause of error.

fieldPathElements

FieldPathElement[]

A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.

trigger

xsd:string

The data that caused the error.

errorString

xsd:string

A simple string representation of the error and reason.

SamSessionError

reason

SamSessionError.Reason


Enumerations
COULD_NOT_REGISTER_SESSION
SAM session could not be registered for monitoring.
MALFORMED_SESSION_ID
User specified an invalid format for a session ID.

Session IDs are UUIDs and look like "123e4567-e89b-12d3-a456-426655440000".

INVALID_SESSION_ID
Error thrown when the user specifies an invalid session ID.

An invalid session ID error is thrown in the following cases: 1. There is no data for this session. 2. There is not enough data to validate that the user has access to the session. 3. The user does not belong to the network that is associated with the live stream event code specified by the session. We lump all of these cases into a single error because we don't want users to know when they have given a real session ID belonging to a different network.

INVALID_DEBUG_KEY
Error thrown when the provided debug key does not match any session ids.
REQUEST_EXCEEDS_SESSION_LIMIT
Error thrown when the number of sessions requested exceeds the limit.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.