feat!: introduce GAM settings for GAM related configs and support ListOperations

Google APIs · copybara-github · commit a5f8761d4cd9 · 2023-04-14T10:40:55.000-07:00
PiperOrigin-RevId: 524328971
diff --git a/google/cloud/video/stitcher/v1/live_configs.proto b/google/cloud/video/stitcher/v1/live_configs.proto
@@ -25,12 +25,12 @@ option java_multiple_files = true;
 option java_outer_classname = "LiveConfigsProto";
 option java_package = "com.google.cloud.video.stitcher.v1";
 
-// Determines the Ad tracking policy.
+// Determines the ad tracking policy.
 enum AdTracking {
   // The ad tracking policy is not specified.
   AD_TRACKING_UNSPECIFIED = 0;
 
-  // Client side ad tracking is specified. The client player is expected to
+  // Client-side ad tracking is specified. The client player is expected to
   // trigger playback and activity events itself.
   CLIENT = 1;
 
@@ -63,7 +63,7 @@ message LiveConfig {
 
   // Defines the ad stitching behavior in case the ad duration does not align
   // exactly with the ad break boundaries. If not specified, the default is
-  // CUT_CURRENT.
+  // `CUT_CURRENT`.
   enum StitchingPolicy {
     // Stitching policy is not specified.
     STITCHING_POLICY_UNSPECIFIED = 0;
@@ -92,14 +92,14 @@ message LiveConfig {
   // Output only. State of the live config.
   State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // Required. Determines how the ads should be tracked. If
+  // Required. Determines how the ads are tracked. If
   // [gam_live_config][google.cloud.video.stitcher.v1.LiveConfig.gam_live_config]
   // is set, the value must be `CLIENT` because the IMA SDK handles ad tracking.
   AdTracking ad_tracking = 6 [(google.api.field_behavior) = REQUIRED];
 
   // This must refer to a slate in the same
-  // project. In case Google Ad Manager (GAM) is being used for ads this will be
-  // used to set the appropriate value of slateCreativeId in
+  // project. If Google Ad Manager (GAM) is used for ads, this string sets the
+  // value of `slateCreativeId` in
   // https://developers.google.com/ad-manager/api/reference/v202211/LiveStreamEventService.LiveStreamEvent#slateCreativeId
   string default_slate = 7 [(google.api.resource_reference) = {
     type: "videostitcher.googleapis.com/Slate"
diff --git a/google/cloud/video/stitcher/v1/sessions.proto b/google/cloud/video/stitcher/v1/sessions.proto
@@ -28,22 +28,23 @@ option java_multiple_files = true;
 option java_outer_classname = "SessionsProto";
 option java_package = "com.google.cloud.video.stitcher.v1";
 
-// Metadata for registering a VOD Session with Google Ad Manager (GAM).
-message GamVodConfig {
-  // Required. Ad Manager network code.
-  string network_code = 1 [(google.api.field_behavior) = REQUIRED];
-
-  // Required. The stream ID generated by Ad Manager.
-  string stream_id = 2 [(google.api.field_behavior) = REQUIRED];
-}
-
 // Metadata for a VOD session. The session expires 4 hours after its creation.
 message VodSession {
   option (google.api.resource) = {
     type: "videostitcher.googleapis.com/VodSession"
     pattern: "projects/{project}/locations/{location}/vodSessions/{vod_session}"
   };
 
+  // Defines fields related to Google Ad Manager (GAM). This should be set if
+  // GAM is being used for ads.
+  message GamSettings {
+    // Required. Ad Manager network code.
+    string network_code = 1 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. The stream ID generated by Ad Manager.
+    string stream_id = 2 [(google.api.field_behavior) = REQUIRED];
+  }
+
   // Output only. The name of the VOD session, in the form of
   // `projects/{project_number}/locations/{location}/vodSessions/{id}`.
   string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -85,9 +86,9 @@ message VodSession {
   // is set, the value must be `CLIENT` because the IMA SDK handles ad tracking.
   AdTracking ad_tracking = 11 [(google.api.field_behavior) = REQUIRED];
 
-  // This has the Google Ad Manager (GAM) related metadata in the case where GAM
-  // is used for the ads.
-  GamVodConfig gam_vod_config = 12;
+  // This field should be set with appropriate values if GAM is being used for
+  // ads.
+  GamSettings gam_settings = 13;
 }
 
 // Describes what was stitched into a VOD session's manifest.
@@ -149,26 +150,6 @@ message LiveSession {
   // GAM
   // is being used for ads.
   message GamSettings {
-    // GamHls is a container for any HLS specific input fields for GAM
-    // Live Stitching.
-    message GamHls {}
-
-    // GamDash is a container for any DASH specific input fields for GAM
-    // Live Stitching.
-    message GamDash {
-      // Required. The session template url by Ad Manager for DASH periods.
-      string period_template_uri = 1 [(google.api.field_behavior) = REQUIRED];
-    }
-
-    // Extra manifest type specific fields.
-    oneof manifest_fields {
-      // Fields that are specific to HLS manifests.
-      GamHls gam_hls = 2;
-
-      // Fields that are specific to DASH manifests.
-      GamDash gam_dash = 3;
-    }
-
     // Required. The stream ID generated by Ad Manager.
     string stream_id = 1 [(google.api.field_behavior) = REQUIRED];
   }
diff --git a/google/cloud/video/stitcher/v1/slates.proto b/google/cloud/video/stitcher/v1/slates.proto
@@ -49,6 +49,6 @@ message Slate {
   // MP4 video with at least one audio track.
   string uri = 2;
 
-  // gam_slate has all the GAM related attributes of slates.
+  // gam_slate has all the GAM-related attributes of slates.
   GamSlate gam_slate = 3;
 }
diff --git a/google/cloud/video/stitcher/v1/video_stitcher_service.proto b/google/cloud/video/stitcher/v1/video_stitcher_service.proto
@@ -54,8 +54,8 @@ service VideoStitcherService {
     };
     option (google.api.method_signature) = "parent,cdn_key,cdn_key_id";
     option (google.longrunning.operation_info) = {
-      response_type: "CdnKey"
-      metadata_type: "OperationMetadata"
+      response_type: "google.cloud.video.stitcher.v1.CdnKey"
+      metadata_type: "google.cloud.video.stitcher.v1.OperationMetadata"
     };
   }
 
@@ -83,7 +83,7 @@ service VideoStitcherService {
     option (google.api.method_signature) = "name";
     option (google.longrunning.operation_info) = {
       response_type: "google.protobuf.Empty"
-      metadata_type: "OperationMetadata"
+      metadata_type: "google.cloud.video.stitcher.v1.OperationMetadata"
     };
   }
 
@@ -96,8 +96,8 @@ service VideoStitcherService {
     };
     option (google.api.method_signature) = "cdn_key,update_mask";
     option (google.longrunning.operation_info) = {
-      response_type: "CdnKey"
-      metadata_type: "OperationMetadata"
+      response_type: "google.cloud.video.stitcher.v1.CdnKey"
+      metadata_type: "google.cloud.video.stitcher.v1.OperationMetadata"
     };
   }
 
@@ -180,8 +180,8 @@ service VideoStitcherService {
     };
     option (google.api.method_signature) = "parent,slate,slate_id";
     option (google.longrunning.operation_info) = {
-      response_type: "Slate"
-      metadata_type: "OperationMetadata"
+      response_type: "google.cloud.video.stitcher.v1.Slate"
+      metadata_type: "google.cloud.video.stitcher.v1.OperationMetadata"
     };
   }
 
@@ -209,8 +209,8 @@ service VideoStitcherService {
     };
     option (google.api.method_signature) = "slate,update_mask";
     option (google.longrunning.operation_info) = {
-      response_type: "Slate"
-      metadata_type: "OperationMetadata"
+      response_type: "google.cloud.video.stitcher.v1.Slate"
+      metadata_type: "google.cloud.video.stitcher.v1.OperationMetadata"
     };
   }
 
@@ -222,7 +222,7 @@ service VideoStitcherService {
     option (google.api.method_signature) = "name";
     option (google.longrunning.operation_info) = {
       response_type: "google.protobuf.Empty"
-      metadata_type: "OperationMetadata"
+      metadata_type: "google.cloud.video.stitcher.v1.OperationMetadata"
     };
   }
 
@@ -253,8 +253,8 @@ service VideoStitcherService {
     };
     option (google.api.method_signature) = "parent,live_config,live_config_id";
     option (google.longrunning.operation_info) = {
-      response_type: "LiveConfig"
-      metadata_type: "OperationMetadata"
+      response_type: "google.cloud.video.stitcher.v1.LiveConfig"
+      metadata_type: "google.cloud.video.stitcher.v1.OperationMetadata"
     };
   }
 
@@ -286,7 +286,7 @@ service VideoStitcherService {
     option (google.api.method_signature) = "name";
     option (google.longrunning.operation_info) = {
       response_type: "google.protobuf.Empty"
-      metadata_type: "OperationMetadata"
+      metadata_type: "google.cloud.video.stitcher.v1.OperationMetadata"
     };
   }
 }
diff --git a/google/cloud/video/stitcher/v1/videostitcher_v1.yaml b/google/cloud/video/stitcher/v1/videostitcher_v1.yaml
@@ -7,12 +7,8 @@ apis:
 - name: google.cloud.video.stitcher.v1.VideoStitcherService
 - name: google.longrunning.Operations
 
-documentation:
-  rules:
-  - selector: google.longrunning.Operations.ListOperations
-    description: |-
-      Lists operations that match the specified filter in the request. If
-      the server doesn't support this method, it returns `UNIMPLEMENTED`.
+types:
+- name: google.cloud.video.stitcher.v1.OperationMetadata
 
 backend:
   rules:

Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,6 @@ message Slate {`
`49`	`49`	`// MP4 video with at least one audio track.`
`50`	`50`	`string uri = 2;`
`51`	`51`
`52`		`- // gam_slate has all the GAM related attributes of slates.`
	`52`	`+ // gam_slate has all the GAM-related attributes of slates.`
`53`	`53`	`GamSlate gam_slate = 3;`
`54`	`54`	`}`