@google-analytics/data 2.8.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,30 @@
1
1
  # Changelog
2
2
 
3
+ ## [3.0.0](https://github.com/googleapis/nodejs-analytics-data/compare/v2.8.0...v3.0.0) (2022-06-27)
4
+
5
+
6
+ ### ⚠ BREAKING CHANGES
7
+
8
+ * rename the `funnel_filter` field of the `FunnelFilterExpression` type to `funnel_field_filter`
9
+ * rename the type `FunnelFilter` to `FunnelFieldFilter` (#218)
10
+ * update library to use Node 12 (#213)
11
+
12
+ ### Features
13
+
14
+ * add `runFunnelReport` method to the Alpha version of the Data API ([#208](https://github.com/googleapis/nodejs-analytics-data/issues/208)) ([2390a92](https://github.com/googleapis/nodejs-analytics-data/commit/2390a922100c4ad0415f914a88b13dd39c487477))
15
+ * support regapic LRO ([#219](https://github.com/googleapis/nodejs-analytics-data/issues/219)) ([547ecd7](https://github.com/googleapis/nodejs-analytics-data/commit/547ecd76afd553051ba4f9d330b355422b7114c5))
16
+
17
+
18
+ ### Bug Fixes
19
+
20
+ * rename the `funnel_filter` field of the `FunnelFilterExpression` type to `funnel_field_filter` ([9ff9521](https://github.com/googleapis/nodejs-analytics-data/commit/9ff9521b386c674809f528892cf1dd49db81edc3))
21
+ * rename the type `FunnelFilter` to `FunnelFieldFilter` ([#218](https://github.com/googleapis/nodejs-analytics-data/issues/218)) ([9ff9521](https://github.com/googleapis/nodejs-analytics-data/commit/9ff9521b386c674809f528892cf1dd49db81edc3))
22
+
23
+
24
+ ### Build System
25
+
26
+ * update library to use Node 12 ([#213](https://github.com/googleapis/nodejs-analytics-data/issues/213)) ([c227cda](https://github.com/googleapis/nodejs-analytics-data/commit/c227cdac99df8c671812bb7d1244bd83d23d01e8))
27
+
3
28
  ## [2.8.0](https://www.github.com/googleapis/nodejs-analytics-data/compare/v2.7.0...v2.8.0) (2021-11-08)
4
29
 
5
30
 
package/README.md CHANGED
@@ -4,9 +4,8 @@
4
4
 
5
5
  # [Google Analytics Data: Node.js Client](https://github.com/googleapis/nodejs-analytics-data)
6
6
 
7
- [![release level](https://img.shields.io/badge/release%20level-beta-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
7
+ [![release level](https://img.shields.io/badge/release%20level-preview-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
8
8
  [![npm version](https://img.shields.io/npm/v/@google-analytics/data.svg)](https://www.npmjs.org/package/@google-analytics/data)
9
- [![codecov](https://img.shields.io/codecov/c/github/googleapis/nodejs-analytics-data/main.svg?style=flat)](https://codecov.io/gh/googleapis/nodejs-analytics-data)
10
9
 
11
10
 
12
11
 
@@ -113,7 +112,16 @@ Samples are in the [`samples/`](https://github.com/googleapis/nodejs-analytics-d
113
112
  | Quickstart | [source code](https://github.com/googleapis/nodejs-analytics-data/blob/main/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-analytics-data&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |
114
113
  | Quickstart_json_credentials | [source code](https://github.com/googleapis/nodejs-analytics-data/blob/main/samples/quickstart_json_credentials.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-analytics-data&page=editor&open_in_editor=samples/quickstart_json_credentials.js,samples/README.md) |
115
114
  | Quickstart_oauth2 | [source code](https://github.com/googleapis/nodejs-analytics-data/blob/main/samples/quickstart_oauth2.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-analytics-data&page=editor&open_in_editor=samples/quickstart_oauth2.js,samples/README.md) |
116
- | Realtime | [source code](https://github.com/googleapis/nodejs-analytics-data/blob/main/samples/realtime.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-analytics-data&page=editor&open_in_editor=samples/realtime.js,samples/README.md) |
115
+ | Run Realtime Report | [source code](https://github.com/googleapis/nodejs-analytics-data/blob/main/samples/runRealtimeReport.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-analytics-data&page=editor&open_in_editor=samples/runRealtimeReport.js,samples/README.md) |
116
+ | Run Realtime Report With Multiple Dimensions | [source code](https://github.com/googleapis/nodejs-analytics-data/blob/main/samples/runRealtimeReportWithMultipleDimensions.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-analytics-data&page=editor&open_in_editor=samples/runRealtimeReportWithMultipleDimensions.js,samples/README.md) |
117
+ | Run Realtime Report With Multiple Metrics | [source code](https://github.com/googleapis/nodejs-analytics-data/blob/main/samples/runRealtimeReportWithMultipleMetrics.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-analytics-data&page=editor&open_in_editor=samples/runRealtimeReportWithMultipleMetrics.js,samples/README.md) |
118
+ | Run Report | [source code](https://github.com/googleapis/nodejs-analytics-data/blob/main/samples/runReport.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-analytics-data&page=editor&open_in_editor=samples/runReport.js,samples/README.md) |
119
+ | Run Report With Aggregations | [source code](https://github.com/googleapis/nodejs-analytics-data/blob/main/samples/runReportWithAggregations.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-analytics-data&page=editor&open_in_editor=samples/runReportWithAggregations.js,samples/README.md) |
120
+ | Run Report With Cohorts | [source code](https://github.com/googleapis/nodejs-analytics-data/blob/main/samples/runReportWithCohorts.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-analytics-data&page=editor&open_in_editor=samples/runReportWithCohorts.js,samples/README.md) |
121
+ | Run Report With Date Ranges | [source code](https://github.com/googleapis/nodejs-analytics-data/blob/main/samples/runReportWithDateRanges.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-analytics-data&page=editor&open_in_editor=samples/runReportWithDateRanges.js,samples/README.md) |
122
+ | Run Report With Dimension Exclude Filter | [source code](https://github.com/googleapis/nodejs-analytics-data/blob/main/samples/runReportWithDimensionExcludeFilter.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-analytics-data&page=editor&open_in_editor=samples/runReportWithDimensionExcludeFilter.js,samples/README.md) |
123
+ | Run Report With Dimension In List Filter | [source code](https://github.com/googleapis/nodejs-analytics-data/blob/main/samples/runReportWithDimensionInListFilter.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-analytics-data&page=editor&open_in_editor=samples/runReportWithDimensionInListFilter.js,samples/README.md) |
124
+ | Run Report With Named Date Ranges | [source code](https://github.com/googleapis/nodejs-analytics-data/blob/main/samples/runReportWithNamedDateRanges.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-analytics-data&page=editor&open_in_editor=samples/runReportWithNamedDateRanges.js,samples/README.md) |
117
125
 
118
126
 
119
127
 
@@ -125,21 +133,21 @@ also contains samples.
125
133
  Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/).
126
134
  Libraries are compatible with all current _active_ and _maintenance_ versions of
127
135
  Node.js.
136
+ If you are using an end-of-life version of Node.js, we recommend that you update
137
+ as soon as possible to an actively supported LTS version.
128
138
 
129
- Client libraries targeting some end-of-life versions of Node.js are available, and
130
- can be installed via npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
131
- The dist-tags follow the naming convention `legacy-(version)`.
132
-
133
- _Legacy Node.js versions are supported as a best effort:_
134
-
135
- * Legacy versions will not be tested in continuous integration.
136
- * Some security patches may not be able to be backported.
137
- * Dependencies will not be kept up-to-date, and features will not be backported.
139
+ Google's client libraries support legacy versions of Node.js runtimes on a
140
+ best-efforts basis with the following warnings:
138
141
 
139
- #### Legacy tags available
142
+ * Legacy versions are not tested in continuous integration.
143
+ * Some security patches and features cannot be backported.
144
+ * Dependencies cannot be kept up-to-date.
140
145
 
141
- * `legacy-8`: install client libraries from this dist-tag for versions
142
- compatible with Node.js 8.
146
+ Client libraries targeting some end-of-life versions of Node.js are available, and
147
+ can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
148
+ The dist-tags follow the naming convention `legacy-(version)`.
149
+ For example, `npm install @google-analytics/data@legacy-8` installs client libraries
150
+ for versions compatible with Node.js 8.
143
151
 
144
152
  ## Versioning
145
153
 
@@ -147,14 +155,15 @@ This library follows [Semantic Versioning](http://semver.org/).
147
155
 
148
156
 
149
157
 
150
- This library is considered to be in **beta**. This means it is expected to be
151
- mostly stable while we work toward a general availability release; however,
152
- complete stability is not guaranteed. We will address issues and requests
153
- against beta libraries with a high priority.
154
158
 
155
159
 
156
160
 
157
161
 
162
+ This library is considered to be in **preview**. This means it is still a
163
+ work-in-progress and under active development. Any release is subject to
164
+ backwards-incompatible changes at any time.
165
+
166
+
158
167
  More Information: [Google Cloud Platform Launch Stages][launch_stages]
159
168
 
160
169
  [launch_stages]: https://cloud.google.com/terms/launch-stages