@google-analytics/data 4.7.0 → 4.9.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [4.9.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.8.0...data-v4.9.0) (2024-09-24)
+
+
+### Features
+
+* [analytics-data] add `GetPropertyQuotasSnapshot` method to the Data API v1alpha ([#5692](https://github.com/googleapis/google-cloud-node/issues/5692)) ([a143a79](https://github.com/googleapis/google-cloud-node/commit/a143a7926ab91dce75a2db2d831d498d3f3524d8))
+
+## [4.8.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.7.0...data-v4.8.0) (2024-08-09)
+
+
+### Features
+
+* [analytics-data] add the `comparisons` field to the `Metadata` resource ([#5600](https://github.com/googleapis/google-cloud-node/issues/5600)) ([e77b934](https://github.com/googleapis/google-cloud-node/commit/e77b9348a198e3a3e60e71474ac3320273d17f6e))
+
 ## [4.7.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.6.0...data-v4.7.0) (2024-05-21)
 
 

package/README.md

@@ -43,7 +43,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 
 1.  [Select or create a Cloud Platform project][projects].
 1.  [Enable the Google Analytics Data API][enable_api].
-1.  [Set up authentication with a service account][auth] so you can access the
+1.  [Set up authentication][auth] so you can access the
     API from your local workstation.
 
 ### Installing the client library
@@ -113,6 +113,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
 | Alpha_analytics_data.create_recurring_audience_list | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.create_recurring_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_recurring_audience_list.js,packages/google-analytics-data/samples/README.md) |
 | Alpha_analytics_data.create_report_task | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.create_report_task.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_report_task.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.get_property_quotas_snapshot | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_property_quotas_snapshot.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_property_quotas_snapshot.js,packages/google-analytics-data/samples/README.md) |
 | Alpha_analytics_data.get_recurring_audience_list | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_recurring_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_recurring_audience_list.js,packages/google-analytics-data/samples/README.md) |
 | Alpha_analytics_data.get_report_task | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_report_task.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_report_task.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) |
@@ -202,4 +203,4 @@ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
 [projects]: https://console.cloud.google.com/project
 [billing]: https://support.google.com/cloud/answer/6293499#enable-billing
 [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=analyticsdata.googleapis.com
-[auth]: https://cloud.google.com/docs/authentication/getting-started
+[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local

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

@@ -266,10 +266,26 @@ service AlphaAnalyticsData {
     option (google.api.method_signature) = "parent";
   }
 
+  // Get all property quotas organized by quota category for a given property.
+  // This will charge 1 property quota from the category with the most quota.
+  rpc GetPropertyQuotasSnapshot(GetPropertyQuotasSnapshotRequest)
+      returns (PropertyQuotasSnapshot) {
+    option (google.api.http) = {
+      get: "/v1alpha/{name=properties/*/propertyQuotasSnapshot}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
   // Initiates the creation of a report task. This method quickly
   // returns a report task and initiates a long running
   // asynchronous request to form a customized report of your Google Analytics
   // event data.
+  //
+  // A report task will be retained and available for querying for 72 hours
+  // after it has been created.
+  //
+  // A report task created by one user can be listed and queried by all users
+  // who have access to the property.
   rpc CreateReportTask(CreateReportTaskRequest)
       returns (google.longrunning.Operation) {
     option (google.api.http) = {
@@ -514,6 +530,40 @@ message ListRecurringAudienceListsResponse {
   optional string next_page_token = 2;
 }
 
+// A request to return the PropertyQuotasSnapshot for a given category.
+message GetPropertyQuotasSnapshotRequest {
+  // Required. Quotas from this property will be listed in the response.
+  // Format: `properties/{property}/propertyQuotasSnapshot`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "analyticsadmin.googleapis.com/PropertyQuotasSnapshot"
+    }
+  ];
+}
+
+// Current state of all Property Quotas organized by quota category.
+message PropertyQuotasSnapshot {
+  option (google.api.resource) = {
+    type: "analyticsadmin.googleapis.com/PropertyQuotasSnapshot"
+    pattern: "properties/{property}/propertyQuotasSnapshot"
+    plural: "propertyQuotasSnapshots"
+    singular: "propertyQuotasSnapshot"
+  };
+
+  // Identifier. The property quota snapshot resource name.
+  string name = 4 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Property Quota for core property tokens
+  PropertyQuota core_property_quota = 1;
+
+  // Property Quota for realtime property tokens
+  PropertyQuota realtime_property_quota = 2;
+
+  // Property Quota for funnel property tokens
+  PropertyQuota funnel_property_quota = 3;
+}
+
 // A request to retrieve configuration metadata about a specific audience list.
 message GetAudienceListRequest {
   // Required. The audience list resource name.
@@ -844,9 +894,9 @@ message RunFunnelReportRequest {
     TRENDED_FUNNEL = 2;
   }
 
-  // Optional. A Google Analytics GA4 property identifier whose events are
-  // tracked. Specified in the URL path and not the body. To learn more, see
-  // [where to find your Property
+  // Optional. A Google Analytics property identifier whose events are tracked.
+  // Specified in the URL path and not the body. To learn more, see [where to
+  // find your Property
   // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
   // Within a batch request, this property should either be unspecified or
   // consistent with the batch-level property.
@@ -1030,7 +1080,7 @@ message ReportTask {
     // 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.
+    // Google Analytics 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
@@ -1104,7 +1154,7 @@ message ReportTask {
   }
 
   // Output only. Identifier. The report task resource name assigned during
-  // creation. Format: `properties/{property}/reportTasks/{report_task}`
+  // creation. Format: "properties/{property}/reportTasks/{report_task}"
   string name = 1 [
     (google.api.field_behavior) = IDENTIFIER,
     (google.api.field_behavior) = OUTPUT_ONLY

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

@@ -1107,7 +1107,7 @@ enum EventExclusionDuration {
 // Another segment might be users who purchase a particular line of products or
 // who visit a specific part of your site or trigger certain events in your app.
 //
-// To learn more, see [GA4 Segment
+// To learn more, see [Segment
 // Builder](https://support.google.com/analytics/answer/9304353).
 message Segment {
   // The name for this segment. If unspecified, segments are named "Segment".
@@ -1561,8 +1561,8 @@ enum MetricType {
   TYPE_KILOMETERS = 13;
 }
 
-// Categories of data that you may be restricted from viewing on certain GA4
-// properties.
+// Categories of data that you may be restricted from viewing on certain
+// Google Analytics properties.
 enum RestrictedMetricType {
   // Unspecified type.
   RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0;

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

@@ -311,6 +311,9 @@ message Metadata {
 
   // The metric descriptions.
   repeated MetricMetadata metrics = 2;
+
+  // The comparison descriptions.
+  repeated ComparisonMetadata comparisons = 4;
 }
 
 // The request to generate a report.
@@ -403,6 +406,11 @@ message RunReportRequest {
   // Toggles whether to return the current state of this Analytics Property's
   // quota. Quota is returned in [PropertyQuota](#PropertyQuota).
   bool return_property_quota = 14;
+
+  // Optional. The configuration of comparisons requested and displayed. The
+  // request only requires a comparisons field in order to receive a comparison
+  // column in the response.
+  repeated Comparison comparisons = 15 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response report table corresponding to a request.
@@ -515,6 +523,11 @@ message RunPivotReportRequest {
   // Toggles whether to return the current state of this Analytics Property's
   // quota. Quota is returned in [PropertyQuota](#PropertyQuota).
   bool return_property_quota = 11;
+
+  // Optional. The configuration of comparisons requested and displayed. The
+  // request requires both a comparisons field and a comparisons dimension to
+  // receive a comparison column in the response.
+  repeated Comparison comparisons = 12 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response pivot report table corresponding to a pivot request.

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

@@ -186,6 +186,25 @@ message Metric {
   bool invisible = 3;
 }
 
+// Defines an individual comparison. Most requests will include multiple
+// comparisons so that the report compares between the comparisons.
+message Comparison {
+  // Each comparison produces separate rows in the response. In the response,
+  // this comparison is identified by this name. If name is unspecified, we will
+  // use the saved comparisons display name.
+  optional string name = 1;
+
+  // One kind of comparison value
+  oneof one_comparison {
+    // A basic comparison.
+    FilterExpression dimension_filter = 2;
+
+    // A saved comparison identified by the comparison's resource name.
+    // For example, 'comparisons/1234'.
+    string comparison = 3;
+  }
+}
+
 // To express dimension or metric filters. The fields in the same
 // FilterExpression need to be either all dimensions or all metrics.
 message FilterExpression {
@@ -861,7 +880,11 @@ message DimensionMetadata {
   // available only by `apiName`.
   repeated string deprecated_api_names = 4;
 
-  // True if the dimension is a custom dimension for this property.
+  // True if the dimension is custom to this property. This includes user,
+  // event, & item scoped custom dimensions; to learn more about custom
+  // dimensions, see https://support.google.com/analytics/answer/14240153. This
+  // also include custom channel groups; to learn more about custom channel
+  // groups, see https://support.google.com/analytics/answer/13051316.
   bool custom_definition = 5;
 
   // The display name of the category that this dimension belongs to. Similar
@@ -928,6 +951,19 @@ message MetricMetadata {
   string category = 10;
 }
 
+// The metadata for a single comparison.
+message ComparisonMetadata {
+  // This comparison's resource name. Useable in [Comparison](#Comparison)'s
+  // `comparison` field. For example, 'comparisons/1234'.
+  string api_name = 1;
+
+  // This comparison's name within the Google Analytics user interface.
+  string ui_name = 2;
+
+  // This comparison's description.
+  string description = 3;
+}
+
 // The compatibility for a single dimension.
 message DimensionCompatibility {
   // The dimension metadata contains the API name for this compatibility