Class: Google::Cloud::Video::Stitcher::V1::LiveSession

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 live session. The session expires 5 minutes after the client stops fetching the session's playlists.

Defined Under Namespace

Classes: AdTagMacrosEntry, GamSettings

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Key value pairs for ad tag macro replacement, only available for live 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 macros: {"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 live 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 macros: {"geoId": "123"}

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 203

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

  # Defines fields related to Google Ad Manager (GAM).
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager. This must be set if GAM
  #     is being used for ads and the session uses client-side ad tracking.
  # @!attribute [rw] targeting_parameters
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     [Targeting
  #     parameters](https://support.google.com/admanager/answer/7320899) to send
  #     to Ad Manager to generate a stream ID. This should only be set if the
  #     session uses server-side ad tracking.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

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

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

Returns Determines how the ad should be tracked. This overrides the value set in the live config for this session.

Returns:



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 203

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

  # Defines fields related to Google Ad Manager (GAM).
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager. This must be set if GAM
  #     is being used for ads and the session uses client-side ad tracking.
  # @!attribute [rw] targeting_parameters
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     [Targeting
  #     parameters](https://support.google.com/admanager/answer/7320899) to send
  #     to Ad Manager to generate a stream ID. This should only be set if the
  #     session uses server-side ad tracking.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

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

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

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

Returns:



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 203

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

  # Defines fields related to Google Ad Manager (GAM).
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager. This must be set if GAM
  #     is being used for ads and the session uses client-side ad tracking.
  # @!attribute [rw] targeting_parameters
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     [Targeting
  #     parameters](https://support.google.com/admanager/answer/7320899) to send
  #     to Ad Manager to generate a stream ID. This should only be set if the
  #     session uses server-side ad tracking.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

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

#live_config ⇒ ::String

Returns Required. The resource name of the live config for this session, in the form of projects/{project}/locations/{location}/liveConfigs/{id}.

Returns:

  • (::String) —

    Required. The resource name of the live config for this session, in the form of projects/{project}/locations/{location}/liveConfigs/{id}.



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 203

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

  # Defines fields related to Google Ad Manager (GAM).
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager. This must be set if GAM
  #     is being used for ads and the session uses client-side ad tracking.
  # @!attribute [rw] targeting_parameters
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     [Targeting
  #     parameters](https://support.google.com/admanager/answer/7320899) to send
  #     to Ad Manager to generate a stream ID. This should only be set if the
  #     session uses server-side ad tracking.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdTagMacrosEntry
    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:



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 203

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

  # Defines fields related to Google Ad Manager (GAM).
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager. This must be set if GAM
  #     is being used for ads and the session uses client-side ad tracking.
  # @!attribute [rw] targeting_parameters
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     [Targeting
  #     parameters](https://support.google.com/admanager/answer/7320899) to send
  #     to Ad Manager to generate a stream ID. This should only be set if the
  #     session uses server-side ad tracking.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

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

#name ⇒ ::String (readonly)

Returns Output only. The name of the live session, in the form of projects/{project}/locations/{location}/liveSessions/{id}.

Returns:

  • (::String) —

    Output only. The name of the live session, in the form of projects/{project}/locations/{location}/liveSessions/{id}.



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 203

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

  # Defines fields related to Google Ad Manager (GAM).
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager. This must be set if GAM
  #     is being used for ads and the session uses client-side ad tracking.
  # @!attribute [rw] targeting_parameters
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     [Targeting
  #     parameters](https://support.google.com/admanager/answer/7320899) to send
  #     to Ad Manager to generate a stream ID. This should only be set if the
  #     session uses server-side ad tracking.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

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

#play_uri ⇒ ::String (readonly)

Returns Output only. The URI to play the live session's ad-stitched stream.

Returns:

  • (::String) —

    Output only. The URI to play the live session's ad-stitched stream.



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/cloud/video/stitcher/v1/sessions.rb', line 203

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

  # Defines fields related to Google Ad Manager (GAM).
  # @!attribute [rw] stream_id
  #   @return [::String]
  #     Required. The stream ID generated by Ad Manager. This must be set if GAM
  #     is being used for ads and the session uses client-side ad tracking.
  # @!attribute [rw] targeting_parameters
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     [Targeting
  #     parameters](https://support.google.com/admanager/answer/7320899) to send
  #     to Ad Manager to generate a stream ID. This should only be set if the
  #     session uses server-side ad tracking.
  class GamSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

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