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

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

Metadata for a VOD session. The session expires 4 hours after its creation.

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.

#ad_tracking

def ad_tracking() -> ::Google::Cloud::Video::Stitcher::V1::AdTracking

Returns

(::Google::Cloud::Video::Stitcher::V1::AdTracking) — Required. Determines how the ad should be tracked. If [gam_vod_config][google.cloud.video.stitcher.v1.VodSession.gam_vod_config] is set, the value must be CLIENT because the IMA SDK handles ad tracking.

#ad_tracking=

def ad_tracking=(value) -> ::Google::Cloud::Video::Stitcher::V1::AdTracking

Parameter

value (::Google::Cloud::Video::Stitcher::V1::AdTracking) — Required. Determines how the ad should be tracked. If [gam_vod_config][google.cloud.video.stitcher.v1.VodSession.gam_vod_config] is set, the value must be CLIENT because the IMA SDK handles ad tracking.

Returns

(::Google::Cloud::Video::Stitcher::V1::AdTracking) — Required. Determines how the ad should be tracked. If [gam_vod_config][google.cloud.video.stitcher.v1.VodSession.gam_vod_config] is set, the value must be CLIENT because the IMA SDK handles ad tracking.

#asset_id

def asset_id() -> ::String

Returns

(::String) — Output only. The generated ID of the VodSession's source media.

#gam_settings

def gam_settings() -> ::Google::Cloud::Video::Stitcher::V1::VodSession::GamSettings

Returns

(::Google::Cloud::Video::Stitcher::V1::VodSession::GamSettings) — This field should be set with appropriate values if GAM is being used for ads.

#gam_settings=

def gam_settings=(value) -> ::Google::Cloud::Video::Stitcher::V1::VodSession::GamSettings

Parameter

value (::Google::Cloud::Video::Stitcher::V1::VodSession::GamSettings) — This field should be set with appropriate values if GAM is being used for ads.

Returns

(::Google::Cloud::Video::Stitcher::V1::VodSession::GamSettings) — This field should be set with appropriate values if GAM is being used for ads.

#interstitials

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

Returns

(::Google::Cloud::Video::Stitcher::V1::Interstitials) — Output only. Metadata of what was stitched into the content.

#manifest_options

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

Returns

(::Google::Cloud::Video::Stitcher::V1::ManifestOptions) — Additional options that affect the output of the manifest.

#manifest_options=

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

Parameter

value (::Google::Cloud::Video::Stitcher::V1::ManifestOptions) — Additional options that affect the output of the manifest.

Returns

(::Google::Cloud::Video::Stitcher::V1::ManifestOptions) — Additional options that affect the output of the manifest.

#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.