feat: add the AcknowledgeUserDataCollection operation which acknowledges the terms of user data collection for the specified property

Google APIs · copybara-github · commit 54861b49348a · 2021-12-16T13:56:20.000-08:00
feat: add the new resource type `DataStream`, which is planned to eventually replace `WebDataStream`, `IosAppDataStream`, `AndroidAppDataStream` resources
fix!: remove `GetEnhancedMeasurementSettings`, `UpdateEnhancedMeasurementSettingsRequest`, `UpdateEnhancedMeasurementSettingsRequest` operations from the API
feat: add `CreateDataStream`, `DeleteDataStream`, `UpdateDataStream`, `ListDataStreams` operations to support the new `DataStream` resource
feat: add `DISPLAY_VIDEO_360_ADVERTISER_LINK`,  `DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL` fields to `ChangeHistoryResourceType` enum
feat: add the `account` field to the `Property` type
docs: update the documentation with a new list of valid values for `UserLink.direct_roles` field

PiperOrigin-RevId: 416888961
diff --git a/google/analytics/admin/v1alpha/analytics_admin.proto b/google/analytics/admin/v1alpha/analytics_admin.proto
@@ -405,27 +405,6 @@ service AnalyticsAdminService {
     option (google.api.method_signature) = "parent";
   }
 
-  // Returns the singleton enhanced measurement settings for this web stream.
-  // Note that the stream must enable enhanced measurement for these settings to
-  // take effect.
-  rpc GetEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest) returns (EnhancedMeasurementSettings) {
-    option (google.api.http) = {
-      get: "/v1alpha/{name=properties/*/webDataStreams/*/enhancedMeasurementSettings}"
-    };
-    option (google.api.method_signature) = "name";
-  }
-
-  // Updates the singleton enhanced measurement settings for this web stream.
-  // Note that the stream must enable enhanced measurement for these settings to
-  // take effect.
-  rpc UpdateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest) returns (EnhancedMeasurementSettings) {
-    option (google.api.http) = {
-      patch: "/v1alpha/{enhanced_measurement_settings.name=properties/*/webDataStreams/*/enhancedMeasurementSettings}"
-      body: "enhanced_measurement_settings"
-    };
-    option (google.api.method_signature) = "enhanced_measurement_settings,update_mask";
-  }
-
   // Creates a FirebaseLink.
   //
   // Properties can have at most one FirebaseLink.
@@ -583,6 +562,17 @@ service AnalyticsAdminService {
     option (google.api.method_signature) = "measurement_protocol_secret,update_mask";
   }
 
+  // Acknowledges the terms of user data collection for the specified property.
+  //
+  // This acknowledgement must be completed (either in the Google Analytics UI
+  // or via this API) before MeasurementProtocolSecret resources may be created.
+  rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse) {
+    option (google.api.http) = {
+      post: "/v1alpha/{property=properties/*}:acknowledgeUserDataCollection"
+      body: "*"
+    };
+  }
+
   // Searches through all changes to an account or its children given the
   // specified set of filters.
   rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse) {
@@ -848,6 +838,48 @@ service AnalyticsAdminService {
     };
     option (google.api.method_signature) = "data_retention_settings,update_mask";
   }
+
+  // Creates a DataStream.
+  rpc CreateDataStream(CreateDataStreamRequest) returns (DataStream) {
+    option (google.api.http) = {
+      post: "/v1alpha/{parent=properties/*}/dataStreams"
+      body: "data_stream"
+    };
+    option (google.api.method_signature) = "parent,data_stream";
+  }
+
+  // Deletes a DataStream on a property.
+  rpc DeleteDataStream(DeleteDataStreamRequest) returns (google.protobuf.Empty) {
+    option (google.api.http) = {
+      delete: "/v1alpha/{name=properties/*/dataStreams/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Updates a DataStream on a property.
+  rpc UpdateDataStream(UpdateDataStreamRequest) returns (DataStream) {
+    option (google.api.http) = {
+      patch: "/v1alpha/{data_stream.name=properties/*/dataStreams/*}"
+      body: "data_stream"
+    };
+    option (google.api.method_signature) = "data_stream,update_mask";
+  }
+
+  // Lists DataStreams on a property.
+  rpc ListDataStreams(ListDataStreamsRequest) returns (ListDataStreamsResponse) {
+    option (google.api.http) = {
+      get: "/v1alpha/{parent=properties/*}/dataStreams"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+
+  // Lookup for a single DataStream.
+  rpc GetDataStream(GetDataStreamRequest) returns (DataStream) {
+    option (google.api.http) = {
+      get: "/v1alpha/{name=properties/*/dataStreams/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
 }
 
 // Request message for GetAccount RPC.
@@ -1479,32 +1511,6 @@ message ListAndroidAppDataStreamsResponse {
   string next_page_token = 2;
 }
 
-// Request message for GetEnhancedMeasurementSettings RPC.
-message GetEnhancedMeasurementSettingsRequest {
-  // Required. The name of the settings to lookup.
-  // Format:
-  // properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings
-  // Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
-  string name = 1 [
-    (google.api.field_behavior) = REQUIRED,
-    (google.api.resource_reference) = {
-      type: "analyticsadmin.googleapis.com/EnhancedMeasurementSettings"
-    }
-  ];
-}
-
-// Request message for UpdateEnhancedMeasurementSettings RPC.
-message UpdateEnhancedMeasurementSettingsRequest {
-  // Required. The settings to update.
-  // The `name` field is used to identify the settings to be updated.
-  EnhancedMeasurementSettings enhanced_measurement_settings = 1 [(google.api.field_behavior) = REQUIRED];
-
-  // Required. The list of fields to be updated. Field names must be in snake case
-  // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
-  // the entire entity, use one path with the string "*" to match all fields.
-  google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
-}
-
 // Request message for CreateFirebaseLink RPC
 message CreateFirebaseLinkRequest {
   // Required. Format: properties/{property_id}
@@ -1689,6 +1695,32 @@ message ListAccountSummariesResponse {
   string next_page_token = 2;
 }
 
+// Request message for AcknowledgeUserDataCollection RPC.
+message AcknowledgeUserDataCollectionRequest {
+  // Required. The property for which to acknowledge user data collection.
+  string property = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "analyticsadmin.googleapis.com/Property"
+    }
+  ];
+
+  // Required. An acknowledgement that the caller of this method understands the terms
+  // of user data collection.
+  //
+  // This field must contain the exact value:
+  // "I acknowledge that I have the necessary privacy disclosures and rights
+  // from my end users for the collection and processing of their data,
+  // including the association of such data with the visitation information
+  // Google Analytics collects from my site and/or app property."
+  string acknowledgement = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response message for AcknowledgeUserDataCollection RPC.
+message AcknowledgeUserDataCollectionResponse {
+
+}
+
 // Request message for SearchChangeHistoryEvents RPC.
 message SearchChangeHistoryEventsRequest {
   // Required. The account resource for which to return change history resources.
@@ -2314,3 +2346,85 @@ message UpdateDataRetentionSettingsRequest {
   // the entire entity, use one path with the string "*" to match all fields.
   google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
 }
+
+// Request message for CreateDataStream RPC.
+message CreateDataStreamRequest {
+  // Required. Example format: properties/1234
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "analyticsadmin.googleapis.com/DataStream"
+    }
+  ];
+
+  // Required. The DataStream to create.
+  DataStream data_stream = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for DeleteDataStream RPC.
+message DeleteDataStreamRequest {
+  // Required. The name of the DataStream to delete.
+  // Example format: properties/1234/dataStreams/5678
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "analyticsadmin.googleapis.com/DataStream"
+    }
+  ];
+}
+
+// Request message for UpdateDataStream RPC.
+message UpdateDataStreamRequest {
+  // The DataStream to update
+  DataStream data_stream = 1;
+
+  // Required. The list of fields to be updated. Omitted fields will not be updated.
+  // To replace the entire entity, use one path with the string "*" to match
+  // all fields.
+  google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for ListDataStreams RPC.
+message ListDataStreamsRequest {
+  // Required. Example format: properties/1234
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "analyticsadmin.googleapis.com/DataStream"
+    }
+  ];
+
+  // The maximum number of resources to return.
+  // If unspecified, at most 50 resources will be returned.
+  // The maximum value is 200 (higher values will be coerced to the maximum).
+  int32 page_size = 2;
+
+  // A page token, received from a previous `ListDataStreams` call.
+  // Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListDataStreams` must
+  // match the call that provided the page token.
+  string page_token = 3;
+}
+
+// Response message for ListDataStreams RPC.
+message ListDataStreamsResponse {
+  // List of DataStreams.
+  repeated DataStream data_streams = 1;
+
+  // A token, which can be sent as `page_token` to retrieve the next page.
+  // If this field is omitted, there are no subsequent pages.
+  string next_page_token = 2;
+}
+
+// Request message for GetDataStream RPC.
+message GetDataStreamRequest {
+  // Required. The name of the DataStream to get.
+  // Example format: properties/1234/dataStreams/5678
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "analyticsadmin.googleapis.com/DataStream"
+    }
+  ];
+}
diff --git a/google/analytics/admin/v1alpha/analyticsadmin_v1alpha.yaml b/google/analytics/admin/v1alpha/analyticsadmin_v1alpha.yaml
@@ -77,17 +77,17 @@ authentication:
       canonical_scopes: |-
         https://www.googleapis.com/auth/analytics.edit,
         https://www.googleapis.com/auth/analytics.readonly
-  - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetDisplayVideo360AdvertiserLink
+  - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetDataStream
     oauth:
       canonical_scopes: |-
         https://www.googleapis.com/auth/analytics.edit,
         https://www.googleapis.com/auth/analytics.readonly
-  - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetDisplayVideo360AdvertiserLinkProposal
+  - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetDisplayVideo360AdvertiserLink
     oauth:
       canonical_scopes: |-
         https://www.googleapis.com/auth/analytics.edit,
         https://www.googleapis.com/auth/analytics.readonly
-  - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetEnhancedMeasurementSettings
+  - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetDisplayVideo360AdvertiserLinkProposal
     oauth:
       canonical_scopes: |-
         https://www.googleapis.com/auth/analytics.edit,
@@ -157,6 +157,11 @@ authentication:
       canonical_scopes: |-
         https://www.googleapis.com/auth/analytics.edit,
         https://www.googleapis.com/auth/analytics.readonly
+  - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListDataStreams
+    oauth:
+      canonical_scopes: |-
+        https://www.googleapis.com/auth/analytics.edit,
+        https://www.googleapis.com/auth/analytics.readonly
   - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListDisplayVideo360AdvertiserLinkProposals
     oauth:
       canonical_scopes: |-
diff --git a/google/analytics/admin/v1alpha/resources.proto b/google/analytics/admin/v1alpha/resources.proto
