@google-analytics/data 3.2.2 → 3.3.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 +7 -0
- package/README.md +15 -12
- package/build/protos/google/analytics/data/v1alpha/analytics_data_api.proto +286 -6
- package/build/protos/google/analytics/data/v1alpha/data.proto +24 -14
- package/build/protos/protos.d.ts +10128 -7485
- package/build/protos/protos.js +55439 -1
- package/build/protos/protos.json +4791 -1
- package/build/src/v1alpha/alpha_analytics_data_client.d.ts +295 -3
- package/build/src/v1alpha/alpha_analytics_data_client.js +299 -2
- package/build/src/v1alpha/alpha_analytics_data_client_config.json +32 -0
- package/package.json +8 -6
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [3.3.0](https://github.com/googleapis/google-cloud-node/compare/data-v3.2.2...data-v3.3.0) (2023-07-11)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* [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))
|
|
9
|
+
|
|
3
10
|
## [3.2.2](https://github.com/googleapis/google-cloud-node/compare/data-v3.2.1...data-v3.2.2) (2023-04-13)
|
|
4
11
|
|
|
5
12
|
|
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
[//]: # "To regenerate it, use `python -m synthtool`."
|
|
3
3
|
<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"/>
|
|
4
4
|
|
|
5
|
-
# [Google Analytics Data: Node.js Client](https://github.com/googleapis/google-cloud-node)
|
|
5
|
+
# [Google Analytics Data: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-analytics-data)
|
|
6
6
|
|
|
7
7
|
[](https://cloud.google.com/terms/launch-stages)
|
|
8
8
|
[](https://www.npmjs.org/package/@google-analytics/data)
|
|
@@ -105,20 +105,23 @@ runReport();
|
|
|
105
105
|
|
|
106
106
|
## Samples
|
|
107
107
|
|
|
108
|
-
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.
|
|
108
|
+
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.
|
|
109
109
|
|
|
110
110
|
| Sample | Source Code | Try it |
|
|
111
111
|
| --------------------------- | --------------------------------- | ------ |
|
|
112
|
-
| Alpha_analytics_data.
|
|
113
|
-
|
|
|
114
|
-
|
|
|
115
|
-
|
|
|
116
|
-
|
|
|
117
|
-
| Beta_analytics_data.
|
|
118
|
-
| Beta_analytics_data.
|
|
119
|
-
| Beta_analytics_data.
|
|
120
|
-
|
|
|
121
|
-
|
|
|
112
|
+
| 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) |
|
|
113
|
+
| 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) |
|
|
114
|
+
| 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) |
|
|
115
|
+
| 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) |
|
|
116
|
+
| 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) |
|
|
117
|
+
| 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) |
|
|
118
|
+
| 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) |
|
|
119
|
+
| 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) |
|
|
120
|
+
| 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) |
|
|
121
|
+
| 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) |
|
|
122
|
+
| 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) |
|
|
123
|
+
| 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) |
|
|
124
|
+
| 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) |
|
|
122
125
|
|
|
123
126
|
|
|
124
127
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Copyright
|
|
1
|
+
// Copyright 2023 Google LLC
|
|
2
2
|
//
|
|
3
3
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
// you may not use this file except in compliance with the License.
|
|
@@ -19,11 +19,19 @@ package google.analytics.data.v1alpha;
|
|
|
19
19
|
import "google/analytics/data/v1alpha/data.proto";
|
|
20
20
|
import "google/api/annotations.proto";
|
|
21
21
|
import "google/api/client.proto";
|
|
22
|
+
import "google/api/field_behavior.proto";
|
|
23
|
+
import "google/api/resource.proto";
|
|
24
|
+
import "google/longrunning/operations.proto";
|
|
25
|
+
import "google/protobuf/timestamp.proto";
|
|
22
26
|
|
|
23
27
|
option go_package = "google.golang.org/genproto/googleapis/analytics/data/v1alpha;data";
|
|
24
28
|
option java_multiple_files = true;
|
|
25
29
|
option java_outer_classname = "AnalyticsDataApiProto";
|
|
26
30
|
option java_package = "com.google.analytics.data.v1alpha";
|
|
31
|
+
option (google.api.resource_definition) = {
|
|
32
|
+
type: "analyticsadmin.googleapis.com/Property"
|
|
33
|
+
pattern: "properties/{propertyId}"
|
|
34
|
+
};
|
|
27
35
|
|
|
28
36
|
// Google Analytics reporting data service.
|
|
29
37
|
service AlphaAnalyticsData {
|
|
@@ -42,12 +50,284 @@ service AlphaAnalyticsData {
|
|
|
42
50
|
// How do one time buyers become repeat buyers? With this information, you can
|
|
43
51
|
// improve inefficient or abandoned customer journeys. To learn more, see [GA4
|
|
44
52
|
// Funnel Explorations](https://support.google.com/analytics/answer/9327974).
|
|
45
|
-
|
|
53
|
+
//
|
|
54
|
+
// This method is introduced at alpha stability with the intention of
|
|
55
|
+
// gathering feedback on syntax and capabilities before entering beta. To give
|
|
56
|
+
// your feedback on this API, complete the [Google Analytics Data API Funnel
|
|
57
|
+
// Reporting
|
|
58
|
+
// Feedback](https://docs.google.com/forms/d/e/1FAIpQLSdwOlQDJAUoBiIgUZZ3S_Lwi8gr7Bb0k1jhvc-DEg7Rol3UjA/viewform).
|
|
59
|
+
rpc RunFunnelReport(RunFunnelReportRequest)
|
|
60
|
+
returns (RunFunnelReportResponse) {
|
|
46
61
|
option (google.api.http) = {
|
|
47
62
|
post: "/v1alpha/{property=properties/*}:runFunnelReport"
|
|
48
63
|
body: "*"
|
|
49
64
|
};
|
|
50
65
|
}
|
|
66
|
+
|
|
67
|
+
// Creates an audience list for later retrieval. This method quickly returns
|
|
68
|
+
// the audience list's resource name and initiates a long running asynchronous
|
|
69
|
+
// request to form an audience list. To list the users in an audience list,
|
|
70
|
+
// first create the audience list through this method and then send the
|
|
71
|
+
// audience resource name to the `QueryAudienceList` method.
|
|
72
|
+
//
|
|
73
|
+
// An audience list is a snapshot of the users currently in the audience at
|
|
74
|
+
// the time of audience list creation. Creating audience lists for one
|
|
75
|
+
// audience on different days will return different results as users enter and
|
|
76
|
+
// exit the audience.
|
|
77
|
+
//
|
|
78
|
+
// Audiences in Google Analytics 4 allow you to segment your users in the ways
|
|
79
|
+
// that are important to your business. To learn more, see
|
|
80
|
+
// https://support.google.com/analytics/answer/9267572. Audience lists contain
|
|
81
|
+
// the users in each audience.
|
|
82
|
+
rpc CreateAudienceList(CreateAudienceListRequest)
|
|
83
|
+
returns (google.longrunning.Operation) {
|
|
84
|
+
option (google.api.http) = {
|
|
85
|
+
post: "/v1alpha/{parent=properties/*}/audienceLists"
|
|
86
|
+
body: "audience_list"
|
|
87
|
+
};
|
|
88
|
+
option (google.api.method_signature) = "parent,audience_list";
|
|
89
|
+
option (google.longrunning.operation_info) = {
|
|
90
|
+
response_type: "AudienceList"
|
|
91
|
+
metadata_type: "AudienceListMetadata"
|
|
92
|
+
};
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
// Retrieves an audience list of users. After creating an audience, the users
|
|
96
|
+
// are not immediately available for listing. First, a request to
|
|
97
|
+
// `CreateAudienceList` is necessary to create an audience list of users, and
|
|
98
|
+
// then second, this method is used to retrieve the users in the audience.
|
|
99
|
+
//
|
|
100
|
+
// Audiences in Google Analytics 4 allow you to segment your users in the ways
|
|
101
|
+
// that are important to your business. To learn more, see
|
|
102
|
+
// https://support.google.com/analytics/answer/9267572.
|
|
103
|
+
rpc QueryAudienceList(QueryAudienceListRequest)
|
|
104
|
+
returns (QueryAudienceListResponse) {
|
|
105
|
+
option (google.api.http) = {
|
|
106
|
+
post: "/v1alpha/{name=properties/*/audienceLists/*}:query"
|
|
107
|
+
body: "*"
|
|
108
|
+
};
|
|
109
|
+
option (google.api.method_signature) = "name";
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
// Gets configuration metadata about a specific audience list. This method
|
|
113
|
+
// can be used to understand an audience list after it has been created.
|
|
114
|
+
rpc GetAudienceList(GetAudienceListRequest) returns (AudienceList) {
|
|
115
|
+
option (google.api.http) = {
|
|
116
|
+
get: "/v1alpha/{name=properties/*/audienceLists/*}"
|
|
117
|
+
};
|
|
118
|
+
option (google.api.method_signature) = "name";
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
// Lists all audience lists for a property. This method can be used for you to
|
|
122
|
+
// find and reuse existing audience lists rather than creating unnecessary new
|
|
123
|
+
// audience lists. The same audience can have multiple audience lists that
|
|
124
|
+
// represent the list of users that were in an audience on different days.
|
|
125
|
+
rpc ListAudienceLists(ListAudienceListsRequest)
|
|
126
|
+
returns (ListAudienceListsResponse) {
|
|
127
|
+
option (google.api.http) = {
|
|
128
|
+
get: "/v1alpha/{parent=properties/*}/audienceLists"
|
|
129
|
+
};
|
|
130
|
+
option (google.api.method_signature) = "parent";
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
// A request to retrieve configuration metadata about a specific audience list.
|
|
135
|
+
message GetAudienceListRequest {
|
|
136
|
+
// Required. The audience list resource name.
|
|
137
|
+
// Format: `properties/{propertyId}/audienceLists/{audienceListId}`
|
|
138
|
+
string name = 1 [
|
|
139
|
+
(google.api.field_behavior) = REQUIRED,
|
|
140
|
+
(google.api.resource_reference) = {
|
|
141
|
+
type: "analyticsdata.googleapis.com/AudienceList"
|
|
142
|
+
}
|
|
143
|
+
];
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
// A request to list all audience lists for a property.
|
|
147
|
+
message ListAudienceListsRequest {
|
|
148
|
+
// Required. All audience lists for this property will be listed in the
|
|
149
|
+
// response. Format: `properties/{propertyId}`
|
|
150
|
+
string parent = 1 [
|
|
151
|
+
(google.api.field_behavior) = REQUIRED,
|
|
152
|
+
(google.api.resource_reference) = {
|
|
153
|
+
child_type: "analyticsdata.googleapis.com/AudienceList"
|
|
154
|
+
}
|
|
155
|
+
];
|
|
156
|
+
|
|
157
|
+
// The maximum number of audience lists to return. The service may return
|
|
158
|
+
// fewer than this value. If unspecified, at most 200 audience lists will be
|
|
159
|
+
// returned. The maximum value is 1000 (higher values will be coerced to the
|
|
160
|
+
// maximum).
|
|
161
|
+
int32 page_size = 2;
|
|
162
|
+
|
|
163
|
+
// A page token, received from a previous `ListAudienceLists` call. Provide
|
|
164
|
+
// this to retrieve the subsequent page.
|
|
165
|
+
//
|
|
166
|
+
// When paginating, all other parameters provided to `ListAudienceLists` must
|
|
167
|
+
// match the call that provided the page token.
|
|
168
|
+
string page_token = 3;
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
// A list of all audience lists for a property.
|
|
172
|
+
message ListAudienceListsResponse {
|
|
173
|
+
// Each audience list for a property.
|
|
174
|
+
repeated AudienceList audience_lists = 1;
|
|
175
|
+
|
|
176
|
+
// A token, which can be sent as `page_token` to retrieve the next page.
|
|
177
|
+
// If this field is omitted, there are no subsequent pages.
|
|
178
|
+
optional string next_page_token = 2;
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
// A request to create a new audience list.
|
|
182
|
+
message CreateAudienceListRequest {
|
|
183
|
+
// Required. The parent resource where this audience list will be created.
|
|
184
|
+
// Format: `properties/{propertyId}`
|
|
185
|
+
string parent = 1 [
|
|
186
|
+
(google.api.field_behavior) = REQUIRED,
|
|
187
|
+
(google.api.resource_reference) = {
|
|
188
|
+
child_type: "analyticsdata.googleapis.com/AudienceList"
|
|
189
|
+
}
|
|
190
|
+
];
|
|
191
|
+
|
|
192
|
+
// Required. The audience list to create.
|
|
193
|
+
AudienceList audience_list = 2 [(google.api.field_behavior) = REQUIRED];
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
// An audience list is a list of users in an audience at the time of the list's
|
|
197
|
+
// creation. One audience may have multiple audience lists created for different
|
|
198
|
+
// days.
|
|
199
|
+
message AudienceList {
|
|
200
|
+
option (google.api.resource) = {
|
|
201
|
+
type: "analyticsdata.googleapis.com/AudienceList"
|
|
202
|
+
pattern: "properties/{propertyId}/audienceLists/{audienceListId}"
|
|
203
|
+
};
|
|
204
|
+
|
|
205
|
+
// The AudienceList currently exists in this state.
|
|
206
|
+
enum State {
|
|
207
|
+
// Unspecified state will never be used.
|
|
208
|
+
STATE_UNSPECIFIED = 0;
|
|
209
|
+
|
|
210
|
+
// The AudienceList is currently creating and will be available in the
|
|
211
|
+
// future. Creating occurs immediately after the CreateAudienceList call.
|
|
212
|
+
CREATING = 1;
|
|
213
|
+
|
|
214
|
+
// The AudienceList is fully created and ready for querying. An AudienceList
|
|
215
|
+
// is updated to active asynchronously from a request; this occurs some
|
|
216
|
+
// time (for example 15 minutes) after the initial create call.
|
|
217
|
+
ACTIVE = 2;
|
|
218
|
+
|
|
219
|
+
// The AudienceList failed to be created. It is possible that re-requesting
|
|
220
|
+
// this audience list will succeed.
|
|
221
|
+
FAILED = 3;
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
// Output only. The audience list resource name assigned during creation. This
|
|
225
|
+
// resource name identifies this `AudienceList`.
|
|
226
|
+
//
|
|
227
|
+
// Format: `properties/{propertyId}/audienceLists/{audienceListId}`
|
|
228
|
+
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
229
|
+
|
|
230
|
+
// Required. The audience resource name. This resource name identifies the
|
|
231
|
+
// audience being listed and is shared between the Analytics Data & Admin
|
|
232
|
+
// APIs.
|
|
233
|
+
//
|
|
234
|
+
// Format: `properties/{propertyId}/audiences/{audienceId}`
|
|
235
|
+
string audience = 2 [(google.api.field_behavior) = REQUIRED];
|
|
236
|
+
|
|
237
|
+
// Output only. The descriptive display name for this audience. For example,
|
|
238
|
+
// "Purchasers".
|
|
239
|
+
string audience_display_name = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
240
|
+
|
|
241
|
+
// Required. The dimensions requested and displayed in the report response.
|
|
242
|
+
repeated AudienceDimension dimensions = 4
|
|
243
|
+
[(google.api.field_behavior) = REQUIRED];
|
|
244
|
+
|
|
245
|
+
// Output only. The current state for this AudienceList.
|
|
246
|
+
optional State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
247
|
+
|
|
248
|
+
// Output only. The time when CreateAudienceList was called and the
|
|
249
|
+
// AudienceList began the `CREATING` state.
|
|
250
|
+
optional google.protobuf.Timestamp begin_creating_time = 6
|
|
251
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
// This metadata is currently blank.
|
|
255
|
+
message AudienceListMetadata {}
|
|
256
|
+
|
|
257
|
+
// A request to list users in an audience list.
|
|
258
|
+
message QueryAudienceListRequest {
|
|
259
|
+
// The name of the audience list to retrieve users from.
|
|
260
|
+
// Format: `properties/{propertyId}/audienceLists/{audienceListId}`
|
|
261
|
+
string name = 1;
|
|
262
|
+
|
|
263
|
+
// The row count of the start row. The first row is counted as row 0.
|
|
264
|
+
//
|
|
265
|
+
// When paging, the first request does not specify offset; or equivalently,
|
|
266
|
+
// sets offset to 0; the first request returns the first `limit` of rows. The
|
|
267
|
+
// second request sets offset to the `limit` of the first request; the second
|
|
268
|
+
// request returns the second `limit` of rows.
|
|
269
|
+
//
|
|
270
|
+
// To learn more about this pagination parameter, see
|
|
271
|
+
// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
|
272
|
+
int64 offset = 2;
|
|
273
|
+
|
|
274
|
+
// The number of rows to return. If unspecified, 10,000 rows are returned. The
|
|
275
|
+
// API returns a maximum of 250,000 rows per request, no matter how many you
|
|
276
|
+
// ask for. `limit` must be positive.
|
|
277
|
+
//
|
|
278
|
+
// The API can also return fewer rows than the requested `limit`, if there
|
|
279
|
+
// aren't as many dimension values as the `limit`.
|
|
280
|
+
//
|
|
281
|
+
// To learn more about this pagination parameter, see
|
|
282
|
+
// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
|
283
|
+
int64 limit = 3;
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
// A list of users in an audience list.
|
|
287
|
+
message QueryAudienceListResponse {
|
|
288
|
+
// Configuration data about AudienceList being queried. Returned to help
|
|
289
|
+
// interpret the audience rows in this response. For example, the dimensions
|
|
290
|
+
// in this AudienceList correspond to the columns in the AudienceRows.
|
|
291
|
+
optional AudienceList audience_list = 1;
|
|
292
|
+
|
|
293
|
+
// Rows for each user in an audience list. The number of rows in this
|
|
294
|
+
// response will be less than or equal to request's page size.
|
|
295
|
+
repeated AudienceRow audience_rows = 2;
|
|
296
|
+
|
|
297
|
+
// The total number of rows in the query result. `rowCount` is independent of
|
|
298
|
+
// the number of rows returned in the response, the `limit` request
|
|
299
|
+
// parameter, and the `offset` request parameter. For example if a query
|
|
300
|
+
// returns 175 rows and includes `limit` of 50 in the API request, the
|
|
301
|
+
// response will contain `rowCount` of 175 but only 50 rows.
|
|
302
|
+
//
|
|
303
|
+
// To learn more about this pagination parameter, see
|
|
304
|
+
// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
|
305
|
+
optional int32 row_count = 3;
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
// Dimension value attributes for the audience user row.
|
|
309
|
+
message AudienceRow {
|
|
310
|
+
// Each dimension value attribute for an audience user. One dimension value
|
|
311
|
+
// will be added for each dimension column requested.
|
|
312
|
+
repeated AudienceDimensionValue dimension_values = 1;
|
|
313
|
+
}
|
|
314
|
+
|
|
315
|
+
// An audience dimension is a user attribute. Specific user attributed are
|
|
316
|
+
// requested and then later returned in the `QueryAudienceListResponse`.
|
|
317
|
+
message AudienceDimension {
|
|
318
|
+
// The API name of the dimension. See the [API
|
|
319
|
+
// Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions)
|
|
320
|
+
// for the list of dimension names.
|
|
321
|
+
string dimension_name = 1;
|
|
322
|
+
}
|
|
323
|
+
|
|
324
|
+
// The value of a dimension.
|
|
325
|
+
message AudienceDimensionValue {
|
|
326
|
+
// One kind of dimension value.
|
|
327
|
+
oneof one_value {
|
|
328
|
+
// Value as a string if the dimension type is a string.
|
|
329
|
+
string value = 1;
|
|
330
|
+
}
|
|
51
331
|
}
|
|
52
332
|
|
|
53
333
|
// The request for a funnel report.
|
|
@@ -97,7 +377,7 @@ message RunFunnelReportRequest {
|
|
|
97
377
|
// If specified, next action adds a dimension to the funnel visualization sub
|
|
98
378
|
// report response. This next action dimension expands each funnel step to the
|
|
99
379
|
// unique values of the next action. For example a next action of the
|
|
100
|
-
// `eventName` dimension will create rows for several events (
|
|
380
|
+
// `eventName` dimension will create rows for several events (for example
|
|
101
381
|
// `session_start` & `click`) and the total.
|
|
102
382
|
//
|
|
103
383
|
// Next action only supports `eventName` and most Page / Screen dimensions
|
|
@@ -120,7 +400,7 @@ message RunFunnelReportRequest {
|
|
|
120
400
|
repeated Segment segments = 7;
|
|
121
401
|
|
|
122
402
|
// The number of rows to return. If unspecified, 10,000 rows are returned. The
|
|
123
|
-
// API returns a maximum of
|
|
403
|
+
// API returns a maximum of 250,000 rows per request, no matter how many you
|
|
124
404
|
// ask for. `limit` must be positive.
|
|
125
405
|
//
|
|
126
406
|
// The API can also return fewer rows than the requested `limit`, if there
|
|
@@ -155,8 +435,8 @@ message RunFunnelReportResponse {
|
|
|
155
435
|
//
|
|
156
436
|
// The segment dimension is only present in this response if a segment was
|
|
157
437
|
// requested. The date dimension is only present in this response if it was
|
|
158
|
-
// requested
|
|
159
|
-
// is only present in the response if it was requested.
|
|
438
|
+
// requested through the `TRENDED_FUNNEL` funnel type. The next action
|
|
439
|
+
// dimension is only present in the response if it was requested.
|
|
160
440
|
FunnelSubReport funnel_visualization = 2;
|
|
161
441
|
|
|
162
442
|
// This Analytics Property's quota state including this request.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Copyright
|
|
1
|
+
// Copyright 2023 Google LLC
|
|
2
2
|
//
|
|
3
3
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
// you may not use this file except in compliance with the License.
|
|
@@ -344,15 +344,15 @@ message MetricValue {
|
|
|
344
344
|
// property is exhausted, all requests to that property will return Resource
|
|
345
345
|
// Exhausted errors.
|
|
346
346
|
message PropertyQuota {
|
|
347
|
-
// Standard Analytics Properties can use up to
|
|
348
|
-
// Analytics 360 Properties can use
|
|
347
|
+
// Standard Analytics Properties can use up to 200,000 tokens per day;
|
|
348
|
+
// Analytics 360 Properties can use 2,000,000 tokens per day. Most requests
|
|
349
349
|
// consume fewer than 10 tokens.
|
|
350
350
|
QuotaStatus tokens_per_day = 1;
|
|
351
351
|
|
|
352
|
-
// Standard Analytics Properties can use up to
|
|
353
|
-
// Analytics 360 Properties can use
|
|
354
|
-
// consumes a single number of tokens, and that number is deducted from
|
|
355
|
-
// the hourly and
|
|
352
|
+
// Standard Analytics Properties can use up to 40,000 tokens per hour;
|
|
353
|
+
// Analytics 360 Properties can use 400,000 tokens per hour. An API request
|
|
354
|
+
// consumes a single number of tokens, and that number is deducted from all of
|
|
355
|
+
// the hourly, daily, and per project hourly quotas.
|
|
356
356
|
QuotaStatus tokens_per_hour = 2;
|
|
357
357
|
|
|
358
358
|
// Standard Analytics Properties can send up to 10 concurrent requests;
|
|
@@ -369,6 +369,14 @@ message PropertyQuota {
|
|
|
369
369
|
// is individually counted for this quota if the request contains potentially
|
|
370
370
|
// thresholded dimensions.
|
|
371
371
|
QuotaStatus potentially_thresholded_requests_per_hour = 5;
|
|
372
|
+
|
|
373
|
+
// Analytics Properties can use up to 35% of their tokens per project per
|
|
374
|
+
// hour. This amounts to standard Analytics Properties can use up to 14,000
|
|
375
|
+
// tokens per project per hour, and Analytics 360 Properties can use 140,000
|
|
376
|
+
// tokens per project per hour. An API request consumes a single number of
|
|
377
|
+
// tokens, and that number is deducted from all of the hourly, daily, and per
|
|
378
|
+
// project hourly quotas.
|
|
379
|
+
QuotaStatus tokens_per_project_per_hour = 6;
|
|
372
380
|
}
|
|
373
381
|
|
|
374
382
|
// Current state for a particular quota group.
|
|
@@ -438,10 +446,10 @@ message Funnel {
|
|
|
438
446
|
// the funnel journey.
|
|
439
447
|
message FunnelStep {
|
|
440
448
|
// The distinctive name for this step. If unspecified, steps will be named
|
|
441
|
-
// by a 1 based indexed name (
|
|
442
|
-
// string value returned by the `funnelStepName` dimension. For
|
|
443
|
-
// specifying `name = Purchase` in the request's third funnel step
|
|
444
|
-
// produce `3. Purchase` in the funnel report response.
|
|
449
|
+
// by a 1 based indexed name (for example "0. ", "1. ", etc.). This name
|
|
450
|
+
// defines string value returned by the `funnelStepName` dimension. For
|
|
451
|
+
// example, specifying `name = Purchase` in the request's third funnel step
|
|
452
|
+
// will produce `3. Purchase` in the funnel report response.
|
|
445
453
|
string name = 1;
|
|
446
454
|
|
|
447
455
|
// If true, this step must directly follow the previous step. If false,
|
|
@@ -804,7 +812,7 @@ message Segment {
|
|
|
804
812
|
// The name for this segment. If unspecified, segments are named "Segment".
|
|
805
813
|
// This name defines string value returned by the `segment` dimension. The
|
|
806
814
|
// `segment` dimension prefixes segment names by the 1-based index number of
|
|
807
|
-
// the segment in the request (
|
|
815
|
+
// the segment in the request (for example "1. Segment", "2. Segment", etc.).
|
|
808
816
|
string name = 1;
|
|
809
817
|
|
|
810
818
|
// A segment is specified in one scope.
|
|
@@ -910,7 +918,8 @@ message SegmentEventFilter {
|
|
|
910
918
|
//
|
|
911
919
|
// Inside the parameter filter expression, only parameter filters are
|
|
912
920
|
// available.
|
|
913
|
-
optional SegmentParameterFilterExpression
|
|
921
|
+
optional SegmentParameterFilterExpression
|
|
922
|
+
segment_parameter_filter_expression = 2;
|
|
914
923
|
}
|
|
915
924
|
|
|
916
925
|
// Expresses combinations of segment filter on parameters.
|
|
@@ -1081,7 +1090,8 @@ message FunnelEventFilter {
|
|
|
1081
1090
|
//
|
|
1082
1091
|
// Inside the parameter filter expression, only parameter filters are
|
|
1083
1092
|
// available.
|
|
1084
|
-
optional FunnelParameterFilterExpression funnel_parameter_filter_expression =
|
|
1093
|
+
optional FunnelParameterFilterExpression funnel_parameter_filter_expression =
|
|
1094
|
+
2;
|
|
1085
1095
|
}
|
|
1086
1096
|
|
|
1087
1097
|
// Expresses combinations of funnel filters on parameters.
|