google-analytics-data-v1beta 0.10.0 → 0.11.1
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.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -101
- data/lib/google/analytics/data/v1beta/analytics_data/client.rb +32 -8
- data/lib/google/analytics/data/v1beta/analytics_data/operations.rb +28 -6
- data/lib/google/analytics/data/v1beta/analytics_data/rest/client.rb +34 -7
- data/lib/google/analytics/data/v1beta/analytics_data/rest/operations.rb +33 -8
- data/lib/google/analytics/data/v1beta/analytics_data/rest/service_stub.rb +23 -2
- data/lib/google/analytics/data/v1beta/version.rb +1 -1
- data/proto_docs/google/api/client.rb +1 -0
- metadata +5 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 37e2311354f2353053d4eb4a35c499ae457a3276e39a5b9b50c80d18d784a9b1
|
|
4
|
+
data.tar.gz: 34ffc0fa6c08e7ad0c898b126aff61ac6a57980509e29e073b9b952dfa5516fb
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 981ab75fb645748f48ecac2db83395e28e2e52e1528cc3695f6cb5f7e63dc9e54d6548a55f7c48a70db867f586e404ac2808197cd787debdb76cd0f0b1f68b36
|
|
7
|
+
data.tar.gz: 156576b65b1c49ba1efcf0b244254fc68bfd58e2ceae5f030e19fcf2d179a9c05ee50542a13e2d114f13bd58da314ef5c535fef04bb21f2e9a099a3f0aad3424
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,151 +1,122 @@
|
|
|
1
1
|
# Authentication
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[
|
|
5
|
-
|
|
6
|
-
[Google Cloud Platform environments](#google-cloud-platform-environments) the
|
|
7
|
-
credentials will be discovered automatically. When running on other
|
|
8
|
-
environments, the Service Account credentials can be specified by providing the
|
|
9
|
-
path to the
|
|
10
|
-
[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
|
|
11
|
-
for the account (or the JSON itself) in
|
|
12
|
-
[environment variables](#environment-variables). Additionally, Cloud SDK
|
|
13
|
-
credentials can also be discovered automatically, but this is only recommended
|
|
14
|
-
during development.
|
|
3
|
+
The recommended way to authenticate to the google-analytics-data-v1beta library is to use
|
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
|
15
6
|
|
|
16
7
|
## Quickstart
|
|
17
8
|
|
|
18
|
-
|
|
19
|
-
|
|
9
|
+
The following example shows how to set up authentication for a local development
|
|
10
|
+
environment with your user credentials.
|
|
20
11
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
3. Initialize the client.
|
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
|
13
|
+
should be used only during development.
|
|
26
14
|
|
|
27
|
-
|
|
28
|
-
|
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
|
29
17
|
|
|
30
|
-
|
|
18
|
+
```sh
|
|
19
|
+
gcloud auth application-default login
|
|
31
20
|
```
|
|
32
21
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
The google-analytics-data-v1beta library aims to make authentication
|
|
36
|
-
as simple as possible, and provides several mechanisms to configure your system
|
|
37
|
-
without requiring **Service Account Credentials** directly in code.
|
|
38
|
-
|
|
39
|
-
**Credentials** are discovered in the following order:
|
|
40
|
-
|
|
41
|
-
1. Specify credentials in method arguments
|
|
42
|
-
2. Specify credentials in configuration
|
|
43
|
-
3. Discover credentials path in environment variables
|
|
44
|
-
4. Discover credentials JSON in environment variables
|
|
45
|
-
5. Discover credentials file in the Cloud SDK's path
|
|
46
|
-
6. Discover GCP credentials
|
|
47
|
-
|
|
48
|
-
### Google Cloud Platform environments
|
|
22
|
+
3. Write code as if already authenticated.
|
|
49
23
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
|
53
|
-
Code should be written as if already authenticated.
|
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
|
54
26
|
|
|
55
|
-
|
|
27
|
+
## Credential Lookup
|
|
56
28
|
|
|
57
|
-
The
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
**Credentials JSON** file can be stored in the environment variable, or the
|
|
62
|
-
**Credentials JSON** itself can be stored for environments such as Docker
|
|
63
|
-
containers where writing files is difficult or not encouraged.
|
|
29
|
+
The google-analytics-data-v1beta library provides several mechanisms to configure your system.
|
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
|
32
|
+
credentials, there are several methods available to you.
|
|
64
33
|
|
|
65
|
-
|
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
|
67
|
-
{::Google::Analytics::Data::V1beta::AnalyticsData::Credentials}):
|
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
|
68
35
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
36
|
+
1. Credentials specified in method arguments
|
|
37
|
+
2. Credentials specified in configuration
|
|
38
|
+
3. Credentials pointed to or included in environment variables
|
|
39
|
+
4. Credentials found in local ADC file
|
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
|
74
41
|
|
|
75
|
-
|
|
76
|
-
require "google/analytics/data/v1beta"
|
|
77
|
-
|
|
78
|
-
ENV["ANALYTICS_DATA_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
79
43
|
|
|
80
|
-
client
|
|
81
|
-
|
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
|
82
49
|
|
|
83
|
-
|
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
|
52
|
+
whenever possible.
|
|
84
53
|
|
|
85
|
-
|
|
86
|
-
it in an environment variable. Either on an individual client initialization:
|
|
54
|
+
To configure a credentials file for an individual client initialization:
|
|
87
55
|
|
|
88
56
|
```ruby
|
|
89
57
|
require "google/analytics/data/v1beta"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Analytics::Data::V1beta::AnalyticsData::Client.new do |config|
|
|
92
|
-
config.credentials = "path/to/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
93
61
|
end
|
|
94
62
|
```
|
|
95
63
|
|
|
96
|
-
|
|
64
|
+
To configure a credentials file globally for all clients:
|
|
97
65
|
|
|
98
66
|
```ruby
|
|
99
67
|
require "google/analytics/data/v1beta"
|
|
100
68
|
|
|
101
69
|
::Google::Analytics::Data::V1beta::AnalyticsData::Client.configure do |config|
|
|
102
|
-
config.credentials = "path/to/
|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
|
103
71
|
end
|
|
104
72
|
|
|
105
73
|
client = ::Google::Analytics::Data::V1beta::AnalyticsData::Client.new
|
|
106
74
|
```
|
|
107
75
|
|
|
108
|
-
###
|
|
76
|
+
### Environment Variables
|
|
109
77
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
|
81
|
+
you can include the credentials file itself.
|
|
113
82
|
|
|
114
|
-
|
|
83
|
+
The JSON file can contain credentials created for
|
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
|
115
87
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
88
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
|
89
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
|
90
|
+
whenever possible.
|
|
91
|
+
|
|
92
|
+
The environment variables that google-analytics-data-v1beta
|
|
93
|
+
checks for credentials are:
|
|
119
94
|
|
|
120
|
-
|
|
121
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
122
97
|
|
|
123
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/analytics/data/v1beta"
|
|
124
100
|
|
|
125
|
-
|
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
127
|
-
connect to most services with google-analytics-data-v1beta.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
128
102
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Analytics::Data::V1beta::AnalyticsData::Client.new
|
|
104
|
+
```
|
|
132
105
|
|
|
133
|
-
|
|
134
|
-
2. Create a new project or click on an existing project.
|
|
135
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
|
136
|
-
here, you will enable the APIs that your application requires.
|
|
106
|
+
### Local ADC file
|
|
137
107
|
|
|
138
|
-
|
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
|
110
|
+
then the local ADC credentials are discovered.
|
|
139
111
|
|
|
140
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
141
113
|
|
|
142
|
-
|
|
143
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
144
115
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
|
149
120
|
|
|
150
|
-
|
|
151
|
-
|
|
121
|
+
For more information, see
|
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
|
@@ -30,6 +30,9 @@ module Google
|
|
|
30
30
|
# Google Analytics reporting data service.
|
|
31
31
|
#
|
|
32
32
|
class Client
|
|
33
|
+
# @private
|
|
34
|
+
DEFAULT_ENDPOINT_TEMPLATE = "analyticsdata.$UNIVERSE_DOMAIN$"
|
|
35
|
+
|
|
33
36
|
include Paths
|
|
34
37
|
|
|
35
38
|
# @private
|
|
@@ -109,6 +112,15 @@ module Google
|
|
|
109
112
|
@config
|
|
110
113
|
end
|
|
111
114
|
|
|
115
|
+
##
|
|
116
|
+
# The effective universe domain
|
|
117
|
+
#
|
|
118
|
+
# @return [String]
|
|
119
|
+
#
|
|
120
|
+
def universe_domain
|
|
121
|
+
@analytics_data_stub.universe_domain
|
|
122
|
+
end
|
|
123
|
+
|
|
112
124
|
##
|
|
113
125
|
# Create a new AnalyticsData client object.
|
|
114
126
|
#
|
|
@@ -142,8 +154,9 @@ module Google
|
|
|
142
154
|
credentials = @config.credentials
|
|
143
155
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
144
156
|
# but only if the default endpoint does not have a region prefix.
|
|
145
|
-
enable_self_signed_jwt = @config.endpoint
|
|
146
|
-
|
|
157
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
158
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
159
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
147
160
|
credentials ||= Credentials.default scope: @config.scope,
|
|
148
161
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
149
162
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -156,12 +169,15 @@ module Google
|
|
|
156
169
|
config.credentials = credentials
|
|
157
170
|
config.quota_project = @quota_project_id
|
|
158
171
|
config.endpoint = @config.endpoint
|
|
172
|
+
config.universe_domain = @config.universe_domain
|
|
159
173
|
end
|
|
160
174
|
|
|
161
175
|
@analytics_data_stub = ::Gapic::ServiceStub.new(
|
|
162
176
|
::Google::Analytics::Data::V1beta::BetaAnalyticsData::Stub,
|
|
163
|
-
credentials:
|
|
164
|
-
endpoint:
|
|
177
|
+
credentials: credentials,
|
|
178
|
+
endpoint: @config.endpoint,
|
|
179
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
180
|
+
universe_domain: @config.universe_domain,
|
|
165
181
|
channel_args: @config.channel_args,
|
|
166
182
|
interceptors: @config.interceptors,
|
|
167
183
|
channel_pool_config: @config.channel_pool
|
|
@@ -1518,9 +1534,9 @@ module Google
|
|
|
1518
1534
|
# end
|
|
1519
1535
|
#
|
|
1520
1536
|
# @!attribute [rw] endpoint
|
|
1521
|
-
#
|
|
1522
|
-
#
|
|
1523
|
-
# @return [::String]
|
|
1537
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1538
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1539
|
+
# @return [::String,nil]
|
|
1524
1540
|
# @!attribute [rw] credentials
|
|
1525
1541
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1526
1542
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1566,13 +1582,20 @@ module Google
|
|
|
1566
1582
|
# @!attribute [rw] quota_project
|
|
1567
1583
|
# A separate project against which to charge quota.
|
|
1568
1584
|
# @return [::String]
|
|
1585
|
+
# @!attribute [rw] universe_domain
|
|
1586
|
+
# The universe domain within which to make requests. This determines the
|
|
1587
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1588
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1589
|
+
# @return [::String,nil]
|
|
1569
1590
|
#
|
|
1570
1591
|
class Configuration
|
|
1571
1592
|
extend ::Gapic::Config
|
|
1572
1593
|
|
|
1594
|
+
# @private
|
|
1595
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1573
1596
|
DEFAULT_ENDPOINT = "analyticsdata.googleapis.com"
|
|
1574
1597
|
|
|
1575
|
-
config_attr :endpoint,
|
|
1598
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1576
1599
|
config_attr :credentials, nil do |value|
|
|
1577
1600
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1578
1601
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -1587,6 +1610,7 @@ module Google
|
|
|
1587
1610
|
config_attr :metadata, nil, ::Hash, nil
|
|
1588
1611
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1589
1612
|
config_attr :quota_project, nil, ::String, nil
|
|
1613
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1590
1614
|
|
|
1591
1615
|
# @private
|
|
1592
1616
|
def initialize parent_config = nil
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module AnalyticsData
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "analyticsdata.$UNIVERSE_DOMAIN$"
|
|
31
|
+
|
|
29
32
|
# @private
|
|
30
33
|
attr_reader :operations_stub
|
|
31
34
|
|
|
@@ -60,6 +63,15 @@ module Google
|
|
|
60
63
|
@config
|
|
61
64
|
end
|
|
62
65
|
|
|
66
|
+
##
|
|
67
|
+
# The effective universe domain
|
|
68
|
+
#
|
|
69
|
+
# @return [String]
|
|
70
|
+
#
|
|
71
|
+
def universe_domain
|
|
72
|
+
@operations_stub.universe_domain
|
|
73
|
+
end
|
|
74
|
+
|
|
63
75
|
##
|
|
64
76
|
# Create a new Operations client object.
|
|
65
77
|
#
|
|
@@ -90,8 +102,10 @@ module Google
|
|
|
90
102
|
|
|
91
103
|
@operations_stub = ::Gapic::ServiceStub.new(
|
|
92
104
|
::Google::Longrunning::Operations::Stub,
|
|
93
|
-
credentials:
|
|
94
|
-
endpoint:
|
|
105
|
+
credentials: credentials,
|
|
106
|
+
endpoint: @config.endpoint,
|
|
107
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
108
|
+
universe_domain: @config.universe_domain,
|
|
95
109
|
channel_args: @config.channel_args,
|
|
96
110
|
interceptors: @config.interceptors,
|
|
97
111
|
channel_pool_config: @config.channel_pool
|
|
@@ -613,9 +627,9 @@ module Google
|
|
|
613
627
|
# end
|
|
614
628
|
#
|
|
615
629
|
# @!attribute [rw] endpoint
|
|
616
|
-
#
|
|
617
|
-
#
|
|
618
|
-
# @return [::String]
|
|
630
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
631
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
632
|
+
# @return [::String,nil]
|
|
619
633
|
# @!attribute [rw] credentials
|
|
620
634
|
# Credentials to send with calls. You may provide any of the following types:
|
|
621
635
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -661,13 +675,20 @@ module Google
|
|
|
661
675
|
# @!attribute [rw] quota_project
|
|
662
676
|
# A separate project against which to charge quota.
|
|
663
677
|
# @return [::String]
|
|
678
|
+
# @!attribute [rw] universe_domain
|
|
679
|
+
# The universe domain within which to make requests. This determines the
|
|
680
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
681
|
+
# universe (usually the default "googleapis.com" universe).
|
|
682
|
+
# @return [::String,nil]
|
|
664
683
|
#
|
|
665
684
|
class Configuration
|
|
666
685
|
extend ::Gapic::Config
|
|
667
686
|
|
|
687
|
+
# @private
|
|
688
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
668
689
|
DEFAULT_ENDPOINT = "analyticsdata.googleapis.com"
|
|
669
690
|
|
|
670
|
-
config_attr :endpoint,
|
|
691
|
+
config_attr :endpoint, nil, ::String, nil
|
|
671
692
|
config_attr :credentials, nil do |value|
|
|
672
693
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
673
694
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -682,6 +703,7 @@ module Google
|
|
|
682
703
|
config_attr :metadata, nil, ::Hash, nil
|
|
683
704
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
684
705
|
config_attr :quota_project, nil, ::String, nil
|
|
706
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
685
707
|
|
|
686
708
|
# @private
|
|
687
709
|
def initialize parent_config = nil
|
|
@@ -32,6 +32,9 @@ module Google
|
|
|
32
32
|
# Google Analytics reporting data service.
|
|
33
33
|
#
|
|
34
34
|
class Client
|
|
35
|
+
# @private
|
|
36
|
+
DEFAULT_ENDPOINT_TEMPLATE = "analyticsdata.$UNIVERSE_DOMAIN$"
|
|
37
|
+
|
|
35
38
|
include Paths
|
|
36
39
|
|
|
37
40
|
# @private
|
|
@@ -111,6 +114,15 @@ module Google
|
|
|
111
114
|
@config
|
|
112
115
|
end
|
|
113
116
|
|
|
117
|
+
##
|
|
118
|
+
# The effective universe domain
|
|
119
|
+
#
|
|
120
|
+
# @return [String]
|
|
121
|
+
#
|
|
122
|
+
def universe_domain
|
|
123
|
+
@analytics_data_stub.universe_domain
|
|
124
|
+
end
|
|
125
|
+
|
|
114
126
|
##
|
|
115
127
|
# Create a new AnalyticsData REST client object.
|
|
116
128
|
#
|
|
@@ -138,8 +150,9 @@ module Google
|
|
|
138
150
|
credentials = @config.credentials
|
|
139
151
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
140
152
|
# but only if the default endpoint does not have a region prefix.
|
|
141
|
-
enable_self_signed_jwt = @config.endpoint
|
|
142
|
-
|
|
153
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
154
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
155
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
143
156
|
credentials ||= Credentials.default scope: @config.scope,
|
|
144
157
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
145
158
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -153,9 +166,15 @@ module Google
|
|
|
153
166
|
config.credentials = credentials
|
|
154
167
|
config.quota_project = @quota_project_id
|
|
155
168
|
config.endpoint = @config.endpoint
|
|
169
|
+
config.universe_domain = @config.universe_domain
|
|
156
170
|
end
|
|
157
171
|
|
|
158
|
-
@analytics_data_stub = ::Google::Analytics::Data::V1beta::AnalyticsData::Rest::ServiceStub.new
|
|
172
|
+
@analytics_data_stub = ::Google::Analytics::Data::V1beta::AnalyticsData::Rest::ServiceStub.new(
|
|
173
|
+
endpoint: @config.endpoint,
|
|
174
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
175
|
+
universe_domain: @config.universe_domain,
|
|
176
|
+
credentials: credentials
|
|
177
|
+
)
|
|
159
178
|
end
|
|
160
179
|
|
|
161
180
|
##
|
|
@@ -1431,9 +1450,9 @@ module Google
|
|
|
1431
1450
|
# end
|
|
1432
1451
|
#
|
|
1433
1452
|
# @!attribute [rw] endpoint
|
|
1434
|
-
#
|
|
1435
|
-
#
|
|
1436
|
-
# @return [::String]
|
|
1453
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1454
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1455
|
+
# @return [::String,nil]
|
|
1437
1456
|
# @!attribute [rw] credentials
|
|
1438
1457
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1439
1458
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1470,13 +1489,20 @@ module Google
|
|
|
1470
1489
|
# @!attribute [rw] quota_project
|
|
1471
1490
|
# A separate project against which to charge quota.
|
|
1472
1491
|
# @return [::String]
|
|
1492
|
+
# @!attribute [rw] universe_domain
|
|
1493
|
+
# The universe domain within which to make requests. This determines the
|
|
1494
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1495
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1496
|
+
# @return [::String,nil]
|
|
1473
1497
|
#
|
|
1474
1498
|
class Configuration
|
|
1475
1499
|
extend ::Gapic::Config
|
|
1476
1500
|
|
|
1501
|
+
# @private
|
|
1502
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1477
1503
|
DEFAULT_ENDPOINT = "analyticsdata.googleapis.com"
|
|
1478
1504
|
|
|
1479
|
-
config_attr :endpoint,
|
|
1505
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1480
1506
|
config_attr :credentials, nil do |value|
|
|
1481
1507
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1482
1508
|
allowed.any? { |klass| klass === value }
|
|
@@ -1488,6 +1514,7 @@ module Google
|
|
|
1488
1514
|
config_attr :metadata, nil, ::Hash, nil
|
|
1489
1515
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1490
1516
|
config_attr :quota_project, nil, ::String, nil
|
|
1517
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1491
1518
|
|
|
1492
1519
|
# @private
|
|
1493
1520
|
def initialize parent_config = nil
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module Rest
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "analyticsdata.$UNIVERSE_DOMAIN$"
|
|
31
|
+
|
|
29
32
|
# @private
|
|
30
33
|
attr_reader :operations_stub
|
|
31
34
|
|
|
@@ -60,6 +63,15 @@ module Google
|
|
|
60
63
|
@config
|
|
61
64
|
end
|
|
62
65
|
|
|
66
|
+
##
|
|
67
|
+
# The effective universe domain
|
|
68
|
+
#
|
|
69
|
+
# @return [String]
|
|
70
|
+
#
|
|
71
|
+
def universe_domain
|
|
72
|
+
@operations_stub.universe_domain
|
|
73
|
+
end
|
|
74
|
+
|
|
63
75
|
##
|
|
64
76
|
# Create a new Operations client object.
|
|
65
77
|
#
|
|
@@ -84,8 +96,10 @@ module Google
|
|
|
84
96
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
85
97
|
|
|
86
98
|
@operations_stub = OperationsServiceStub.new(
|
|
87
|
-
endpoint:
|
|
88
|
-
|
|
99
|
+
endpoint: @config.endpoint,
|
|
100
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
101
|
+
universe_domain: @config.universe_domain,
|
|
102
|
+
credentials: credentials
|
|
89
103
|
)
|
|
90
104
|
|
|
91
105
|
# Used by an LRO wrapper for some methods of this service
|
|
@@ -478,9 +492,9 @@ module Google
|
|
|
478
492
|
# end
|
|
479
493
|
#
|
|
480
494
|
# @!attribute [rw] endpoint
|
|
481
|
-
#
|
|
482
|
-
#
|
|
483
|
-
# @return [::String]
|
|
495
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
496
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
497
|
+
# @return [::String,nil]
|
|
484
498
|
# @!attribute [rw] credentials
|
|
485
499
|
# Credentials to send with calls. You may provide any of the following types:
|
|
486
500
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -517,13 +531,20 @@ module Google
|
|
|
517
531
|
# @!attribute [rw] quota_project
|
|
518
532
|
# A separate project against which to charge quota.
|
|
519
533
|
# @return [::String]
|
|
534
|
+
# @!attribute [rw] universe_domain
|
|
535
|
+
# The universe domain within which to make requests. This determines the
|
|
536
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
537
|
+
# universe (usually the default "googleapis.com" universe).
|
|
538
|
+
# @return [::String,nil]
|
|
520
539
|
#
|
|
521
540
|
class Configuration
|
|
522
541
|
extend ::Gapic::Config
|
|
523
542
|
|
|
543
|
+
# @private
|
|
544
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
524
545
|
DEFAULT_ENDPOINT = "analyticsdata.googleapis.com"
|
|
525
546
|
|
|
526
|
-
config_attr :endpoint,
|
|
547
|
+
config_attr :endpoint, nil, ::String, nil
|
|
527
548
|
config_attr :credentials, nil do |value|
|
|
528
549
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
529
550
|
allowed.any? { |klass| klass === value }
|
|
@@ -535,6 +556,7 @@ module Google
|
|
|
535
556
|
config_attr :metadata, nil, ::Hash, nil
|
|
536
557
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
537
558
|
config_attr :quota_project, nil, ::String, nil
|
|
559
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
538
560
|
|
|
539
561
|
# @private
|
|
540
562
|
def initialize parent_config = nil
|
|
@@ -617,12 +639,15 @@ module Google
|
|
|
617
639
|
# Service stub contains baseline method implementations
|
|
618
640
|
# including transcoding, making the REST call, and deserialing the response.
|
|
619
641
|
class OperationsServiceStub
|
|
620
|
-
def initialize endpoint:, credentials:
|
|
642
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
621
643
|
# These require statements are intentionally placed here to initialize
|
|
622
644
|
# the REST modules only when it's required.
|
|
623
645
|
require "gapic/rest"
|
|
624
646
|
|
|
625
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
647
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
648
|
+
endpoint_template: endpoint_template,
|
|
649
|
+
universe_domain: universe_domain,
|
|
650
|
+
credentials: credentials
|
|
626
651
|
end
|
|
627
652
|
|
|
628
653
|
##
|
|
@@ -30,16 +30,37 @@ module Google
|
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
|
31
31
|
#
|
|
32
32
|
class ServiceStub
|
|
33
|
-
def initialize endpoint:, credentials:
|
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
34
34
|
# These require statements are intentionally placed here to initialize
|
|
35
35
|
# the REST modules only when it's required.
|
|
36
36
|
require "gapic/rest"
|
|
37
37
|
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
39
|
+
endpoint_template: endpoint_template,
|
|
40
|
+
universe_domain: universe_domain,
|
|
41
|
+
credentials: credentials,
|
|
39
42
|
numeric_enums: true,
|
|
40
43
|
raise_faraday_errors: false
|
|
41
44
|
end
|
|
42
45
|
|
|
46
|
+
##
|
|
47
|
+
# The effective universe domain
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
#
|
|
51
|
+
def universe_domain
|
|
52
|
+
@client_stub.universe_domain
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
##
|
|
56
|
+
# The effective endpoint
|
|
57
|
+
#
|
|
58
|
+
# @return [String]
|
|
59
|
+
#
|
|
60
|
+
def endpoint
|
|
61
|
+
@client_stub.endpoint
|
|
62
|
+
end
|
|
63
|
+
|
|
43
64
|
##
|
|
44
65
|
# Baseline implementation for the run_report REST call
|
|
45
66
|
#
|
|
@@ -21,6 +21,7 @@ module Google
|
|
|
21
21
|
module Api
|
|
22
22
|
# Required information for every language.
|
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
24
25
|
# @return [::String]
|
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-analytics-data-v1beta
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.11.1
|
|
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: 2024-01-12 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
@@ -16,7 +16,7 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - ">="
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: 0.
|
|
19
|
+
version: 0.21.1
|
|
20
20
|
- - "<"
|
|
21
21
|
- !ruby/object:Gem::Version
|
|
22
22
|
version: 2.a
|
|
@@ -26,7 +26,7 @@ dependencies:
|
|
|
26
26
|
requirements:
|
|
27
27
|
- - ">="
|
|
28
28
|
- !ruby/object:Gem::Version
|
|
29
|
-
version: 0.
|
|
29
|
+
version: 0.21.1
|
|
30
30
|
- - "<"
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: 2.a
|
|
@@ -218,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
218
218
|
- !ruby/object:Gem::Version
|
|
219
219
|
version: '0'
|
|
220
220
|
requirements: []
|
|
221
|
-
rubygems_version: 3.
|
|
221
|
+
rubygems_version: 3.5.3
|
|
222
222
|
signing_key:
|
|
223
223
|
specification_version: 4
|
|
224
224
|
summary: 'Accesses report data in Google Analytics. Warning: Creating multiple Customer
|