google-analytics-admin-v1alpha 0.4.0 → 0.5.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e32852bbcc1562112cba21edd419039aad815748490414587a1edbf580ab1771
4
- data.tar.gz: 4fef8c3b9a2ac6c3c9d48f6ed513b412235e0b536d896db4dbcff5955ed5f7ba
3
+ metadata.gz: 154bfe2cbb778dff4fce01b1e2b4631ad3f9ec2c5cd9ad4dee19106e2520cf9e
4
+ data.tar.gz: cb6539719dcfbf4d25c5f62932c9ca84341a41cfc2bfc83ea6c82f693933f6d0
5
5
  SHA512:
6
- metadata.gz: 386b01797bd722053cbb321cd0720dc3e3ce9c3ffae0ad8c8595e3c5d628d15837abff83a04be9e33103c08eb61843dfa7cc19713d7977b62af26797ff83ac79
7
- data.tar.gz: 4214abd44d02bd59db7670c98f5383d3ce127b61b7c90b0eaa7b74d377531140f151157392c75959e4637e04981c652ec8261e4c4befd74dcb61795622f63260
6
+ metadata.gz: bce72ad4c9ddfaf75be715b1d0b3ec84517b4ec126df1a7c3263ba60ac6023e2335f075c862040dea181780bb6e715b18033fe26e17e00be61aaff0a00859d66
7
+ data.tar.gz: 58cedbb4468e2b475a8643c962f8749fbe1c6f991ffa2fbb0d33c86c5b0e1392e3851633258ff946c9d7825b732e139a77d58d5f84965426e5a35ec8f0f66ab7
data/README.md CHANGED
@@ -6,6 +6,12 @@ The Analytics Admin API allows for programmatic access to the Google Analytics A
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 Admin V1alpha API. Most users should consider using
11
+ the main client gem,
12
+ [google-analytics-admin](https://rubygems.org/gems/google-analytics-admin).
13
+ See the section below titled *Which client should I use?* for more information.
14
+
9
15
  ## Installation
10
16
 
11
17
  ```
@@ -70,3 +76,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
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-admin`,
84
+ and lower-level _versioned_ client libraries with names such as
85
+ `google-analytics-admin-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-admin`.
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-admin-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.
@@ -224,7 +224,13 @@ module Google
224
224
 
225
225
  # Create credentials
226
226
  credentials = @config.credentials
227
- credentials ||= Credentials.default scope: @config.scope
227
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
228
+ # but only if the default endpoint does not have a region prefix.
229
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
230
+ @config.endpoint == Client.configure.endpoint &&
231
+ !@config.endpoint.split(".").first.include?("-")
232
+ credentials ||= Credentials.default scope: @config.scope,
233
+ enable_self_signed_jwt: enable_self_signed_jwt
228
234
  if credentials.is_a?(String) || credentials.is_a?(Hash)
229
235
  credentials = Credentials.new credentials, scope: @config.scope
230
236
  end
@@ -21,7 +21,7 @@ module Google
21
21
  module Analytics
22
22
  module Admin
23
23
  module V1alpha
24
- VERSION = "0.4.0"
24
+ VERSION = "0.5.0"
25
25
  end
26
26
  end
27
27
  end
@@ -54,6 +54,12 @@ 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
57
63
  end
58
64
  end
59
65
  end
@@ -70,7 +70,16 @@ module Google
70
70
  # .setNanos((int) ((millis % 1000) * 1000000)).build();
71
71
  #
72
72
  #
73
- # Example 5: Compute Timestamp from current time in Python.
73
+ # Example 5: Compute Timestamp from Java `Instant.now()`.
74
+ #
75
+ # Instant now = Instant.now();
76
+ #
77
+ # Timestamp timestamp =
78
+ # Timestamp.newBuilder().setSeconds(now.getEpochSecond())
79
+ # .setNanos(now.getNano()).build();
80
+ #
81
+ #
82
+ # Example 6: Compute Timestamp from current time in Python.
74
83
  #
75
84
  # timestamp = Timestamp()
76
85
  # timestamp.GetCurrentTime()
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-analytics-admin-v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0
4
+ version: 0.5.0
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-01-20 00:00:00.000000000 Z
11
+ date: 2021-02-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -152,7 +152,9 @@ dependencies:
152
152
  version: '0.9'
153
153
  description: The Analytics Admin API allows for programmatic access to the Google
154
154
  Analytics App+Web configuration data. You can use the Google Analytics Admin API
155
- to manage accounts and App+Web properties.
155
+ to manage accounts and App+Web properties. Note that google-analytics-admin-v1alpha
156
+ is a version-specific client library. For most uses, we recommend installing the
157
+ main client library google-analytics-admin instead. See the readme for more details.
156
158
  email: googleapis-packages@google.com
157
159
  executables: []
158
160
  extensions: []