google-analytics-admin-v1alpha 0.2.2 → 0.7.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 +4 -4
- data/LICENSE.md +188 -190
- data/README.md +66 -2
- data/lib/google/analytics/admin/v1alpha.rb +3 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +21 -10
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +202 -238
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +1 -1
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +4 -19
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +59 -11
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +99 -35
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +156 -41
- data/proto_docs/google/api/field_behavior.rb +6 -0
- data/proto_docs/google/protobuf/timestamp.rb +10 -1
- metadata +11 -9
@@ -36,13 +36,9 @@ module Google
|
|
36
36
|
# @!attribute [rw] display_name
|
37
37
|
# @return [::String]
|
38
38
|
# Required. Human-readable display name for this account.
|
39
|
-
# @!attribute [rw]
|
39
|
+
# @!attribute [rw] region_code
|
40
40
|
# @return [::String]
|
41
|
-
# Country of business. Must be a
|
42
|
-
#
|
43
|
-
# https:
|
44
|
-
# //unicode.org/cldr/charts/latest/supplem
|
45
|
-
# // ental/territory_containment_un_m_49.html
|
41
|
+
# Country of business. Must be a Unicode CLDR region code.
|
46
42
|
# @!attribute [r] deleted
|
47
43
|
# @return [::Boolean]
|
48
44
|
# Output only. Indicates whether this Account is soft-deleted or not. Deleted
|
@@ -82,7 +78,7 @@ module Google
|
|
82
78
|
# Example: AUTOMOTIVE, FOOD_AND_DRINK
|
83
79
|
# @!attribute [rw] time_zone
|
84
80
|
# @return [::String]
|
85
|
-
# Reporting Time Zone, used as the day boundary for reports, regardless of
|
81
|
+
# Required. Reporting Time Zone, used as the day boundary for reports, regardless of
|
86
82
|
# where the data originates. If the time zone honors DST, Analytics will
|
87
83
|
# automatically adjust for the changes.
|
88
84
|
#
|
@@ -98,10 +94,15 @@ module Google
|
|
98
94
|
#
|
99
95
|
# Format: https://en.wikipedia.org/wiki/ISO_4217
|
100
96
|
# Examples: "USD", "EUR", "JPY"
|
101
|
-
# @!attribute [r]
|
102
|
-
# @return [::
|
103
|
-
# Output only.
|
104
|
-
#
|
97
|
+
# @!attribute [r] delete_time
|
98
|
+
# @return [::Google::Protobuf::Timestamp]
|
99
|
+
# Output only. If set, the time at which this property was trashed. If not set, then this
|
100
|
+
# property is not currently in the trash can.
|
101
|
+
# @!attribute [r] expire_time
|
102
|
+
# @return [::Google::Protobuf::Timestamp]
|
103
|
+
# Output only. If set, the time at which this trashed property will be permanently
|
104
|
+
# deleted. If not set, then this property is not currently in the trash can
|
105
|
+
# and is not slated to be deleted.
|
105
106
|
class Property
|
106
107
|
include ::Google::Protobuf::MessageExts
|
107
108
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -261,7 +262,6 @@ module Google
|
|
261
262
|
# @return [::String]
|
262
263
|
# Output only. Resource name of this Data Stream.
|
263
264
|
# Format:
|
264
|
-
#
|
265
265
|
# properties/\\{property_id}/webDataStreams/\\{stream_id}/enhancedMeasurementSettings
|
266
266
|
# Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
|
267
267
|
# @!attribute [rw] stream_enabled
|
@@ -283,18 +283,10 @@ module Google
|
|
283
283
|
# @return [::Boolean]
|
284
284
|
# If enabled, capture an outbound click event each time a visitor clicks a
|
285
285
|
# link that leads them away from your domain.
|
286
|
-
# @!attribute [rw] content_views_enabled
|
287
|
-
# @return [::Boolean]
|
288
|
-
# Capture events when your visitors view content on your site that has
|
289
|
-
# structured data (eg, articles, blog posts, product details screens, etc.).
|
290
286
|
# @!attribute [rw] site_search_enabled
|
291
287
|
# @return [::Boolean]
|
292
288
|
# If enabled, capture a view search results event each time a visitor
|
293
289
|
# performs a search on your site (based on a query parameter).
|
294
|
-
# @!attribute [rw] form_interactions_enabled
|
295
|
-
# @return [::Boolean]
|
296
|
-
# If enabled, capture a view search results event each time a visitor
|
297
|
-
# interacts with a form on your site.
|
298
290
|
# @!attribute [rw] video_engagement_enabled
|
299
291
|
# @return [::Boolean]
|
300
292
|
# If enabled, capture video play, progress, and complete events as visitors
|
@@ -303,36 +295,21 @@ module Google
|
|
303
295
|
# @return [::Boolean]
|
304
296
|
# If enabled, capture a file download event each time a link is clicked with
|
305
297
|
# a common document, compressed file, application, video, or audio extension.
|
306
|
-
# @!attribute [
|
298
|
+
# @!attribute [r] page_loads_enabled
|
307
299
|
# @return [::Boolean]
|
308
|
-
# If enabled, capture a
|
309
|
-
# element that has data attributes beginning with "data-ga".
|
310
|
-
# @!attribute [rw] page_loads_enabled
|
311
|
-
# @return [::Boolean]
|
312
|
-
# If enabled, capture a page view event each time a page loads.
|
300
|
+
# Output only. If enabled, capture a page view event each time a page loads.
|
313
301
|
# @!attribute [rw] page_changes_enabled
|
314
302
|
# @return [::Boolean]
|
315
303
|
# If enabled, capture a page view event each time the website changes the
|
316
304
|
# browser history state.
|
317
|
-
# @!attribute [rw] articles_and_blogs_enabled
|
318
|
-
# @return [::Boolean]
|
319
|
-
# Capture events when your visitors view content on your site that has
|
320
|
-
# articles or blog posts.
|
321
|
-
# @!attribute [rw] products_and_ecommerce_enabled
|
322
|
-
# @return [::Boolean]
|
323
|
-
# Capture events when your visitors view content on your site that has
|
324
|
-
# product details screens, etc.
|
325
305
|
# @!attribute [rw] search_query_parameter
|
326
306
|
# @return [::String]
|
327
307
|
# Required. URL query parameters to interpret as site search parameters.
|
328
308
|
# Max length is 1024 characters. Must not be empty.
|
329
|
-
# @!attribute [rw]
|
309
|
+
# @!attribute [rw] uri_query_parameter
|
330
310
|
# @return [::String]
|
331
311
|
# Additional URL query parameters.
|
332
312
|
# Max length is 1024 characters.
|
333
|
-
# @!attribute [rw] excluded_domains
|
334
|
-
# @return [::String]
|
335
|
-
# Domains to exclude from measurement. Max length is 1024 characters.
|
336
313
|
class EnhancedMeasurementSettings
|
337
314
|
include ::Google::Protobuf::MessageExts
|
338
315
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -365,6 +342,10 @@ module Google
|
|
365
342
|
|
366
343
|
# Read-only resource with the tag for sending data from a website to a
|
367
344
|
# WebDataStream.
|
345
|
+
# @!attribute [r] name
|
346
|
+
# @return [::String]
|
347
|
+
# Output only. Resource name for this GlobalSiteTag resource.
|
348
|
+
# Format: properties/\\{propertyId}/globalSiteTag
|
368
349
|
# @!attribute [rw] snippet
|
369
350
|
# @return [::String]
|
370
351
|
# Immutable. JavaScript code snippet to be pasted as the first item into the head tag of
|
@@ -380,9 +361,6 @@ module Google
|
|
380
361
|
# Output only. Format: properties/\\{propertyId}/googleAdsLinks/\\{googleAdsLinkId}
|
381
362
|
#
|
382
363
|
# Note: googleAdsLinkId is not the Google Ads customer ID.
|
383
|
-
# @!attribute [rw] parent
|
384
|
-
# @return [::String]
|
385
|
-
# Immutable. Format: properties/\\{propertyId}
|
386
364
|
# @!attribute [rw] customer_id
|
387
365
|
# @return [::String]
|
388
366
|
# Immutable. Google Ads customer ID.
|
@@ -478,6 +456,85 @@ module Google
|
|
478
456
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
479
457
|
end
|
480
458
|
|
459
|
+
# A set of changes within a Google Analytics account or its child properties
|
460
|
+
# that resulted from the same cause. Common causes would be updates made in the
|
461
|
+
# Google Analytics UI, changes from customer support, or automatic Google
|
462
|
+
# Analytics system changes.
|
463
|
+
# @!attribute [rw] id
|
464
|
+
# @return [::String]
|
465
|
+
# ID of this change history event. This ID is unique across Google Analytics.
|
466
|
+
# @!attribute [rw] change_time
|
467
|
+
# @return [::Google::Protobuf::Timestamp]
|
468
|
+
# Time when change was made.
|
469
|
+
# @!attribute [rw] actor_type
|
470
|
+
# @return [::Google::Analytics::Admin::V1alpha::ActorType]
|
471
|
+
# The type of actor that made this change.
|
472
|
+
# @!attribute [rw] user_actor_email
|
473
|
+
# @return [::String]
|
474
|
+
# Email address of the Google account that made the change. This will be a
|
475
|
+
# valid email address if the actor field is set to USER, and empty otherwise.
|
476
|
+
# Google accounts that have been deleted will cause an error.
|
477
|
+
# @!attribute [rw] changes_filtered
|
478
|
+
# @return [::Boolean]
|
479
|
+
# If true, then the list of changes returned was filtered, and does not
|
480
|
+
# represent all changes that occurred in this event.
|
481
|
+
# @!attribute [rw] changes
|
482
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryChange>]
|
483
|
+
# A list of changes made in this change history event that fit the filters
|
484
|
+
# specified in SearchChangeHistoryEventsRequest.
|
485
|
+
class ChangeHistoryEvent
|
486
|
+
include ::Google::Protobuf::MessageExts
|
487
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
488
|
+
end
|
489
|
+
|
490
|
+
# A description of a change to a single Google Analytics resource.
|
491
|
+
# @!attribute [rw] resource
|
492
|
+
# @return [::String]
|
493
|
+
# Resource name of the resource whose changes are described by this entry.
|
494
|
+
# @!attribute [rw] action
|
495
|
+
# @return [::Google::Analytics::Admin::V1alpha::ActionType]
|
496
|
+
# The type of action that changed this resource.
|
497
|
+
# @!attribute [rw] resource_before_change
|
498
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChangeHistoryChange::ChangeHistoryResource]
|
499
|
+
# Resource contents from before the change was made. If this resource was
|
500
|
+
# created in this change, this field will be missing.
|
501
|
+
# @!attribute [rw] resource_after_change
|
502
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChangeHistoryChange::ChangeHistoryResource]
|
503
|
+
# Resource contents from after the change was made. If this resource was
|
504
|
+
# deleted in this change, this field will be missing.
|
505
|
+
class ChangeHistoryChange
|
506
|
+
include ::Google::Protobuf::MessageExts
|
507
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
508
|
+
|
509
|
+
# A snapshot of a resource as before or after the result of a change in
|
510
|
+
# change history.
|
511
|
+
# @!attribute [rw] account
|
512
|
+
# @return [::Google::Analytics::Admin::V1alpha::Account]
|
513
|
+
# A snapshot of an Account resource in change history.
|
514
|
+
# @!attribute [rw] property
|
515
|
+
# @return [::Google::Analytics::Admin::V1alpha::Property]
|
516
|
+
# A snapshot of a Property resource in change history.
|
517
|
+
# @!attribute [rw] web_data_stream
|
518
|
+
# @return [::Google::Analytics::Admin::V1alpha::WebDataStream]
|
519
|
+
# A snapshot of a WebDataStream resource in change history.
|
520
|
+
# @!attribute [rw] android_app_data_stream
|
521
|
+
# @return [::Google::Analytics::Admin::V1alpha::AndroidAppDataStream]
|
522
|
+
# A snapshot of an AndroidAppDataStream resource in change history.
|
523
|
+
# @!attribute [rw] ios_app_data_stream
|
524
|
+
# @return [::Google::Analytics::Admin::V1alpha::IosAppDataStream]
|
525
|
+
# A snapshot of an IosAppDataStream resource in change history.
|
526
|
+
# @!attribute [rw] firebase_link
|
527
|
+
# @return [::Google::Analytics::Admin::V1alpha::FirebaseLink]
|
528
|
+
# A snapshot of a FirebaseLink resource in change history.
|
529
|
+
# @!attribute [rw] google_ads_link
|
530
|
+
# @return [::Google::Analytics::Admin::V1alpha::GoogleAdsLink]
|
531
|
+
# A snapshot of a GoogleAdsLink resource in change history.
|
532
|
+
class ChangeHistoryResource
|
533
|
+
include ::Google::Protobuf::MessageExts
|
534
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
535
|
+
end
|
536
|
+
end
|
537
|
+
|
481
538
|
# Maximum access settings that Firebase user receive on the linked Analytics
|
482
539
|
# property.
|
483
540
|
module MaximumUserAccess
|
@@ -582,6 +639,64 @@ module Google
|
|
582
639
|
# Shopping
|
583
640
|
SHOPPING = 26
|
584
641
|
end
|
642
|
+
|
643
|
+
# Different kinds of actors that can make changes to Google Analytics
|
644
|
+
# resources.
|
645
|
+
module ActorType
|
646
|
+
# Unknown or unspecified actor type.
|
647
|
+
ACTOR_TYPE_UNSPECIFIED = 0
|
648
|
+
|
649
|
+
# Changes made by the user specified in actor_email.
|
650
|
+
USER = 1
|
651
|
+
|
652
|
+
# Changes made by the Google Analytics system.
|
653
|
+
SYSTEM = 2
|
654
|
+
|
655
|
+
# Changes made by Google Analytics support team staff.
|
656
|
+
SUPPORT = 3
|
657
|
+
end
|
658
|
+
|
659
|
+
# Types of actions that may change a resource.
|
660
|
+
module ActionType
|
661
|
+
# Action type unknown or not specified.
|
662
|
+
ACTION_TYPE_UNSPECIFIED = 0
|
663
|
+
|
664
|
+
# Resource was created in this change.
|
665
|
+
CREATED = 1
|
666
|
+
|
667
|
+
# Resource was updated in this change.
|
668
|
+
UPDATED = 2
|
669
|
+
|
670
|
+
# Resource was deleted in this change.
|
671
|
+
DELETED = 3
|
672
|
+
end
|
673
|
+
|
674
|
+
# Types of resources whose changes may be returned from change history.
|
675
|
+
module ChangeHistoryResourceType
|
676
|
+
# Resource type unknown or not specified.
|
677
|
+
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED = 0
|
678
|
+
|
679
|
+
# Account resource
|
680
|
+
ACCOUNT = 1
|
681
|
+
|
682
|
+
# Property resource
|
683
|
+
PROPERTY = 2
|
684
|
+
|
685
|
+
# WebDataStream resource
|
686
|
+
WEB_DATA_STREAM = 3
|
687
|
+
|
688
|
+
# AndroidAppDataStream resource
|
689
|
+
ANDROID_APP_DATA_STREAM = 4
|
690
|
+
|
691
|
+
# IosAppDataStream resource
|
692
|
+
IOS_APP_DATA_STREAM = 5
|
693
|
+
|
694
|
+
# FirebaseLink resource
|
695
|
+
FIREBASE_LINK = 6
|
696
|
+
|
697
|
+
# GoogleAdsLink resource
|
698
|
+
GOOGLE_ADS_LINK = 7
|
699
|
+
end
|
585
700
|
end
|
586
701
|
end
|
587
702
|
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
|
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
|
+
version: 0.7.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:
|
11
|
+
date: 2021-05-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,14 +16,14 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - "~>"
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: '0.
|
19
|
+
version: '0.4'
|
20
20
|
type: :runtime
|
21
21
|
prerelease: false
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
23
23
|
requirements:
|
24
24
|
- - "~>"
|
25
25
|
- !ruby/object:Gem::Version
|
26
|
-
version: '0.
|
26
|
+
version: '0.4'
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
28
|
name: google-cloud-errors
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
@@ -44,14 +44,14 @@ dependencies:
|
|
44
44
|
requirements:
|
45
45
|
- - "~>"
|
46
46
|
- !ruby/object:Gem::Version
|
47
|
-
version: 1.
|
47
|
+
version: 1.25.1
|
48
48
|
type: :development
|
49
49
|
prerelease: false
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
51
51
|
requirements:
|
52
52
|
- - "~>"
|
53
53
|
- !ruby/object:Gem::Version
|
54
|
-
version: 1.
|
54
|
+
version: 1.25.1
|
55
55
|
- !ruby/object:Gem::Dependency
|
56
56
|
name: minitest
|
57
57
|
requirement: !ruby/object:Gem::Requirement
|
@@ -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: []
|
@@ -193,14 +195,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
193
195
|
requirements:
|
194
196
|
- - ">="
|
195
197
|
- !ruby/object:Gem::Version
|
196
|
-
version: '2.
|
198
|
+
version: '2.5'
|
197
199
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
198
200
|
requirements:
|
199
201
|
- - ">="
|
200
202
|
- !ruby/object:Gem::Version
|
201
203
|
version: '0'
|
202
204
|
requirements: []
|
203
|
-
rubygems_version: 3.
|
205
|
+
rubygems_version: 3.2.16
|
204
206
|
signing_key:
|
205
207
|
specification_version: 4
|
206
208
|
summary: API Client library for the Google Analytics Admin V1alpha API
|