feat: add SamplingLevel type to Data API v1alpha

Google APIs · copybara-github · commit 7b6975c4bb1f · 2024-10-16T10:39:43.000-07:00
feat: add `sampling_level` to the `ReportDefinition` type

PiperOrigin-RevId: 686560382
diff --git a/google/analytics/data/v1alpha/analytics_data_api.proto b/google/analytics/data/v1alpha/analytics_data_api.proto
@@ -1086,6 +1086,10 @@ message ReportTask {
     // the `eventName` dimension and  `eventCount` metric will not have a row
     // containing eventName: "purchase" and eventCount: 0.
     bool keep_empty_rows = 13 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The report's sampling level.
+    optional SamplingLevel sampling_level = 14
+        [(google.api.field_behavior) = OPTIONAL];
   }
 
   // The report metadata for a specific report task.
diff --git a/google/analytics/data/v1alpha/data.proto b/google/analytics/data/v1alpha/data.proto
@@ -1573,3 +1573,23 @@ enum RestrictedMetricType {
   // Revenue metrics such as `purchaseRevenue`.
   REVENUE_DATA = 2;
 }
+
+// Categories of sampling levels for the requests.
+enum SamplingLevel {
+  // Unspecified type.
+  SAMPLING_LEVEL_UNSPECIFIED = 0;
+
+  // Applies a sampling level of 10 million to standard properties and
+  // 100 million to Google Analytics 360 properties.
+  LOW = 1;
+
+  // Exclusive to Google Analytics 360 properties with a sampling level of 1
+  // billion.
+  MEDIUM = 2;
+
+  // Exclusive to Google Analytics 360 properties. Unsampled explorations are
+  // more accurate and can reveal insights that aren't visible in standard
+  // explorations. To learn more, see
+  // https://support.google.com/analytics/answer/10896953.
+  UNSAMPLED = 3;
+}
