@google-analytics/data 4.2.0 → 4.3.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [4.3.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.2.0...data-v4.3.0) (2023-12-11)
+
+
+### Features
+
+* [analytics-data] add `CreateAudienceExport`, `QueryAudienceExport`, `GetAudienceExport`, `ListAudienceExports` methods to the Data API v1 beta ([#4878](https://github.com/googleapis/google-cloud-node/issues/4878)) ([1f9dc5a](https://github.com/googleapis/google-cloud-node/commit/1f9dc5ae6faf68324ab358b3f4f40328f62e7b64))
+
 ## [4.2.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.1.0...data-v4.2.0) (2023-11-30)
 
 

package/README.md

@@ -121,7 +121,11 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
 | Beta_analytics_data.batch_run_pivot_reports | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.batch_run_pivot_reports.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.batch_run_pivot_reports.js,packages/google-analytics-data/samples/README.md) |
 | Beta_analytics_data.batch_run_reports | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.batch_run_reports.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.batch_run_reports.js,packages/google-analytics-data/samples/README.md) |
 | Beta_analytics_data.check_compatibility | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.check_compatibility.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.check_compatibility.js,packages/google-analytics-data/samples/README.md) |
+| Beta_analytics_data.create_audience_export | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.create_audience_export.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.create_audience_export.js,packages/google-analytics-data/samples/README.md) |
+| Beta_analytics_data.get_audience_export | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.get_audience_export.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.get_audience_export.js,packages/google-analytics-data/samples/README.md) |
 | Beta_analytics_data.get_metadata | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.get_metadata.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.get_metadata.js,packages/google-analytics-data/samples/README.md) |
+| Beta_analytics_data.list_audience_exports | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.list_audience_exports.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.list_audience_exports.js,packages/google-analytics-data/samples/README.md) |
+| Beta_analytics_data.query_audience_export | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.query_audience_export.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.query_audience_export.js,packages/google-analytics-data/samples/README.md) |
 | Beta_analytics_data.run_pivot_report | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_pivot_report.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_pivot_report.js,packages/google-analytics-data/samples/README.md) |
 | Beta_analytics_data.run_realtime_report | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_realtime_report.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_realtime_report.js,packages/google-analytics-data/samples/README.md) |
 | Beta_analytics_data.run_report | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_report.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.run_report.js,packages/google-analytics-data/samples/README.md) |

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

@@ -21,11 +21,17 @@ import "google/api/annotations.proto";
 import "google/api/client.proto";
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
+import "google/longrunning/operations.proto";
+import "google/protobuf/timestamp.proto";
 
 option go_package = "google.golang.org/genproto/googleapis/analytics/data/v1beta;data";
 option java_multiple_files = true;
 option java_outer_classname = "AnalyticsDataApiProto";
 option java_package = "com.google.analytics.data.v1beta";
+option (google.api.resource_definition) = {
+  type: "analyticsadmin.googleapis.com/Property"
+  pattern: "properties/{property}"
+};
 
 // Google Analytics reporting data service.
 service BetaAnalyticsData {
@@ -135,6 +141,114 @@ service BetaAnalyticsData {
       body: "*"
     };
   }
+
+  // Creates an audience export for later retrieval. This method quickly returns
+  // the audience export's resource name and initiates a long running
+  // asynchronous request to form an audience export. To export the users in an
+  // audience export, first create the audience export through this method and
+  // then send the audience resource name to the `QueryAudienceExport` method.
+  //
+  // See [Creating an Audience
+  // Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+  // for an introduction to Audience Exports with examples.
+  //
+  // An audience export is a snapshot of the users currently in the audience at
+  // the time of audience export creation. Creating audience exports for one
+  // audience on different days will return different results as users enter and
+  // exit the audience.
+  //
+  // Audiences in Google Analytics 4 allow you to segment your users in the ways
+  // that are important to your business. To learn more, see
+  // https://support.google.com/analytics/answer/9267572. Audience exports
+  // contain the users in each audience.
+  //
+  // Audience Export APIs have some methods at alpha and other methods at beta
+  // stability. The intention is to advance methods to beta stability after some
+  // feedback and adoption. To give your feedback on this API, complete the
+  // [Google Analytics Audience Export API
+  // Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+  rpc CreateAudienceExport(CreateAudienceExportRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1beta/{parent=properties/*}/audienceExports"
+      body: "audience_export"
+    };
+    option (google.api.method_signature) = "parent,audience_export";
+    option (google.longrunning.operation_info) = {
+      response_type: "AudienceExport"
+      metadata_type: "AudienceExportMetadata"
+    };
+  }
+
+  // Retrieves an audience export of users. After creating an audience, the
+  // users are not immediately available for exporting. First, a request to
+  // `CreateAudienceExport` is necessary to create an audience export of users,
+  // and then second, this method is used to retrieve the users in the audience
+  // export.
+  //
+  // See [Creating an Audience
+  // Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+  // for an introduction to Audience Exports with examples.
+  //
+  // Audiences in Google Analytics 4 allow you to segment your users in the ways
+  // that are important to your business. To learn more, see
+  // https://support.google.com/analytics/answer/9267572.
+  //
+  // Audience Export APIs have some methods at alpha and other methods at beta
+  // stability. The intention is to advance methods to beta stability after some
+  // feedback and adoption. To give your feedback on this API, complete the
+  // [Google Analytics Audience Export API
+  // Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+  rpc QueryAudienceExport(QueryAudienceExportRequest)
+      returns (QueryAudienceExportResponse) {
+    option (google.api.http) = {
+      post: "/v1beta/{name=properties/*/audienceExports/*}:query"
+      body: "*"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Gets configuration metadata about a specific audience export. This method
+  // can be used to understand an audience export after it has been created.
+  //
+  // See [Creating an Audience
+  // Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+  // for an introduction to Audience Exports with examples.
+  //
+  // Audience Export APIs have some methods at alpha and other methods at beta
+  // stability. The intention is to advance methods to beta stability after some
+  // feedback and adoption. To give your feedback on this API, complete the
+  // [Google Analytics Audience Export API
+  // Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+  rpc GetAudienceExport(GetAudienceExportRequest) returns (AudienceExport) {
+    option (google.api.http) = {
+      get: "/v1beta/{name=properties/*/audienceExports/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Lists all audience exports for a property. This method can be used for you
+  // to find and reuse existing audience exports rather than creating
+  // unnecessary new audience exports. The same audience can have multiple
+  // audience exports that represent the export of users that were in an
+  // audience on different days.
+  //
+  // See [Creating an Audience
+  // Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+  // for an introduction to Audience Exports with examples.
+  //
+  // Audience Export APIs have some methods at alpha and other methods at beta
+  // stability. The intention is to advance methods to beta stability after some
+  // feedback and adoption. To give your feedback on this API, complete the
+  // [Google Analytics Audience Export API
+  // Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+  rpc ListAudienceExports(ListAudienceExportsRequest)
+      returns (ListAudienceExportsResponse) {
+    option (google.api.http) = {
+      get: "/v1beta/{parent=properties/*}/audienceExports"
+    };
+    option (google.api.method_signature) = "parent";
+  }
 }
 
 // The request for compatibility information for a report's dimensions and
@@ -181,7 +295,8 @@ message CheckCompatibilityResponse {
   repeated MetricCompatibility metric_compatibilities = 2;
 }
 
-// The dimensions and metrics currently accepted in reporting methods.
+// The dimensions, metrics and comparisons currently accepted in reporting
+// methods.
 message Metadata {
   option (google.api.resource) = {
     type: "analyticsdata.googleapis.com/Metadata"
@@ -640,3 +755,228 @@ message RunRealtimeReportResponse {
   // between response types in JSON.
   string kind = 9;
 }
+
+// A request to retrieve configuration metadata about a specific audience
+// export.
+message GetAudienceExportRequest {
+  // Required. The audience export resource name.
+  // Format: `properties/{property}/audienceExports/{audience_export}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "analyticsdata.googleapis.com/AudienceExport"
+    }
+  ];
+}
+
+// A request to list all audience exports for a property.
+message ListAudienceExportsRequest {
+  // Required. All audience exports for this property will be listed in the
+  // response. Format: `properties/{property}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "analyticsdata.googleapis.com/AudienceExport"
+    }
+  ];
+
+  // Optional. The maximum number of audience exports to return. The service may
+  // return fewer than this value. If unspecified, at most 200 audience exports
+  // will be returned. The maximum value is 1000 (higher values will be coerced
+  // to the maximum).
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. A page token, received from a previous `ListAudienceExports`
+  // call. Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListAudienceExports`
+  // must match the call that provided the page token.
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// A list of all audience exports for a property.
+message ListAudienceExportsResponse {
+  // Each audience export for a property.
+  repeated AudienceExport audience_exports = 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.
+  optional string next_page_token = 2;
+}
+
+// A request to create a new audience export.
+message CreateAudienceExportRequest {
+  // Required. The parent resource where this audience export will be created.
+  // Format: `properties/{property}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "analyticsdata.googleapis.com/AudienceExport"
+    }
+  ];
+
+  // Required. The audience export to create.
+  AudienceExport audience_export = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// An audience export is a list of users in an audience at the time of the
+// list's creation. One audience may have multiple audience exports created for
+// different days.
+message AudienceExport {
+  option (google.api.resource) = {
+    type: "analyticsdata.googleapis.com/AudienceExport"
+    pattern: "properties/{property}/audienceExports/{audience_export}"
+    plural: "audienceExports"
+    singular: "audienceExport"
+  };
+
+  // The AudienceExport currently exists in this state.
+  enum State {
+    // Unspecified state will never be used.
+    STATE_UNSPECIFIED = 0;
+
+    // The AudienceExport is currently creating and will be available in the
+    // future. Creating occurs immediately after the CreateAudienceExport call.
+    CREATING = 1;
+
+    // The AudienceExport is fully created and ready for querying. An
+    // AudienceExport is updated to active asynchronously from a request; this
+    // occurs some time (for example 15 minutes) after the initial create call.
+    ACTIVE = 2;
+
+    // The AudienceExport failed to be created. It is possible that
+    // re-requesting this audience export will succeed.
+    FAILED = 3;
+  }
+
+  // Output only. Identifier. The audience export resource name assigned during
+  // creation. This resource name identifies this `AudienceExport`.
+  //
+  // Format: `properties/{property}/audienceExports/{audience_export}`
+  string name = 1 [
+    (google.api.field_behavior) = IDENTIFIER,
+    (google.api.field_behavior) = OUTPUT_ONLY
+  ];
+
+  // Required. The audience resource name. This resource name identifies the
+  // audience being listed and is shared between the Analytics Data & Admin
+  // APIs.
+  //
+  // Format: `properties/{property}/audiences/{audience}`
+  string audience = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Output only. The descriptive display name for this audience. For example,
+  // "Purchasers".
+  string audience_display_name = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Required. The dimensions requested and displayed in the query response.
+  repeated AudienceDimension dimensions = 4
+      [(google.api.field_behavior) = REQUIRED];
+
+  // Output only. The current state for this AudienceExport.
+  optional State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The time when CreateAudienceExport was called and the
+  // AudienceExport began the `CREATING` state.
+  optional google.protobuf.Timestamp begin_creating_time = 6
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The total quota tokens charged during creation of the
+  // AudienceExport. Because this token count is based on activity from the
+  // `CREATING` state, this tokens charged will be fixed once an AudienceExport
+  // enters the `ACTIVE` or `FAILED` states.
+  int32 creation_quota_tokens_charged = 7
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The total number of rows in the AudienceExport result.
+  optional int32 row_count = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Error message is populated when an audience export fails
+  // during creation. A common reason for such a failure is quota exhaustion.
+  optional string error_message = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The percentage completed for this audience export ranging
+  // between 0 to 100.
+  optional double percentage_completed = 10
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// This metadata is currently blank.
+message AudienceExportMetadata {}
+
+// A request to list users in an audience export.
+message QueryAudienceExportRequest {
+  // Required. The name of the audience export to retrieve users from.
+  // Format: `properties/{property}/audienceExports/{audience_export}`
+  string name = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. The row count of the start row. The first row is counted as row
+  // 0.
+  //
+  // When paging, the first request does not specify offset; or equivalently,
+  // sets offset to 0; the first request returns the first `limit` of rows. The
+  // second request sets offset to the `limit` of the first request; the second
+  // request returns the second `limit` of rows.
+  //
+  // To learn more about this pagination parameter, see
+  // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+  int64 offset = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The number of rows to return. If unspecified, 10,000 rows are
+  // returned. The API returns a maximum of 250,000 rows per request, no matter
+  // how many you ask for. `limit` must be positive.
+  //
+  // The API can also return fewer rows than the requested `limit`, if there
+  // aren't as many dimension values as the `limit`.
+  //
+  // To learn more about this pagination parameter, see
+  // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+  int64 limit = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// A list of users in an audience export.
+message QueryAudienceExportResponse {
+  // Configuration data about AudienceExport being queried. Returned to help
+  // interpret the audience rows in this response. For example, the dimensions
+  // in this AudienceExport correspond to the columns in the AudienceRows.
+  optional AudienceExport audience_export = 1;
+
+  // Rows for each user in an audience export. The number of rows in this
+  // response will be less than or equal to request's page size.
+  repeated AudienceRow audience_rows = 2;
+
+  // The total number of rows in the AudienceExport result. `rowCount` is
+  // independent of the number of rows returned in the response, the `limit`
+  // request parameter, and the `offset` request parameter. For example if a
+  // query returns 175 rows and includes `limit` of 50 in the API request, the
+  // response will contain `rowCount` of 175 but only 50 rows.
+  //
+  // To learn more about this pagination parameter, see
+  // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+  optional int32 row_count = 3;
+}
+
+// Dimension value attributes for the audience user row.
+message AudienceRow {
+  // Each dimension value attribute for an audience user. One dimension value
+  // will be added for each dimension column requested.
+  repeated AudienceDimensionValue dimension_values = 1;
+}
+
+// An audience dimension is a user attribute. Specific user attributed are
+// requested and then later returned in the `QueryAudienceExportResponse`.
+message AudienceDimension {
+  // Optional. The API name of the dimension. See the [API
+  // Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions)
+  // for the list of dimension names.
+  string dimension_name = 1 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// The value of a dimension.
+message AudienceDimensionValue {
+  // One kind of dimension value.
+  oneof one_value {
+    // Value as a string if the dimension type is a string.
+    string value = 1;
+  }
+}

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.