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
- 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:
- LiveStreamEvent.name
- LiveStreamEvent.startDateTime
- LiveStreamEvent.endDateTime
- LiveStreamEvent.contentUrls
- LiveStreamEvent.adTags
Parameters
Field | Type | Description |
---|---|---|
liveStreamEvents
|
|
the live stream events to create |
Response
Field | Type | Description |
---|---|---|
rval
|
|
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
|
|
a Publisher Query Language statement to filter a list of live stream events |
Response
Field | Type | Description |
---|---|---|
rval
|
|
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
|
|
the action to perform |
filterStatement
|
|
a Publisher Query Language statement used to filter a set of live stream events |
Response
Field | Type | Description |
---|---|---|
rval
|
|
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
|
|
a list of session IDs to register for monitoring |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the list of session IDs that were registered for monitoring |
updateLiveStreamEvents
Updates the specified LiveStreamEvent objects.
Parameters
Field | Type | Description |
---|---|---|
liveStreamEvents
|
|
the live stream events to update |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the updated live stream events |
Errors
Error | Reasons |
---|---|
ApiVersionError
|
Errors related to the usage of API versions.
Enumerations
|
AuthenticationError
|
An error for an exception that occurred when authenticating.
Enumerations
|
CollectionSizeError
|
Error for the size of the collection being too large
Enumerations
|
CommonError
|
A place for common errors that can be used across services.
Enumerations
|
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
|
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
|
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
|
InvalidUrlError
|
Lists all errors associated with URLs.
Enumerations
|
LiveStreamEventActionError
|
Lists all errors associated with live stream event action.
Enumerations
|
LiveStreamEventCdnSettingsError
|
Lists all errors associated with LiveStreamEvent CDN configurations.
Enumerations
|
LiveStreamEventDateTimeError
|
Lists all errors associated with live stream event start and end date times.
Enumerations
|
LiveStreamEventDvrWindowError
|
Lists the errors associated with setting the LiveStreamEvent DVR window duration.
Enumerations
|
LiveStreamEventSlateError
|
Lists all errors associated with LiveStreamEvent slate creative id.
Enumerations
|
NotNullError
|
Caused by supplying a null value for an attribute that cannot be null.
Enumerations
|
NullError
|
Errors associated with violation of a NOT NULL check.
Enumerations
|
ParseError
|
Lists errors related to parsing.
Enumerations
|
PermissionError
|
Errors related to incorrect permission.
Enumerations
|
PublisherQueryLanguageContextError
|
An error that occurs while executing a PQL query contained in
a Statement object.
Enumerations
|
PublisherQueryLanguageSyntaxError
|
An error that occurs while parsing a PQL query contained in a
Statement object.
Enumerations
|
QuotaError
|
Describes a client-side error on which a user is attempting
to perform an action to which they have no quota remaining.
Enumerations
|
RangeError
|
A list of all errors associated with the Range constraint.
Enumerations
|
RequiredCollectionError
|
A list of all errors to be used for validating sizes of collections.
Enumerations
|
RequiredError
|
Errors due to missing required field.
Enumerations
|
ServerError
|
Errors related to the server.
Enumerations
|
StatementError
|
An error that occurs while parsing Statement objects.
Enumerations
|
StringFormatError
|
A list of error code for reporting invalid content of input strings.
Enumerations
|
StringLengthError
|
Errors for Strings which do not meet given length constraints.
Enumerations
|
UniqueError
|
An error for a field which must satisfy a uniqueness constraint |
VideoAdTagError
|
Lists all errors associated with live stream event ad tags.
Enumerations
|