feat: add several new functions and types (#119)

* feat: add `GetMeasurementProtocolSecret`, `ListMeasurementProtocolSecrets`, `CreateMeasurementProtocolSecret`, `DeleteMeasurementProtocolSecret`, `UpdateMeasurementProtocolSecret` methods to the API feat: add `GetGoogleSignalsSettings`, `UpdateGoogleSignalsSettings` methods to the API feat: add `CreateConversionEvent`, `GetConversionEvent`, `DeleteConversionEvent`, `ListConversionEvents` methods to the API feat: add `CreateCustomDimension`, `GetCustomDimension`, `UpdateCustomDimension`, `ListCustomDimensions`, `ArchiveCustomDimension` methods to the API feat: add `CreateCustomMetric`, `GetCustomMetric`, `UpdateCustomMetric`, `ListCustomMetrics`, `ArchiveCustomMetric` methods to the API feat: add `GoogleSignalsState`, `GoogleSignalsConsent` types feat: add `GoogleSignalsSettings`  type feat: add `MeasurementProtocolSecret` type feat: add `ConversionEvent` type feat: add `CustomDimension` type feat: add `CustomMetric` type feat: extend `ChangeHistoryResourceType` enum to support `GOOGLE_SIGNALS_SETTINGS`, `CONVERSION_EVENT`, `MEASUREMENT_PROTOCOL_SECRET`, `CUSTOM_DIMENSION`, `CUSTOM_METRIC` values fix: label `email_address` field of `UserLink` type as immutable fix: label `name` field of `UserLink` type as output only

PiperOrigin-RevId: 375776214

Source-Link: googleapis/googleapis@c3bf1b7

Source-Link: https://github.com/googleapis/googleapis-gen/commit/23248c2d6af2ceb679b5bbc226ce505089d9ffe0

* 🦉 Updates from OwlBot

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Author: gcf-owl-bot[bot]

protos/google/analytics/admin/v1alpha/analytics_admin.proto

@@ -187,6 +187,50 @@ enum ChangeHistoryResourceType {
 
   // GoogleAdsLink resource
   GOOGLE_ADS_LINK = 7;
+
+  // GoogleSignalsSettings resource
+  GOOGLE_SIGNALS_SETTINGS = 8;
+
+  // ConversionEvent resource
+  CONVERSION_EVENT = 9;
+
+  // MeasurementProtocolSecret resource
+  MEASUREMENT_PROTOCOL_SECRET = 10;
+
+  // CustomDimension resource
+  CUSTOM_DIMENSION = 11;
+
+  // CustomMetric resource
+  CUSTOM_METRIC = 12;
+}
+
+// Status of the Google Signals settings (i.e., whether this feature has been
+// enabled for the property).
+enum GoogleSignalsState {
+  // Google Signals status defaults to GOOGLE_SIGNALS_STATE_UNSPECIFIED to
+  // represent that the user has not made an explicit choice.
+  GOOGLE_SIGNALS_STATE_UNSPECIFIED = 0;
+
+  // Google Signals is enabled.
+  GOOGLE_SIGNALS_ENABLED = 1;
+
+  // Google Signals is disabled.
+  GOOGLE_SIGNALS_DISABLED = 2;
+}
+
+// Consent field of the Google Signals settings (i.e., whether the user has
+// consented to the Google Signals terms of service.)
+enum GoogleSignalsConsent {
+  // Google Signals consent value defaults to
+  // GOOGLE_SIGNALS_CONSENT_UNSPECIFIED.  This will be treated as
+  // GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED.
+  GOOGLE_SIGNALS_CONSENT_UNSPECIFIED = 0;
+
+  // Terms of service have been accepted
+  GOOGLE_SIGNALS_CONSENT_CONSENTED = 2;
+
+  // Terms of service have not been accepted
+  GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED = 1;
 }
 
 // A resource message representing a Google Analytics account.
@@ -392,11 +436,11 @@ message UserLink {
     pattern: "properties/{property}/userLinks/{user_link}"
   };
 
-  // Example format: properties/1234/userLinks/5678
-  string name = 1;
+  // Output only. Example format: properties/1234/userLinks/5678
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // Email address of the user to link
-  string email_address = 2;
+  // Immutable. Email address of the user to link
+  string email_address = 2 [(google.api.field_behavior) = IMMUTABLE];
 
   // Roles directly assigned to this user for this account or property.
   //
@@ -563,7 +607,7 @@ message GoogleAdsLink {
   // Enable personalized advertising features with this integration.
   // Automatically publish my Google Analytics audience lists and Google
   // Analytics remarketing events/parameters to the linked Google Ads account.
-  // If this field is not set on create/update it will be defaulted to true.
+  // If this field is not set on create/update, it will be defaulted to true.
   google.protobuf.BoolValue ads_personalization_enabled = 5;
 
   // Output only. Email address of the user that created the link.
@@ -650,6 +694,28 @@ message PropertySummary {
   string display_name = 2;
 }
 
+// A secret value used for sending hits to Measurement Protocol.
+message MeasurementProtocolSecret {
+  option (google.api.resource) = {
+    type: "analyticsadmin.googleapis.com/MeasurementProtocolSecret"
+    pattern: "properties/{property}/webDataStreams/{web_data_stream}/measurementProtocolSecrets/{measurement_protocol_secret}"
+  };
+
+  // Output only. Resource name of this secret. This secret may be a child of any type of
+  // stream.
+  // Format:
+  // properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Required. Human-readable display name for this secret.
+  string display_name = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Output only. The measurement protocol secret value. Pass this value to the api_secret
+  // field of the Measurement Protocol API when sending hits to this
+  // secret's parent property.
+  string secret_value = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
 // A set of changes within a Google Analytics account or its child properties
 // that resulted from the same cause. Common causes would be updates made in the
 // Google Analytics UI, changes from customer support, or automatic Google
@@ -704,6 +770,21 @@ message ChangeHistoryChange {
 
       // A snapshot of a GoogleAdsLink resource in change history.
       GoogleAdsLink google_ads_link = 7;
+
+      // A snapshot of a GoogleSignalsSettings resource in change history.
+      GoogleSignalsSettings google_signals_settings = 8;
+
+      // A snapshot of a ConversionEvent resource in change history.
+      ConversionEvent conversion_event = 11;
+
+      // A snapshot of a MeasurementProtocolSecret resource in change history.
+      MeasurementProtocolSecret measurement_protocol_secret = 12;
+
+      // A snapshot of a CustomDimension resource in change history.
+      CustomDimension custom_dimension = 13;
+
+      // A snapshot of a CustomMetric resource in change history.
+      CustomMetric custom_metric = 14;
     }
   }
 
@@ -721,3 +802,199 @@ message ChangeHistoryChange {
   // deleted in this change, this field will be missing.
   ChangeHistoryResource resource_after_change = 4;
 }
+
+// A conversion event in a Google Analytics property.
+message ConversionEvent {
+  option (google.api.resource) = {
+    type: "analyticsadmin.googleapis.com/ConversionEvent"
+    pattern: "properties/{property}/conversionEvents/{conversion_event}"
+  };
+
+  // Output only. Resource name of this conversion event.
+  // Format: properties/{property}/conversionEvents/{conversion_event}
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Immutable. The event name for this conversion event.
+  // Examples: 'click', 'purchase'
+  string event_name = 2 [(google.api.field_behavior) = IMMUTABLE];
+
+  // Output only. Time when this conversion event was created in the property.
+  google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. If set, this event can currently be deleted via DeleteConversionEvent.
+  bool is_deletable = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Settings values for Google Signals.  This is a singleton resource.
+message GoogleSignalsSettings {
+  option (google.api.resource) = {
+    type: "analyticsadmin.googleapis.com/GoogleSignalsSettings"
+    pattern: "properties/{property}/googleSignalsSettings"
+  };
+
+  // Output only. Resource name of this setting.
+  // Format: properties/{property_id}/googleSignalsSettings
+  // Example: "properties/1000/googleSignalsSettings"
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Status of this setting.
+  GoogleSignalsState state = 3;
+
+  // Output only. Terms of Service acceptance.
+  GoogleSignalsConsent consent = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// A definition for a CustomDimension.
+message CustomDimension {
+  option (google.api.resource) = {
+    type: "analyticsadmin.googleapis.com/CustomDimension"
+    pattern: "properties/{property}/customDimensions"
+  };
+
+  // Valid values for the scope of this dimension.
+  enum DimensionScope {
+    // Scope unknown or not specified.
+    DIMENSION_SCOPE_UNSPECIFIED = 0;
+
+    // Dimension scoped to an event.
+    EVENT = 1;
+
+    // Dimension scoped to a user.
+    USER = 2;
+  }
+
+  // Output only. Resource name for this CustomDimension resource.
+  // Format: properties/{property}/customDimensions/{customDimension}
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Required. Immutable. Tagging parameter name for this custom dimension.
+  //
+  // If this is a user-scoped dimension, then this is the user property name.
+  // If this is an event-scoped dimension, then this is the event parameter
+  // name.
+  //
+  // May only contain alphanumeric and underscore characters, starting with a
+  // letter. Max length of 24 characters for user-scoped dimensions, 40
+  // characters for event-scoped dimensions.
+  string parameter_name = 2 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.field_behavior) = IMMUTABLE
+  ];
+
+  // Required. Display name for this custom dimension as shown in the Analytics UI.
+  // Max length of 82 characters, alphanumeric plus space and underscore
+  // starting with a letter. Legacy system-generated display names may contain
+  // square brackets, but updates to this field will never permit square
+  // brackets.
+  string display_name = 3 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. Description for this custom dimension. Max length of 150 characters.
+  string description = 4 [(google.api.field_behavior) = OPTIONAL];
+
+  // Required. Immutable. The scope of this dimension.
+  DimensionScope scope = 5 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.field_behavior) = IMMUTABLE
+  ];
+
+  // Optional. If set to true, sets this dimension as NPA and excludes it from ads
+  // personalization.
+  //
+  // This is currently only supported by user-scoped custom dimensions.
+  bool disallow_ads_personalization = 6 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// A definition for a custom metric.
+message CustomMetric {
+  option (google.api.resource) = {
+    type: "analyticsadmin.googleapis.com/CustomMetric"
+    pattern: "properties/{property}/customMetrics"
+  };
+
+  // Possible types of representing the custom metric's value.
+  //
+  // Currency representation may change in the future, requiring a breaking API
+  // change.
+  enum MeasurementUnit {
+    // MeasurementUnit unspecified or missing.
+    MEASUREMENT_UNIT_UNSPECIFIED = 0;
+
+    // This metric uses default units.
+    STANDARD = 1;
+
+    // This metric measures a currency.
+    CURRENCY = 2;
+
+    // This metric measures feet.
+    FEET = 3;
+
+    // This metric measures meters.
+    METERS = 4;
+
+    // This metric measures kilometers.
+    KILOMETERS = 5;
+
+    // This metric measures miles.
+    MILES = 6;
+
+    // This metric measures milliseconds.
+    MILLISECONDS = 7;
+
+    // This metric measures seconds.
+    SECONDS = 8;
+
+    // This metric measures minutes.
+    MINUTES = 9;
+
+    // This metric measures hours.
+    HOURS = 10;
+  }
+
+  // The scope of this metric.
+  enum MetricScope {
+    // Scope unknown or not specified.
+    METRIC_SCOPE_UNSPECIFIED = 0;
+
+    // Metric scoped to an event.
+    EVENT = 1;
+  }
+
+  // Output only. Resource name for this CustomMetric resource.
+  // Format: properties/{property}/customMetrics/{customMetric}
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Required. Immutable. Tagging name for this custom metric.
+  //
+  // If this is an event-scoped metric, then this is the event parameter
+  // name.
+  //
+  // May only contain alphanumeric and underscore charactes, starting with a
+  // letter. Max length of 40 characters for event-scoped metrics.
+  string parameter_name = 2 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.field_behavior) = IMMUTABLE
+  ];
+
+  // Required. Display name for this custom metric as shown in the Analytics UI.
+  // Max length of 82 characters, alphanumeric plus space and underscore
+  // starting with a letter. Legacy system-generated display names may contain
+  // square brackets, but updates to this field will never permit square
+  // brackets.
+  string display_name = 3 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. Description for this custom dimension.
+  // Max length of 150 characters.
+  string description = 4 [(google.api.field_behavior) = OPTIONAL];
+
+  // Required. Immutable. The type for the custom metric's value.
+  MeasurementUnit measurement_unit = 5 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.field_behavior) = IMMUTABLE
+  ];
+
+  // Required. Immutable. The scope of this custom metric.
+  MetricScope scope = 6 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.field_behavior) = IMMUTABLE
+  ];
+}