(::Google::Protobuf::Map{::String => ::String}) — Key value pairs for ad tag macro replacement, only available for VOD
sessions that do not implement Google Ad manager ad insertion. 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"
value (::Google::Protobuf::Map{::String => ::String}) — Key value pairs for ad tag macro replacement, only available for VOD
sessions that do not implement Google Ad manager ad insertion. 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, only available for VOD
sessions that do not implement Google Ad manager ad insertion. 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
defad_tag_uri()->::String
Returns
(::String) — Ad tag URI. For most use cases, you should create a
VodConfig with this information
rather than setting this field directly.
#ad_tag_uri=
defad_tag_uri=(value)->::String
Parameter
value (::String) — Ad tag URI. For most use cases, you should create a
VodConfig with this information
rather than setting this field directly.
Returns
(::String) — Ad tag URI. For most use cases, you should create a
VodConfig with this information
rather than setting this field directly.
(::String) — Output only. The name of the VOD session, in the form of
projects/{project_number}/locations/{location}/vodSessions/{id}.
#play_uri
defplay_uri()->::String
Returns
(::String) — Output only. The playback URI of the stitched content.
#source_uri
defsource_uri()->::String
Returns
(::String) — URI of the media to stitch. For most use cases, you should create a
VodConfig with this information
rather than setting this field directly.
#source_uri=
defsource_uri=(value)->::String
Parameter
value (::String) — URI of the media to stitch. For most use cases, you should create a
VodConfig with this information
rather than setting this field directly.
Returns
(::String) — URI of the media to stitch. For most use cases, you should create a
VodConfig with this information
rather than setting this field directly.
#vod_config
defvod_config()->::String
Returns
(::String) — The resource name of the VOD config for this session, in the form of
projects/{project}/locations/{location}/vodConfigs/{id}.
#vod_config=
defvod_config=(value)->::String
Parameter
value (::String) — The resource name of the VOD config for this session, in the form of
projects/{project}/locations/{location}/vodConfigs/{id}.
Returns
(::String) — The resource name of the VOD config for this session, in the form of
projects/{project}/locations/{location}/vodConfigs/{id}.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Video Stitcher V1 API - Class Google::Cloud::Video::Stitcher::V1::VodSession (v1.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.0 (latest)](/ruby/docs/reference/google-cloud-video-stitcher-v1/latest/Google-Cloud-Video-Stitcher-V1-VodSession)\n- [1.2.1](/ruby/docs/reference/google-cloud-video-stitcher-v1/1.2.1/Google-Cloud-Video-Stitcher-V1-VodSession)\n- [1.1.0](/ruby/docs/reference/google-cloud-video-stitcher-v1/1.1.0/Google-Cloud-Video-Stitcher-V1-VodSession)\n- [1.0.1](/ruby/docs/reference/google-cloud-video-stitcher-v1/1.0.1/Google-Cloud-Video-Stitcher-V1-VodSession)\n- [0.10.0](/ruby/docs/reference/google-cloud-video-stitcher-v1/0.10.0/Google-Cloud-Video-Stitcher-V1-VodSession)\n- [0.9.0](/ruby/docs/reference/google-cloud-video-stitcher-v1/0.9.0/Google-Cloud-Video-Stitcher-V1-VodSession)\n- [0.8.2](/ruby/docs/reference/google-cloud-video-stitcher-v1/0.8.2/Google-Cloud-Video-Stitcher-V1-VodSession)\n- [0.7.0](/ruby/docs/reference/google-cloud-video-stitcher-v1/0.7.0/Google-Cloud-Video-Stitcher-V1-VodSession)\n- [0.6.2](/ruby/docs/reference/google-cloud-video-stitcher-v1/0.6.2/Google-Cloud-Video-Stitcher-V1-VodSession)\n- [0.5.0](/ruby/docs/reference/google-cloud-video-stitcher-v1/0.5.0/Google-Cloud-Video-Stitcher-V1-VodSession)\n- [0.4.0](/ruby/docs/reference/google-cloud-video-stitcher-v1/0.4.0/Google-Cloud-Video-Stitcher-V1-VodSession)\n- [0.3.0](/ruby/docs/reference/google-cloud-video-stitcher-v1/0.3.0/Google-Cloud-Video-Stitcher-V1-VodSession)\n- [0.2.0](/ruby/docs/reference/google-cloud-video-stitcher-v1/0.2.0/Google-Cloud-Video-Stitcher-V1-VodSession)\n- [0.1.0](/ruby/docs/reference/google-cloud-video-stitcher-v1/0.1.0/Google-Cloud-Video-Stitcher-V1-VodSession) \nReference documentation and code samples for the Video Stitcher V1 API class Google::Cloud::Video::Stitcher::V1::VodSession.\n\nMetadata for a VOD session. The session expires 4 hours after its creation. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #ad_tag_macro_map\n\n def ad_tag_macro_map() -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Key value pairs for ad tag macro replacement, only available for VOD sessions that do not implement Google Ad manager ad insertion. 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.\n\n Macros are designated by square brackets, for example:\n\n Ad tag URI: `\"https://doubleclick.google.com/ad/1?geo_id=[geoId]\"`\n\n Ad tag macro map: `{\"geoId\": \"123\"}`\n\n Fully qualified ad tag:\n `\"https://doubleclick.google.com/ad/1?geo_id=123\"`\n\n### #ad_tag_macro_map=\n\n def ad_tag_macro_map=(value) -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Parameter**\n\n- **value** (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Key value pairs for ad tag macro replacement, only available for VOD sessions that do not implement Google Ad manager ad insertion. 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.\n\n\n Macros are designated by square brackets, for example:\n\n Ad tag URI: `\"https://doubleclick.google.com/ad/1?geo_id=[geoId]\"`\n\n Ad tag macro map: `{\"geoId\": \"123\"}`\n\n Fully qualified ad tag:\n`\"https://doubleclick.google.com/ad/1?geo_id=123\"` \n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Key value pairs for ad tag macro replacement, only available for VOD sessions that do not implement Google Ad manager ad insertion. 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.\n\n Macros are designated by square brackets, for example:\n\n Ad tag URI: `\"https://doubleclick.google.com/ad/1?geo_id=[geoId]\"`\n\n Ad tag macro map: `{\"geoId\": \"123\"}`\n\n Fully qualified ad tag:\n `\"https://doubleclick.google.com/ad/1?geo_id=123\"`\n\n### #ad_tag_uri\n\n def ad_tag_uri() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Ad tag URI. For most use cases, you should create a [VodConfig](/ruby/docs/reference/google-cloud-video-stitcher-v1/latest/Google-Cloud-Video-Stitcher-V1-VodConfig \"Google::Cloud::Video::Stitcher::V1::VodConfig (class)\") with this information rather than setting this field directly.\n\n### #ad_tag_uri=\n\n def ad_tag_uri=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Ad tag URI. For most use cases, you should create a [VodConfig](/ruby/docs/reference/google-cloud-video-stitcher-v1/latest/Google-Cloud-Video-Stitcher-V1-VodConfig \"Google::Cloud::Video::Stitcher::V1::VodConfig (class)\") with this information rather than setting this field directly. \n**Returns**\n\n- (::String) --- Ad tag URI. For most use cases, you should create a [VodConfig](/ruby/docs/reference/google-cloud-video-stitcher-v1/latest/Google-Cloud-Video-Stitcher-V1-VodConfig \"Google::Cloud::Video::Stitcher::V1::VodConfig (class)\") with this information rather than setting this field directly.\n\n### #ad_tracking\n\n def ad_tracking() -\u003e ::Google::Cloud::Video::Stitcher::V1::AdTracking\n\n**Returns**\n\n- ([::Google::Cloud::Video::Stitcher::V1::AdTracking](./Google-Cloud-Video-Stitcher-V1-AdTracking)) --- Required. Determines how the ad should be tracked.\n\n### #ad_tracking=\n\n def ad_tracking=(value) -\u003e ::Google::Cloud::Video::Stitcher::V1::AdTracking\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Video::Stitcher::V1::AdTracking](./Google-Cloud-Video-Stitcher-V1-AdTracking)) --- Required. Determines how the ad should be tracked. \n**Returns**\n\n- ([::Google::Cloud::Video::Stitcher::V1::AdTracking](./Google-Cloud-Video-Stitcher-V1-AdTracking)) --- Required. Determines how the ad should be tracked.\n\n### #asset_id\n\n def asset_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The generated ID of the VodSession's source media.\n\n### #gam_settings\n\n def gam_settings() -\u003e ::Google::Cloud::Video::Stitcher::V1::VodSession::GamSettings\n\n**Returns**\n\n- ([::Google::Cloud::Video::Stitcher::V1::VodSession::GamSettings](./Google-Cloud-Video-Stitcher-V1-VodSession-GamSettings)) --- This field should be set with appropriate values if GAM is being used for ads.\n\n### #gam_settings=\n\n def gam_settings=(value) -\u003e ::Google::Cloud::Video::Stitcher::V1::VodSession::GamSettings\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Video::Stitcher::V1::VodSession::GamSettings](./Google-Cloud-Video-Stitcher-V1-VodSession-GamSettings)) --- This field should be set with appropriate values if GAM is being used for ads. \n**Returns**\n\n- ([::Google::Cloud::Video::Stitcher::V1::VodSession::GamSettings](./Google-Cloud-Video-Stitcher-V1-VodSession-GamSettings)) --- This field should be set with appropriate values if GAM is being used for ads.\n\n### #interstitials\n\n def interstitials() -\u003e ::Google::Cloud::Video::Stitcher::V1::Interstitials\n\n**Returns**\n\n- ([::Google::Cloud::Video::Stitcher::V1::Interstitials](./Google-Cloud-Video-Stitcher-V1-Interstitials)) --- Output only. Metadata of what was stitched into the content.\n\n### #manifest_options\n\n def manifest_options() -\u003e ::Google::Cloud::Video::Stitcher::V1::ManifestOptions\n\n**Returns**\n\n- ([::Google::Cloud::Video::Stitcher::V1::ManifestOptions](./Google-Cloud-Video-Stitcher-V1-ManifestOptions)) --- Additional options that affect the output of the manifest.\n\n### #manifest_options=\n\n def manifest_options=(value) -\u003e ::Google::Cloud::Video::Stitcher::V1::ManifestOptions\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Video::Stitcher::V1::ManifestOptions](./Google-Cloud-Video-Stitcher-V1-ManifestOptions)) --- Additional options that affect the output of the manifest. \n**Returns**\n\n- ([::Google::Cloud::Video::Stitcher::V1::ManifestOptions](./Google-Cloud-Video-Stitcher-V1-ManifestOptions)) --- Additional options that affect the output of the manifest.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The name of the VOD session, in the form of `projects/{project_number}/locations/{location}/vodSessions/{id}`.\n\n### #play_uri\n\n def play_uri() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The playback URI of the stitched content.\n\n### #source_uri\n\n def source_uri() -\u003e ::String\n\n**Returns**\n\n- (::String) --- URI of the media to stitch. For most use cases, you should create a [VodConfig](/ruby/docs/reference/google-cloud-video-stitcher-v1/latest/Google-Cloud-Video-Stitcher-V1-VodConfig \"Google::Cloud::Video::Stitcher::V1::VodConfig (class)\") with this information rather than setting this field directly.\n\n### #source_uri=\n\n def source_uri=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- URI of the media to stitch. For most use cases, you should create a [VodConfig](/ruby/docs/reference/google-cloud-video-stitcher-v1/latest/Google-Cloud-Video-Stitcher-V1-VodConfig \"Google::Cloud::Video::Stitcher::V1::VodConfig (class)\") with this information rather than setting this field directly. \n**Returns**\n\n- (::String) --- URI of the media to stitch. For most use cases, you should create a [VodConfig](/ruby/docs/reference/google-cloud-video-stitcher-v1/latest/Google-Cloud-Video-Stitcher-V1-VodConfig \"Google::Cloud::Video::Stitcher::V1::VodConfig (class)\") with this information rather than setting this field directly.\n\n### #vod_config\n\n def vod_config() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The resource name of the VOD config for this session, in the form of `projects/{project}/locations/{location}/vodConfigs/{id}`.\n\n### #vod_config=\n\n def vod_config=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The resource name of the VOD config for this session, in the form of `projects/{project}/locations/{location}/vodConfigs/{id}`. \n**Returns**\n\n- (::String) --- The resource name of the VOD config for this session, in the form of `projects/{project}/locations/{location}/vodConfigs/{id}`."]]
