@google-analytics/data 4.1.0 → 4.3.0

package/build/protos/google/analytics/data/v1beta/data.proto

@@ -81,7 +81,16 @@ message MinuteRange {
 message Dimension {
   // The name of the dimension. See the [API
   // Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
-  // for the list of dimension names.
+  // for the list of dimension names supported by core reporting methods such
+  // as `runReport` and `batchRunReports`. See
+  // [Realtime
+  // Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions)
+  // for the list of dimension names supported by the `runRealtimeReport`
+  // method. See
+  // [Funnel
+  // Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions)
+  // for the list of dimension names supported by the `runFunnelReport`
+  // method.
   //
   // If `dimensionExpression` is specified, `name` can be any string that you
   // would like within the allowed character set. For example if a
@@ -146,7 +155,16 @@ message DimensionExpression {
 message Metric {
   // The name of the metric. See the [API
   // Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
-  // for the list of metric names.
+  // for the list of metric names supported by core reporting methods such
+  // as `runReport` and `batchRunReports`. See
+  // [Realtime
+  // Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#metrics)
+  // for the list of metric names supported by the `runRealtimeReport`
+  // method. See
+  // [Funnel
+  // Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#metrics)
+  // for the list of metric names supported by the `runFunnelReport`
+  // method.
   //
   // If `expression` is specified, `name` can be any string that you would like
   // within the allowed character set. For example if `expression` is
@@ -626,10 +644,39 @@ message ResponseMetaData {
   // possible for a request to be subject to thresholding thresholding and no
   // data is absent from the report, and this happens when all data is above the
   // thresholds. To learn more, see [Data
-  // thresholds](https://support.google.com/analytics/answer/9383630) and [About
-  // Demographics and
-  // Interests](https://support.google.com/analytics/answer/2799357).
+  // thresholds](https://support.google.com/analytics/answer/9383630).
   optional bool subject_to_thresholding = 8;
+
+  // If this report results is
+  // [sampled](https://support.google.com/analytics/answer/13331292), this
+  // describes the percentage of events used in this report. One
+  // `samplingMetadatas` is populated for each date range. Each
+  // `samplingMetadatas` corresponds to a date range in order that date ranges
+  // were specified in the request.
+  //
+  // However if the results are not sampled, this field will not be defined.
+  repeated SamplingMetadata sampling_metadatas = 9;
+}
+
+// If this report results is
+// [sampled](https://support.google.com/analytics/answer/13331292), this
+// describes the percentage of events used in this report. Sampling is the
+// practice of analyzing a subset of all data in order to uncover the meaningful
+// information in the larger data set.
+message SamplingMetadata {
+  // The total number of events read in this sampled report for a date range.
+  // This is the size of the subset this property's data that was analyzed in
+  // this report.
+  int64 samples_read_count = 1;
+
+  // The total number of events present in this property's data that could
+  // have been analyzed in this report for a date range. Sampling
+  // uncovers the meaningful information about the larger data set, and this
+  // is the size of the larger data set.
+  //
+  // To calculate the percentage of available data that was used in this
+  // report, compute `samplesReadCount/samplingSpaceSize`.
+  int64 sampling_space_size = 2;
 }
 
 // Describes a dimension column in the report. Dimensions requested in a report
@@ -789,10 +836,10 @@ message PropertyQuota {
 // Current state for a particular quota group.
 message QuotaStatus {
   // Quota consumed by this request.
-  int32 consumed = 1;
+  optional int32 consumed = 1;
 
   // Quota remaining after this request.
-  int32 remaining = 2;
+  optional int32 remaining = 2;
 }
 
 // Explains a dimension.