sessions.rb in google-cloud-video-stitcher-v1-0.10.0

- old
+ new

@@ -33,28 +33,33 @@
           # @!attribute [r] play_uri
           #   @return [::String]
           #     Output only. The playback URI of the stitched content.
           # @!attribute [rw] source_uri
           #   @return [::String]
-          #     Required. URI of the media to stitch.
+          #     URI of the media to stitch. For most use cases, you should create a
+          #     {::Google::Cloud::Video::Stitcher::V1::VodConfig VodConfig} with this information
+          #     rather than setting this field directly.
           # @!attribute [rw] ad_tag_uri
           #   @return [::String]
-          #     Required. Ad tag URI.
+          #     Ad tag URI. For most use cases, you should create a
+          #     {::Google::Cloud::Video::Stitcher::V1::VodConfig VodConfig} with this information
+          #     rather than setting this field directly.
           # @!attribute [rw] ad_tag_macro_map
           #   @return [::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:
+          #     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"`
+          #       `"https://doubleclick.google.com/ad/1?geo_id=123"`
           # @!attribute [rw] manifest_options
           #   @return [::Google::Cloud::Video::Stitcher::V1::ManifestOptions]
           #     Additional options that affect the output of the manifest.
           # @!attribute [r] asset_id
           #   @return [::String]
@@ -64,10 +69,14 @@
           #     Required. Determines how the ad should be tracked.
           # @!attribute [rw] gam_settings
           #   @return [::Google::Cloud::Video::Stitcher::V1::VodSession::GamSettings]
           #     This field should be set with appropriate values if GAM is being used for
           #     ads.
+          # @!attribute [rw] vod_config
+          #   @return [::String]
+          #     The resource name of the VOD config for this session, in the form of
+          #     `projects/{project}/locations/{location}/vodConfigs/{id}`.
           class VodSession
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
 
             # Defines fields related to Google Ad Manager (GAM). This should be set if
@@ -161,16 +170,16 @@
           # @!attribute [r] play_uri
           #   @return [::String]
           #     Output only. The URI to play the live session's ad-stitched stream.
           # @!attribute [rw] ad_tag_macros
           #   @return [::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.
+          #     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.
           #
-          #     For example:
+          #     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"}`
           #
@@ -185,21 +194,40 @@
           #     ads.
           # @!attribute [rw] live_config
           #   @return [::String]
           #     Required. The resource name of the live config for this session, in the
           #     form of `projects/{project}/locations/{location}/liveConfigs/{id}`.
+          # @!attribute [rw] ad_tracking
+          #   @return [::Google::Cloud::Video::Stitcher::V1::AdTracking]
+          #     Determines how the ad should be tracked. This overrides the value set in
+          #     the live config for this session.
           class LiveSession
             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.
+            # Defines fields related to Google Ad Manager (GAM).
             # @!attribute [rw] stream_id
             #   @return [::String]
-            #     Required. The stream ID generated by Ad Manager.
+            #     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