docs(samples): add example tags to generated samples (#164)

- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 408439482

Source-Link: googleapis/googleapis@b9f6184

Source-Link: googleapis/googleapis-gen@eb888bc
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZWI4ODhiYzIxNGVmYzdiZjQzYmY0NjM0YjQ3MDI1NDU2NWE2NTlhNSJ9

packages/google-analytics-admin/linkinator.config.json

@@ -6,5 +6,5 @@
     "img.shields.io"
   ],
   "silent": true,
-  "concurrency": 10
+  "concurrency": 5
 }

packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/resources.proto

@@ -26,27 +26,6 @@ option java_multiple_files = true;
 option java_outer_classname = "ResourcesProto";
 option java_package = "com.google.analytics.admin.v1alpha";
 
-// Maximum access settings that Firebase user receive on the linked Analytics
-// property.
-enum MaximumUserAccess {
-  // Unspecified maximum user access.
-  MAXIMUM_USER_ACCESS_UNSPECIFIED = 0;
-
-  // Firebase users have no access to the Analytics property.
-  NO_ACCESS = 1;
-
-  // Firebase users have Read & Analyze access to the Analytics property.
-  READ_AND_ANALYZE = 2;
-
-  // Firebase users have edit access to the Analytics property, but may not
-  // manage the Firebase link.
-  EDITOR_WITHOUT_LINK_MANAGEMENT = 3;
-
-  // Firebase users have edit access to the Analytics property and may manage
-  // the Firebase link.
-  EDITOR_INCLUDING_LINK_MANAGEMENT = 4;
-}
-
 // The category selected for this property, used for industry benchmarking.
 enum IndustryCategory {
   // Industry category unspecified
@@ -131,6 +110,18 @@ enum IndustryCategory {
   SHOPPING = 26;
 }
 
+// Various levels of service for Google Analytics.
+enum ServiceLevel {
+  // Service level not specified or invalid.
+  SERVICE_LEVEL_UNSPECIFIED = 0;
+
+  // The standard version of Google Analytics.
+  GOOGLE_ANALYTICS_STANDARD = 1;
+
+  // The paid, premium version of Google Analytics.
+  GOOGLE_ANALYTICS_360 = 2;
+}
+
 // Different kinds of actors that can make changes to Google Analytics
 // resources.
 enum ActorType {
@@ -202,6 +193,9 @@ enum ChangeHistoryResourceType {
 
   // CustomMetric resource
   CUSTOM_METRIC = 12;
+
+  // DataRetentionSettings resource
+  DATA_RETENTION_SETTINGS = 13;
 }
 
 // Status of the Google Signals settings (i.e., whether this feature has been
@@ -233,6 +227,51 @@ enum GoogleSignalsConsent {
   GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED = 1;
 }
 
+// An indication of which product the user initiated a link proposal from.
+enum LinkProposalInitiatingProduct {
+  // Unspecified product.
+  LINK_PROPOSAL_INITIATING_PRODUCT_UNSPECIFIED = 0;
+
+  // This proposal was created by a user from Google Analytics.
+  GOOGLE_ANALYTICS = 1;
+
+  // This proposal was created by a user from a linked product (not Google
+  // Analytics).
+  LINKED_PRODUCT = 2;
+}
+
+// The state of a link proposal resource.
+enum LinkProposalState {
+  // Unspecified state
+  LINK_PROPOSAL_STATE_UNSPECIFIED = 0;
+
+  // This proposal is awaiting review from a Google Analytics user. This
+  // proposal will automatically expire after some time.
+  AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS = 1;
+
+  // This proposal is awaiting review from a user of a linked product. This
+  // proposal will automatically expire after some time.
+  AWAITING_REVIEW_FROM_LINKED_PRODUCT = 2;
+
+  // This proposal has been withdrawn by an admin on the initiating product.
+  // This proposal will be automatically deleted after some time.
+  WITHDRAWN = 3;
+
+  // This proposal has been declined by an admin on the receiving product. This
+  // proposal will be automatically deleted after some time.
+  DECLINED = 4;
+
+  // This proposal expired due to lack of response from an admin on the
+  // receiving product. This proposal will be automatically deleted after some
+  // time.
+  EXPIRED = 5;
+
+  // This proposal has become obsolete because a link was directly created to
+  // the same external product resource that this proposal specifies. This
+  // proposal will be automatically deleted after some time.
+  OBSOLETE = 6;
+}
+
 // A resource message representing a Google Analytics account.
 message Account {
   option (google.api.resource) = {
@@ -314,6 +353,9 @@ message Property {
   // Examples: "USD", "EUR", "JPY"
   string currency_code = 8;
 
+  // Output only. The Google Analytics service level that applies to this property.
+  ServiceLevel service_level = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+
   // Output only. If set, the time at which this property was trashed. If not set, then this
   // property is not currently in the trash can.
   google.protobuf.Timestamp delete_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -563,10 +605,6 @@ message FirebaseLink {
 
   // Output only. Time when this FirebaseLink was originally created.
   google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
-
-  // Maximum user access to the GA4 property allowed to admins of
-  // the linked Firebase project.
-  MaximumUserAccess maximum_user_access = 4;
 }
 
 // Read-only resource with the tag for sending data from a website to a
@@ -610,15 +648,15 @@ message GoogleAdsLink {
   // 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.
-  // An empty string will be returned if the email address can't be retrieved.
-  string email_address = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
-
   // Output only. Time when this link was originally created.
   google.protobuf.Timestamp create_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. Time when this link was last updated.
   google.protobuf.Timestamp update_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Email address of the user that created the link.
+  // An empty string will be returned if the email address can't be retrieved.
+  string creator_email_address = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
 // A resource message representing data sharing settings of a Google Analytics
@@ -774,6 +812,14 @@ message ChangeHistoryChange {
       // A snapshot of a GoogleSignalsSettings resource in change history.
       GoogleSignalsSettings google_signals_settings = 8;
 
+      // A snapshot of a DisplayVideo360AdvertiserLink resource in change
+      // history.
+      DisplayVideo360AdvertiserLink display_video_360_advertiser_link = 9;
+
+      // A snapshot of a DisplayVideo360AdvertiserLinkProposal resource in
+      // change history.
+      DisplayVideo360AdvertiserLinkProposal display_video_360_advertiser_link_proposal = 10;
+
       // A snapshot of a ConversionEvent resource in change history.
       ConversionEvent conversion_event = 11;
 
@@ -785,6 +831,9 @@ message ChangeHistoryChange {
 
       // A snapshot of a CustomMetric resource in change history.
       CustomMetric custom_metric = 14;
+
+      // A snapshot of a data retention settings resource in change history.
+      DataRetentionSettings data_retention_settings = 15;
     }
   }
 
@@ -803,6 +852,106 @@ message ChangeHistoryChange {
   ChangeHistoryResource resource_after_change = 4;
 }
 
+// A link between a GA4 property and a Display & Video 360 advertiser.
+message DisplayVideo360AdvertiserLink {
+  option (google.api.resource) = {
+    type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLink"
+    pattern: "properties/{property}/displayVideo360AdvertiserLinks/{display_video_360_advertiser_link}"
+  };
+
+  // Output only. The resource name for this DisplayVideo360AdvertiserLink resource.
+  // Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId}
+  //
+  // Note: linkId is not the Display & Video 360 Advertiser ID
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Immutable. The Display & Video 360 Advertiser's advertiser ID.
+  string advertiser_id = 2 [(google.api.field_behavior) = IMMUTABLE];
+
+  // Output only. The display name of the Display & Video 360 Advertiser.
+  string advertiser_display_name = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Enables personalized advertising features with this integration.
+  // If this field is not set on create/update, it will be defaulted to true.
+  google.protobuf.BoolValue ads_personalization_enabled = 4;
+
+  // Immutable. Enables the import of campaign data from Display & Video 360 into the GA4
+  // property. After link creation, this can only be updated from the Display &
+  // Video 360 product.
+  // If this field is not set on create, it will be defaulted to true.
+  google.protobuf.BoolValue campaign_data_sharing_enabled = 5 [(google.api.field_behavior) = IMMUTABLE];
+
+  // Immutable. Enables the import of cost data from Display & Video 360 into the GA4
+  // property. This can only be enabled if campaign_data_import_enabled is
+  // enabled. After link creation, this can only be updated from the Display &
+  // Video 360 product.
+  // If this field is not set on create, it will be defaulted to true.
+  google.protobuf.BoolValue cost_data_sharing_enabled = 6 [(google.api.field_behavior) = IMMUTABLE];
+}
+
+// A proposal for a link between an GA4 property and a Display & Video 360
+// advertiser.
+//
+// A proposal is converted to a DisplayVideo360AdvertiserLink once approved.
+// Google Analytics admins approve inbound proposals while Display & Video 360
+// admins approve outbound proposals.
+message DisplayVideo360AdvertiserLinkProposal {
+  option (google.api.resource) = {
+    type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLinkProposal"
+    pattern: "properties/{property}/displayVideo360AdvertiserLinkProposals/{display_video_360_advertiser_link_proposal}"
+  };
+
+  // Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource.
+  // Format:
+  // properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId}
+  //
+  // Note: proposalId is not the Display & Video 360 Advertiser ID
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Immutable. The Display & Video 360 Advertiser's advertiser ID.
+  string advertiser_id = 2 [(google.api.field_behavior) = IMMUTABLE];
+
+  // Output only. The status information for this link proposal.
+  LinkProposalStatusDetails link_proposal_status_details = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The display name of the Display & Video Advertiser.
+  // Only populated for proposals that originated from Display & Video 360.
+  string advertiser_display_name = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Input only. On a proposal being sent to Display & Video 360, this field must be set to
+  // the email address of an admin on the target advertiser. This is used to
+  // verify that the Google Analytics admin is aware of at least one admin on
+  // the Display & Video 360 Advertiser. This does not restrict approval of the
+  // proposal to a single user. Any admin on the Display & Video 360 Advertiser
+  // may approve the proposal.
+  string validation_email = 5 [(google.api.field_behavior) = INPUT_ONLY];
+
+  // Immutable. Enables personalized advertising features with this integration.
+  // If this field is not set on create, it will be defaulted to true.
+  google.protobuf.BoolValue ads_personalization_enabled = 6 [(google.api.field_behavior) = IMMUTABLE];
+
+  // Immutable. Enables the import of campaign data from Display & Video 360.
+  // If this field is not set on create, it will be defaulted to true.
+  google.protobuf.BoolValue campaign_data_sharing_enabled = 7 [(google.api.field_behavior) = IMMUTABLE];
+
+  // Immutable. Enables the import of cost data from Display & Video 360.
+  // This can only be enabled if campaign_data_import_enabled is enabled.
+  // If this field is not set on create, it will be defaulted to true.
+  google.protobuf.BoolValue cost_data_sharing_enabled = 8 [(google.api.field_behavior) = IMMUTABLE];
+}
+
+// Status information for a link proposal.
+message LinkProposalStatusDetails {
+  // Output only. The source of this proposal.
+  LinkProposalInitiatingProduct link_proposal_initiating_product = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The email address of the user that proposed this linkage.
+  string requestor_email = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The state of this proposal.
+  LinkProposalState link_proposal_state = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
 // A conversion event in a Google Analytics property.
 message ConversionEvent {
   option (google.api.resource) = {
@@ -822,7 +971,15 @@ message ConversionEvent {
   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];
+  bool deletable = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. If set to true, this conversion event refers to a custom event.  If set to
+  // false, this conversion event refers to a default event in GA. Default
+  // events typically have special meaning in GA. Default events are usually
+  // created for you by the GA system, but in some cases can be created by
+  // property admins. Custom events count towards the maximum number of
+  // custom conversion events that may be created per property.
+  bool custom = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
 // Settings values for Google Signals.  This is a singleton resource.
@@ -986,15 +1143,55 @@ message CustomMetric {
   // 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. The type for the custom metric's value.
+  MeasurementUnit measurement_unit = 5 [(google.api.field_behavior) = REQUIRED];
 
   // Required. Immutable. The scope of this custom metric.
   MetricScope scope = 6 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.field_behavior) = IMMUTABLE
   ];
 }
+
+// Settings values for data retention. This is a singleton resource.
+message DataRetentionSettings {
+  option (google.api.resource) = {
+    type: "analyticsadmin.googleapis.com/DataRetentionSettings"
+    pattern: "properties/{property}/dataRetentionSettings"
+  };
+
+  // Valid values for the data retention duration.
+  enum RetentionDuration {
+    // Data retention time duration is not specified.
+    RETENTION_DURATION_UNSPECIFIED = 0;
+
+    // The data retention time duration is 2 months.
+    TWO_MONTHS = 1;
+
+    // The data retention time duration is 14 months.
+    FOURTEEN_MONTHS = 3;
+
+    // The data retention time duration is 26 months.
+    // Available to 360 properties only.
+    TWENTY_SIX_MONTHS = 4;
+
+    // The data retention time duration is 38 months.
+    // Available to 360 properties only.
+    THIRTY_EIGHT_MONTHS = 5;
+
+    // The data retention time duration is 50 months.
+    // Available to 360 properties only.
+    FIFTY_MONTHS = 6;
+  }
+
+  // Output only. Resource name for this DataRetentionSetting resource.
+  // Format: properties/{property}/dataRetentionSettings
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // The length of time that event-level data is retained.
+  RetentionDuration event_data_retention = 2;
+
+  // If true, reset the retention period for the user identifier with every
+  // event from that user.
+  bool reset_user_data_on_new_activity = 3;
+}