@google-analytics/data 4.5.0 → 4.7.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [4.7.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.6.0...data-v4.7.0) (2024-05-21)
+
+
+### Features
+
+* [Many APIs] update Nodejs generator to send API versions in headers for GAPICs ([#5351](https://github.com/googleapis/google-cloud-node/issues/5351)) ([01f48fc](https://github.com/googleapis/google-cloud-node/commit/01f48fce63ec4ddf801d59ee2b8c0db9f6fb8372))
+* [Many APIs] update Nodejs generator to send API versions in headers for GAPICs ([#5354](https://github.com/googleapis/google-cloud-node/issues/5354)) ([a9784ed](https://github.com/googleapis/google-cloud-node/commit/a9784ed3db6ee96d171762308bbbcd57390b6866))
+
+## [4.6.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.5.0...data-v4.6.0) (2024-05-08)
+
+
+### Features
+
+* Add `ReportTask`, `Metric`, `OrderBy`, `Cohort`, `CohortsRange`, `CohortReportSettings`, `ResponseMetaData`, `MetricAggregation`, `RestrictedMetricType` types to the Data API v1alpha ([#5318](https://github.com/googleapis/google-cloud-node/issues/5318)) ([76ae561](https://github.com/googleapis/google-cloud-node/commit/76ae561ee40d66cbba815cd7c9c964a6b92cc00c))
+
 ## [4.5.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.4.0...data-v4.5.0) (2024-04-16)
 
 

package/README.md

@@ -111,11 +111,15 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
 | --------------------------- | --------------------------------- | ------ |
 | 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.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_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) |
 | Alpha_analytics_data.list_recurring_audience_lists | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.list_recurring_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_recurring_audience_lists.js,packages/google-analytics-data/samples/README.md) |
+| Alpha_analytics_data.list_report_tasks | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.list_report_tasks.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_report_tasks.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.query_report_task | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.query_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.query_report_task.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) |
 | Alpha_analytics_data.sheet_export_audience_list | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.sheet_export_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.sheet_export_audience_list.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) |

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

@@ -1,4 +1,4 @@
-// Copyright 2023 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -265,6 +265,56 @@ service AlphaAnalyticsData {
     };
     option (google.api.method_signature) = "parent";
   }
+
+  // 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.
+  rpc CreateReportTask(CreateReportTaskRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1alpha/{parent=properties/*}/reportTasks"
+      body: "report_task"
+    };
+    option (google.api.method_signature) = "parent,report_task";
+    option (google.longrunning.operation_info) = {
+      response_type: "ReportTask"
+      metadata_type: "ReportTaskMetadata"
+    };
+  }
+
+  // Retrieves a report task's content. After requesting the `CreateReportTask`,
+  // you are able to retrieve the report content once the report is
+  // ACTIVE. This method will return an error if the report task's state is not
+  // `ACTIVE`. A query response will return the tabular row & column values of
+  // the report.
+  rpc QueryReportTask(QueryReportTaskRequest)
+      returns (QueryReportTaskResponse) {
+    option (google.api.http) = {
+      post: "/v1alpha/{name=properties/*/reportTasks/*}:query"
+      body: "*"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Gets report metadata about a specific report task. After creating a report
+  // task, use this method to check its processing state or inspect its
+  // report definition.
+  rpc GetReportTask(GetReportTaskRequest) returns (ReportTask) {
+    option (google.api.http) = {
+      get: "/v1alpha/{name=properties/*/reportTasks/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Lists all report tasks for a property.
+  rpc ListReportTasks(ListReportTasksRequest)
+      returns (ListReportTasksResponse) {
+    option (google.api.http) = {
+      get: "/v1alpha/{parent=properties/*}/reportTasks"
+    };
+    option (google.api.method_signature) = "parent";
+  }
 }
 
 // A request to create a new recurring audience list.
@@ -898,3 +948,303 @@ message RunFunnelReportResponse {
   // response types in JSON.
   string kind = 4;
 }
+
+// A specific report task configuration.
+message ReportTask {
+  option (google.api.resource) = {
+    type: "analyticsdata.googleapis.com/ReportTask"
+    pattern: "properties/{property}/reportTasks/{report_task}"
+    plural: "reportTasks"
+    singular: "reportTask"
+  };
+
+  // The definition of how a report should be run.
+  message ReportDefinition {
+    // Optional. The dimensions requested and displayed.
+    repeated Dimension dimensions = 2 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The metrics requested and displayed.
+    repeated Metric metrics = 3 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Date ranges of data to read. If multiple date ranges are
+    // requested, each response row will contain a zero based date range index.
+    // If two date ranges overlap, the event data for the overlapping days is
+    // included in the response rows for both date ranges. In a cohort request,
+    // this `dateRanges` must be unspecified.
+    repeated DateRange date_ranges = 4 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. 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.
+    FilterExpression dimension_filter = 5
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The filter clause of metrics. Applied after aggregating the
+    // report's rows, similar to SQL having-clause. Dimensions cannot be used in
+    // this filter.
+    FilterExpression metric_filter = 6 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The row count of the start row from Google Analytics Storage.
+    // The first row is counted as row 0.
+    //
+    // When creating a report task, the `offset` and `limit` parameters define
+    // the subset of data rows from Google Analytics storage to be included in
+    // the generated report. For example, if there are a total of 300,000 rows
+    // in Google Analytics storage, the initial report task may have the
+    // first 10,000 rows with a limit of 10,000 and an offset of 0.
+    // Subsequently, another report task could cover the next 10,000 rows with a
+    // limit of 10,000 and an offset of 10,000.
+    int64 offset = 7 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The number of rows to return in the Report. 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`. For instance, there are
+    // fewer than 300 possible values for the dimension `country`, so when
+    // reporting on only `country`, you can't get more than 300 rows, even if
+    // you set `limit` to a higher value.
+    int64 limit = 8 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Aggregation of metrics. Aggregated metric values will be shown
+    // in rows where the dimension_values are set to
+    // "RESERVED_(MetricAggregation)".
+    repeated MetricAggregation metric_aggregations = 9
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Specifies how rows are ordered in the response.
+    repeated OrderBy order_bys = 10 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. A currency code in ISO4217 format, such as "AED", "USD", "JPY".
+    // If the field is empty, the report uses the property's default currency.
+    string currency_code = 11 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Cohort group associated with this request. If there is a cohort
+    // group in the request the 'cohort' dimension must be present.
+    CohortSpec cohort_spec = 12 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. 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
+    // containing eventName: "purchase" and eventCount: 0.
+    bool keep_empty_rows = 13 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // The report metadata for a specific report task.
+  message ReportMetadata {
+    // The processing state.
+    enum State {
+      // Unspecified state will never be used.
+      STATE_UNSPECIFIED = 0;
+
+      // The report is currently creating and will be available in the
+      // future. Creating occurs immediately after the CreateReport call.
+      CREATING = 1;
+
+      // The report is fully created and ready for querying.
+      ACTIVE = 2;
+
+      // The report failed to be created.
+      FAILED = 3;
+    }
+
+    // Output only. The current state for this report task.
+    optional State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. The time when `CreateReportTask` was called and the report
+    // began the `CREATING` state.
+    optional google.protobuf.Timestamp begin_creating_time = 2
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. The total quota tokens charged during creation of the
+    // report. Because this token count is based on activity from the `CREATING`
+    // state, this tokens charge will be fixed once a report task enters the
+    // `ACTIVE` or `FAILED` state.
+    int32 creation_quota_tokens_charged = 3
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. The total number of rows in the report result. This field
+    // will be populated when the state is active. You can utilize
+    // `task_row_count` for pagination within the confines of their existing
+    // report.
+    optional int32 task_row_count = 4
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. Error message is populated if a report task fails during
+    // creation.
+    optional string error_message = 5
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. The total number of rows in Google Analytics storage. If you
+    // want to query additional data rows beyond the current report, they can
+    // initiate a new report task based on the `total_row_count`.
+    //
+    // The `task_row_count` represents the number of rows specifically
+    // pertaining to the current report, whereas `total_row_count` encompasses
+    // the total count of rows across all data retrieved from Google
+    // Analytics storage.
+    //
+    // For example, suppose the current report's `task_row_count` is 20,
+    // displaying the data from the first 20 rows. Simultaneously, the
+    // `total_row_count` is 30, indicating the presence of data for all 30 rows.
+    // The `task_row_count` can be utilizated to paginate through the initial 20
+    // rows. To expand the report and include data from all 30 rows, a new
+    // report task can be created using the total_row_count to access the full
+    // set of 30 rows' worth of data.
+    optional int32 total_row_count = 6
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+  }
+
+  // Output only. Identifier. The report task resource name assigned during
+  // creation. Format: `properties/{property}/reportTasks/{report_task}`
+  string name = 1 [
+    (google.api.field_behavior) = IDENTIFIER,
+    (google.api.field_behavior) = OUTPUT_ONLY
+  ];
+
+  // Optional. A report definition to fetch report data, which describes the
+  // structure of a report. It typically includes the fields that will be
+  // included in the report and the criteria that will be used to filter the
+  // data.
+  ReportDefinition report_definition = 2
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. The report metadata for a specific report task, which provides
+  // information about a report.  It typically includes the following
+  // information: the resource name of the report, the state of the report, the
+  // timestamp the report was created, etc,
+  ReportMetadata report_metadata = 3
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// A request to create a report task.
+message CreateReportTaskRequest {
+  // Required. The parent resource where this report task will be created.
+  // Format: `properties/{propertyId}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "analyticsdata.googleapis.com/ReportTask"
+    }
+  ];
+
+  // Required. The report task configuration to create.
+  ReportTask report_task = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Represents the metadata of a long-running operation. Currently, this metadata
+// is blank.
+message ReportTaskMetadata {}
+
+// A request to fetch the report content for a report task.
+message QueryReportTaskRequest {
+  // Required. The report source name.
+  // Format: `properties/{property}/reportTasks/{report}`
+  string name = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. The row count of the start row in the report. 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 from the report. 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`. The number of rows
+  // available to a QueryReportTaskRequest is further limited by the limit of
+  // the associated ReportTask. A query can retrieve at most ReportTask.limit
+  // rows. For example, if the ReportTask has a limit of 1,000, then a
+  // QueryReportTask request with offset=900 and limit=500 will return at most
+  // 100 rows.
+  //
+  // 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];
+}
+
+// The report content corresponding to a report task.
+message QueryReportTaskResponse {
+  // Describes dimension columns. The number of DimensionHeaders and ordering of
+  // DimensionHeaders matches the dimensions present in rows.
+  repeated DimensionHeader dimension_headers = 1;
+
+  // Describes metric columns. The number of MetricHeaders and ordering of
+  // MetricHeaders matches the metrics present in rows.
+  repeated MetricHeader metric_headers = 2;
+
+  // Rows of dimension value combinations and metric values in the report.
+  repeated Row rows = 3;
+
+  // If requested, the totaled values of metrics.
+  repeated Row totals = 4;
+
+  // If requested, the maximum values of metrics.
+  repeated Row maximums = 5;
+
+  // If requested, the minimum values of metrics.
+  repeated Row minimums = 6;
+
+  // The total number of rows in the query result.
+  int32 row_count = 7;
+
+  // Metadata for the report.
+  ResponseMetaData metadata = 8;
+}
+
+// A request to retrieve configuration metadata about a specific report task.
+message GetReportTaskRequest {
+  // Required. The report task resource name.
+  // Format: `properties/{property}/reportTasks/{report_task}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "analyticsdata.googleapis.com/ReportTask"
+    }
+  ];
+}
+
+// A request to list all report tasks for a property.
+message ListReportTasksRequest {
+  // Required. All report tasks 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/ReportTask"
+    }
+  ];
+
+  // Optional. The maximum number of report tasks to return.
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. A page token, received from a previous `ListReportTasks` call.
+  // Provide this to retrieve the subsequent page.
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// A list of all report tasks for a property.
+message ListReportTasksResponse {
+  // Each report task for a property.
+  repeated ReportTask report_tasks = 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;
+}