google-apis-analyticsadmin_v1alpha 0.17.0 → 0.18.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2bcbf276bbbb98e5259e87065bd0a299e007088d9158fdfb339503f1a11b4e13
4
- data.tar.gz: 369b8bb9dc4f0954715e3941dad8fce3e38f34bbb18f26f2f446332ea5d04011
3
+ metadata.gz: 7f18e02239cff4fb86844a84750f2963e3fbf819ab9194a1040921b259ef021c
4
+ data.tar.gz: 87591921c0de42625efffdc20b13e723e79cb354db06dd511e7fa054ce69cfee
5
5
  SHA512:
6
- metadata.gz: 9257b7c64a02a3b28bd989544f60bbf939220330e27842deff37540831f354179ce6b6d1a7bb40c1431ab9c56f54eb5756be7aa238787a49b42ba12a05dc0716
7
- data.tar.gz: 4faaa69db909ffb1328c462e3b0bcf5448ef797196727acd78550b18673835efa7e8ca8c811f269df6b00083d06c61fa345ffd509334d6b0af156ba5fcbe8262
6
+ metadata.gz: a8fa87603d5d2d52b5c741960fbb701c2e79be7a7a99e2dbbe9873d161e8b8d10db5a18133f0dbc86ac4f928a536fb910bee049cf5e945cbc8fde377bf58863d
7
+ data.tar.gz: 97f430f138786de7b5789339071cc5cf2808624fa2e0acb419b0a2d1bf192a2ccf777226a59da6cfb8c778c0b7c56a80d93d1a237acbc316e50040f0424b1de0
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-analyticsadmin_v1alpha
2
2
 
3
+ ### v0.18.0 (2021-10-22)
4
+
5
+ * Regenerated from discovery document revision 20211021
6
+
3
7
  ### v0.17.0 (2021-10-06)
4
8
 
5
9
  * Regenerated from discovery document revision 20211005
data/OVERVIEW.md CHANGED
@@ -60,8 +60,8 @@ See the class reference docs for information on the methods you can call from a
60
60
 
61
61
  More detailed descriptions of the Google simple REST clients are available in two documents.
62
62
 
63
- * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
- * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
65
 
66
66
  (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Analyticsadmin service in particular.)
67
67
 
@@ -578,7 +578,7 @@ module Google
578
578
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink]
579
579
  attr_accessor :display_video360_advertiser_link
580
580
 
581
- # A proposal for a link between an GA4 property and a Display & Video 360
581
+ # A proposal for a link between a GA4 property and a Display & Video 360
582
582
  # advertiser. A proposal is converted to a DisplayVideo360AdvertiserLink once
583
583
  # approved. Google Analytics admins approve inbound proposals while Display &
584
584
  # Video 360 admins approve outbound proposals.
@@ -586,12 +586,12 @@ module Google
586
586
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal]
587
587
  attr_accessor :display_video360_advertiser_link_proposal
588
588
 
589
- # A link between an GA4 property and a Firebase project.
589
+ # A link between a GA4 property and a Firebase project.
590
590
  # Corresponds to the JSON property `firebaseLink`
591
591
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink]
592
592
  attr_accessor :firebase_link
593
593
 
594
- # A link between an GA4 property and a Google Ads account.
594
+ # A link between a GA4 property and a Google Ads account.
595
595
  # Corresponds to the JSON property `googleAdsLink`
596
596
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink]
597
597
  attr_accessor :google_ads_link
@@ -1054,7 +1054,7 @@ module Google
1054
1054
  alias_method :campaign_data_sharing_enabled?, :campaign_data_sharing_enabled
1055
1055
 
1056
1056
  # Immutable. Enables the import of cost data from Display & Video 360 into the
1057
- # GA4 property. This can only be enabled if campaign_data_import_enabled is
1057
+ # GA4 property. This can only be enabled if campaign_data_sharing_enabled is
1058
1058
  # enabled. After link creation, this can only be updated from the Display &
1059
1059
  # Video 360 product. If this field is not set on create, it will be defaulted to
1060
1060
  # true.
@@ -1085,7 +1085,7 @@ module Google
1085
1085
  end
1086
1086
  end
1087
1087
 
1088
- # A proposal for a link between an GA4 property and a Display & Video 360
1088
+ # A proposal for a link between a GA4 property and a Display & Video 360
1089
1089
  # advertiser. A proposal is converted to a DisplayVideo360AdvertiserLink once
1090
1090
  # approved. Google Analytics admins approve inbound proposals while Display &
1091
1091
  # Video 360 admins approve outbound proposals.
@@ -1118,7 +1118,7 @@ module Google
1118
1118
  alias_method :campaign_data_sharing_enabled?, :campaign_data_sharing_enabled
1119
1119
 
1120
1120
  # Immutable. Enables the import of cost data from Display & Video 360. This can
1121
- # only be enabled if campaign_data_import_enabled is enabled. If this field is
1121
+ # only be enabled if campaign_data_sharing_enabled is enabled. If this field is
1122
1122
  # not set on create, it will be defaulted to true.
1123
1123
  # Corresponds to the JSON property `costDataSharingEnabled`
1124
1124
  # @return [Boolean]
@@ -1165,114 +1165,7 @@ module Google
1165
1165
  end
1166
1166
  end
1167
1167
 
1168
- # Singleton resource under a WebDataStream, configuring measurement of
1169
- # additional site interactions and content.
1170
- class GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings
1171
- include Google::Apis::Core::Hashable
1172
-
1173
- # If enabled, capture a file download event each time a link is clicked with a
1174
- # common document, compressed file, application, video, or audio extension.
1175
- # Corresponds to the JSON property `fileDownloadsEnabled`
1176
- # @return [Boolean]
1177
- attr_accessor :file_downloads_enabled
1178
- alias_method :file_downloads_enabled?, :file_downloads_enabled
1179
-
1180
- # Output only. Resource name of this Data Stream. Format: properties/`
1181
- # property_id`/webDataStreams/`stream_id`/enhancedMeasurementSettings Example: "
1182
- # properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
1183
- # Corresponds to the JSON property `name`
1184
- # @return [String]
1185
- attr_accessor :name
1186
-
1187
- # If enabled, capture an outbound click event each time a visitor clicks a link
1188
- # that leads them away from your domain.
1189
- # Corresponds to the JSON property `outboundClicksEnabled`
1190
- # @return [Boolean]
1191
- attr_accessor :outbound_clicks_enabled
1192
- alias_method :outbound_clicks_enabled?, :outbound_clicks_enabled
1193
-
1194
- # If enabled, capture a page view event each time the website changes the
1195
- # browser history state.
1196
- # Corresponds to the JSON property `pageChangesEnabled`
1197
- # @return [Boolean]
1198
- attr_accessor :page_changes_enabled
1199
- alias_method :page_changes_enabled?, :page_changes_enabled
1200
-
1201
- # Output only. If enabled, capture a page view event each time a page loads.
1202
- # Corresponds to the JSON property `pageLoadsEnabled`
1203
- # @return [Boolean]
1204
- attr_accessor :page_loads_enabled
1205
- alias_method :page_loads_enabled?, :page_loads_enabled
1206
-
1207
- # Output only. If enabled, capture a page view event each time a page loads or
1208
- # the website changes the browser history state.
1209
- # Corresponds to the JSON property `pageViewsEnabled`
1210
- # @return [Boolean]
1211
- attr_accessor :page_views_enabled
1212
- alias_method :page_views_enabled?, :page_views_enabled
1213
-
1214
- # If enabled, capture scroll events each time a visitor gets to the bottom of a
1215
- # page.
1216
- # Corresponds to the JSON property `scrollsEnabled`
1217
- # @return [Boolean]
1218
- attr_accessor :scrolls_enabled
1219
- alias_method :scrolls_enabled?, :scrolls_enabled
1220
-
1221
- # Required. URL query parameters to interpret as site search parameters. Max
1222
- # length is 1024 characters. Must not be empty.
1223
- # Corresponds to the JSON property `searchQueryParameter`
1224
- # @return [String]
1225
- attr_accessor :search_query_parameter
1226
-
1227
- # If enabled, capture a view search results event each time a visitor performs a
1228
- # search on your site (based on a query parameter).
1229
- # Corresponds to the JSON property `siteSearchEnabled`
1230
- # @return [Boolean]
1231
- attr_accessor :site_search_enabled
1232
- alias_method :site_search_enabled?, :site_search_enabled
1233
-
1234
- # Indicates whether Enhanced Measurement Settings will be used to automatically
1235
- # measure interactions and content on this web stream. Changing this value does
1236
- # not affect the settings themselves, but determines whether they are respected.
1237
- # Corresponds to the JSON property `streamEnabled`
1238
- # @return [Boolean]
1239
- attr_accessor :stream_enabled
1240
- alias_method :stream_enabled?, :stream_enabled
1241
-
1242
- # Additional URL query parameters. Max length is 1024 characters.
1243
- # Corresponds to the JSON property `uriQueryParameter`
1244
- # @return [String]
1245
- attr_accessor :uri_query_parameter
1246
-
1247
- # If enabled, capture video play, progress, and complete events as visitors view
1248
- # embedded videos on your site.
1249
- # Corresponds to the JSON property `videoEngagementEnabled`
1250
- # @return [Boolean]
1251
- attr_accessor :video_engagement_enabled
1252
- alias_method :video_engagement_enabled?, :video_engagement_enabled
1253
-
1254
- def initialize(**args)
1255
- update!(**args)
1256
- end
1257
-
1258
- # Update properties of this object
1259
- def update!(**args)
1260
- @file_downloads_enabled = args[:file_downloads_enabled] if args.key?(:file_downloads_enabled)
1261
- @name = args[:name] if args.key?(:name)
1262
- @outbound_clicks_enabled = args[:outbound_clicks_enabled] if args.key?(:outbound_clicks_enabled)
1263
- @page_changes_enabled = args[:page_changes_enabled] if args.key?(:page_changes_enabled)
1264
- @page_loads_enabled = args[:page_loads_enabled] if args.key?(:page_loads_enabled)
1265
- @page_views_enabled = args[:page_views_enabled] if args.key?(:page_views_enabled)
1266
- @scrolls_enabled = args[:scrolls_enabled] if args.key?(:scrolls_enabled)
1267
- @search_query_parameter = args[:search_query_parameter] if args.key?(:search_query_parameter)
1268
- @site_search_enabled = args[:site_search_enabled] if args.key?(:site_search_enabled)
1269
- @stream_enabled = args[:stream_enabled] if args.key?(:stream_enabled)
1270
- @uri_query_parameter = args[:uri_query_parameter] if args.key?(:uri_query_parameter)
1271
- @video_engagement_enabled = args[:video_engagement_enabled] if args.key?(:video_engagement_enabled)
1272
- end
1273
- end
1274
-
1275
- # A link between an GA4 property and a Firebase project.
1168
+ # A link between a GA4 property and a Firebase project.
1276
1169
  class GoogleAnalyticsAdminV1alphaFirebaseLink
1277
1170
  include Google::Apis::Core::Hashable
1278
1171
 
@@ -1335,7 +1228,7 @@ module Google
1335
1228
  end
1336
1229
  end
1337
1230
 
1338
- # A link between an GA4 property and a Google Ads account.
1231
+ # A link between a GA4 property and a Google Ads account.
1339
1232
  class GoogleAnalyticsAdminV1alphaGoogleAdsLink
1340
1233
  include Google::Apis::Core::Hashable
1341
1234
 
@@ -2038,7 +1931,7 @@ module Google
2038
1931
  end
2039
1932
  end
2040
1933
 
2041
- # A virtual resource representing metadata for an GA4 property.
1934
+ # A virtual resource representing metadata for a GA4 property.
2042
1935
  class GoogleAnalyticsAdminV1alphaPropertySummary
2043
1936
  include Google::Apis::Core::Hashable
2044
1937
 
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module AnalyticsadminV1alpha
18
18
  # Version of the google-apis-analyticsadmin_v1alpha gem
19
- GEM_VERSION = "0.17.0"
19
+ GEM_VERSION = "0.18.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20211005"
25
+ REVISION = "20211021"
26
26
  end
27
27
  end
28
28
  end
@@ -208,12 +208,6 @@ module Google
208
208
  include Google::Apis::Core::JsonObjectSupport
209
209
  end
210
210
 
211
- class GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings
212
- class Representation < Google::Apis::Core::JsonRepresentation; end
213
-
214
- include Google::Apis::Core::JsonObjectSupport
215
- end
216
-
217
211
  class GoogleAnalyticsAdminV1alphaFirebaseLink
218
212
  class Representation < Google::Apis::Core::JsonRepresentation; end
219
213
 
@@ -723,24 +717,6 @@ module Google
723
717
  end
724
718
  end
725
719
 
726
- class GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings
727
- # @private
728
- class Representation < Google::Apis::Core::JsonRepresentation
729
- property :file_downloads_enabled, as: 'fileDownloadsEnabled'
730
- property :name, as: 'name'
731
- property :outbound_clicks_enabled, as: 'outboundClicksEnabled'
732
- property :page_changes_enabled, as: 'pageChangesEnabled'
733
- property :page_loads_enabled, as: 'pageLoadsEnabled'
734
- property :page_views_enabled, as: 'pageViewsEnabled'
735
- property :scrolls_enabled, as: 'scrollsEnabled'
736
- property :search_query_parameter, as: 'searchQueryParameter'
737
- property :site_search_enabled, as: 'siteSearchEnabled'
738
- property :stream_enabled, as: 'streamEnabled'
739
- property :uri_query_parameter, as: 'uriQueryParameter'
740
- property :video_engagement_enabled, as: 'videoEngagementEnabled'
741
- end
742
- end
743
-
744
720
  class GoogleAnalyticsAdminV1alphaFirebaseLink
745
721
  # @private
746
722
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3306,40 +3306,6 @@ module Google
3306
3306
  execute_or_queue_command(command, &block)
3307
3307
  end
3308
3308
 
3309
- # Returns the singleton enhanced measurement settings for this web stream. Note
3310
- # that the stream must enable enhanced measurement for these settings to take
3311
- # effect.
3312
- # @param [String] name
3313
- # Required. The name of the settings to lookup. Format: properties/`property_id`/
3314
- # webDataStreams/`stream_id`/enhancedMeasurementSettings Example: "properties/
3315
- # 1000/webDataStreams/2000/enhancedMeasurementSettings"
3316
- # @param [String] fields
3317
- # Selector specifying which fields to include in a partial response.
3318
- # @param [String] quota_user
3319
- # Available to use for quota purposes for server-side applications. Can be any
3320
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3321
- # @param [Google::Apis::RequestOptions] options
3322
- # Request-specific options
3323
- #
3324
- # @yield [result, err] Result & error if block supplied
3325
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings] parsed result object
3326
- # @yieldparam err [StandardError] error object if request failed
3327
- #
3328
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings]
3329
- #
3330
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3331
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3332
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3333
- def get_property_web_data_stream_enhanced_measurement_settings(name, fields: nil, quota_user: nil, options: nil, &block)
3334
- command = make_simple_command(:get, 'v1alpha/{+name}', options)
3335
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings::Representation
3336
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings
3337
- command.params['name'] = name unless name.nil?
3338
- command.query['fields'] = fields unless fields.nil?
3339
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3340
- execute_or_queue_command(command, &block)
3341
- end
3342
-
3343
3309
  # Returns the Site Tag for the specified web stream. Site Tags are immutable
3344
3310
  # singletons.
3345
3311
  # @param [String] name
@@ -3458,48 +3424,6 @@ module Google
3458
3424
  execute_or_queue_command(command, &block)
3459
3425
  end
3460
3426
 
3461
- # Updates the singleton enhanced measurement settings for this web stream. Note
3462
- # that the stream must enable enhanced measurement for these settings to take
3463
- # effect.
3464
- # @param [String] name
3465
- # Output only. Resource name of this Data Stream. Format: properties/`
3466
- # property_id`/webDataStreams/`stream_id`/enhancedMeasurementSettings Example: "
3467
- # properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
3468
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings] google_analytics_admin_v1alpha_enhanced_measurement_settings_object
3469
- # @param [String] update_mask
3470
- # Required. The list of fields to be updated. Field names must be in snake case (
3471
- # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
3472
- # entire entity, use one path with the string "*" to match all fields.
3473
- # @param [String] fields
3474
- # Selector specifying which fields to include in a partial response.
3475
- # @param [String] quota_user
3476
- # Available to use for quota purposes for server-side applications. Can be any
3477
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3478
- # @param [Google::Apis::RequestOptions] options
3479
- # Request-specific options
3480
- #
3481
- # @yield [result, err] Result & error if block supplied
3482
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings] parsed result object
3483
- # @yieldparam err [StandardError] error object if request failed
3484
- #
3485
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings]
3486
- #
3487
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3488
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3489
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3490
- def update_property_web_data_stream_enhanced_measurement_settings(name, google_analytics_admin_v1alpha_enhanced_measurement_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3491
- command = make_simple_command(:patch, 'v1alpha/{+name}', options)
3492
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings::Representation
3493
- command.request_object = google_analytics_admin_v1alpha_enhanced_measurement_settings_object
3494
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings::Representation
3495
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings
3496
- command.params['name'] = name unless name.nil?
3497
- command.query['updateMask'] = update_mask unless update_mask.nil?
3498
- command.query['fields'] = fields unless fields.nil?
3499
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3500
- execute_or_queue_command(command, &block)
3501
- end
3502
-
3503
3427
  # Creates a measurement protocol secret.
3504
3428
  # @param [String] parent
3505
3429
  # Required. The parent resource where this secret will be created. Any type of
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-analyticsadmin_v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.17.0
4
+ version: 0.18.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-10-11 00:00:00.000000000 Z
11
+ date: 2021-10-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -57,9 +57,9 @@ licenses:
57
57
  - Apache-2.0
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
- changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-analyticsadmin_v1alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.17.0
62
- source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-analyticsadmin_v1alpha
60
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha/CHANGELOG.md
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.18.0
62
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha
63
63
  post_install_message:
64
64
  rdoc_options: []
65
65
  require_paths: