google-analytics-data-v1alpha 0.6.0 → 0.8.2
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/LICENSE.md +188 -190
- data/README.md +67 -3
- data/lib/google/analytics/data/v1alpha.rb +3 -0
- data/lib/google/analytics/data/v1alpha/analytics_data/client.rb +19 -16
- 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 +12 -0
- metadata +19 -11
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f7e528a1618693ab9be4d5fa1d19395c64adc2a9985e855d9f7eccf30988462c
|
|
4
|
+
data.tar.gz: 44845f4c1e6f481c5037c7775777d42fceb12515c4011691cf2d176c013254dd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 95e1cb2613fac88cfc42628bfa4aecae39c40f8b985ca30ebf69fcd68fc73123ae572758ee3c2ab072086a173621dda7d56a1181150b6ecdecaf926a3f423ba5
|
|
7
|
+
data.tar.gz: a984e9d0f45468e2b9a690f2a631b1ea7161be17831a2a9fd56eb793d209f49aa28c9275b6d14e6b09e5be6fe6e5a1c8cfa8d909da3a64845ba4bdd2ba31f6c7
|
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/LICENSE.md
CHANGED
|
@@ -1,192 +1,190 @@
|
|
|
1
|
-
Apache License
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
same "printed page" as the copyright notice for easier
|
|
189
|
-
identification within third-party archives.
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
190
188
|
|
|
191
189
|
Copyright [yyyy] [name of copyright owner]
|
|
192
190
|
|
|
@@ -194,7 +192,7 @@ identification within third-party archives.
|
|
|
194
192
|
you may not use this file except in compliance with the License.
|
|
195
193
|
You may obtain a copy of the License at
|
|
196
194
|
|
|
197
|
-
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
198
196
|
|
|
199
197
|
Unless required by applicable law or agreed to in writing, software
|
|
200
198
|
distributed under the License is distributed on an "AS IS" BASIS,
|
data/README.md
CHANGED
|
@@ -6,6 +6,12 @@ The Google Analytics Data API provides programmatic methods to access report dat
|
|
|
6
6
|
|
|
7
7
|
https://github.com/googleapis/google-cloud-ruby
|
|
8
8
|
|
|
9
|
+
This gem is a _versioned_ client. It provides basic client classes for a
|
|
10
|
+
specific version of the Google Analytics Data V1alpha API. Most users should consider using
|
|
11
|
+
the main client gem,
|
|
12
|
+
[google-analytics-data](https://rubygems.org/gems/google-analytics-data).
|
|
13
|
+
See the section below titled *Which client should I use?* for more information.
|
|
14
|
+
|
|
9
15
|
## Installation
|
|
10
16
|
|
|
11
17
|
```
|
|
@@ -27,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
|
|
|
27
33
|
require "google/analytics/data/v1alpha"
|
|
28
34
|
|
|
29
35
|
client = ::Google::Analytics::Data::V1alpha::AnalyticsData::Client.new
|
|
30
|
-
request =
|
|
36
|
+
request = ::Google::Analytics::Data::V1alpha::RunReportRequest.new # (request fields as keyword arguments...)
|
|
31
37
|
response = client.run_report request
|
|
32
38
|
```
|
|
33
39
|
|
|
@@ -62,11 +68,69 @@ end
|
|
|
62
68
|
|
|
63
69
|
## Supported Ruby Versions
|
|
64
70
|
|
|
65
|
-
This library is supported on Ruby 2.
|
|
71
|
+
This library is supported on Ruby 2.5+.
|
|
66
72
|
|
|
67
73
|
Google provides official support for Ruby versions that are actively supported
|
|
68
74
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
|
69
|
-
in security maintenance, and not end of life. Currently, this means Ruby 2.
|
|
75
|
+
in security maintenance, and not end of life. Currently, this means Ruby 2.5
|
|
70
76
|
and later. Older versions of Ruby _may_ still work, but are unsupported and not
|
|
71
77
|
recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
|
|
72
78
|
about the Ruby support schedule.
|
|
79
|
+
|
|
80
|
+
## Which client should I use?
|
|
81
|
+
|
|
82
|
+
Most modern Ruby client libraries for Google APIs come in two flavors: the main
|
|
83
|
+
client library with a name such as `google-analytics-data`,
|
|
84
|
+
and lower-level _versioned_ client libraries with names such as
|
|
85
|
+
`google-analytics-data-v1alpha`.
|
|
86
|
+
_In most cases, you should install the main client._
|
|
87
|
+
|
|
88
|
+
### What's the difference between the main client and a versioned client?
|
|
89
|
+
|
|
90
|
+
A _versioned client_ provides a basic set of data types and client classes for
|
|
91
|
+
a _single version_ of a specific service. (That is, for a service with multiple
|
|
92
|
+
versions, there might be a separate versioned client for each service version.)
|
|
93
|
+
Most versioned clients are written and maintained by a code generator.
|
|
94
|
+
|
|
95
|
+
The _main client_ is designed to provide you with the _recommended_ client
|
|
96
|
+
interfaces for the service. There will be only one main client for any given
|
|
97
|
+
service, even a service with multiple versions. The main client includes
|
|
98
|
+
factory methods for constructing the client objects we recommend for most
|
|
99
|
+
users. In some cases, those will be classes provided by an underlying versioned
|
|
100
|
+
client; in other cases, they will be handwritten higher-level client objects
|
|
101
|
+
with additional capabilities, convenience methods, or best practices built in.
|
|
102
|
+
Generally, the main client will default to a recommended service version,
|
|
103
|
+
although in some cases you can override this if you need to talk to a specific
|
|
104
|
+
service version.
|
|
105
|
+
|
|
106
|
+
### Why would I want to use the main client?
|
|
107
|
+
|
|
108
|
+
We recommend that most users install the main client gem for a service. You can
|
|
109
|
+
identify this gem as the one _without_ a version in its name, e.g.
|
|
110
|
+
`google-analytics-data`.
|
|
111
|
+
The main client is recommended because it will embody the best practices for
|
|
112
|
+
accessing the service, and may also provide more convenient interfaces or
|
|
113
|
+
tighter integration into frameworks and third-party libraries. In addition, the
|
|
114
|
+
documentation and samples published by Google will generally demonstrate use of
|
|
115
|
+
the main client.
|
|
116
|
+
|
|
117
|
+
### Why would I want to use a versioned client?
|
|
118
|
+
|
|
119
|
+
You can use a versioned client if you are content with a possibly lower-level
|
|
120
|
+
class interface, you explicitly want to avoid features provided by the main
|
|
121
|
+
client, or you want to access a specific service version not be covered by the
|
|
122
|
+
main client. You can identify versioned client gems because the service version
|
|
123
|
+
is part of the name, e.g. `google-analytics-data-v1alpha`.
|
|
124
|
+
|
|
125
|
+
### What about the google-apis-<name> clients?
|
|
126
|
+
|
|
127
|
+
Client library gems with names that begin with `google-apis-` are based on an
|
|
128
|
+
older code generation technology. They talk to a REST/JSON backend (whereas
|
|
129
|
+
most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
|
|
130
|
+
not offer the same performance, features, and ease of use provided by more
|
|
131
|
+
modern clients.
|
|
132
|
+
|
|
133
|
+
The `google-apis-` clients have wide coverage across Google services, so you
|
|
134
|
+
might need to use one if there is no modern client available for the service.
|
|
135
|
+
However, if a modern client is available, we generally recommend it over the
|
|
136
|
+
older `google-apis-` clients.
|
|
@@ -60,17 +60,14 @@ module Google
|
|
|
60
60
|
parent_config = while namespace.any?
|
|
61
61
|
parent_name = namespace.join "::"
|
|
62
62
|
parent_const = const_get parent_name
|
|
63
|
-
break parent_const.configure if parent_const
|
|
63
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
|
64
64
|
namespace.pop
|
|
65
65
|
end
|
|
66
66
|
default_config = Client::Configuration.new parent_config
|
|
67
67
|
|
|
68
68
|
default_config.timeout = 60.0
|
|
69
69
|
default_config.retry_policy = {
|
|
70
|
-
initial_delay: 1.0,
|
|
71
|
-
max_delay: 60.0,
|
|
72
|
-
multiplier: 1.3,
|
|
73
|
-
retry_codes: [2]
|
|
70
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [2]
|
|
74
71
|
}
|
|
75
72
|
|
|
76
73
|
default_config.rpcs.run_report.timeout = 60.0
|
|
@@ -142,8 +139,14 @@ module Google
|
|
|
142
139
|
|
|
143
140
|
# Create credentials
|
|
144
141
|
credentials = @config.credentials
|
|
145
|
-
|
|
146
|
-
if
|
|
142
|
+
# Use self-signed JWT if the scope and endpoint are unchanged from default,
|
|
143
|
+
# but only if the default endpoint does not have a region prefix.
|
|
144
|
+
enable_self_signed_jwt = @config.scope == Client.configure.scope &&
|
|
145
|
+
@config.endpoint == Client.configure.endpoint &&
|
|
146
|
+
!@config.endpoint.split(".").first.include?("-")
|
|
147
|
+
credentials ||= Credentials.default scope: @config.scope,
|
|
148
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
|
149
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
147
150
|
credentials = Credentials.new credentials, scope: @config.scope
|
|
148
151
|
end
|
|
149
152
|
@quota_project_id = @config.quota_project
|
|
@@ -780,7 +783,7 @@ module Google
|
|
|
780
783
|
config_attr :scope, nil, ::String, ::Array, nil
|
|
781
784
|
config_attr :lib_name, nil, ::String, nil
|
|
782
785
|
config_attr :lib_version, nil, ::String, nil
|
|
783
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
|
|
786
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
|
784
787
|
config_attr :interceptors, nil, ::Array, nil
|
|
785
788
|
config_attr :timeout, nil, ::Numeric, nil
|
|
786
789
|
config_attr :metadata, nil, ::Hash, nil
|
|
@@ -801,7 +804,7 @@ module Google
|
|
|
801
804
|
def rpcs
|
|
802
805
|
@rpcs ||= begin
|
|
803
806
|
parent_rpcs = nil
|
|
804
|
-
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config
|
|
807
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
|
805
808
|
Rpcs.new parent_rpcs
|
|
806
809
|
end
|
|
807
810
|
end
|
|
@@ -813,7 +816,7 @@ module Google
|
|
|
813
816
|
# Each configuration object is of type `Gapic::Config::Method` and includes
|
|
814
817
|
# the following configuration fields:
|
|
815
818
|
#
|
|
816
|
-
# * `timeout` (*type:* `Numeric`) - The call timeout in
|
|
819
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
|
817
820
|
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
|
|
818
821
|
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
|
819
822
|
# include the following keys:
|
|
@@ -857,17 +860,17 @@ module Google
|
|
|
857
860
|
|
|
858
861
|
# @private
|
|
859
862
|
def initialize parent_rpcs = nil
|
|
860
|
-
run_report_config = parent_rpcs
|
|
863
|
+
run_report_config = parent_rpcs.run_report if parent_rpcs.respond_to? :run_report
|
|
861
864
|
@run_report = ::Gapic::Config::Method.new run_report_config
|
|
862
|
-
run_pivot_report_config = parent_rpcs
|
|
865
|
+
run_pivot_report_config = parent_rpcs.run_pivot_report if parent_rpcs.respond_to? :run_pivot_report
|
|
863
866
|
@run_pivot_report = ::Gapic::Config::Method.new run_pivot_report_config
|
|
864
|
-
batch_run_reports_config = parent_rpcs
|
|
867
|
+
batch_run_reports_config = parent_rpcs.batch_run_reports if parent_rpcs.respond_to? :batch_run_reports
|
|
865
868
|
@batch_run_reports = ::Gapic::Config::Method.new batch_run_reports_config
|
|
866
|
-
batch_run_pivot_reports_config = parent_rpcs
|
|
869
|
+
batch_run_pivot_reports_config = parent_rpcs.batch_run_pivot_reports if parent_rpcs.respond_to? :batch_run_pivot_reports
|
|
867
870
|
@batch_run_pivot_reports = ::Gapic::Config::Method.new batch_run_pivot_reports_config
|
|
868
|
-
get_metadata_config = parent_rpcs
|
|
871
|
+
get_metadata_config = parent_rpcs.get_metadata if parent_rpcs.respond_to? :get_metadata
|
|
869
872
|
@get_metadata = ::Gapic::Config::Method.new get_metadata_config
|
|
870
|
-
run_realtime_report_config = parent_rpcs
|
|
873
|
+
run_realtime_report_config = parent_rpcs.run_realtime_report if parent_rpcs.respond_to? :run_realtime_report
|
|
871
874
|
@run_realtime_report = ::Gapic::Config::Method.new run_realtime_report_config
|
|
872
875
|
|
|
873
876
|
yield self if block_given?
|
|
@@ -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"
|
|
@@ -54,6 +54,18 @@ module Google
|
|
|
54
54
|
# This indicates that the field may be set once in a request to create a
|
|
55
55
|
# resource, but may not be changed thereafter.
|
|
56
56
|
IMMUTABLE = 5
|
|
57
|
+
|
|
58
|
+
# Denotes that a (repeated) field is an unordered list.
|
|
59
|
+
# This indicates that the service may provide the elements of the list
|
|
60
|
+
# in any arbitrary order, rather than the order the user originally
|
|
61
|
+
# provided. Additionally, the list's order may or may not be stable.
|
|
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
|
|
57
69
|
end
|
|
58
70
|
end
|
|
59
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.
|
|
4
|
+
version: 0.8.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2021-07-12 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.5'
|
|
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.5'
|
|
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
|
|
@@ -44,14 +50,14 @@ dependencies:
|
|
|
44
50
|
requirements:
|
|
45
51
|
- - "~>"
|
|
46
52
|
- !ruby/object:Gem::Version
|
|
47
|
-
version: 1.
|
|
53
|
+
version: 1.25.1
|
|
48
54
|
type: :development
|
|
49
55
|
prerelease: false
|
|
50
56
|
version_requirements: !ruby/object:Gem::Requirement
|
|
51
57
|
requirements:
|
|
52
58
|
- - "~>"
|
|
53
59
|
- !ruby/object:Gem::Version
|
|
54
|
-
version: 1.
|
|
60
|
+
version: 1.25.1
|
|
55
61
|
- !ruby/object:Gem::Dependency
|
|
56
62
|
name: minitest
|
|
57
63
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -154,7 +160,9 @@ description: The Google Analytics Data API provides programmatic methods to acce
|
|
|
154
160
|
report data in Google Analytics App+Web properties. With the Google Analytics Data
|
|
155
161
|
API, you can build custom dashboards to display Google Analytics data, automate
|
|
156
162
|
complex reporting tasks to save time, and integrate your Google Analytics data with
|
|
157
|
-
other business applications.
|
|
163
|
+
other business applications. Note that google-analytics-data-v1alpha is a version-specific
|
|
164
|
+
client library. For most uses, we recommend installing the main client library google-analytics-data
|
|
165
|
+
instead. See the readme for more details.
|
|
158
166
|
email: googleapis-packages@google.com
|
|
159
167
|
executables: []
|
|
160
168
|
extensions: []
|
|
@@ -191,14 +199,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
191
199
|
requirements:
|
|
192
200
|
- - ">="
|
|
193
201
|
- !ruby/object:Gem::Version
|
|
194
|
-
version: '2.
|
|
202
|
+
version: '2.5'
|
|
195
203
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
196
204
|
requirements:
|
|
197
205
|
- - ">="
|
|
198
206
|
- !ruby/object:Gem::Version
|
|
199
207
|
version: '0'
|
|
200
208
|
requirements: []
|
|
201
|
-
rubygems_version: 3.
|
|
209
|
+
rubygems_version: 3.2.17
|
|
202
210
|
signing_key:
|
|
203
211
|
specification_version: 4
|
|
204
212
|
summary: API Client library for the Google Analytics Data V1alpha API
|