LiveStreamEventService (v202002)

Provides methods for creating, updating and retrieving LiveStreamEvent objects.

This feature is not yet openly available for DFP Video publishers. Publishers will need to apply for access for this feature through their account managers.

Production WSDL


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

Namespace

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

Operations

createLiveStreamEvents
getLiveStreamEventsByStatement
performLiveStreamEventAction
registerSessionsForMonitoring
updateLiveStreamEvents

Errors

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

createLiveStreamEvents

Creates new LiveStreamEvent objects. The following fields are required:

Parameters

Field	Type	Description
`liveStreamEvents`	`LiveStreamEvent[]`	the live stream events to create

Response

Field	Type	Description
`rval`	`LiveStreamEvent[]`	the created live stream events with their IDs filled in

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

Parameters

Field	Type	Description
`filterStatement`	`Statement`	a Publisher Query Language statement to filter a list of live stream events

Response

Field	Type	Description
`rval`	`LiveStreamEventPage`	the live stream events that match the filter

performLiveStreamEventAction

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

Parameters

Field	Type	Description
`liveStreamEventAction`	`LiveStreamEventAction ActivateLiveStreamEvents ArchiveLiveStreamEvents PauseLiveStreamEventAds PauseLiveStreamEvents RefreshLiveStreamEventMaste...`	the action to perform
`filterStatement`	`Statement`	a Publisher Query Language statement used to filter a set of live stream events

Response

Field	Type	Description
`rval`	`UpdateResult`	the result of the action performed

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[]`	a list of session IDs to register for monitoring

Response

Field	Type	Description
`rval`	`xsd:string[]`	the list of session IDs that were registered for monitoring

updateLiveStreamEvents

Updates the specified LiveStreamEvent objects.

Parameters

Field	Type	Description
`liveStreamEvents`	`LiveStreamEvent[]`	the live stream events to update

Response

Field	Type	Description
`rval`	`LiveStreamEvent[]`	the updated live stream events

Errors

Error	Reasons
`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` `NOT_WHITELISTED_FOR_API_ACCESS` The customer is not whitelisted for API access. `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. `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. `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. `InternalApiError`s 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.
`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` `DateTime`s 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.
`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. `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.
`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.
`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. `UNKNOWN` The value returned if the actual value is not exposed by the requested API version.