google-apis-analyticsadmin_v1alpha 0.43.0 → 0.44.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: d10c7bcf6bd87478d2fd09151999264b8fc4adf6e0e1b2bf162bbf2193236fb0
4
- data.tar.gz: 907313022907a50e44abc7b3e30520de0371d1571e92b9e3ee733a8046023511
3
+ metadata.gz: 39a7c0fd9f29e24766bf675629e7cfd7ce60295441977e989f67c0249b0b193e
4
+ data.tar.gz: 1b004bc486738dc3bd27577592d7893787d0679ea7e397343991ed1c15113f71
5
5
  SHA512:
6
- metadata.gz: c3c305530efce5fccaa62a2b1ce18461a3af6a9deb9d448a58c79fb21ab6c0fec4867b01e985968f5d119257eada6cf4aa7c60f5b80e83b9edda9aa3ec19069c
7
- data.tar.gz: eebba2ffeea7298f1b6b091590e1bce7f0dc3d083218cb5d5c10ef5600e78cc48ed692172c95592530d4a1fed00e30616e2f2237ebe8cab703bf89be748ea4fc
6
+ metadata.gz: fe2c09f0bebf544a7d953faec6d99dcc391f7335b9229dec900195dd64a4b72fcb8a2c0f7d21a3ffd523419e775b453244653989a9bb6ceb7d078ec104116d49
7
+ data.tar.gz: dc0528eca97553bc1cb88bce771ca8564e0c3e2d34d4c0205706900092b762c68a533563b1f820c8ff62705960a923e03a77e8b4024d23cf225e0aa76ff14207
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-analyticsadmin_v1alpha
2
2
 
3
+ ### v0.44.0 (2022-12-07)
4
+
5
+ * Regenerated from discovery document revision 20221205
6
+
3
7
  ### v0.43.0 (2022-11-06)
4
8
 
5
9
  * Regenerated from discovery document revision 20221101
@@ -1564,6 +1564,79 @@ module Google
1564
1564
  end
1565
1565
  end
1566
1566
 
1567
+ # A link between a GA4 Property and BigQuery project.
1568
+ class GoogleAnalyticsAdminV1alphaBigQueryLink
1569
+ include Google::Apis::Core::Hashable
1570
+
1571
+ # Output only. Time when the link was created.
1572
+ # Corresponds to the JSON property `createTime`
1573
+ # @return [String]
1574
+ attr_accessor :create_time
1575
+
1576
+ # If set true, enables daily data export to the linked Google Cloud project.
1577
+ # Corresponds to the JSON property `dailyExportEnabled`
1578
+ # @return [Boolean]
1579
+ attr_accessor :daily_export_enabled
1580
+ alias_method :daily_export_enabled?, :daily_export_enabled
1581
+
1582
+ # The list of event names that will be excluded from exports.
1583
+ # Corresponds to the JSON property `excludedEvents`
1584
+ # @return [Array<String>]
1585
+ attr_accessor :excluded_events
1586
+
1587
+ # The list of streams under the parent property for which data will be exported.
1588
+ # Format: properties/`property_id`/dataStreams/`stream_id` Example: ['properties/
1589
+ # 1000/dataStreams/2000']
1590
+ # Corresponds to the JSON property `exportStreams`
1591
+ # @return [Array<String>]
1592
+ attr_accessor :export_streams
1593
+
1594
+ # If set true, exported data will include advertising identifiers for mobile app
1595
+ # streams.
1596
+ # Corresponds to the JSON property `includeAdvertisingId`
1597
+ # @return [Boolean]
1598
+ attr_accessor :include_advertising_id
1599
+ alias_method :include_advertising_id?, :include_advertising_id
1600
+
1601
+ # Output only. Resource name of this BigQuery link. Format: 'properties/`
1602
+ # property_id`/bigQueryLinks/`bigquery_link_id`' Format: 'properties/1234/
1603
+ # bigQueryLinks/abc567'
1604
+ # Corresponds to the JSON property `name`
1605
+ # @return [String]
1606
+ attr_accessor :name
1607
+
1608
+ # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you
1609
+ # may provide this resource name using either a project number or project ID.
1610
+ # Once this resource has been created, the returned project will always have a
1611
+ # project that contains a project number. Format: 'projects/`project number`'
1612
+ # Example: 'projects/1234'
1613
+ # Corresponds to the JSON property `project`
1614
+ # @return [String]
1615
+ attr_accessor :project
1616
+
1617
+ # If set true, enables streaming export to the linked Google Cloud project.
1618
+ # Corresponds to the JSON property `streamingExportEnabled`
1619
+ # @return [Boolean]
1620
+ attr_accessor :streaming_export_enabled
1621
+ alias_method :streaming_export_enabled?, :streaming_export_enabled
1622
+
1623
+ def initialize(**args)
1624
+ update!(**args)
1625
+ end
1626
+
1627
+ # Update properties of this object
1628
+ def update!(**args)
1629
+ @create_time = args[:create_time] if args.key?(:create_time)
1630
+ @daily_export_enabled = args[:daily_export_enabled] if args.key?(:daily_export_enabled)
1631
+ @excluded_events = args[:excluded_events] if args.key?(:excluded_events)
1632
+ @export_streams = args[:export_streams] if args.key?(:export_streams)
1633
+ @include_advertising_id = args[:include_advertising_id] if args.key?(:include_advertising_id)
1634
+ @name = args[:name] if args.key?(:name)
1635
+ @project = args[:project] if args.key?(:project)
1636
+ @streaming_export_enabled = args[:streaming_export_enabled] if args.key?(:streaming_export_enabled)
1637
+ end
1638
+ end
1639
+
1567
1640
  # Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC.
1568
1641
  class GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest
1569
1642
  include Google::Apis::Core::Hashable
@@ -1632,6 +1705,11 @@ module Google
1632
1705
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings]
1633
1706
  attr_accessor :attribution_settings
1634
1707
 
1708
+ # A link between a GA4 Property and BigQuery project.
1709
+ # Corresponds to the JSON property `bigqueryLink`
1710
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink]
1711
+ attr_accessor :bigquery_link
1712
+
1635
1713
  # A conversion event in a Google Analytics property.
1636
1714
  # Corresponds to the JSON property `conversionEvent`
1637
1715
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent]
@@ -1713,6 +1791,7 @@ module Google
1713
1791
  def update!(**args)
1714
1792
  @account = args[:account] if args.key?(:account)
1715
1793
  @attribution_settings = args[:attribution_settings] if args.key?(:attribution_settings)
1794
+ @bigquery_link = args[:bigquery_link] if args.key?(:bigquery_link)
1716
1795
  @conversion_event = args[:conversion_event] if args.key?(:conversion_event)
1717
1796
  @custom_dimension = args[:custom_dimension] if args.key?(:custom_dimension)
1718
1797
  @custom_metric = args[:custom_metric] if args.key?(:custom_metric)
@@ -2880,6 +2959,32 @@ module Google
2880
2959
  end
2881
2960
  end
2882
2961
 
2962
+ # Response message for ListBigQueryLinks RPC
2963
+ class GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse
2964
+ include Google::Apis::Core::Hashable
2965
+
2966
+ # List of BigQueryLinks.
2967
+ # Corresponds to the JSON property `bigqueryLinks`
2968
+ # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink>]
2969
+ attr_accessor :bigquery_links
2970
+
2971
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
2972
+ # field is omitted, there are no subsequent pages.
2973
+ # Corresponds to the JSON property `nextPageToken`
2974
+ # @return [String]
2975
+ attr_accessor :next_page_token
2976
+
2977
+ def initialize(**args)
2978
+ update!(**args)
2979
+ end
2980
+
2981
+ # Update properties of this object
2982
+ def update!(**args)
2983
+ @bigquery_links = args[:bigquery_links] if args.key?(:bigquery_links)
2984
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2985
+ end
2986
+ end
2987
+
2883
2988
  # Response message for ListConversionEvents RPC.
2884
2989
  class GoogleAnalyticsAdminV1alphaListConversionEventsResponse
2885
2990
  include Google::Apis::Core::Hashable
@@ -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.43.0"
19
+ GEM_VERSION = "0.44.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.11.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20221101"
25
+ REVISION = "20221205"
26
26
  end
27
27
  end
28
28
  end
@@ -346,6 +346,12 @@ module Google
346
346
  include Google::Apis::Core::JsonObjectSupport
347
347
  end
348
348
 
349
+ class GoogleAnalyticsAdminV1alphaBigQueryLink
350
+ class Representation < Google::Apis::Core::JsonRepresentation; end
351
+
352
+ include Google::Apis::Core::JsonObjectSupport
353
+ end
354
+
349
355
  class GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest
350
356
  class Representation < Google::Apis::Core::JsonRepresentation; end
351
357
 
@@ -532,6 +538,12 @@ module Google
532
538
  include Google::Apis::Core::JsonObjectSupport
533
539
  end
534
540
 
541
+ class GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse
542
+ class Representation < Google::Apis::Core::JsonRepresentation; end
543
+
544
+ include Google::Apis::Core::JsonObjectSupport
545
+ end
546
+
535
547
  class GoogleAnalyticsAdminV1alphaListConversionEventsResponse
536
548
  class Representation < Google::Apis::Core::JsonRepresentation; end
537
549
 
@@ -1184,6 +1196,20 @@ module Google
1184
1196
  end
1185
1197
  end
1186
1198
 
1199
+ class GoogleAnalyticsAdminV1alphaBigQueryLink
1200
+ # @private
1201
+ class Representation < Google::Apis::Core::JsonRepresentation
1202
+ property :create_time, as: 'createTime'
1203
+ property :daily_export_enabled, as: 'dailyExportEnabled'
1204
+ collection :excluded_events, as: 'excludedEvents'
1205
+ collection :export_streams, as: 'exportStreams'
1206
+ property :include_advertising_id, as: 'includeAdvertisingId'
1207
+ property :name, as: 'name'
1208
+ property :project, as: 'project'
1209
+ property :streaming_export_enabled, as: 'streamingExportEnabled'
1210
+ end
1211
+ end
1212
+
1187
1213
  class GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest
1188
1214
  # @private
1189
1215
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1209,6 +1235,8 @@ module Google
1209
1235
 
1210
1236
  property :attribution_settings, as: 'attributionSettings', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings::Representation
1211
1237
 
1238
+ property :bigquery_link, as: 'bigqueryLink', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink::Representation
1239
+
1212
1240
  property :conversion_event, as: 'conversionEvent', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent::Representation
1213
1241
 
1214
1242
  property :custom_dimension, as: 'customDimension', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
@@ -1533,6 +1561,15 @@ module Google
1533
1561
  end
1534
1562
  end
1535
1563
 
1564
+ class GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse
1565
+ # @private
1566
+ class Representation < Google::Apis::Core::JsonRepresentation
1567
+ collection :bigquery_links, as: 'bigqueryLinks', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink::Representation
1568
+
1569
+ property :next_page_token, as: 'nextPageToken'
1570
+ end
1571
+ end
1572
+
1536
1573
  class GoogleAnalyticsAdminV1alphaListConversionEventsResponse
1537
1574
  # @private
1538
1575
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1351,6 +1351,81 @@ module Google
1351
1351
  execute_or_queue_command(command, &block)
1352
1352
  end
1353
1353
 
1354
+ # Lookup for a single BigQuery Link.
1355
+ # @param [String] name
1356
+ # Required. The name of the BigQuery link to lookup. Format: properties/`
1357
+ # property_id`/bigQueryLinks/`bigquery_link_id` Example: properties/123/
1358
+ # bigQueryLinks/456
1359
+ # @param [String] fields
1360
+ # Selector specifying which fields to include in a partial response.
1361
+ # @param [String] quota_user
1362
+ # Available to use for quota purposes for server-side applications. Can be any
1363
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1364
+ # @param [Google::Apis::RequestOptions] options
1365
+ # Request-specific options
1366
+ #
1367
+ # @yield [result, err] Result & error if block supplied
1368
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink] parsed result object
1369
+ # @yieldparam err [StandardError] error object if request failed
1370
+ #
1371
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink]
1372
+ #
1373
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1374
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1375
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1376
+ def get_property_big_query_link(name, fields: nil, quota_user: nil, options: nil, &block)
1377
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1378
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink::Representation
1379
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink
1380
+ command.params['name'] = name unless name.nil?
1381
+ command.query['fields'] = fields unless fields.nil?
1382
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1383
+ execute_or_queue_command(command, &block)
1384
+ end
1385
+
1386
+ # Lists BigQuery Links on a property.
1387
+ # @param [String] parent
1388
+ # Required. The name of the property to list BigQuery links under. Format:
1389
+ # properties/`property_id` Example: properties/1234
1390
+ # @param [Fixnum] page_size
1391
+ # The maximum number of resources to return. The service may return fewer than
1392
+ # this value, even if there are additional pages. If unspecified, at most 50
1393
+ # resources will be returned. The maximum value is 200; (higher values will be
1394
+ # coerced to the maximum)
1395
+ # @param [String] page_token
1396
+ # A page token, received from a previous `ListBigQueryLinks` call. Provide this
1397
+ # to retrieve the subsequent page. When paginating, all other parameters
1398
+ # provided to `ListBigQueryLinks` must match the call that provided the page
1399
+ # token.
1400
+ # @param [String] fields
1401
+ # Selector specifying which fields to include in a partial response.
1402
+ # @param [String] quota_user
1403
+ # Available to use for quota purposes for server-side applications. Can be any
1404
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1405
+ # @param [Google::Apis::RequestOptions] options
1406
+ # Request-specific options
1407
+ #
1408
+ # @yield [result, err] Result & error if block supplied
1409
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse] parsed result object
1410
+ # @yieldparam err [StandardError] error object if request failed
1411
+ #
1412
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse]
1413
+ #
1414
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1415
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1416
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1417
+ def list_property_big_query_links(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1418
+ command = make_simple_command(:get, 'v1alpha/{+parent}/bigQueryLinks', options)
1419
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse::Representation
1420
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse
1421
+ command.params['parent'] = parent unless parent.nil?
1422
+ command.query['pageSize'] = page_size unless page_size.nil?
1423
+ command.query['pageToken'] = page_token unless page_token.nil?
1424
+ command.query['fields'] = fields unless fields.nil?
1425
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1426
+ execute_or_queue_command(command, &block)
1427
+ end
1428
+
1354
1429
  # Creates a conversion event with the specified attributes.
1355
1430
  # @param [String] parent
1356
1431
  # Required. The resource name of the parent property where this conversion event
@@ -2701,7 +2776,8 @@ module Google
2701
2776
  # @param [String] page_token
2702
2777
  # A page token, received from a previous `ListFirebaseLinks` call. Provide this
2703
2778
  # to retrieve the subsequent page. When paginating, all other parameters
2704
- # provided to `ListProperties` must match the call that provided the page token.
2779
+ # provided to `ListFirebaseLinks` must match the call that provided the page
2780
+ # token.
2705
2781
  # @param [String] fields
2706
2782
  # Selector specifying which fields to include in a partial response.
2707
2783
  # @param [String] quota_user
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.43.0
4
+ version: 0.44.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: 2022-11-07 00:00:00.000000000 Z
11
+ date: 2022-12-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
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.43.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.44.0
62
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: []