Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdManager.v202208.LiveStreamEventService Class Reference

Provides methods for creating, updating and retrieving LiveStreamEvent objects. More...

Inheritance diagram for Google.Api.Ads.AdManager.v202208.LiveStreamEventService:
Google.Api.Ads.AdManager.v202208.ILiveStreamEventService Google.Api.Ads.AdManager.v202208.LiveStreamEventServiceInterface

Public Member Functions

 LiveStreamEventService ()
 Creates a new instance of the LiveStreamEventService class. More...
 
 LiveStreamEventService (string endpointConfigurationName)
 Creates a new instance of the LiveStreamEventService class. More...
 
 LiveStreamEventService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the LiveStreamEventService class. More...
 
 LiveStreamEventService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the LiveStreamEventService class. More...
 
 LiveStreamEventService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the LiveStreamEventService class. More...
 
virtual
Google.Api.Ads.AdManager.v202208.LiveStreamEvent[] 
createLiveStreamEvents (Google.Api.Ads.AdManager.v202208.LiveStreamEvent[] liveStreamEvents)
 Creates new LiveStreamEvent objects. The following fields are required: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.LiveStreamEvent[]> 
createLiveStreamEventsAsync (Google.Api.Ads.AdManager.v202208.LiveStreamEvent[] liveStreamEvents)
 
virtual
Google.Api.Ads.AdManager.v202208.Slate[] 
createSlates (Google.Api.Ads.AdManager.v202208.Slate[] slates)
 Create new slates. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.Slate[]> 
createSlatesAsync (Google.Api.Ads.AdManager.v202208.Slate[] slates)
 
virtual
Google.Api.Ads.AdManager.v202208.LiveStreamEventPage 
getLiveStreamEventsByStatement (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Gets a LiveStreamEventPage of LiveStreamEvent objects that satisfy the given Statement::query. The following fields are supported for filtering: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.LiveStreamEventPage
getLiveStreamEventsByStatementAsync (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.SlatePage 
getSlatesByStatement (Google.Api.Ads.AdManager.v202208.Statement statement)
 Gets a SlatePage of Slate objects that satisfy the given Statement::query. The following fields are supported for filtering: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.SlatePage
getSlatesByStatementAsync (Google.Api.Ads.AdManager.v202208.Statement statement)
 
virtual
Google.Api.Ads.AdManager.v202208.UpdateResult 
performLiveStreamEventAction (Google.Api.Ads.AdManager.v202208.LiveStreamEventAction liveStreamEventAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Performs actions on LiveStreamEvent objects that match the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.UpdateResult
performLiveStreamEventActionAsync (Google.Api.Ads.AdManager.v202208.LiveStreamEventAction liveStreamEventAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.UpdateResult 
performSlateAction (Google.Api.Ads.AdManager.v202208.SlateAction slateAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Performs actions on slates that match the given Statement. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.UpdateResult
performSlateActionAsync (Google.Api.Ads.AdManager.v202208.SlateAction slateAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.LiveStreamEvent[] 
updateLiveStreamEvents (Google.Api.Ads.AdManager.v202208.LiveStreamEvent[] liveStreamEvents)
 Updates the specified LiveStreamEvent objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.LiveStreamEvent[]> 
updateLiveStreamEventsAsync (Google.Api.Ads.AdManager.v202208.LiveStreamEvent[] liveStreamEvents)
 
virtual
Google.Api.Ads.AdManager.v202208.Slate[] 
updateSlates (Google.Api.Ads.AdManager.v202208.Slate[] slates)
 Update existing slates. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.Slate[]> 
updateSlatesAsync (Google.Api.Ads.AdManager.v202208.Slate[] slates)
 

Detailed Description

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.

Constructor & Destructor Documentation

Google.Api.Ads.AdManager.v202208.LiveStreamEventService.LiveStreamEventService ( )
inline

Creates a new instance of the LiveStreamEventService class.

Google.Api.Ads.AdManager.v202208.LiveStreamEventService.LiveStreamEventService ( string  endpointConfigurationName)
inline

Creates a new instance of the LiveStreamEventService class.

Google.Api.Ads.AdManager.v202208.LiveStreamEventService.LiveStreamEventService ( string  endpointConfigurationName,
string  remoteAddress 
)
inline

Creates a new instance of the LiveStreamEventService class.

Google.Api.Ads.AdManager.v202208.LiveStreamEventService.LiveStreamEventService ( string  endpointConfigurationName,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the LiveStreamEventService class.

Google.Api.Ads.AdManager.v202208.LiveStreamEventService.LiveStreamEventService ( System.ServiceModel.Channels.Binding  binding,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the LiveStreamEventService class.

Member Function Documentation

virtual Google.Api.Ads.AdManager.v202208.LiveStreamEvent [] Google.Api.Ads.AdManager.v202208.LiveStreamEventService.createLiveStreamEvents ( Google.Api.Ads.AdManager.v202208.LiveStreamEvent[]  liveStreamEvents)
inlinevirtual

Creates new LiveStreamEvent objects. The following fields are required:

Parameters
liveStreamEventsthe live stream events to create
Returns
the created live stream events with their IDs filled in

Implements Google.Api.Ads.AdManager.v202208.ILiveStreamEventService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.LiveStreamEvent[]> Google.Api.Ads.AdManager.v202208.LiveStreamEventService.createLiveStreamEventsAsync ( Google.Api.Ads.AdManager.v202208.LiveStreamEvent[]  liveStreamEvents)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.Slate [] Google.Api.Ads.AdManager.v202208.LiveStreamEventService.createSlates ( Google.Api.Ads.AdManager.v202208.Slate[]  slates)
inlinevirtual

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
slateslist of slate objects to create.
Exceptions
ApiExceptionif there is an error while fetching the logging information

Implements Google.Api.Ads.AdManager.v202208.ILiveStreamEventService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.Slate[]> Google.Api.Ads.AdManager.v202208.LiveStreamEventService.createSlatesAsync ( Google.Api.Ads.AdManager.v202208.Slate[]  slates)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.LiveStreamEventPage Google.Api.Ads.AdManager.v202208.LiveStreamEventService.getLiveStreamEventsByStatement ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual

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
filterStatementa Publisher Query Language statement to filter a list of live stream events
Returns
the live stream events that match the filter

Implements Google.Api.Ads.AdManager.v202208.LiveStreamEventServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.LiveStreamEventPage> Google.Api.Ads.AdManager.v202208.LiveStreamEventService.getLiveStreamEventsByStatementAsync ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.SlatePage Google.Api.Ads.AdManager.v202208.LiveStreamEventService.getSlatesByStatement ( Google.Api.Ads.AdManager.v202208.Statement  statement)
inlinevirtual

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
statementa Publisher Query Language statement used to filter slates
Returns
the slates that match the given filter

Implements Google.Api.Ads.AdManager.v202208.LiveStreamEventServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.SlatePage> Google.Api.Ads.AdManager.v202208.LiveStreamEventService.getSlatesByStatementAsync ( Google.Api.Ads.AdManager.v202208.Statement  statement)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.UpdateResult Google.Api.Ads.AdManager.v202208.LiveStreamEventService.performLiveStreamEventAction ( Google.Api.Ads.AdManager.v202208.LiveStreamEventAction  liveStreamEventAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual

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

Parameters
liveStreamEventActionthe action to perform
filterStatementa Publisher Query Language statement used to filter a set of live stream events
Returns
the result of the action performed

Implements Google.Api.Ads.AdManager.v202208.LiveStreamEventServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.UpdateResult> Google.Api.Ads.AdManager.v202208.LiveStreamEventService.performLiveStreamEventActionAsync ( Google.Api.Ads.AdManager.v202208.LiveStreamEventAction  liveStreamEventAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.UpdateResult Google.Api.Ads.AdManager.v202208.LiveStreamEventService.performSlateAction ( Google.Api.Ads.AdManager.v202208.SlateAction  slateAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual

Performs actions on slates that match the given Statement.

Parameters
slateActionthe action to perform
filterStatementa Publisher Query Language statement used to filter a set of slates
Returns
the result of the action performed

Implements Google.Api.Ads.AdManager.v202208.LiveStreamEventServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.UpdateResult> Google.Api.Ads.AdManager.v202208.LiveStreamEventService.performSlateActionAsync ( Google.Api.Ads.AdManager.v202208.SlateAction  slateAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.LiveStreamEvent [] Google.Api.Ads.AdManager.v202208.LiveStreamEventService.updateLiveStreamEvents ( Google.Api.Ads.AdManager.v202208.LiveStreamEvent[]  liveStreamEvents)
inlinevirtual

Updates the specified LiveStreamEvent objects.

Parameters
liveStreamEventsthe live stream events to update
Returns
the updated live stream events
Exceptions
ApiExceptionif there is an error updating the live stream events

Implements Google.Api.Ads.AdManager.v202208.ILiveStreamEventService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.LiveStreamEvent[]> Google.Api.Ads.AdManager.v202208.LiveStreamEventService.updateLiveStreamEventsAsync ( Google.Api.Ads.AdManager.v202208.LiveStreamEvent[]  liveStreamEvents)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.Slate [] Google.Api.Ads.AdManager.v202208.LiveStreamEventService.updateSlates ( Google.Api.Ads.AdManager.v202208.Slate[]  slates)
inlinevirtual

Update existing slates.

Only the slateName is editable.

Parameters
slateslist of slate objects to update.
Exceptions
ApiExceptionif there is an error while fetching the logging information

Implements Google.Api.Ads.AdManager.v202208.ILiveStreamEventService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.Slate[]> Google.Api.Ads.AdManager.v202208.LiveStreamEventService.updateSlatesAsync ( Google.Api.Ads.AdManager.v202208.Slate[]  slates)
inlinevirtual

The documentation for this class was generated from the following file: