google-apis-analyticsadmin_v1alpha 0.42.0 → 0.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebaab5457b925b0c4d4c71e794ee5a48883f5ce5019fffbfa3dbba3fd70d0e01
-  data.tar.gz: 373bd772982ec441535cdf5494d017227aa5fec8253fa6a41781af93c7a3a1a8
+  metadata.gz: 39a7c0fd9f29e24766bf675629e7cfd7ce60295441977e989f67c0249b0b193e
+  data.tar.gz: 1b004bc486738dc3bd27577592d7893787d0679ea7e397343991ed1c15113f71
 SHA512:
-  metadata.gz: 8c05f12b741bce8dc57aeffdce347bb6e46b5e883ff6a155d4e8561d1a13f9ae677389fa2755828a4b3b71f753d81ace8f6e226847667e3d4c4d7305d16e43b9
-  data.tar.gz: 8d9ea52a285adb8badbd206289508439df039f6331c7f1d807d4d39a0eac909b723a72086b323e786abdfecb6e26b068ce0666246b53eb86ae66a984ecbdbf23
+  metadata.gz: fe2c09f0bebf544a7d953faec6d99dcc391f7335b9229dec900195dd64a4b72fcb8a2c0f7d21a3ffd523419e775b453244653989a9bb6ceb7d078ec104116d49
+  data.tar.gz: dc0528eca97553bc1cb88bce771ca8564e0c3e2d34d4c0205706900092b762c68a533563b1f820c8ff62705960a923e03a77e8b4024d23cf225e0aa76ff14207

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-analyticsadmin_v1alpha
 
+### v0.44.0 (2022-12-07)
+
+* Regenerated from discovery document revision 20221205
+
+### v0.43.0 (2022-11-06)
+
+* Regenerated from discovery document revision 20221101
+
 ### v0.42.0 (2022-10-28)
 
 * Regenerated from discovery document revision 20221025

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

@@ -846,8 +846,8 @@ module Google
         # @return [String]
         attr_accessor :exclusion_duration_mode
       
-        # Required. Immutable. null Filter clauses that define the Audience. All clauses
-        # will be AND’ed together.
+        # Required. Immutable. Unordered list. Filter clauses that define the Audience.
+        # All clauses will be AND’ed together.
         # Corresponds to the JSON property `filterClauses`
         # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterClause>]
         attr_accessor :filter_clauses
@@ -1564,6 +1564,79 @@ module Google
         end
       end
       
+      # A link between a GA4 Property and BigQuery project.
+      class GoogleAnalyticsAdminV1alphaBigQueryLink
+        include Google::Apis::Core::Hashable
+      
+        # Output only. Time when the link was created.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # If set true, enables daily data export to the linked Google Cloud project.
+        # Corresponds to the JSON property `dailyExportEnabled`
+        # @return [Boolean]
+        attr_accessor :daily_export_enabled
+        alias_method :daily_export_enabled?, :daily_export_enabled
+      
+        # The list of event names that will be excluded from exports.
+        # Corresponds to the JSON property `excludedEvents`
+        # @return [Array<String>]
+        attr_accessor :excluded_events
+      
+        # The list of streams under the parent property for which data will be exported.
+        # Format: properties/`property_id`/dataStreams/`stream_id` Example: ['properties/
+        # 1000/dataStreams/2000']
+        # Corresponds to the JSON property `exportStreams`
+        # @return [Array<String>]
+        attr_accessor :export_streams
+      
+        # If set true, exported data will include advertising identifiers for mobile app
+        # streams.
+        # Corresponds to the JSON property `includeAdvertisingId`
+        # @return [Boolean]
+        attr_accessor :include_advertising_id
+        alias_method :include_advertising_id?, :include_advertising_id
+      
+        # Output only. Resource name of this BigQuery link. Format: 'properties/`
+        # property_id`/bigQueryLinks/`bigquery_link_id`' Format: 'properties/1234/
+        # bigQueryLinks/abc567'
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you
+        # may provide this resource name using either a project number or project ID.
+        # Once this resource has been created, the returned project will always have a
+        # project that contains a project number. Format: 'projects/`project number`'
+        # Example: 'projects/1234'
+        # Corresponds to the JSON property `project`
+        # @return [String]
+        attr_accessor :project
+      
+        # If set true, enables streaming export to the linked Google Cloud project.
+        # Corresponds to the JSON property `streamingExportEnabled`
+        # @return [Boolean]
+        attr_accessor :streaming_export_enabled
+        alias_method :streaming_export_enabled?, :streaming_export_enabled
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @daily_export_enabled = args[:daily_export_enabled] if args.key?(:daily_export_enabled)
+          @excluded_events = args[:excluded_events] if args.key?(:excluded_events)
+          @export_streams = args[:export_streams] if args.key?(:export_streams)
+          @include_advertising_id = args[:include_advertising_id] if args.key?(:include_advertising_id)
+          @name = args[:name] if args.key?(:name)
+          @project = args[:project] if args.key?(:project)
+          @streaming_export_enabled = args[:streaming_export_enabled] if args.key?(:streaming_export_enabled)
+        end
+      end
+      
       # Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC.
       class GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest
         include Google::Apis::Core::Hashable
@@ -1632,6 +1705,11 @@ module Google
         # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings]
         attr_accessor :attribution_settings
       
+        # A link between a GA4 Property and BigQuery project.
+        # Corresponds to the JSON property `bigqueryLink`
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink]
+        attr_accessor :bigquery_link
+      
         # A conversion event in a Google Analytics property.
         # Corresponds to the JSON property `conversionEvent`
         # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent]
@@ -1713,6 +1791,7 @@ module Google
         def update!(**args)
           @account = args[:account] if args.key?(:account)
           @attribution_settings = args[:attribution_settings] if args.key?(:attribution_settings)
+          @bigquery_link = args[:bigquery_link] if args.key?(:bigquery_link)
           @conversion_event = args[:conversion_event] if args.key?(:conversion_event)
           @custom_dimension = args[:custom_dimension] if args.key?(:custom_dimension)
           @custom_metric = args[:custom_metric] if args.key?(:custom_metric)
@@ -2880,6 +2959,32 @@ module Google
         end
       end
       
+      # Response message for ListBigQueryLinks RPC
+      class GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse
+        include Google::Apis::Core::Hashable
+      
+        # List of BigQueryLinks.
+        # Corresponds to the JSON property `bigqueryLinks`
+        # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink>]
+        attr_accessor :bigquery_links
+      
+        # A token, which can be sent as `page_token` to retrieve the next page. If this
+        # field is omitted, there are no subsequent pages.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @bigquery_links = args[:bigquery_links] if args.key?(:bigquery_links)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+        end
+      end
+      
       # Response message for ListConversionEvents RPC.
       class GoogleAnalyticsAdminV1alphaListConversionEventsResponse
         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.42.0"
+      GEM_VERSION = "0.44.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.11.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20221025"
+      REVISION = "20221205"
     end
   end
 end

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

@@ -346,6 +346,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleAnalyticsAdminV1alphaBigQueryLink
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -532,6 +538,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleAnalyticsAdminV1alphaListConversionEventsResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1184,6 +1196,20 @@ module Google
         end
       end
       
+      class GoogleAnalyticsAdminV1alphaBigQueryLink
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          property :daily_export_enabled, as: 'dailyExportEnabled'
+          collection :excluded_events, as: 'excludedEvents'
+          collection :export_streams, as: 'exportStreams'
+          property :include_advertising_id, as: 'includeAdvertisingId'
+          property :name, as: 'name'
+          property :project, as: 'project'
+          property :streaming_export_enabled, as: 'streamingExportEnabled'
+        end
+      end
+      
       class GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1209,6 +1235,8 @@ module Google
       
           property :attribution_settings, as: 'attributionSettings', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings::Representation
       
+          property :bigquery_link, as: 'bigqueryLink', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink::Representation
+      
           property :conversion_event, as: 'conversionEvent', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent::Representation
       
           property :custom_dimension, as: 'customDimension', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
@@ -1533,6 +1561,15 @@ module Google
         end
       end
       
+      class GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :bigquery_links, as: 'bigqueryLinks', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink::Representation
+      
+          property :next_page_token, as: 'nextPageToken'
+        end
+      end
+      
       class GoogleAnalyticsAdminV1alphaListConversionEventsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -760,7 +760,7 @@ module Google
         # the expiration time, the Property and all child resources (eg: GoogleAdsLinks,
         # Streams, UserLinks) will be permanently purged. https://support.google.com/
         # analytics/answer/6154772 Returns an error if the target is not found, or is
-        # not an GA4 Property.
+        # not a GA4 Property.
         # @param [String] name
         #   Required. The name of the Property to soft-delete. Format: properties/`
         #   property_id` Example: "properties/1000"
@@ -1351,6 +1351,81 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Lookup for a single BigQuery Link.
+        # @param [String] name
+        #   Required. The name of the BigQuery link to lookup. Format: properties/`
+        #   property_id`/bigQueryLinks/`bigquery_link_id` Example: properties/123/
+        #   bigQueryLinks/456
+        # @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::GoogleAnalyticsAdminV1alphaBigQueryLink] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink]
+        #
+        # @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 get_property_big_query_link(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1alpha/{+name}', options)
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Lists BigQuery Links on a property.
+        # @param [String] parent
+        #   Required. The name of the property to list BigQuery links under. Format:
+        #   properties/`property_id` Example: properties/1234
+        # @param [Fixnum] page_size
+        #   The maximum number of resources to return. The service may return fewer than
+        #   this value, even if there are additional pages. If unspecified, at most 50
+        #   resources will be returned. The maximum value is 200; (higher values will be
+        #   coerced to the maximum)
+        # @param [String] page_token
+        #   A page token, received from a previous `ListBigQueryLinks` call. Provide this
+        #   to retrieve the subsequent page. When paginating, all other parameters
+        #   provided to `ListBigQueryLinks` must match the call that provided the page
+        #   token.
+        # @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::GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse]
+        #
+        # @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 list_property_big_query_links(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1alpha/{+parent}/bigQueryLinks', options)
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates a conversion event with the specified attributes.
         # @param [String] parent
         #   Required. The resource name of the parent property where this conversion event
@@ -2701,7 +2776,8 @@ module Google
         # @param [String] page_token
         #   A page token, received from a previous `ListFirebaseLinks` call. Provide this
         #   to retrieve the subsequent page. When paginating, all other parameters
-        #   provided to `ListProperties` must match the call that provided the page token.
+        #   provided to `ListFirebaseLinks` must match the call that provided the page
+        #   token.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-analyticsadmin_v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.42.0
+  version: 0.44.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-31 00:00:00.000000000 Z
+date: 2022-12-12 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.42.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.44.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha
 post_install_message: 
 rdoc_options: []