@google-analytics/data 3.2.2 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [4.0.0](https://github.com/googleapis/google-cloud-node/compare/data-v3.3.0...data-v4.0.0) (2023-08-06)
+
+
+### ⚠ BREAKING CHANGES
+
+* migrate to Node 14 ([#4443](https://github.com/googleapis/google-cloud-node/issues/4443))
+
+### Bug Fixes
+
+* [Many APIs] fix typings for IAM methods ([#4459](https://github.com/googleapis/google-cloud-node/issues/4459)) ([1d510be](https://github.com/googleapis/google-cloud-node/commit/1d510bef5bd7b0ac3552b4729ef3d9ebe1ac3dc4))
+
+
+### Miscellaneous Chores
+
+* Migrate to Node 14 ([#4443](https://github.com/googleapis/google-cloud-node/issues/4443)) ([2260f12](https://github.com/googleapis/google-cloud-node/commit/2260f12543d171bda95345e53475f5f0fdc45770))
+
+## [3.3.0](https://github.com/googleapis/google-cloud-node/compare/data-v3.2.2...data-v3.3.0) (2023-07-11)
+
+
+### Features
+
+* [analytics-data] add `CreateAudienceList`, `QueryAudienceList`,`GetAudienceList`,`ListAudienceLists` methods to the Data API v1 alpha ([#4409](https://github.com/googleapis/google-cloud-node/issues/4409)) ([b81d695](https://github.com/googleapis/google-cloud-node/commit/b81d695e7f0a70d0b2821a8c2de8dbf34f801b70))
+
 ## [3.2.2](https://github.com/googleapis/google-cloud-node/compare/data-v3.2.1...data-v3.2.2) (2023-04-13)
 
 

package/README.md

@@ -2,7 +2,7 @@
 [//]: # "To regenerate it, use `python -m synthtool`."
 <img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
 
-# [Google Analytics Data: Node.js Client](https://github.com/googleapis/google-cloud-node)
+# [Google Analytics Data: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-analytics-data)
 
 [![release level](https://img.shields.io/badge/release%20level-preview-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
 [![npm version](https://img.shields.io/npm/v/@google-analytics/data.svg)](https://www.npmjs.org/package/@google-analytics/data)
@@ -105,20 +105,23 @@ runReport();
 
 ## Samples
 
-Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample.
+Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-analytics-data/samples) directory. Each sample's `README.md` has instructions for running its sample.
 
 | Sample                      | Source Code                       | Try it |
 | --------------------------- | --------------------------------- | ------ |
-| Alpha_analytics_data.run_funnel_report | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.run_funnel_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/v1alpha/alpha_analytics_data.run_funnel_report.js,samples/README.md) |
-| 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,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,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,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,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,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,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,samples/README.md) |
-| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/quickstart.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/quickstart.js,samples/README.md) |
-| Quickstart.test | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/test/quickstart.test.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/test/quickstart.test.js,samples/README.md) |
+| Alpha_analytics_data.create_audience_list | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.create_audience_list.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/v1alpha/alpha_analytics_data.create_audience_list.js,packages/google-analytics-data/samples/README.md) |
+| Alpha_analytics_data.get_audience_list | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_audience_list.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/v1alpha/alpha_analytics_data.get_audience_list.js,packages/google-analytics-data/samples/README.md) |
+| Alpha_analytics_data.list_audience_lists | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.list_audience_lists.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/v1alpha/alpha_analytics_data.list_audience_lists.js,packages/google-analytics-data/samples/README.md) |
+| Alpha_analytics_data.query_audience_list | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.query_audience_list.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/v1alpha/alpha_analytics_data.query_audience_list.js,packages/google-analytics-data/samples/README.md) |
+| Alpha_analytics_data.run_funnel_report | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.run_funnel_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/v1alpha/alpha_analytics_data.run_funnel_report.js,packages/google-analytics-data/samples/README.md) |
+| 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.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.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) |
+| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/quickstart.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/quickstart.js,packages/google-analytics-data/samples/README.md) |
 
 
 
@@ -127,7 +130,7 @@ also contains samples.
 
 ## Supported Node.js Versions
 
-Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/).
+Our client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule).
 Libraries are compatible with all current _active_ and _maintenance_ versions of
 Node.js.
 If you are using an end-of-life version of Node.js, we recommend that you update

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

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -19,11 +19,19 @@ package google.analytics.data.v1alpha;
 import "google/analytics/data/v1alpha/data.proto";
 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/v1alpha;data";
 option java_multiple_files = true;
 option java_outer_classname = "AnalyticsDataApiProto";
 option java_package = "com.google.analytics.data.v1alpha";
+option (google.api.resource_definition) = {
+  type: "analyticsadmin.googleapis.com/Property"
+  pattern: "properties/{propertyId}"
+};
 
 // Google Analytics reporting data service.
 service AlphaAnalyticsData {
@@ -42,12 +50,284 @@ service AlphaAnalyticsData {
   // How do one time buyers become repeat buyers? With this information, you can
   // improve inefficient or abandoned customer journeys. To learn more, see [GA4
   // Funnel Explorations](https://support.google.com/analytics/answer/9327974).
-  rpc RunFunnelReport(RunFunnelReportRequest) returns (RunFunnelReportResponse) {
+  //
+  // This method is introduced at alpha stability with the intention of
+  // gathering feedback on syntax and capabilities before entering beta. To give
+  // your feedback on this API, complete the [Google Analytics Data API Funnel
+  // Reporting
+  // Feedback](https://docs.google.com/forms/d/e/1FAIpQLSdwOlQDJAUoBiIgUZZ3S_Lwi8gr7Bb0k1jhvc-DEg7Rol3UjA/viewform).
+  rpc RunFunnelReport(RunFunnelReportRequest)
+      returns (RunFunnelReportResponse) {
     option (google.api.http) = {
       post: "/v1alpha/{property=properties/*}:runFunnelReport"
       body: "*"
     };
   }
+
+  // Creates an audience list for later retrieval. This method quickly returns
+  // the audience list's resource name and initiates a long running asynchronous
+  // request to form an audience list. To list the users in an audience list,
+  // first create the audience list through this method and then send the
+  // audience resource name to the `QueryAudienceList` method.
+  //
+  // An audience list is a snapshot of the users currently in the audience at
+  // the time of audience list creation. Creating audience lists 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 lists contain
+  // the users in each audience.
+  rpc CreateAudienceList(CreateAudienceListRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1alpha/{parent=properties/*}/audienceLists"
+      body: "audience_list"
+    };
+    option (google.api.method_signature) = "parent,audience_list";
+    option (google.longrunning.operation_info) = {
+      response_type: "AudienceList"
+      metadata_type: "AudienceListMetadata"
+    };
+  }
+
+  // Retrieves an audience list of users. After creating an audience, the users
+  // are not immediately available for listing. First, a request to
+  // `CreateAudienceList` is necessary to create an audience list of users, and
+  // then second, this method is used to retrieve the users in 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.
+  rpc QueryAudienceList(QueryAudienceListRequest)
+      returns (QueryAudienceListResponse) {
+    option (google.api.http) = {
+      post: "/v1alpha/{name=properties/*/audienceLists/*}:query"
+      body: "*"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Gets configuration metadata about a specific audience list. This method
+  // can be used to understand an audience list after it has been created.
+  rpc GetAudienceList(GetAudienceListRequest) returns (AudienceList) {
+    option (google.api.http) = {
+      get: "/v1alpha/{name=properties/*/audienceLists/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Lists all audience lists for a property. This method can be used for you to
+  // find and reuse existing audience lists rather than creating unnecessary new
+  // audience lists. The same audience can have multiple audience lists that
+  // represent the list of users that were in an audience on different days.
+  rpc ListAudienceLists(ListAudienceListsRequest)
+      returns (ListAudienceListsResponse) {
+    option (google.api.http) = {
+      get: "/v1alpha/{parent=properties/*}/audienceLists"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+}
+
+// A request to retrieve configuration metadata about a specific audience list.
+message GetAudienceListRequest {
+  // Required. The audience list resource name.
+  // Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "analyticsdata.googleapis.com/AudienceList"
+    }
+  ];
+}
+
+// A request to list all audience lists for a property.
+message ListAudienceListsRequest {
+  // Required. All audience lists for this property will be listed in the
+  // response. Format: `properties/{propertyId}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "analyticsdata.googleapis.com/AudienceList"
+    }
+  ];
+
+  // The maximum number of audience lists to return. The service may return
+  // fewer than this value. If unspecified, at most 200 audience lists will be
+  // returned. The maximum value is 1000 (higher values will be coerced to the
+  // maximum).
+  int32 page_size = 2;
+
+  // A page token, received from a previous `ListAudienceLists` call. Provide
+  // this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListAudienceLists` must
+  // match the call that provided the page token.
+  string page_token = 3;
+}
+
+// A list of all audience lists for a property.
+message ListAudienceListsResponse {
+  // Each audience list for a property.
+  repeated AudienceList audience_lists = 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 list.
+message CreateAudienceListRequest {
+  // Required. The parent resource where this audience list will be created.
+  // Format: `properties/{propertyId}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "analyticsdata.googleapis.com/AudienceList"
+    }
+  ];
+
+  // Required. The audience list to create.
+  AudienceList audience_list = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// An audience list is a list of users in an audience at the time of the list's
+// creation. One audience may have multiple audience lists created for different
+// days.
+message AudienceList {
+  option (google.api.resource) = {
+    type: "analyticsdata.googleapis.com/AudienceList"
+    pattern: "properties/{propertyId}/audienceLists/{audienceListId}"
+  };
+
+  // The AudienceList currently exists in this state.
+  enum State {
+    // Unspecified state will never be used.
+    STATE_UNSPECIFIED = 0;
+
+    // The AudienceList is currently creating and will be available in the
+    // future. Creating occurs immediately after the CreateAudienceList call.
+    CREATING = 1;
+
+    // The AudienceList is fully created and ready for querying. An AudienceList
+    // is updated to active asynchronously from a request; this occurs some
+    // time (for example 15 minutes) after the initial create call.
+    ACTIVE = 2;
+
+    // The AudienceList failed to be created. It is possible that re-requesting
+    // this audience list will succeed.
+    FAILED = 3;
+  }
+
+  // Output only. The audience list resource name assigned during creation. This
+  // resource name identifies this `AudienceList`.
+  //
+  // Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+  string name = 1 [(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/{propertyId}/audiences/{audienceId}`
+  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 report response.
+  repeated AudienceDimension dimensions = 4
+      [(google.api.field_behavior) = REQUIRED];
+
+  // Output only. The current state for this AudienceList.
+  optional State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The time when CreateAudienceList was called and the
+  // AudienceList began the `CREATING` state.
+  optional google.protobuf.Timestamp begin_creating_time = 6
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// This metadata is currently blank.
+message AudienceListMetadata {}
+
+// A request to list users in an audience list.
+message QueryAudienceListRequest {
+  // The name of the audience list to retrieve users from.
+  // Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+  string name = 1;
+
+  // 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;
+
+  // 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;
+}
+
+// A list of users in an audience list.
+message QueryAudienceListResponse {
+  // Configuration data about AudienceList being queried. Returned to help
+  // interpret the audience rows in this response. For example, the dimensions
+  // in this AudienceList correspond to the columns in the AudienceRows.
+  optional AudienceList audience_list = 1;
+
+  // Rows for each user in an audience list. 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 query 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 `QueryAudienceListResponse`.
+message AudienceDimension {
+  // 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;
+}
+
+// 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;
+  }
 }
 
 // The request for a funnel report.
@@ -97,7 +377,7 @@ message RunFunnelReportRequest {
   // If specified, next action adds a dimension to the funnel visualization sub
   // report response. This next action dimension expands each funnel step to the
   // unique values of the next action. For example a next action of the
-  // `eventName` dimension will create rows for several events (i.e.
+  // `eventName` dimension will create rows for several events (for example
   // `session_start` & `click`) and the total.
   //
   // Next action only supports `eventName` and most Page / Screen dimensions
@@ -120,7 +400,7 @@ message RunFunnelReportRequest {
   repeated Segment segments = 7;
 
   // The number of rows to return. If unspecified, 10,000 rows are returned. The
-  // API returns a maximum of 100,000 rows per request, no matter how many you
+  // 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
@@ -155,8 +435,8 @@ message RunFunnelReportResponse {
   //
   // The segment dimension is only present in this response if a segment was
   // requested. The date dimension is only present in this response if it was
-  // requested via the `TRENDED_FUNNEL` funnel type. The next action dimension
-  // is only present in the response if it was requested.
+  // requested through the `TRENDED_FUNNEL` funnel type. The next action
+  // dimension is only present in the response if it was requested.
   FunnelSubReport funnel_visualization = 2;
 
   // This Analytics Property's quota state including this request.

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

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -344,15 +344,15 @@ message MetricValue {
 // property is exhausted, all requests to that property will return Resource
 // Exhausted errors.
 message PropertyQuota {
-  // Standard Analytics Properties can use up to 25,000 tokens per day;
-  // Analytics 360 Properties can use 250,000 tokens per day. Most requests
+  // Standard Analytics Properties can use up to 200,000 tokens per day;
+  // Analytics 360 Properties can use 2,000,000 tokens per day. Most requests
   // consume fewer than 10 tokens.
   QuotaStatus tokens_per_day = 1;
 
-  // Standard Analytics Properties can use up to 5,000 tokens per hour;
-  // Analytics 360 Properties can use 50,000 tokens per hour. An API request
-  // consumes a single number of tokens, and that number is deducted from both
-  // the hourly and daily quotas.
+  // Standard Analytics Properties can use up to 40,000 tokens per hour;
+  // Analytics 360 Properties can use 400,000 tokens per hour. An API request
+  // consumes a single number of tokens, and that number is deducted from all of
+  // the hourly, daily, and per project hourly quotas.
   QuotaStatus tokens_per_hour = 2;
 
   // Standard Analytics Properties can send up to 10 concurrent requests;
@@ -369,6 +369,14 @@ message PropertyQuota {
   // is individually counted for this quota if the request contains potentially
   // thresholded dimensions.
   QuotaStatus potentially_thresholded_requests_per_hour = 5;
+
+  // Analytics Properties can use up to 35% of their tokens per project per
+  // hour. This amounts to standard Analytics Properties can use up to 14,000
+  // tokens per project per hour, and Analytics 360 Properties can use 140,000
+  // tokens per project per hour. An API request consumes a single number of
+  // tokens, and that number is deducted from all of the hourly, daily, and per
+  // project hourly quotas.
+  QuotaStatus tokens_per_project_per_hour = 6;
 }
 
 // Current state for a particular quota group.
@@ -438,10 +446,10 @@ message Funnel {
 // the funnel journey.
 message FunnelStep {
   // The distinctive name for this step. If unspecified, steps will be named
-  // by a 1 based indexed name (i.e. "0. ", "1. ", etc.). This name defines
-  // string value returned by the `funnelStepName` dimension. For example,
-  // specifying `name = Purchase` in the request's third funnel step will
-  // produce `3. Purchase` in the funnel report response.
+  // by a 1 based indexed name (for example "0. ", "1. ", etc.). This name
+  // defines string value returned by the `funnelStepName` dimension. For
+  // example, specifying `name = Purchase` in the request's third funnel step
+  // will produce `3. Purchase` in the funnel report response.
   string name = 1;
 
   // If true, this step must directly follow the previous step. If false,
@@ -804,7 +812,7 @@ message Segment {
   // The name for this segment. If unspecified, segments are named "Segment".
   // This name defines string value returned by the `segment` dimension. The
   // `segment` dimension prefixes segment names by the 1-based index number of
-  // the segment in the request (i.e. "1. Segment", "2. Segment", etc.).
+  // the segment in the request (for example "1. Segment", "2. Segment", etc.).
   string name = 1;
 
   // A segment is specified in one scope.
@@ -910,7 +918,8 @@ message SegmentEventFilter {
   //
   // Inside the parameter filter expression, only parameter filters are
   // available.
-  optional SegmentParameterFilterExpression segment_parameter_filter_expression = 2;
+  optional SegmentParameterFilterExpression
+      segment_parameter_filter_expression = 2;
 }
 
 // Expresses combinations of segment filter on parameters.
@@ -1081,7 +1090,8 @@ message FunnelEventFilter {
   //
   // Inside the parameter filter expression, only parameter filters are
   // available.
-  optional FunnelParameterFilterExpression funnel_parameter_filter_expression = 2;
+  optional FunnelParameterFilterExpression funnel_parameter_filter_expression =
+      2;
 }
 
 // Expresses combinations of funnel filters on parameters.

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

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -66,7 +66,8 @@ service BetaAnalyticsData {
 
   // Returns multiple reports in a batch. All reports must be for the same
   // GA4 Property.
-  rpc BatchRunReports(BatchRunReportsRequest) returns (BatchRunReportsResponse) {
+  rpc BatchRunReports(BatchRunReportsRequest)
+      returns (BatchRunReportsResponse) {
     option (google.api.http) = {
       post: "/v1beta/{property=properties/*}:batchRunReports"
       body: "*"
@@ -75,7 +76,8 @@ service BetaAnalyticsData {
 
   // Returns multiple pivot reports in a batch. All reports must be for the same
   // GA4 Property.
-  rpc BatchRunPivotReports(BatchRunPivotReportsRequest) returns (BatchRunPivotReportsResponse) {
+  rpc BatchRunPivotReports(BatchRunPivotReportsRequest)
+      returns (BatchRunPivotReportsResponse) {
     option (google.api.http) = {
       post: "/v1beta/{property=properties/*}:batchRunPivotReports"
       body: "*"
@@ -108,7 +110,8 @@ service BetaAnalyticsData {
   // For a guide to constructing realtime requests & understanding responses,
   // see [Creating a Realtime
   // Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics).
-  rpc RunRealtimeReport(RunRealtimeReportRequest) returns (RunRealtimeReportResponse) {
+  rpc RunRealtimeReport(RunRealtimeReportRequest)
+      returns (RunRealtimeReportResponse) {
     option (google.api.http) = {
       post: "/v1beta/{property=properties/*}:runRealtimeReport"
       body: "*"
@@ -125,7 +128,8 @@ service BetaAnalyticsData {
   //
   // The Realtime and Core reports have different compatibility rules. This
   // method checks compatibility for Core reports.
-  rpc CheckCompatibility(CheckCompatibilityRequest) returns (CheckCompatibilityResponse) {
+  rpc CheckCompatibility(CheckCompatibilityRequest)
+      returns (CheckCompatibilityResponse) {
     option (google.api.http) = {
       post: "/v1beta/{property=properties/*}:checkCompatibility"
       body: "*"
@@ -144,10 +148,6 @@ message CheckCompatibilityRequest {
   // `property` should be the same value as in your `runReport` request.
   //
   // Example: properties/1234
-  //
-  // Set the Property ID to 0 for compatibility checking on dimensions and
-  // metrics common to all properties. In this special mode, this method will
-  // not return custom dimensions and metrics.
   string property = 1;
 
   // The dimensions in this report. `dimensions` should be the same value as in
@@ -223,7 +223,7 @@ message RunReportRequest {
   // must be unspecified.
   repeated DateRange date_ranges = 4;
 
-  // Dimension filters allow you to ask for only specific dimension values in
+  // Dimension filters let you ask for only specific dimension values in
   // the report. To learn more, see [Fundamentals of Dimension
   // Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
   // for examples. Metrics cannot be used in this filter.
@@ -245,7 +245,7 @@ message RunReportRequest {
   int64 offset = 7;
 
   // The number of rows to return. If unspecified, 10,000 rows are returned. The
-  // API returns a maximum of 100,000 rows per request, no matter how many you
+  // 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
@@ -276,6 +276,13 @@ message RunReportRequest {
   // If false or unspecified, each row with all metrics equal to 0 will not be
   // returned. If true, these rows will be returned if they are not separately
   // removed by a filter.
+  //
+  // Regardless of this `keep_empty_rows` setting, only data recorded by the
+  // Google Analytics (GA4) property can be displayed in a report.
+  //
+  // For example if a property never logs a `purchase` event, then a query for
+  // the `eventName` dimension and  `eventCount` metric will not have a row
+  // eventName: "purchase" and eventCount: 0.
   bool keep_empty_rows = 13;
 
   // Toggles whether to return the current state of this Analytics Property's
@@ -381,6 +388,13 @@ message RunPivotReportRequest {
   // If false or unspecified, each row with all metrics equal to 0 will not be
   // returned. If true, these rows will be returned if they are not separately
   // removed by a filter.
+  //
+  // Regardless of this `keep_empty_rows` setting, only data recorded by the
+  // Google Analytics (GA4) property can be displayed in a report.
+  //
+  // For example if a property never logs a `purchase` event, then a query for
+  // the `eventName` dimension and  `eventCount` metric will not have a row
+  // eventName: "purchase" and eventCount: 0.
   bool keep_empty_rows = 10;
 
   // Toggles whether to return the current state of this Analytics Property's
@@ -560,7 +574,7 @@ message RunRealtimeReportRequest {
   FilterExpression metric_filter = 5;
 
   // The number of rows to return. If unspecified, 10,000 rows are returned. The
-  // API returns a maximum of 100,000 rows per request, no matter how many you
+  // 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