Video Stitcher V1 API - Class Google::Cloud::Video::Stitcher::V1::VodSession (v0.4.0)

Reference documentation and code samples for the Video Stitcher V1 API class Google::Cloud::Video::Stitcher::V1::VodSession.

Metadata for a VOD session.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#ad_tag_macro_map

def ad_tag_macro_map() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Key value pairs for ad tag macro replacement. If the specified ad tag URI has macros, this field provides the mapping to the value that will replace the macro in the ad tag URI. Macros are designated by square brackets. For example:

    Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]"

    Ad tag macro map: {"geoId": "123"}

    Fully qualified ad tag: "https://doubleclick.google.com/ad/1?geo_id=123"`

#ad_tag_macro_map=

def ad_tag_macro_map=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Key value pairs for ad tag macro replacement. If the specified ad tag URI has macros, this field provides the mapping to the value that will replace the macro in the ad tag URI. Macros are designated by square brackets. For example:

    Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]"

    Ad tag macro map: {"geoId": "123"}

    Fully qualified ad tag: "https://doubleclick.google.com/ad/1?geo_id=123"`

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Key value pairs for ad tag macro replacement. If the specified ad tag URI has macros, this field provides the mapping to the value that will replace the macro in the ad tag URI. Macros are designated by square brackets. For example:

    Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]"

    Ad tag macro map: {"geoId": "123"}

    Fully qualified ad tag: "https://doubleclick.google.com/ad/1?geo_id=123"`

#ad_tag_uri

def ad_tag_uri() -> ::String
Returns
  • (::String) — Required. Ad tag URI.

#ad_tag_uri=

def ad_tag_uri=(value) -> ::String
Parameter
  • value (::String) — Required. Ad tag URI.
Returns
  • (::String) — Required. Ad tag URI.

#asset_id

def asset_id() -> ::String
Returns
  • (::String) — Output only. The generated ID of the VodSession's source media.

#client_ad_tracking

def client_ad_tracking() -> ::Boolean
Returns
  • (::Boolean) — Indicates whether client side ad tracking is enabled. If client side ad tracking is enabled, then the client player is expected to trigger playback and activity events itself. If this is set to false, server side ad tracking is enabled, causing the Video Stitcher service will trigger playback events on behalf of the client player.

#client_ad_tracking=

def client_ad_tracking=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Indicates whether client side ad tracking is enabled. If client side ad tracking is enabled, then the client player is expected to trigger playback and activity events itself. If this is set to false, server side ad tracking is enabled, causing the Video Stitcher service will trigger playback events on behalf of the client player.
Returns
  • (::Boolean) — Indicates whether client side ad tracking is enabled. If client side ad tracking is enabled, then the client player is expected to trigger playback and activity events itself. If this is set to false, server side ad tracking is enabled, causing the Video Stitcher service will trigger playback events on behalf of the client player.

#interstitials

def interstitials() -> ::Google::Cloud::Video::Stitcher::V1::Interstitials
Returns

#manifest_options

def manifest_options() -> ::Google::Cloud::Video::Stitcher::V1::ManifestOptions
Returns

#manifest_options=

def manifest_options=(value) -> ::Google::Cloud::Video::Stitcher::V1::ManifestOptions
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Output only. The name of the VOD session, in the form of projects/{project_number}/locations/{location}/vodSessions/{id}.

#play_uri

def play_uri() -> ::String
Returns
  • (::String) — Output only. The playback URI of the stitched content.

#source_uri

def source_uri() -> ::String
Returns
  • (::String) — Required. URI of the media to stitch.

#source_uri=

def source_uri=(value) -> ::String
Parameter
  • value (::String) — Required. URI of the media to stitch.
Returns
  • (::String) — Required. URI of the media to stitch.