google-analytics-data-v1alpha 0.8.0 → 0.8.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +10 -10
- data/README.md +1 -1
- data/lib/google/analytics/data/v1alpha/analytics_data/client.rb +49 -47
- data/lib/google/analytics/data/v1alpha/analytics_data/credentials.rb +4 -4
- data/lib/google/analytics/data/v1alpha/version.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +7 -1
- metadata +13 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a727e02bbe69d7c6609007c45c0b36a029d4132fea1e5107d83c68ee3af6b417
|
|
4
|
+
data.tar.gz: 81c1c6f54ca2b4edd09a93ac9831b26451a5d7a705446a4c7233b366328119ae
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2ae74881a642924bad5cc5a338ec2b59993db6098858466741b4b91f126048e89fa38499036907b97a44b86f7d032e616ce2b68037f46cce25bef3fdfddd392f
|
|
7
|
+
data.tar.gz: a51e2bec5efef798d5697b358a11632653fecc107a7b1d45174e94c6f8c0c2f77a18a8a26dcbd91bc613ad6bc0e2e073baf9a0c6df949fc85a2ce629f1c6247b
|
data/AUTHENTICATION.md
CHANGED
|
@@ -19,7 +19,7 @@ during development.
|
|
|
19
19
|
2. Set the [environment variable](#environment-variables).
|
|
20
20
|
|
|
21
21
|
```sh
|
|
22
|
-
export
|
|
22
|
+
export ANALYTICS_DATA_CREDENTIALS=path/to/keyfile.json
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
3. Initialize the client.
|
|
@@ -66,24 +66,24 @@ The environment variables that google-analytics-data-v1alpha
|
|
|
66
66
|
checks for credentials are configured on the service Credentials class (such as
|
|
67
67
|
{::Google::Analytics::Data::V1alpha::AnalyticsData::Credentials}):
|
|
68
68
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
69
|
+
* `ANALYTICS_DATA_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
70
|
+
* `ANALYTICS_DATA_KEYFILE` - Path to JSON file, or JSON contents
|
|
71
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
72
|
+
* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
|
|
73
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
74
74
|
|
|
75
75
|
```ruby
|
|
76
76
|
require "google/analytics/data/v1alpha"
|
|
77
77
|
|
|
78
|
-
ENV["
|
|
78
|
+
ENV["ANALYTICS_DATA_CREDENTIALS"] = "path/to/keyfile.json"
|
|
79
79
|
|
|
80
80
|
client = ::Google::Analytics::Data::V1alpha::AnalyticsData::Client.new
|
|
81
81
|
```
|
|
82
82
|
|
|
83
83
|
### Configuration
|
|
84
84
|
|
|
85
|
-
The **Credentials JSON** can be configured instead of
|
|
86
|
-
environment
|
|
85
|
+
The path to the **Credentials JSON** file can be configured instead of storing
|
|
86
|
+
it in an environment variable. Either on an individual client initialization:
|
|
87
87
|
|
|
88
88
|
```ruby
|
|
89
89
|
require "google/analytics/data/v1alpha"
|
|
@@ -93,7 +93,7 @@ client = ::Google::Analytics::Data::V1alpha::AnalyticsData::Client.new do |confi
|
|
|
93
93
|
end
|
|
94
94
|
```
|
|
95
95
|
|
|
96
|
-
Or
|
|
96
|
+
Or globally for all clients:
|
|
97
97
|
|
|
98
98
|
```ruby
|
|
99
99
|
require "google/analytics/data/v1alpha"
|
data/README.md
CHANGED
|
@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
|
|
|
33
33
|
require "google/analytics/data/v1alpha"
|
|
34
34
|
|
|
35
35
|
client = ::Google::Analytics::Data::V1alpha::AnalyticsData::Client.new
|
|
36
|
-
request =
|
|
36
|
+
request = ::Google::Analytics::Data::V1alpha::RunReportRequest.new # (request fields as keyword arguments...)
|
|
37
37
|
response = client.run_report request
|
|
38
38
|
```
|
|
39
39
|
|
|
@@ -41,13 +41,12 @@ module Google
|
|
|
41
41
|
# See {::Google::Analytics::Data::V1alpha::AnalyticsData::Client::Configuration}
|
|
42
42
|
# for a description of the configuration fields.
|
|
43
43
|
#
|
|
44
|
-
#
|
|
44
|
+
# @example
|
|
45
45
|
#
|
|
46
|
-
#
|
|
47
|
-
#
|
|
48
|
-
#
|
|
49
|
-
#
|
|
50
|
-
# end
|
|
46
|
+
# # Modify the configuration for all AnalyticsData clients
|
|
47
|
+
# ::Google::Analytics::Data::V1alpha::AnalyticsData::Client.configure do |config|
|
|
48
|
+
# config.timeout = 10.0
|
|
49
|
+
# end
|
|
51
50
|
#
|
|
52
51
|
# @yield [config] Configure the Client client.
|
|
53
52
|
# @yieldparam config [Client::Configuration]
|
|
@@ -67,10 +66,7 @@ module Google
|
|
|
67
66
|
|
|
68
67
|
default_config.timeout = 60.0
|
|
69
68
|
default_config.retry_policy = {
|
|
70
|
-
initial_delay: 1.0,
|
|
71
|
-
max_delay: 60.0,
|
|
72
|
-
multiplier: 1.3,
|
|
73
|
-
retry_codes: [2]
|
|
69
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [2]
|
|
74
70
|
}
|
|
75
71
|
|
|
76
72
|
default_config.rpcs.run_report.timeout = 60.0
|
|
@@ -110,19 +106,15 @@ module Google
|
|
|
110
106
|
##
|
|
111
107
|
# Create a new AnalyticsData client object.
|
|
112
108
|
#
|
|
113
|
-
#
|
|
114
|
-
#
|
|
115
|
-
# To create a new AnalyticsData client with the default
|
|
116
|
-
# configuration:
|
|
109
|
+
# @example
|
|
117
110
|
#
|
|
118
|
-
#
|
|
111
|
+
# # Create a client using the default configuration
|
|
112
|
+
# client = ::Google::Analytics::Data::V1alpha::AnalyticsData::Client.new
|
|
119
113
|
#
|
|
120
|
-
#
|
|
121
|
-
#
|
|
122
|
-
#
|
|
123
|
-
#
|
|
124
|
-
# config.timeout = 10.0
|
|
125
|
-
# end
|
|
114
|
+
# # Create a client using a custom configuration
|
|
115
|
+
# client = ::Google::Analytics::Data::V1alpha::AnalyticsData::Client.new do |config|
|
|
116
|
+
# config.timeout = 10.0
|
|
117
|
+
# end
|
|
126
118
|
#
|
|
127
119
|
# @yield [config] Configure the AnalyticsData client.
|
|
128
120
|
# @yieldparam config [Client::Configuration]
|
|
@@ -142,14 +134,13 @@ module Google
|
|
|
142
134
|
|
|
143
135
|
# Create credentials
|
|
144
136
|
credentials = @config.credentials
|
|
145
|
-
# Use self-signed JWT if the
|
|
137
|
+
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
146
138
|
# but only if the default endpoint does not have a region prefix.
|
|
147
|
-
enable_self_signed_jwt = @config.
|
|
148
|
-
@config.endpoint == Client.configure.endpoint &&
|
|
139
|
+
enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
|
|
149
140
|
!@config.endpoint.split(".").first.include?("-")
|
|
150
141
|
credentials ||= Credentials.default scope: @config.scope,
|
|
151
142
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
152
|
-
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
|
143
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
153
144
|
credentials = Credentials.new credentials, scope: @config.scope
|
|
154
145
|
end
|
|
155
146
|
@quota_project_id = @config.quota_project
|
|
@@ -268,7 +259,9 @@ module Google
|
|
|
268
259
|
options.apply_defaults timeout: @config.rpcs.run_report.timeout,
|
|
269
260
|
metadata: metadata,
|
|
270
261
|
retry_policy: @config.rpcs.run_report.retry_policy
|
|
271
|
-
|
|
262
|
+
|
|
263
|
+
options.apply_defaults timeout: @config.timeout,
|
|
264
|
+
metadata: @config.metadata,
|
|
272
265
|
retry_policy: @config.retry_policy
|
|
273
266
|
|
|
274
267
|
@analytics_data_stub.call_rpc :run_report, request, options: options do |response, operation|
|
|
@@ -371,7 +364,9 @@ module Google
|
|
|
371
364
|
options.apply_defaults timeout: @config.rpcs.run_pivot_report.timeout,
|
|
372
365
|
metadata: metadata,
|
|
373
366
|
retry_policy: @config.rpcs.run_pivot_report.retry_policy
|
|
374
|
-
|
|
367
|
+
|
|
368
|
+
options.apply_defaults timeout: @config.timeout,
|
|
369
|
+
metadata: @config.metadata,
|
|
375
370
|
retry_policy: @config.retry_policy
|
|
376
371
|
|
|
377
372
|
@analytics_data_stub.call_rpc :run_pivot_report, request, options: options do |response, operation|
|
|
@@ -437,7 +432,9 @@ module Google
|
|
|
437
432
|
options.apply_defaults timeout: @config.rpcs.batch_run_reports.timeout,
|
|
438
433
|
metadata: metadata,
|
|
439
434
|
retry_policy: @config.rpcs.batch_run_reports.retry_policy
|
|
440
|
-
|
|
435
|
+
|
|
436
|
+
options.apply_defaults timeout: @config.timeout,
|
|
437
|
+
metadata: @config.metadata,
|
|
441
438
|
retry_policy: @config.retry_policy
|
|
442
439
|
|
|
443
440
|
@analytics_data_stub.call_rpc :batch_run_reports, request, options: options do |response, operation|
|
|
@@ -503,7 +500,9 @@ module Google
|
|
|
503
500
|
options.apply_defaults timeout: @config.rpcs.batch_run_pivot_reports.timeout,
|
|
504
501
|
metadata: metadata,
|
|
505
502
|
retry_policy: @config.rpcs.batch_run_pivot_reports.retry_policy
|
|
506
|
-
|
|
503
|
+
|
|
504
|
+
options.apply_defaults timeout: @config.timeout,
|
|
505
|
+
metadata: @config.metadata,
|
|
507
506
|
retry_policy: @config.retry_policy
|
|
508
507
|
|
|
509
508
|
@analytics_data_stub.call_rpc :batch_run_pivot_reports, request, options: options do |response, operation|
|
|
@@ -588,7 +587,9 @@ module Google
|
|
|
588
587
|
options.apply_defaults timeout: @config.rpcs.get_metadata.timeout,
|
|
589
588
|
metadata: metadata,
|
|
590
589
|
retry_policy: @config.rpcs.get_metadata.retry_policy
|
|
591
|
-
|
|
590
|
+
|
|
591
|
+
options.apply_defaults timeout: @config.timeout,
|
|
592
|
+
metadata: @config.metadata,
|
|
592
593
|
retry_policy: @config.retry_policy
|
|
593
594
|
|
|
594
595
|
@analytics_data_stub.call_rpc :get_metadata, request, options: options do |response, operation|
|
|
@@ -683,7 +684,9 @@ module Google
|
|
|
683
684
|
options.apply_defaults timeout: @config.rpcs.run_realtime_report.timeout,
|
|
684
685
|
metadata: metadata,
|
|
685
686
|
retry_policy: @config.rpcs.run_realtime_report.retry_policy
|
|
686
|
-
|
|
687
|
+
|
|
688
|
+
options.apply_defaults timeout: @config.timeout,
|
|
689
|
+
metadata: @config.metadata,
|
|
687
690
|
retry_policy: @config.retry_policy
|
|
688
691
|
|
|
689
692
|
@analytics_data_stub.call_rpc :run_realtime_report, request, options: options do |response, operation|
|
|
@@ -707,22 +710,21 @@ module Google
|
|
|
707
710
|
# Configuration can be applied globally to all clients, or to a single client
|
|
708
711
|
# on construction.
|
|
709
712
|
#
|
|
710
|
-
#
|
|
711
|
-
#
|
|
712
|
-
#
|
|
713
|
-
# to 20 seconds,
|
|
714
|
-
#
|
|
715
|
-
#
|
|
716
|
-
#
|
|
717
|
-
#
|
|
718
|
-
#
|
|
719
|
-
#
|
|
720
|
-
#
|
|
721
|
-
#
|
|
722
|
-
#
|
|
723
|
-
#
|
|
724
|
-
#
|
|
725
|
-
# end
|
|
713
|
+
# @example
|
|
714
|
+
#
|
|
715
|
+
# # Modify the global config, setting the timeout for
|
|
716
|
+
# # run_report to 20 seconds,
|
|
717
|
+
# # and all remaining timeouts to 10 seconds.
|
|
718
|
+
# ::Google::Analytics::Data::V1alpha::AnalyticsData::Client.configure do |config|
|
|
719
|
+
# config.timeout = 10.0
|
|
720
|
+
# config.rpcs.run_report.timeout = 20.0
|
|
721
|
+
# end
|
|
722
|
+
#
|
|
723
|
+
# # Apply the above configuration only to a new client.
|
|
724
|
+
# client = ::Google::Analytics::Data::V1alpha::AnalyticsData::Client.new do |config|
|
|
725
|
+
# config.timeout = 10.0
|
|
726
|
+
# config.rpcs.run_report.timeout = 20.0
|
|
727
|
+
# end
|
|
726
728
|
#
|
|
727
729
|
# @!attribute [rw] endpoint
|
|
728
730
|
# The hostname or hostname:port of the service endpoint.
|
|
@@ -30,13 +30,13 @@ module Google
|
|
|
30
30
|
"https://www.googleapis.com/auth/analytics.readonly"
|
|
31
31
|
]
|
|
32
32
|
self.env_vars = [
|
|
33
|
-
"
|
|
34
|
-
"
|
|
33
|
+
"ANALYTICS_DATA_CREDENTIALS",
|
|
34
|
+
"ANALYTICS_DATA_KEYFILE",
|
|
35
35
|
"GOOGLE_CLOUD_CREDENTIALS",
|
|
36
36
|
"GOOGLE_CLOUD_KEYFILE",
|
|
37
37
|
"GCLOUD_KEYFILE",
|
|
38
|
-
"
|
|
39
|
-
"
|
|
38
|
+
"ANALYTICS_DATA_CREDENTIALS_JSON",
|
|
39
|
+
"ANALYTICS_DATA_KEYFILE_JSON",
|
|
40
40
|
"GOOGLE_CLOUD_CREDENTIALS_JSON",
|
|
41
41
|
"GOOGLE_CLOUD_KEYFILE_JSON",
|
|
42
42
|
"GCLOUD_KEYFILE_JSON"
|
|
@@ -57,9 +57,15 @@ module Google
|
|
|
57
57
|
|
|
58
58
|
# Denotes that a (repeated) field is an unordered list.
|
|
59
59
|
# This indicates that the service may provide the elements of the list
|
|
60
|
-
# in any arbitrary
|
|
60
|
+
# in any arbitrary order, rather than the order the user originally
|
|
61
61
|
# provided. Additionally, the list's order may or may not be stable.
|
|
62
62
|
UNORDERED_LIST = 6
|
|
63
|
+
|
|
64
|
+
# Denotes that this field returns a non-empty default value if not set.
|
|
65
|
+
# This indicates that if the user provides the empty value in a request,
|
|
66
|
+
# a non-empty value will be returned. The user will not be aware of what
|
|
67
|
+
# non-empty value to expect.
|
|
68
|
+
NON_EMPTY_DEFAULT = 7
|
|
63
69
|
end
|
|
64
70
|
end
|
|
65
71
|
end
|
metadata
CHANGED
|
@@ -1,29 +1,35 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-analytics-data-v1alpha
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.8.
|
|
4
|
+
version: 0.8.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-
|
|
11
|
+
date: 2021-08-11 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
|
16
16
|
requirements:
|
|
17
|
-
- - "
|
|
17
|
+
- - ">="
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '0.7'
|
|
20
|
+
- - "<"
|
|
18
21
|
- !ruby/object:Gem::Version
|
|
19
|
-
version:
|
|
22
|
+
version: 2.a
|
|
20
23
|
type: :runtime
|
|
21
24
|
prerelease: false
|
|
22
25
|
version_requirements: !ruby/object:Gem::Requirement
|
|
23
26
|
requirements:
|
|
24
|
-
- - "
|
|
27
|
+
- - ">="
|
|
28
|
+
- !ruby/object:Gem::Version
|
|
29
|
+
version: '0.7'
|
|
30
|
+
- - "<"
|
|
25
31
|
- !ruby/object:Gem::Version
|
|
26
|
-
version:
|
|
32
|
+
version: 2.a
|
|
27
33
|
- !ruby/object:Gem::Dependency
|
|
28
34
|
name: google-cloud-errors
|
|
29
35
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -200,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
200
206
|
- !ruby/object:Gem::Version
|
|
201
207
|
version: '0'
|
|
202
208
|
requirements: []
|
|
203
|
-
rubygems_version: 3.2.
|
|
209
|
+
rubygems_version: 3.2.17
|
|
204
210
|
signing_key:
|
|
205
211
|
specification_version: 4
|
|
206
212
|
summary: API Client library for the Google Analytics Data V1alpha API
|