Class: Google::Cloud::Video::Stitcher::V1::VodSession

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/video/stitcher/v1/sessions.rb

Overview

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

Defined Under Namespace

Classes: AdTagMacroMapEntry, GamSettings

Instance Attribute Summary collapse

Instance Attribute Details

#ad_tag_macro_map ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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"`



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 69

class VodSession
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines fields related to Google Ad Manager (GAM). This should be set if
  # GAM is being used for ads.
  # @!attribute [rw] network_code
  #   @return [::String]
  #     Required. Ad Manager network code.
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdTagMacroMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ad_tag_uri ⇒ ::String

Returns Required. Ad tag URI.

Returns:

  • (::String) —

    Required. Ad tag URI.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 69

class VodSession
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines fields related to Google Ad Manager (GAM). This should be set if
  # GAM is being used for ads.
  # @!attribute [rw] network_code
  #   @return [::String]
  #     Required. Ad Manager network code.
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdTagMacroMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ad_tracking ⇒ ::Google::Cloud::Video::Stitcher::V1::AdTracking

Returns Required. Determines how the ad should be tracked.

Returns:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 69

class VodSession
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines fields related to Google Ad Manager (GAM). This should be set if
  # GAM is being used for ads.
  # @!attribute [rw] network_code
  #   @return [::String]
  #     Required. Ad Manager network code.
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdTagMacroMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#asset_id ⇒ ::String (readonly)

Returns Output only. The generated ID of the VodSession's source media.

Returns:

  • (::String) —

    Output only. The generated ID of the VodSession's source media.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 69

class VodSession
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines fields related to Google Ad Manager (GAM). This should be set if
  # GAM is being used for ads.
  # @!attribute [rw] network_code
  #   @return [::String]
  #     Required. Ad Manager network code.
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdTagMacroMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#gam_settings ⇒ ::Google::Cloud::Video::Stitcher::V1::VodSession::GamSettings

Returns This field should be set with appropriate values if GAM is being used for ads.

Returns:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 69

class VodSession
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines fields related to Google Ad Manager (GAM). This should be set if
  # GAM is being used for ads.
  # @!attribute [rw] network_code
  #   @return [::String]
  #     Required. Ad Manager network code.
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdTagMacroMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#interstitials ⇒ ::Google::Cloud::Video::Stitcher::V1::Interstitials (readonly)

Returns Output only. Metadata of what was stitched into the content.

Returns:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 69

class VodSession
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines fields related to Google Ad Manager (GAM). This should be set if
  # GAM is being used for ads.
  # @!attribute [rw] network_code
  #   @return [::String]
  #     Required. Ad Manager network code.
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdTagMacroMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#manifest_options ⇒ ::Google::Cloud::Video::Stitcher::V1::ManifestOptions

Returns Additional options that affect the output of the manifest.

Returns:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 69

class VodSession
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines fields related to Google Ad Manager (GAM). This should be set if
  # GAM is being used for ads.
  # @!attribute [rw] network_code
  #   @return [::String]
  #     Required. Ad Manager network code.
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdTagMacroMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The name of the VOD session, in the form of projects/{project_number}/locations/{location}/vodSessions/{id}.

Returns:

  • (::String) —

    Output only. The name of the VOD session, in the form of projects/{project_number}/locations/{location}/vodSessions/{id}.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 69

class VodSession
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines fields related to Google Ad Manager (GAM). This should be set if
  # GAM is being used for ads.
  # @!attribute [rw] network_code
  #   @return [::String]
  #     Required. Ad Manager network code.
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdTagMacroMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#play_uri ⇒ ::String (readonly)

Returns Output only. The playback URI of the stitched content.

Returns:

  • (::String) —

    Output only. The playback URI of the stitched content.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 69

class VodSession
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines fields related to Google Ad Manager (GAM). This should be set if
  # GAM is being used for ads.
  # @!attribute [rw] network_code
  #   @return [::String]
  #     Required. Ad Manager network code.
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdTagMacroMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#source_uri ⇒ ::String

Returns Required. URI of the media to stitch.

Returns:

  • (::String) —

    Required. URI of the media to stitch.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 69

class VodSession
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines fields related to Google Ad Manager (GAM). This should be set if
  # GAM is being used for ads.
  # @!attribute [rw] network_code
  #   @return [::String]
  #     Required. Ad Manager network code.
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdTagMacroMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end