google-apis-analyticsadmin_v1alpha 0.51.0 → 0.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d58777a9da11d232310d618df65606d1098413230cbc5941c12854e44522bfa
-  data.tar.gz: e36a1f0446828ed6aac47a0f4ed0f8c40a8ff7f7cc3e4112b2e6730733d6feaa
+  metadata.gz: 7ebde55e8d2880cc61290c841e3a5a4581ebf09cbe213d274f06e6b0b35ebfdd
+  data.tar.gz: 0e5365274e227fa6bcb0ca824d0f3c556a9913028569548097953079a0c7e18f
 SHA512:
-  metadata.gz: d5c4dd436408e73ce862a892f95d537c8d5ecdc43abf09e47b1c418278ce4d6031f8892187c0eafa13a8401a64c621555c4fb7c26ac4933b4e4e3b13ddfe16d3
-  data.tar.gz: ca028659264a6c459acd3ba0085e46bf31d77591f1f0d80d12c246a3b8023a5c0f11def5d7eb60b82fffb30f6a869d92826b2fb6ad571dc8a9978d5c561ae1ef
+  metadata.gz: dd42cfa354a06efd3225f86daf68a045c4b997eeb187239d1f51d2588263319c8ff0b90365e4462d9b107fde5cced90507c9edb5cddfbc032203058b8228bfe4
+  data.tar.gz: bbbac20f26524ada5599c7bab3aec1d103df87145069e78394406ce89b15b5c19bfda89e24e158119e43e782dfde7f8138ff1de416e1ef55779480079b6ae6c6

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-analyticsadmin_v1alpha
 
+### v0.53.0 (2023-04-30)
+
+* Regenerated from discovery document revision 20230427
+
+### v0.52.0 (2023-04-23)
+
+* Regenerated from discovery document revision 20230416
+
 ### v0.51.0 (2023-04-16)
 
 * Regenerated from discovery document revision 20230410

data/lib/google/apis/analyticsadmin_v1alpha/classes.rb

@@ -940,17 +940,22 @@ module Google
         # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter]
         attr_accessor :between_filter
       
-        # Required. Immutable. The dimension name or metric name to filter.
+        # Required. Immutable. The dimension name or metric name to filter. If the field
+        # name refers to a custom dimension or metric, a scope prefix will be added to
+        # the front of the custom dimensions or metric name. For more on scope prefixes
+        # or custom dimensions/metrics, reference the [Google Analytics Data API
+        # documentation] (https://developers.google.com/analytics/devguides/reporting/
+        # data/v1/api-schema#custom_dimensions).
         # Corresponds to the JSON property `fieldName`
         # @return [String]
         attr_accessor :field_name
       
         # Optional. If set, specifies the time window for which to evaluate data in
         # number of days. If not set, then audience data is evaluated against lifetime
-        # data (i.e., infinite time window). For example, if set to 1 day, only the
-        # current day's data is evaluated. The reference point is the current day when
-        # at_any_point_in_time is unset or false. It can only be set when Audience scope
-        # is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.
+        # data (For example, infinite time window). For example, if set to 1 day, only
+        # the current day's data is evaluated. The reference point is the current day
+        # when at_any_point_in_time is unset or false. It can only be set when Audience
+        # scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.
         # Corresponds to the JSON property `inAnyNDayPeriod`
         # @return [Fixnum]
         attr_accessor :in_any_n_day_period
@@ -1176,9 +1181,9 @@ module Google
       end
       
       # A clause for defining either a simple or sequence filter. A filter can be
-      # inclusive (i.e., users satisfying the filter clause are included in the
-      # Audience) or exclusive (i.e., users satisfying the filter clause are excluded
-      # from the Audience).
+      # inclusive (For example, users satisfying the filter clause are included in the
+      # Audience) or exclusive (For example, users satisfying the filter clause are
+      # excluded from the Audience).
       class GoogleAnalyticsAdminV1alphaAudienceFilterClause
         include Google::Apis::Core::Hashable
       
@@ -1314,9 +1319,9 @@ module Google
         include Google::Apis::Core::Hashable
       
         # Optional. When set, this step must be satisfied within the constraint_duration
-        # of the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not set,
-        # there is no duration requirement (the duration is effectively unlimited). It
-        # is ignored for the first step.
+        # of the previous step (For example, t[i] - t[i-1] <= constraint_duration). If
+        # not set, there is no duration requirement (the duration is effectively
+        # unlimited). It is ignored for the first step.
         # Corresponds to the JSON property `constraintDuration`
         # @return [String]
         attr_accessor :constraint_duration
@@ -1867,6 +1872,11 @@ module Google
         # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings]
         attr_accessor :attribution_settings
       
+        # A resource message representing a GA4 Audience.
+        # Corresponds to the JSON property `audience`
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience]
+        attr_accessor :audience
+      
         # A link between a GA4 Property and BigQuery project.
         # Corresponds to the JSON property `bigqueryLink`
         # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink]
@@ -1964,6 +1974,7 @@ module Google
         def update!(**args)
           @account = args[:account] if args.key?(:account)
           @attribution_settings = args[:attribution_settings] if args.key?(:attribution_settings)
+          @audience = args[:audience] if args.key?(:audience)
           @bigquery_link = args[:bigquery_link] if args.key?(:bigquery_link)
           @channel_group = args[:channel_group] if args.key?(:channel_group)
           @conversion_event = args[:conversion_event] if args.key?(:conversion_event)
@@ -3329,6 +3340,27 @@ module Google
         end
       end
       
+      # Response for looking up GA4 property connected to a UA property.
+      class GoogleAnalyticsAdminV1alphaFetchConnectedGa4PropertyResponse
+        include Google::Apis::Core::Hashable
+      
+        # The GA4 property connected to the UA property. An empty string is returned
+        # when there is no connected GA4 property. Format: properties/`property_id`
+        # Example: properties/1234
+        # Corresponds to the JSON property `property`
+        # @return [String]
+        attr_accessor :property
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @property = args[:property] if args.key?(:property)
+        end
+      end
+      
       # A link between a GA4 property and a Firebase project.
       class GoogleAnalyticsAdminV1alphaFirebaseLink
         include Google::Apis::Core::Hashable

data/lib/google/apis/analyticsadmin_v1alpha/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module AnalyticsadminV1alpha
       # Version of the google-apis-analyticsadmin_v1alpha gem
-      GEM_VERSION = "0.51.0"
+      GEM_VERSION = "0.53.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230410"
+      REVISION = "20230427"
     end
   end
 end

data/lib/google/apis/analyticsadmin_v1alpha/representations.rb

@@ -622,6 +622,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleAnalyticsAdminV1alphaFetchConnectedGa4PropertyResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleAnalyticsAdminV1alphaFirebaseLink
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1479,6 +1485,8 @@ module Google
       
           property :attribution_settings, as: 'attributionSettings', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings::Representation
       
+          property :audience, as: 'audience', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience::Representation
+      
           property :bigquery_link, as: 'bigqueryLink', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink::Representation
       
           property :channel_group, as: 'channelGroup', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaChannelGroup, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaChannelGroup::Representation
@@ -1872,6 +1880,13 @@ module Google
         end
       end
       
+      class GoogleAnalyticsAdminV1alphaFetchConnectedGa4PropertyResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :property, as: 'property'
+        end
+      end
+      
       class GoogleAnalyticsAdminV1alphaFirebaseLink
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/analyticsadmin_v1alpha/service.rb

@@ -1252,6 +1252,40 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Given a specified UA property, looks up the GA4 property connected to it. Note:
+        # this cannot be used with GA4 properties.
+        # @param [String] property
+        #   Required. The UA property for which to look up the connected GA4 property.
+        #   Note this request uses the internal property ID, not the tracking ID of the
+        #   form UA-XXXXXX-YY. Format: properties/`internal_web_property_id` Example:
+        #   properties/1234
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFetchConnectedGa4PropertyResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFetchConnectedGa4PropertyResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def fetch_property_connected_ga4_property(property: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1alpha/properties:fetchConnectedGa4Property', options)
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFetchConnectedGa4PropertyResponse::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFetchConnectedGa4PropertyResponse
+          command.query['property'] = property unless property.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Lookup for a single "GA4" Property.
         # @param [String] name
         #   Required. The name of the property to lookup. Format: properties/`property_id`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-analyticsadmin_v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.51.0
+  version: 0.53.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-16 00:00:00.000000000 Z
+date: 2023-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.51.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.53.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha
 post_install_message: 
 rdoc_options: []