LiveStreamEventService (v202505)

Provides methods for creating, updating and retrieving LiveStreamEvent objects.

This feature is only available for Ad Manager 360 networks. Publishers will need to be activated through the Video > Live streams tab in the Ad Manager UI. For access, apply through your account manager.

---

Production WSDL

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

Namespace

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

Operations

• createLiveStreamEvents
• createSlates
• getLiveStreamEventsByStatement
• getSlatesByStatement
• performLiveStreamEventAction
• performSlateAction
• updateLiveStreamEvents
• updateSlates

Errors

• AdBreakMarkupError
• ApiVersionError
• AuthenticationError
• CollectionSizeError
• CommonError
• EntityLimitReachedError
• FeatureError
• InternalApiError
• InvalidUrlError
• LiveStreamEventActionError
• LiveStreamEventCdnSettingsError
• LiveStreamEventConditioningError
• LiveStreamEventCustomAssetKeyError
• LiveStreamEventDateTimeError
• LiveStreamEventDvrWindowError
• LiveStreamEventPrerollSettingsError
• LiveStreamEventSlateError
• NotNullError
• NullError
• ParseError
• PermissionError
• PublisherQueryLanguageContextError
• PublisherQueryLanguageSyntaxError
• QuotaError
• RangeError
• RequiredCollectionError
• RequiredError
• RequiredNumberError
• ServerError
• StatementError
• StringFormatError
• StringLengthError
• UniqueError
• VideoAdTagError

createLiveStreamEvents

Creates new LiveStreamEvent objects.

The following fields are required:

• LiveStreamEvent.name
• LiveStreamEvent.startDateTime
• LiveStreamEvent.endDateTime
• LiveStreamEvent.contentUrls
• LiveStreamEvent.adTags

Parameters

Field	Type	Description
liveStreamEvents	LiveStreamEvent[]

Response

Field	Type	Description
rval	LiveStreamEvent[]

createSlates

Create new slates.

A slate creative is served as backup content in a live stream event when no other creatives are eligible to be served.

Parameters

Field	Type	Description
slates	Slate[]

Response

Field	Type	Description
rval	Slate[]

getLiveStreamEventsByStatement

Gets a LiveStreamEventPage of LiveStreamEvent objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
id	LiveStreamEvent.id
slateCreativeId	LiveStreamEvent.slateCreativeId
assetKey	LiveStreamEvent.assetKey
streamCreateDaiAuthenticationKeyIds	LiveStreamEvent.streamCreateDaiAuthenticationKeyIds
dynamicAdInsertionType	LiveStreamEvent.dynamicAdInsertionType
streamingFormat	LiveStreamEvent.streamingFormat
customAssetKey	LiveStreamEvent.customAssetKey
daiEncodingProfileIds	LiveStreamEvent.daiEncodingProfileIds
segmentUrlAuthenticationKeyIds	LiveStreamEvent.segmentUrlAuthenticationKeyIds

Parameters

Field	Type	Description
filterStatement	Statement

Response

Field	Type	Description
rval	LiveStreamEventPage

getSlatesByStatement

Gets a SlatePage of Slate objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
id	Slate.id
name	Slate.name
lastModifiedDateTime	Slate.lastModifiedDateTime

Parameters

Field	Type	Description
statement	Statement

Response

Field	Type	Description
rval	SlatePage

performLiveStreamEventAction

Performs actions on LiveStreamEvent objects that match the given Statement.query.

Parameters

Field	Type	Description
liveStreamEventAction	LiveStreamEventAction ActivateLiveStreamEvents ArchiveLiveStreamEvents PauseLiveStreamEventAds PauseLiveStreamEvents RefreshLiveStreamEventMaste...
filterStatement	Statement

Response

Field	Type	Description
rval	UpdateResult

performSlateAction

Performs actions on slates that match the given Statement.

Parameters

Field	Type	Description
slateAction	SlateAction ArchiveSlates UnarchiveSlates
filterStatement	Statement

Response

Field	Type	Description
rval	UpdateResult

updateLiveStreamEvents

Updates the specified LiveStreamEvent objects.

Parameters

Field	Type	Description
liveStreamEvents	LiveStreamEvent[]

Response

Field	Type	Description
rval	LiveStreamEvent[]

updateSlates

Update existing slates.

Only the slateName is editable.

Parameters

Field	Type	Description
slates	Slate[]

Response

Field	Type	Description
rval	Slate[]

Errors

Error	Reasons
AdBreakMarkupError	An error for publisher provided ad break markups in a LiveStreamEvent which are invalid for the given StreamingFormat. Enumerations INVALID_AD_BREAK_MARKUPS_FOR_STREAMING_FORMAT The ad break markups provided are not valid for the Streaming Format UNKNOWN The value returned if the actual value is not exposed by the requested API version.
ApiVersionError	Errors related to the usage of API versions. Enumerations UPDATE_TO_NEWER_VERSION Indicates that the operation is not allowed in the version the request was made in. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
AuthenticationError	An error for an exception that occurred when authenticating. Enumerations AMBIGUOUS_SOAP_REQUEST_HEADER The SOAP message contains a request header with an ambiguous definition of the authentication header fields. This means either the authToken and oAuthToken fields were both null or both were specified. Exactly one value should be specified with each request. INVALID_EMAIL The login provided is invalid. AUTHENTICATION_FAILED Tried to authenticate with provided information, but failed. INVALID_OAUTH_SIGNATURE The OAuth provided is invalid. INVALID_SERVICE The specified service to use was not recognized. MISSING_SOAP_REQUEST_HEADER The SOAP message is missing a request header with an authToken and optional networkCode. MISSING_AUTHENTICATION_HTTP_HEADER The HTTP request is missing a request header with an authToken MISSING_AUTHENTICATION The request is missing an authToken NETWORK_API_ACCESS_DISABLED The network does not have API access enabled. NO_NETWORKS_TO_ACCESS The user is not associated with any network. NETWORK_NOT_FOUND No network for the given networkCode was found. NETWORK_CODE_REQUIRED The user has access to more than one network, but did not provide a networkCode. CONNECTION_ERROR An error happened on the server side during connection to authentication service. GOOGLE_ACCOUNT_ALREADY_ASSOCIATED_WITH_NETWORK The user tried to create a test network using an account that already is associated with a network. UNDER_INVESTIGATION The account is blocked and under investigation by the collections team. Please contact Google for more information. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
CollectionSizeError	Error for the size of the collection being too large Enumerations TOO_LARGE UNKNOWN The value returned if the actual value is not exposed by the requested API version.
CommonError	A place for common errors that can be used across services. Enumerations NOT_FOUND Indicates that an attempt was made to retrieve an entity that does not exist. ALREADY_EXISTS Indicates that an attempt was made to create an entity that already exists. NOT_APPLICABLE Indicates that a value is not applicable for given use case. DUPLICATE_OBJECT Indicates that two elements in the collection were identical. CANNOT_UPDATE Indicates that an attempt was made to change an immutable field. UNSUPPORTED_OPERATION Indicates that the requested operation is not supported. CONCURRENT_MODIFICATION Indicates that another request attempted to update the same data in the same network at about the same time. Please wait and try the request again. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
EntityLimitReachedError	An error that occurs when creating an entity if the limit on the number of allowed entities for a network has already been reached. Enumerations CUSTOM_TARGETING_VALUES_LIMIT_REACHED The number of custom targeting values exceeds the max number allowed in the network. AD_EXCLUSION_RULES_LIMIT_REACHED The number of ad exclusion rules exceeds the max number allowed in the network. FIRST_PARTY_AUDIENCE_SEGMENTS_LIMIT_REACHED The number of first party audience segments exceeds the max number allowed in the network. PLACEMENTS_LIMIT_REACHED The number of active placements exceeds the max number allowed in the network. LINE_ITEMS_LIMIT_REACHED The number of line items excceeds the max number allowed in the network. ACTIVE_LINE_ITEMS_LIMIT_REACHED The number of active line items exceeds the max number allowed in the network. DAI_ENCODING_PROFILES_LIMIT_REACHED The number of not-archived encoding profiles exceeds the max number allowed in the network. TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED The number of traffic forecast segments exceeds the max number allowed in the network. FORECAST_ADJUSTMENTS_LIMIT_REACHED The number of forecast adjustments exceeds the max number allowed in the network. ACTIVE_EXPERIMENTS_LIMIT_REACHED The number of active experiments exceeds the max number allowed in the network. SITES_LIMIT_REACHED The number of sites exceeds the max number allowed in the network. USER_TEAMS_LIMIT_REACHED The number of teams on the user exceeds the max number allowed. ACTIVE_TARGETING_PRESETS_LIMIT_REACHED The count of active targeting presets exceeds the limit. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
FeatureError	Errors related to feature management. If you attempt using a feature that is not available to the current network you'll receive a FeatureError with the missing feature as the trigger. Enumerations MISSING_FEATURE A feature is being used that is not enabled on the current network. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
InternalApiError	Indicates that a server-side error has occured. InternalApiErrors are generally not the result of an invalid request or message sent by the client. Enumerations UNEXPECTED_INTERNAL_API_ERROR API encountered an unexpected internal error. TRANSIENT_ERROR A temporary error occurred during the request. Please retry. UNKNOWN The cause of the error is not known or only defined in newer versions. DOWNTIME The API is currently unavailable for a planned downtime. ERROR_GENERATING_RESPONSE Mutate succeeded but server was unable to build response. Client should not retry mutate.
InvalidUrlError	Lists all errors associated with URLs. Enumerations ILLEGAL_CHARACTERS The URL contains invalid characters. INVALID_FORMAT The format of the URL is not allowed. This could occur for a number of reasons. For example, if an invalid scheme is specified (like "ftp://") or if a port is specified when not required, or if a query was specified when not required. INSECURE_SCHEME URL contains insecure scheme. NO_SCHEME The URL does not contain a scheme. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
LiveStreamEventActionError	Lists all errors associated with live stream event action. Enumerations INVALID_STATUS_TRANSITION The operation is not applicable to the current status. IS_ARCHIVED The operation cannot be applied because the live stream event is archived. INVALID_SLATE_SETTING Both the live stream event slate and the network default slate are not set. SLATE_CREATIVE_NOT_TRANSCODED The slate creative has not been transcoded. SLATE_CREATIVE_ARCHIVED Unable to activate live stream event that has an associated archived slate. CANNOT_ACTIVATE_IF_USING_INACTIVE_DAI_AUTHENTICATION_KEYS A live stream cannot be activated if it is using inactive DAI authentication keys. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
LiveStreamEventCdnSettingsError	Lists all errors associated with LiveStreamEvent CDN configurations. Enumerations CDN_CONFIGURATIONS_MUST_HAVE_UNIQUE_CDN_URL_PREFIXES CDN configurations in a single LiveStreamEvent cannot have duplicate URL prefixes. MUST_BE_LIVE_CDN_CONFIGURATION Only CDN configurations of type VodConfigurationType.LINEAR_SOURCE_CONTENT can be listed in LiveStreamEvent.sourceContentConfigurations. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
LiveStreamEventConditioningError	Lists all errors associated with conditioning applied to a LiveStreamEvent. Enumerations CANNOT_APPLY_DASH_BRIDGE DASH bridge conditioning cannot be applied. CANNOT_UPDATE_DASH_BRIDGE_AFTER_START_TIME DASH bridge conditioning cannot be modified after start time. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
LiveStreamEventCustomAssetKeyError	Lists all errors associated with live stream event custom asset keys. Enumerations CONTAINS_INVALID_CHARACTERS Custom asset key contains invalid characters. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
LiveStreamEventDateTimeError	Lists all errors associated with live stream event start and end date times. Enumerations START_DATE_TIME_IS_IN_PAST Cannot create a new live stream event with a start date in the past. END_DATE_TIME_NOT_AFTER_START_DATE_TIME End date must be after the start date. END_DATE_TIME_TOO_LATE DateTimes after 1 January 2037 are not supported. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
LiveStreamEventDvrWindowError	Lists the errors associated with setting the LiveStreamEvent DVR window duration. Enumerations DVR_WINDOW_TOO_HIGH The DVR window cannot be higher than the value allowed for this network. DVR_WINDOW_TOO_LOW The DVR window cannot be lower than the minimum value allowed. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
LiveStreamEventPrerollSettingsError	Lists all errors associated with preroll settings applied to a LiveStreamEvent. Enumerations INVALID_PREROLL_SETTINGS Preroll settings are only supported for livestream events of dynamic ad insertion type linear. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
LiveStreamEventSlateError	Lists all errors associated with LiveStreamEvent slate creative id. Enumerations INVALID_SLATE_CREATIVE_ID The slate creative ID does not correspond to a slate creative. LIVE_STREAM_EVENT_SLATE_CREATIVE_ID_REQUIRED The required field live stream event slate is not set. There must either be a slate creative ID assigned to the live stream event or a valid network level slate selected. MISSING_SOURCE_FOR_SLATE The slate does not have a videoSourceUrl or assetSourcePath. INVALID_SLATE_TYPE The slate is of an invalid type. CANNOT_CHANGE_SLATE_VIDEO_SOURCE_URL The slate video source url cannot change. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
NotNullError	Caused by supplying a null value for an attribute that cannot be null. Enumerations ARG1_NULL Assuming that a method will not have more than 3 arguments, if it does, return NULL ARG2_NULL ARG3_NULL NULL UNKNOWN The value returned if the actual value is not exposed by the requested API version.
NullError	Errors associated with violation of a NOT NULL check. Enumerations NULL_CONTENT Specified list/container must not contain any null elements
ParseError	Lists errors related to parsing. Enumerations UNPARSABLE Indicates an error in parsing an attribute. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
PermissionError	Errors related to incorrect permission. Enumerations PERMISSION_DENIED User does not have the required permission for the request. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
PublisherQueryLanguageContextError	An error that occurs while executing a PQL query contained in a Statement object. Enumerations UNEXECUTABLE Indicates that there was an error executing the PQL. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
PublisherQueryLanguageSyntaxError	An error that occurs while parsing a PQL query contained in a Statement object. Enumerations UNPARSABLE Indicates that there was a PQL syntax error. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
QuotaError	Describes a client-side error on which a user is attempting to perform an action to which they have no quota remaining. Enumerations EXCEEDED_QUOTA The number of requests made per second is too high and has exceeded the allowable limit. The recommended approach to handle this error is to wait about 5 seconds and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time. Another way to mitigate this error is to limit requests to 8 per second for Ad Manager 360 accounts, or 2 per second for Ad Manager accounts. Once again this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error. UNKNOWN The value returned if the actual value is not exposed by the requested API version. REPORT_JOB_LIMIT This user has exceeded the allowed number of new report requests per hour (this includes both reports run via the UI and reports run via ReportService.runReportJob). The recommended approach to handle this error is to wait about 10 minutes and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time. Another way to mitigate this error is to limit the number of new report requests to 250 per hour per user. Once again, this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error. SEGMENT_POPULATION_LIMIT This network has exceeded the allowed number of identifiers uploaded within a 24 hour period. The recommended approach to handle this error is to wait 30 minutes and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time.
RangeError	A list of all errors associated with the Range constraint. Enumerations TOO_HIGH TOO_LOW UNKNOWN The value returned if the actual value is not exposed by the requested API version.
RequiredCollectionError	A list of all errors to be used for validating sizes of collections. Enumerations REQUIRED A required collection is missing. TOO_LARGE Collection size is too large. TOO_SMALL Collection size is too small. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
RequiredError	Errors due to missing required field. Enumerations REQUIRED Missing required field.
RequiredNumberError	A list of all errors to be used in conjunction with required number validators. Enumerations REQUIRED TOO_LARGE TOO_SMALL TOO_LARGE_WITH_DETAILS TOO_SMALL_WITH_DETAILS UNKNOWN The value returned if the actual value is not exposed by the requested API version.
ServerError	Errors related to the server. Enumerations SERVER_ERROR Indicates that an unexpected error occured. SERVER_BUSY Indicates that the server is currently experiencing a high load. Please wait and try your request again. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
StatementError	An error that occurs while parsing Statement objects. Enumerations VARIABLE_NOT_BOUND_TO_VALUE A bind variable has not been bound to a value. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
StringFormatError	A list of error code for reporting invalid content of input strings. Enumerations UNKNOWN ILLEGAL_CHARS The input string value contains disallowed characters. INVALID_FORMAT The input string value is invalid for the associated field.
StringLengthError	Errors for Strings which do not meet given length constraints. Enumerations TOO_LONG TOO_SHORT UNKNOWN The value returned if the actual value is not exposed by the requested API version.
UniqueError	An error for a field which must satisfy a uniqueness constraint
VideoAdTagError	Lists all errors associated with live stream event ad tags. Enumerations MISSING_REQUIRED_FIELDS One or more required fields are not specified in the ad tag. NO_LIVE_TRAFFIC Ad tag URL is not a live traffic URL. Url should start with: https://pubads.g.doubleclick.net/gampad/live/ads, not https://pubads.g.doubleclick.net/gampad/ads NO_VOD_TRAFFIC Ad tag URL is not a VOD traffic URL. Url should start with: https://pubads.g.doubleclick.net/gampad/ads , not https://pubads.g.doubleclick.net/gampad/live/ads INVALID_AD_TAG_HOST URL hostname is not a valid Google Publisher Tag or Freewheel Tag host name. INVALID_SCHEME Only HTTPS is supported. INVALID_AD_OUTPUT_FORMAT Invalid ad output format. Settings for VAST and VMAP must be aligned. UNKNOWN The value returned if the actual value is not exposed by the requested API version.