google-analytics-admin-v1alpha 0.13.0 → 0.14.0

data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb

@@ -69,6 +69,23 @@ module Google
               "properties/#{property}/audiences/#{audience}"
             end
 
+            ##
+            # Create a fully-qualified BigQueryLink resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `properties/{property}/bigQueryLinks/{bigquery_link}`
+            #
+            # @param property [String]
+            # @param bigquery_link [String]
+            #
+            # @return [::String]
+            def big_query_link_path property:, bigquery_link:
+              raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"
+
+              "properties/#{property}/bigQueryLinks/#{bigquery_link}"
+            end
+
             ##
             # Create a fully-qualified ConversionEvent resource string.
             #
@@ -297,6 +314,23 @@ module Google
               "properties/#{property}"
             end
 
+            ##
+            # Create a fully-qualified SearchAds360Link resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `properties/{property}/searchAds360Links/{search_ads_360_link}`
+            #
+            # @param property [String]
+            # @param search_ads_360_link [String]
+            #
+            # @return [::String]
+            def search_ads360_link_path property:, search_ads_360_link:
+              raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"
+
+              "properties/#{property}/searchAds360Links/#{search_ads_360_link}"
+            end
+
             ##
             # Create a fully-qualified UserLink resource string.
             #

data/lib/google/analytics/admin/v1alpha/analytics_admin_service.rb

@@ -33,7 +33,7 @@ module Google
         ##
         # Service Interface for the Analytics Admin API (GA4).
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/analytics/admin/v1alpha/analytics_admin_service"
         #     client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb

@@ -80,7 +80,7 @@ module Google
             # 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.
+            # Returns an error if the target is not found, or is not a GA4 Property.
             rpc :DeleteProperty, ::Google::Analytics::Admin::V1alpha::DeletePropertyRequest, ::Google::Analytics::Admin::V1alpha::Property
             # Updates a property.
             rpc :UpdateProperty, ::Google::Analytics::Admin::V1alpha::UpdatePropertyRequest, ::Google::Analytics::Admin::V1alpha::Property
@@ -244,9 +244,11 @@ module Google
             rpc :GetDataStream, ::Google::Analytics::Admin::V1alpha::GetDataStreamRequest, ::Google::Analytics::Admin::V1alpha::DataStream
             # Lookup for a single Audience.
             # Audiences created before 2020 may not be supported.
+            # Default audiences will not show filter definitions.
             rpc :GetAudience, ::Google::Analytics::Admin::V1alpha::GetAudienceRequest, ::Google::Analytics::Admin::V1alpha::Audience
             # Lists Audiences on a property.
             # Audiences created before 2020 may not be supported.
+            # Default audiences will not show filter definitions.
             rpc :ListAudiences, ::Google::Analytics::Admin::V1alpha::ListAudiencesRequest, ::Google::Analytics::Admin::V1alpha::ListAudiencesResponse
             # Creates an Audience.
             rpc :CreateAudience, ::Google::Analytics::Admin::V1alpha::CreateAudienceRequest, ::Google::Analytics::Admin::V1alpha::Audience
@@ -254,6 +256,16 @@ module Google
             rpc :UpdateAudience, ::Google::Analytics::Admin::V1alpha::UpdateAudienceRequest, ::Google::Analytics::Admin::V1alpha::Audience
             # Archives an Audience on a property.
             rpc :ArchiveAudience, ::Google::Analytics::Admin::V1alpha::ArchiveAudienceRequest, ::Google::Protobuf::Empty
+            # Look up a single SearchAds360Link
+            rpc :GetSearchAds360Link, ::Google::Analytics::Admin::V1alpha::GetSearchAds360LinkRequest, ::Google::Analytics::Admin::V1alpha::SearchAds360Link
+            # Lists all SearchAds360Links on a property.
+            rpc :ListSearchAds360Links, ::Google::Analytics::Admin::V1alpha::ListSearchAds360LinksRequest, ::Google::Analytics::Admin::V1alpha::ListSearchAds360LinksResponse
+            # Creates a SearchAds360Link.
+            rpc :CreateSearchAds360Link, ::Google::Analytics::Admin::V1alpha::CreateSearchAds360LinkRequest, ::Google::Analytics::Admin::V1alpha::SearchAds360Link
+            # Deletes a SearchAds360Link on a property.
+            rpc :DeleteSearchAds360Link, ::Google::Analytics::Admin::V1alpha::DeleteSearchAds360LinkRequest, ::Google::Protobuf::Empty
+            # Updates a SearchAds360Link on a property.
+            rpc :UpdateSearchAds360Link, ::Google::Analytics::Admin::V1alpha::UpdateSearchAds360LinkRequest, ::Google::Analytics::Admin::V1alpha::SearchAds360Link
             # Lookup for a AttributionSettings singleton.
             rpc :GetAttributionSettings, ::Google::Analytics::Admin::V1alpha::GetAttributionSettingsRequest, ::Google::Analytics::Admin::V1alpha::AttributionSettings
             # Updates attribution settings on a property.
@@ -272,6 +284,18 @@ module Google
             # property's time zone. For configuration change history, see
             # [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
             rpc :RunAccessReport, ::Google::Analytics::Admin::V1alpha::RunAccessReportRequest, ::Google::Analytics::Admin::V1alpha::RunAccessReportResponse
+            # Sets the opt out status for the automated GA4 setup process for a UA
+            # property.
+            # Note: this has no effect on GA4 property.
+            rpc :SetAutomatedGa4ConfigurationOptOut, ::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest, ::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse
+            # Fetches the opt out status for the automated GA4 setup process for a UA
+            # property.
+            # Note: this has no effect on GA4 property.
+            rpc :FetchAutomatedGa4ConfigurationOptOut, ::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest, ::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse
+            # Lookup for a single BigQuery Link.
+            rpc :GetBigQueryLink, ::Google::Analytics::Admin::V1alpha::GetBigQueryLinkRequest, ::Google::Analytics::Admin::V1alpha::BigQueryLink
+            # Lists BigQuery Links on a property.
+            rpc :ListBigQueryLinks, ::Google::Analytics::Admin::V1alpha::ListBigQueryLinksRequest, ::Google::Analytics::Admin::V1alpha::ListBigQueryLinksResponse
           end
 
           Stub = Service.rpc_stub_class

data/lib/google/analytics/admin/v1alpha/audience_pb.rb

@@ -32,7 +32,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :ENDS_WITH, 3
       value :CONTAINS, 4
       value :FULL_REGEXP, 5
-      value :PARTIAL_REGEXP, 6
     end
     add_message "google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.InListFilter" do
       repeated :values, :string, 1
@@ -52,9 +51,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :OPERATION_UNSPECIFIED, 0
       value :EQUAL, 1
       value :LESS_THAN, 2
-      value :LESS_THAN_OR_EQUAL, 3
       value :GREATER_THAN, 4
-      value :GREATER_THAN_OR_EQUAL, 5
     end
     add_message "google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.BetweenFilter" do
       optional :from_value, :message, 1, "google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericValue"

data/lib/google/analytics/admin/v1alpha/expanded_data_set_pb.rb

@@ -0,0 +1,69 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/analytics/admin/v1alpha/expanded_data_set.proto
+
+require 'google/protobuf'
+
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/protobuf/timestamp_pb'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/analytics/admin/v1alpha/expanded_data_set.proto", :syntax => :proto3) do
+    add_message "google.analytics.admin.v1alpha.ExpandedDataSetFilter" do
+      optional :field_name, :string, 1
+      oneof :one_filter do
+        optional :string_filter, :message, 2, "google.analytics.admin.v1alpha.ExpandedDataSetFilter.StringFilter"
+        optional :in_list_filter, :message, 3, "google.analytics.admin.v1alpha.ExpandedDataSetFilter.InListFilter"
+      end
+    end
+    add_message "google.analytics.admin.v1alpha.ExpandedDataSetFilter.StringFilter" do
+      optional :match_type, :enum, 1, "google.analytics.admin.v1alpha.ExpandedDataSetFilter.StringFilter.MatchType"
+      optional :value, :string, 2
+      optional :case_sensitive, :bool, 3
+    end
+    add_enum "google.analytics.admin.v1alpha.ExpandedDataSetFilter.StringFilter.MatchType" do
+      value :MATCH_TYPE_UNSPECIFIED, 0
+      value :EXACT, 1
+      value :CONTAINS, 2
+    end
+    add_message "google.analytics.admin.v1alpha.ExpandedDataSetFilter.InListFilter" do
+      repeated :values, :string, 1
+      optional :case_sensitive, :bool, 2
+    end
+    add_message "google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression" do
+      oneof :expr do
+        optional :and_group, :message, 1, "google.analytics.admin.v1alpha.ExpandedDataSetFilterExpressionList"
+        optional :not_expression, :message, 2, "google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression"
+        optional :filter, :message, 3, "google.analytics.admin.v1alpha.ExpandedDataSetFilter"
+      end
+    end
+    add_message "google.analytics.admin.v1alpha.ExpandedDataSetFilterExpressionList" do
+      repeated :filter_expressions, :message, 1, "google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression"
+    end
+    add_message "google.analytics.admin.v1alpha.ExpandedDataSet" do
+      optional :name, :string, 1
+      optional :display_name, :string, 2
+      optional :description, :string, 3
+      repeated :dimension_names, :string, 4
+      repeated :metric_names, :string, 5
+      optional :dimension_filter_expression, :message, 6, "google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression"
+      optional :data_collection_start_time, :message, 7, "google.protobuf.Timestamp"
+    end
+  end
+end
+
+module Google
+  module Analytics
+    module Admin
+      module V1alpha
+        ExpandedDataSetFilter = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ExpandedDataSetFilter").msgclass
+        ExpandedDataSetFilter::StringFilter = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ExpandedDataSetFilter.StringFilter").msgclass
+        ExpandedDataSetFilter::StringFilter::MatchType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ExpandedDataSetFilter.StringFilter.MatchType").enummodule
+        ExpandedDataSetFilter::InListFilter = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ExpandedDataSetFilter.InListFilter").msgclass
+        ExpandedDataSetFilterExpression = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression").msgclass
+        ExpandedDataSetFilterExpressionList = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ExpandedDataSetFilterExpressionList").msgclass
+        ExpandedDataSet = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ExpandedDataSet").msgclass
+      end
+    end
+  end
+end

data/lib/google/analytics/admin/v1alpha/resources_pb.rb

@@ -3,6 +3,7 @@
 
 require 'google/protobuf'
 
+require 'google/analytics/admin/v1alpha/expanded_data_set_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/protobuf/timestamp_pb'
@@ -146,8 +147,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
         optional :custom_dimension, :message, 13, "google.analytics.admin.v1alpha.CustomDimension"
         optional :custom_metric, :message, 14, "google.analytics.admin.v1alpha.CustomMetric"
         optional :data_retention_settings, :message, 15, "google.analytics.admin.v1alpha.DataRetentionSettings"
+        optional :search_ads_360_link, :message, 16, "google.analytics.admin.v1alpha.SearchAds360Link"
         optional :data_stream, :message, 18, "google.analytics.admin.v1alpha.DataStream"
         optional :attribution_settings, :message, 20, "google.analytics.admin.v1alpha.AttributionSettings"
+        optional :expanded_data_set, :message, 21, "google.analytics.admin.v1alpha.ExpandedDataSet"
+        optional :bigquery_link, :message, 23, "google.analytics.admin.v1alpha.BigQueryLink"
       end
     end
     add_message "google.analytics.admin.v1alpha.DisplayVideo360AdvertiserLink" do
@@ -168,6 +172,15 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :campaign_data_sharing_enabled, :message, 7, "google.protobuf.BoolValue"
       optional :cost_data_sharing_enabled, :message, 8, "google.protobuf.BoolValue"
     end
+    add_message "google.analytics.admin.v1alpha.SearchAds360Link" do
+      optional :name, :string, 1
+      optional :advertiser_id, :string, 2
+      optional :campaign_data_sharing_enabled, :message, 3, "google.protobuf.BoolValue"
+      optional :cost_data_sharing_enabled, :message, 4, "google.protobuf.BoolValue"
+      optional :advertiser_display_name, :string, 5
+      optional :ads_personalization_enabled, :message, 6, "google.protobuf.BoolValue"
+      optional :site_stats_sharing_enabled, :message, 7, "google.protobuf.BoolValue"
+    end
     add_message "google.analytics.admin.v1alpha.LinkProposalStatusDetails" do
       optional :link_proposal_initiating_product, :enum, 1, "google.analytics.admin.v1alpha.LinkProposalInitiatingProduct"
       optional :requestor_email, :string, 2
@@ -269,6 +282,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :CROSS_CHANNEL_TIME_DECAY, 6
       value :ADS_PREFERRED_LAST_CLICK, 7
     end
+    add_message "google.analytics.admin.v1alpha.BigQueryLink" do
+      optional :name, :string, 1
+      optional :project, :string, 2
+      optional :create_time, :message, 3, "google.protobuf.Timestamp"
+      optional :daily_export_enabled, :bool, 4
+      optional :streaming_export_enabled, :bool, 5
+      optional :include_advertising_id, :bool, 6
+      repeated :export_streams, :string, 7
+      repeated :excluded_events, :string, 8
+    end
     add_enum "google.analytics.admin.v1alpha.IndustryCategory" do
       value :INDUSTRY_CATEGORY_UNSPECIFIED, 0
       value :AUTOMOTIVE, 1
@@ -332,6 +355,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :SEARCH_ADS_360_LINK, 16
       value :DATA_STREAM, 18
       value :ATTRIBUTION_SETTINGS, 20
+      value :EXPANDED_DATA_SET, 21
+      value :CHANNEL_GROUP, 22
     end
     add_enum "google.analytics.admin.v1alpha.GoogleSignalsState" do
       value :GOOGLE_SIGNALS_STATE_UNSPECIFIED, 0
@@ -391,6 +416,7 @@ module Google
         ChangeHistoryChange::ChangeHistoryResource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ChangeHistoryChange.ChangeHistoryResource").msgclass
         DisplayVideo360AdvertiserLink = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DisplayVideo360AdvertiserLink").msgclass
         DisplayVideo360AdvertiserLinkProposal = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DisplayVideo360AdvertiserLinkProposal").msgclass
+        SearchAds360Link = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.SearchAds360Link").msgclass
         LinkProposalStatusDetails = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.LinkProposalStatusDetails").msgclass
         ConversionEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ConversionEvent").msgclass
         GoogleSignalsSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GoogleSignalsSettings").msgclass
@@ -406,6 +432,7 @@ module Google
         AttributionSettings::AcquisitionConversionEventLookbackWindow = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.AttributionSettings.AcquisitionConversionEventLookbackWindow").enummodule
         AttributionSettings::OtherConversionEventLookbackWindow = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.AttributionSettings.OtherConversionEventLookbackWindow").enummodule
         AttributionSettings::ReportingAttributionModel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.AttributionSettings.ReportingAttributionModel").enummodule
+        BigQueryLink = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.BigQueryLink").msgclass
         IndustryCategory = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.IndustryCategory").enummodule
         ServiceLevel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ServiceLevel").enummodule
         ActorType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ActorType").enummodule

data/lib/google/analytics/admin/v1alpha/version.rb

@@ -21,7 +21,7 @@ module Google
   module Analytics
     module Admin
       module V1alpha
-        VERSION = "0.13.0"
+        VERSION = "0.14.0"
       end
     end
   end

data/lib/google/analytics/admin/v1alpha.rb

@@ -23,9 +23,9 @@ module Google
   module Analytics
     module Admin
       ##
-      # To load this package, including all its services, and instantiate a client:
+      # API client module.
       #
-      # @example
+      # @example Load this package, including all its services, and instantiate a gRPC client
       #
       #     require "google/analytics/admin/v1alpha"
       #     client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

data/proto_docs/google/analytics/admin/v1alpha/access_report.rb

@@ -352,8 +352,8 @@ module Google
         # @!attribute [rw] tokens_per_hour
         #   @return [::Google::Analytics::Admin::V1alpha::AccessQuotaStatus]
         #     Properties can use 50,000 tokens per hour. An API request consumes a single
-        #     number of tokens, and that number is deducted from both the hourly and
-        #     daily quotas.
+        #     number of tokens, and that number is deducted from all of the hourly,
+        #     daily, and per project hourly quotas.
         # @!attribute [rw] concurrent_requests
         #   @return [::Google::Analytics::Admin::V1alpha::AccessQuotaStatus]
         #     Properties can use up to 50 concurrent requests.
@@ -361,6 +361,12 @@ module Google
         #   @return [::Google::Analytics::Admin::V1alpha::AccessQuotaStatus]
         #     Properties and cloud project pairs can have up to 50 server errors per
         #     hour.
+        # @!attribute [rw] tokens_per_project_per_hour
+        #   @return [::Google::Analytics::Admin::V1alpha::AccessQuotaStatus]
+        #     Properties can use up to 25% of their tokens per project per hour. This
+        #     amounts to Analytics 360 Properties can use 12,500 tokens per project per
+        #     hour. An API request consumes a single number of tokens, and that number is
+        #     deducted from all of the hourly, daily, and per project hourly quotas.
         class AccessQuota
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods