# frozen_string_literal: true

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Auto-generated by gapic-generator-ruby. DO NOT EDIT!


module Google
  module Analytics
    module Admin
      module V1alpha
        # A resource message representing a Google Analytics account.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. Resource name of this account.
        #     Format: accounts/\\{account}
        #     Example: "accounts/100"
        # @!attribute [r] create_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. Time when this account was originally created.
        # @!attribute [r] update_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. Time when account payload fields were last updated.
        # @!attribute [rw] display_name
        #   @return [::String]
        #     Required. Human-readable display name for this account.
        # @!attribute [rw] region_code
        #   @return [::String]
        #     Country of business. Must be a Unicode CLDR region code.
        # @!attribute [r] deleted
        #   @return [::Boolean]
        #     Output only. Indicates whether this Account is soft-deleted or not. Deleted
        #     accounts are excluded from List results unless specifically requested.
        class Account
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # A resource message representing a Google Analytics GA4 property.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. Resource name of this property.
        #     Format: properties/\\{property_id}
        #     Example: "properties/1000"
        # @!attribute [r] create_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. Time when the entity was originally created.
        # @!attribute [r] update_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. Time when entity payload fields were last updated.
        # @!attribute [rw] parent
        #   @return [::String]
        #     Immutable. Resource name of this property's logical parent.
        #
        #     Note: The Property-Moving UI can be used to change the parent.
        #     Format: accounts/\\{account}
        #     Example: "accounts/100"
        # @!attribute [rw] display_name
        #   @return [::String]
        #     Required. Human-readable display name for this property.
        #
        #     The max allowed display name length is 100 UTF-16 code units.
        # @!attribute [rw] industry_category
        #   @return [::Google::Analytics::Admin::V1alpha::IndustryCategory]
        #     Industry associated with this property
        #     Example: AUTOMOTIVE, FOOD_AND_DRINK
        # @!attribute [rw] time_zone
        #   @return [::String]
        #     Required. Reporting Time Zone, used as the day boundary for reports, regardless of
        #     where the data originates. If the time zone honors DST, Analytics will
        #     automatically adjust for the changes.
        #
        #     NOTE: Changing the time zone only affects data going forward, and is not
        #     applied retroactively.
        #
        #     Format: https://www.iana.org/time-zones
        #     Example: "America/Los_Angeles"
        # @!attribute [rw] currency_code
        #   @return [::String]
        #     The currency type used in reports involving monetary values.
        #
        #
        #     Format: https://en.wikipedia.org/wiki/ISO_4217
        #     Examples: "USD", "EUR", "JPY"
        # @!attribute [r] delete_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. If set, the time at which this property was trashed. If not set, then this
        #     property is not currently in the trash can.
        # @!attribute [r] expire_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. If set, the time at which this trashed property will be permanently
        #     deleted. If not set, then this property is not currently in the trash can
        #     and is not slated to be deleted.
        class Property
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # A resource message representing a Google Analytics Android app stream.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. Resource name of this Data Stream.
        #     Format: properties/\\{property_id}/androidAppDataStreams/\\{stream_id}
        #     Example: "properties/1000/androidAppDataStreams/2000"
        # @!attribute [r] firebase_app_id
        #   @return [::String]
        #     Output only. ID of the corresponding Android app in Firebase, if any.
        #     This ID can change if the Android app is deleted and recreated.
        # @!attribute [r] create_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. Time when this stream was originally created.
        # @!attribute [r] update_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. Time when stream payload fields were last updated.
        # @!attribute [rw] package_name
        #   @return [::String]
        #     Immutable. The package name for the app being measured.
        #     Example: "com.example.myandroidapp"
        # @!attribute [rw] display_name
        #   @return [::String]
        #     Human-readable display name for the Data Stream.
        #
        #     The max allowed display name length is 255 UTF-16 code units.
        class AndroidAppDataStream
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # A resource message representing a Google Analytics IOS app stream.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. Resource name of this Data Stream.
        #     Format: properties/\\{property_id}/iosAppDataStreams/\\{stream_id}
        #     Example: "properties/1000/iosAppDataStreams/2000"
        # @!attribute [r] firebase_app_id
        #   @return [::String]
        #     Output only. ID of the corresponding iOS app in Firebase, if any.
        #     This ID can change if the iOS app is deleted and recreated.
        # @!attribute [r] create_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. Time when this stream was originally created.
        # @!attribute [r] update_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. Time when stream payload fields were last updated.
        # @!attribute [rw] bundle_id
        #   @return [::String]
        #     Required. Immutable. The Apple App Store Bundle ID for the app
        #     Example: "com.example.myiosapp"
        # @!attribute [rw] display_name
        #   @return [::String]
        #     Human-readable display name for the Data Stream.
        #
        #     The max allowed display name length is 255 UTF-16 code units.
        class IosAppDataStream
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # A resource message representing a Google Analytics web stream.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. Resource name of this Data Stream.
        #     Format: properties/\\{property_id}/webDataStreams/\\{stream_id}
        #     Example: "properties/1000/webDataStreams/2000"
        # @!attribute [r] measurement_id
        #   @return [::String]
        #     Output only. Analytics "Measurement ID", without the "G-" prefix.
        #     Example: "G-1A2BCD345E" would just be "1A2BCD345E"
        # @!attribute [r] firebase_app_id
        #   @return [::String]
        #     Output only. ID of the corresponding web app in Firebase, if any.
        #     This ID can change if the web app is deleted and recreated.
        # @!attribute [r] create_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. Time when this stream was originally created.
        # @!attribute [r] update_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. Time when stream payload fields were last updated.
        # @!attribute [rw] default_uri
        #   @return [::String]
        #     Immutable. Domain name of the web app being measured, or empty.
        #     Example: "http://www.google.com", "https://www.google.com"
        # @!attribute [rw] display_name
        #   @return [::String]
        #     Required. Human-readable display name for the Data Stream.
        #
        #     The max allowed display name length is 100 UTF-16 code units.
        class WebDataStream
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # A resource message representing a user's permissions on an Account or
        # Property resource.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. Example format: properties/1234/userLinks/5678
        # @!attribute [rw] email_address
        #   @return [::String]
        #     Immutable. Email address of the user to link
        # @!attribute [rw] direct_roles
        #   @return [::Array<::String>]
        #     Roles directly assigned to this user for this account or property.
        #
        #     Valid values:
        #     predefinedRoles/read
        #     predefinedRoles/collaborate
        #     predefinedRoles/edit
        #     predefinedRoles/manage-users
        #
        #     Excludes roles that are inherited from a higher-level entity, group,
        #     or organization admin role.
        #
        #     A UserLink that is updated to have an empty list of direct_roles will be
        #     deleted.
        class UserLink
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Read-only resource used to summarize a principal's effective roles.
        # @!attribute [rw] name
        #   @return [::String]
        #     Example format: properties/1234/userLinks/5678
        # @!attribute [rw] email_address
        #   @return [::String]
        #     Email address of the linked user
        # @!attribute [rw] direct_roles
        #   @return [::Array<::String>]
        #     Roles directly assigned to this user for this entity.
        #
        #     Format: predefinedRoles/read
        #
        #     Excludes roles that are inherited from an account (if this is for a
        #     property), group, or organization admin role.
        # @!attribute [rw] effective_roles
        #   @return [::Array<::String>]
        #     Union of all permissions a user has at this account or property (includes
        #     direct permissions, group-inherited permissions, etc.).
        #
        #     Format: predefinedRoles/read
        class AuditUserLink
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Singleton resource under a WebDataStream, configuring measurement of
        # additional site interactions and content.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. Resource name of this Data Stream.
        #     Format:
        #     properties/\\{property_id}/webDataStreams/\\{stream_id}/enhancedMeasurementSettings
        #     Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
        # @!attribute [rw] stream_enabled
        #   @return [::Boolean]
        #     Indicates whether Enhanced Measurement Settings will be used to
        #     automatically measure interactions and content on this web stream.
        #
        #     Changing this value does not affect the settings themselves, but determines
        #     whether they are respected.
        # @!attribute [r] page_views_enabled
        #   @return [::Boolean]
        #     Output only. If enabled, capture a page view event each time a page loads or the
        #     website changes the browser history state.
        # @!attribute [rw] scrolls_enabled
        #   @return [::Boolean]
        #     If enabled, capture scroll events each time a visitor gets to the bottom of
        #     a page.
        # @!attribute [rw] outbound_clicks_enabled
        #   @return [::Boolean]
        #     If enabled, capture an outbound click event each time a visitor clicks a
        #     link that leads them away from your domain.
        # @!attribute [rw] site_search_enabled
        #   @return [::Boolean]
        #     If enabled, capture a view search results event each time a visitor
        #     performs a search on your site (based on a query parameter).
        # @!attribute [rw] video_engagement_enabled
        #   @return [::Boolean]
        #     If enabled, capture video play, progress, and complete events as visitors
        #     view embedded videos on your site.
        # @!attribute [rw] file_downloads_enabled
        #   @return [::Boolean]
        #     If enabled, capture a file download event each time a link is clicked with
        #     a common document, compressed file, application, video, or audio extension.
        # @!attribute [r] page_loads_enabled
        #   @return [::Boolean]
        #     Output only. If enabled, capture a page view event each time a page loads.
        # @!attribute [rw] page_changes_enabled
        #   @return [::Boolean]
        #     If enabled, capture a page view event each time the website changes the
        #     browser history state.
        # @!attribute [rw] search_query_parameter
        #   @return [::String]
        #     Required. URL query parameters to interpret as site search parameters.
        #     Max length is 1024 characters. Must not be empty.
        # @!attribute [rw] uri_query_parameter
        #   @return [::String]
        #     Additional URL query parameters.
        #     Max length is 1024 characters.
        class EnhancedMeasurementSettings
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # A link between an GA4 property and a Firebase project.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. Example format: properties/1234/firebaseLinks/5678
        # @!attribute [rw] project
        #   @return [::String]
        #     Immutable. Firebase project resource name. When creating a FirebaseLink, you may
        #     provide this resource name using either a project number or project ID.
        #     Once this resource has been created, returned FirebaseLinks will always
        #     have a project_name that contains a project number.
        #
        #     Format: 'projects/\\{project number}'
        #     Example: 'projects/1234'
        # @!attribute [r] create_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. Time when this FirebaseLink was originally created.
        # @!attribute [rw] maximum_user_access
        #   @return [::Google::Analytics::Admin::V1alpha::MaximumUserAccess]
        #     Maximum user access to the GA4 property allowed to admins of
        #     the linked Firebase project.
        class FirebaseLink
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Read-only resource with the tag for sending data from a website to a
        # WebDataStream.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. Resource name for this GlobalSiteTag resource.
        #     Format: properties/\\{propertyId}/globalSiteTag
        # @!attribute [rw] snippet
        #   @return [::String]
        #     Immutable. JavaScript code snippet to be pasted as the first item into the head tag of
        #     every webpage to measure.
        class GlobalSiteTag
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # A link between an GA4 property and a Google Ads account.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. Format: properties/\\{propertyId}/googleAdsLinks/\\{googleAdsLinkId}
        #
        #     Note: googleAdsLinkId is not the Google Ads customer ID.
        # @!attribute [rw] customer_id
        #   @return [::String]
        #     Immutable. Google Ads customer ID.
        # @!attribute [r] can_manage_clients
        #   @return [::Boolean]
        #     Output only. If true, this link is for a Google Ads manager account.
        # @!attribute [rw] ads_personalization_enabled
        #   @return [::Google::Protobuf::BoolValue]
        #     Enable personalized advertising features with this integration.
        #     Automatically publish my Google Analytics audience lists and Google
        #     Analytics remarketing events/parameters to the linked Google Ads account.
        #     If this field is not set on create/update, it will be defaulted to true.
        # @!attribute [r] email_address
        #   @return [::String]
        #     Output only. Email address of the user that created the link.
        #     An empty string will be returned if the email address can't be retrieved.
        # @!attribute [r] create_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. Time when this link was originally created.
        # @!attribute [r] update_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. Time when this link was last updated.
        class GoogleAdsLink
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # A resource message representing data sharing settings of a Google Analytics
        # account.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. Resource name.
        #     Format: accounts/\\{account}/dataSharingSettings
        #     Example: "accounts/1000/dataSharingSettings"
        # @!attribute [rw] sharing_with_google_support_enabled
        #   @return [::Boolean]
        #     Allows Google support to access the data in order to help troubleshoot
        #     issues.
        # @!attribute [rw] sharing_with_google_assigned_sales_enabled
        #   @return [::Boolean]
        #     Allows Google sales teams that are assigned to the customer to access the
        #     data in order to suggest configuration changes to improve results.
        #     Sales team restrictions still apply when enabled.
        # @!attribute [rw] sharing_with_google_any_sales_enabled
        #   @return [::Boolean]
        #     Allows any of Google sales to access the data in order to suggest
        #     configuration changes to improve results.
        # @!attribute [rw] sharing_with_google_products_enabled
        #   @return [::Boolean]
        #     Allows Google to use the data to improve other Google products or services.
        # @!attribute [rw] sharing_with_others_enabled
        #   @return [::Boolean]
        #     Allows Google to share the data anonymously in aggregate form with others.
        class DataSharingSettings
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # A virtual resource representing an overview of an account and
        # all its child GA4 properties.
        # @!attribute [rw] name
        #   @return [::String]
        #     Resource name for this account summary.
        #     Format: accountSummaries/\\{account_id}
        #     Example: "accountSummaries/1000"
        # @!attribute [rw] account
        #   @return [::String]
        #     Resource name of account referred to by this account summary
        #     Format: accounts/\\{account_id}
        #     Example: "accounts/1000"
        # @!attribute [rw] display_name
        #   @return [::String]
        #     Display name for the account referred to in this account summary.
        # @!attribute [rw] property_summaries
        #   @return [::Array<::Google::Analytics::Admin::V1alpha::PropertySummary>]
        #     List of summaries for child accounts of this account.
        class AccountSummary
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # A virtual resource representing metadata for an GA4 property.
        # @!attribute [rw] property
        #   @return [::String]
        #     Resource name of property referred to by this property summary
        #     Format: properties/\\{property_id}
        #     Example: "properties/1000"
        # @!attribute [rw] display_name
        #   @return [::String]
        #     Display name for the property referred to in this account summary.
        class PropertySummary
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # A secret value used for sending hits to Measurement Protocol.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. Resource name of this secret. This secret may be a child of any type of
        #     stream.
        #     Format:
        #     properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
        # @!attribute [rw] display_name
        #   @return [::String]
        #     Required. Human-readable display name for this secret.
        # @!attribute [r] secret_value
        #   @return [::String]
        #     Output only. The measurement protocol secret value. Pass this value to the api_secret
        #     field of the Measurement Protocol API when sending hits to this
        #     secret's parent property.
        class MeasurementProtocolSecret
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # A set of changes within a Google Analytics account or its child properties
        # that resulted from the same cause. Common causes would be updates made in the
        # Google Analytics UI, changes from customer support, or automatic Google
        # Analytics system changes.
        # @!attribute [rw] id
        #   @return [::String]
        #     ID of this change history event. This ID is unique across Google Analytics.
        # @!attribute [rw] change_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Time when change was made.
        # @!attribute [rw] actor_type
        #   @return [::Google::Analytics::Admin::V1alpha::ActorType]
        #     The type of actor that made this change.
        # @!attribute [rw] user_actor_email
        #   @return [::String]
        #     Email address of the Google account that made the change. This will be a
        #     valid email address if the actor field is set to USER, and empty otherwise.
        #     Google accounts that have been deleted will cause an error.
        # @!attribute [rw] changes_filtered
        #   @return [::Boolean]
        #     If true, then the list of changes returned was filtered, and does not
        #     represent all changes that occurred in this event.
        # @!attribute [rw] changes
        #   @return [::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryChange>]
        #     A list of changes made in this change history event that fit the filters
        #     specified in SearchChangeHistoryEventsRequest.
        class ChangeHistoryEvent
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # A description of a change to a single Google Analytics resource.
        # @!attribute [rw] resource
        #   @return [::String]
        #     Resource name of the resource whose changes are described by this entry.
        # @!attribute [rw] action
        #   @return [::Google::Analytics::Admin::V1alpha::ActionType]
        #     The type of action that changed this resource.
        # @!attribute [rw] resource_before_change
        #   @return [::Google::Analytics::Admin::V1alpha::ChangeHistoryChange::ChangeHistoryResource]
        #     Resource contents from before the change was made. If this resource was
        #     created in this change, this field will be missing.
        # @!attribute [rw] resource_after_change
        #   @return [::Google::Analytics::Admin::V1alpha::ChangeHistoryChange::ChangeHistoryResource]
        #     Resource contents from after the change was made. If this resource was
        #     deleted in this change, this field will be missing.
        class ChangeHistoryChange
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # A snapshot of a resource as before or after the result of a change in
          # change history.
          # @!attribute [rw] account
          #   @return [::Google::Analytics::Admin::V1alpha::Account]
          #     A snapshot of an Account resource in change history.
          # @!attribute [rw] property
          #   @return [::Google::Analytics::Admin::V1alpha::Property]
          #     A snapshot of a Property resource in change history.
          # @!attribute [rw] web_data_stream
          #   @return [::Google::Analytics::Admin::V1alpha::WebDataStream]
          #     A snapshot of a WebDataStream resource in change history.
          # @!attribute [rw] android_app_data_stream
          #   @return [::Google::Analytics::Admin::V1alpha::AndroidAppDataStream]
          #     A snapshot of an AndroidAppDataStream resource in change history.
          # @!attribute [rw] ios_app_data_stream
          #   @return [::Google::Analytics::Admin::V1alpha::IosAppDataStream]
          #     A snapshot of an IosAppDataStream resource in change history.
          # @!attribute [rw] firebase_link
          #   @return [::Google::Analytics::Admin::V1alpha::FirebaseLink]
          #     A snapshot of a FirebaseLink resource in change history.
          # @!attribute [rw] google_ads_link
          #   @return [::Google::Analytics::Admin::V1alpha::GoogleAdsLink]
          #     A snapshot of a GoogleAdsLink resource in change history.
          # @!attribute [rw] google_signals_settings
          #   @return [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
          #     A snapshot of a GoogleSignalsSettings resource in change history.
          # @!attribute [rw] conversion_event
          #   @return [::Google::Analytics::Admin::V1alpha::ConversionEvent]
          #     A snapshot of a ConversionEvent resource in change history.
          # @!attribute [rw] measurement_protocol_secret
          #   @return [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
          #     A snapshot of a MeasurementProtocolSecret resource in change history.
          # @!attribute [rw] custom_dimension
          #   @return [::Google::Analytics::Admin::V1alpha::CustomDimension]
          #     A snapshot of a CustomDimension resource in change history.
          # @!attribute [rw] custom_metric
          #   @return [::Google::Analytics::Admin::V1alpha::CustomMetric]
          #     A snapshot of a CustomMetric resource in change history.
          class ChangeHistoryResource
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end
        end

        # A conversion event in a Google Analytics property.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. Resource name of this conversion event.
        #     Format: properties/\\{property}/conversionEvents/\\{conversion_event}
        # @!attribute [rw] event_name
        #   @return [::String]
        #     Immutable. The event name for this conversion event.
        #     Examples: 'click', 'purchase'
        # @!attribute [r] create_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. Time when this conversion event was created in the property.
        # @!attribute [r] is_deletable
        #   @return [::Boolean]
        #     Output only. If set, this event can currently be deleted via DeleteConversionEvent.
        class ConversionEvent
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Settings values for Google Signals.  This is a singleton resource.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. Resource name of this setting.
        #     Format: properties/\\{property_id}/googleSignalsSettings
        #     Example: "properties/1000/googleSignalsSettings"
        # @!attribute [rw] state
        #   @return [::Google::Analytics::Admin::V1alpha::GoogleSignalsState]
        #     Status of this setting.
        # @!attribute [r] consent
        #   @return [::Google::Analytics::Admin::V1alpha::GoogleSignalsConsent]
        #     Output only. Terms of Service acceptance.
        class GoogleSignalsSettings
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # A definition for a CustomDimension.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. Resource name for this CustomDimension resource.
        #     Format: properties/\\{property}/customDimensions/\\{customDimension}
        # @!attribute [rw] parameter_name
        #   @return [::String]
        #     Required. Immutable. Tagging parameter name for this custom dimension.
        #
        #     If this is a user-scoped dimension, then this is the user property name.
        #     If this is an event-scoped dimension, then this is the event parameter
        #     name.
        #
        #     May only contain alphanumeric and underscore characters, starting with a
        #     letter. Max length of 24 characters for user-scoped dimensions, 40
        #     characters for event-scoped dimensions.
        # @!attribute [rw] display_name
        #   @return [::String]
        #     Required. Display name for this custom dimension as shown in the Analytics UI.
        #     Max length of 82 characters, alphanumeric plus space and underscore
        #     starting with a letter. Legacy system-generated display names may contain
        #     square brackets, but updates to this field will never permit square
        #     brackets.
        # @!attribute [rw] description
        #   @return [::String]
        #     Optional. Description for this custom dimension. Max length of 150 characters.
        # @!attribute [rw] scope
        #   @return [::Google::Analytics::Admin::V1alpha::CustomDimension::DimensionScope]
        #     Required. Immutable. The scope of this dimension.
        # @!attribute [rw] disallow_ads_personalization
        #   @return [::Boolean]
        #     Optional. If set to true, sets this dimension as NPA and excludes it from ads
        #     personalization.
        #
        #     This is currently only supported by user-scoped custom dimensions.
        class CustomDimension
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # Valid values for the scope of this dimension.
          module DimensionScope
            # Scope unknown or not specified.
            DIMENSION_SCOPE_UNSPECIFIED = 0

            # Dimension scoped to an event.
            EVENT = 1

            # Dimension scoped to a user.
            USER = 2
          end
        end

        # A definition for a custom metric.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. Resource name for this CustomMetric resource.
        #     Format: properties/\\{property}/customMetrics/\\{customMetric}
        # @!attribute [rw] parameter_name
        #   @return [::String]
        #     Required. Immutable. Tagging name for this custom metric.
        #
        #     If this is an event-scoped metric, then this is the event parameter
        #     name.
        #
        #     May only contain alphanumeric and underscore charactes, starting with a
        #     letter. Max length of 40 characters for event-scoped metrics.
        # @!attribute [rw] display_name
        #   @return [::String]
        #     Required. Display name for this custom metric as shown in the Analytics UI.
        #     Max length of 82 characters, alphanumeric plus space and underscore
        #     starting with a letter. Legacy system-generated display names may contain
        #     square brackets, but updates to this field will never permit square
        #     brackets.
        # @!attribute [rw] description
        #   @return [::String]
        #     Optional. Description for this custom dimension.
        #     Max length of 150 characters.
        # @!attribute [rw] measurement_unit
        #   @return [::Google::Analytics::Admin::V1alpha::CustomMetric::MeasurementUnit]
        #     Required. Immutable. The type for the custom metric's value.
        # @!attribute [rw] scope
        #   @return [::Google::Analytics::Admin::V1alpha::CustomMetric::MetricScope]
        #     Required. Immutable. The scope of this custom metric.
        class CustomMetric
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # Possible types of representing the custom metric's value.
          #
          # Currency representation may change in the future, requiring a breaking API
          # change.
          module MeasurementUnit
            # MeasurementUnit unspecified or missing.
            MEASUREMENT_UNIT_UNSPECIFIED = 0

            # This metric uses default units.
            STANDARD = 1

            # This metric measures a currency.
            CURRENCY = 2

            # This metric measures feet.
            FEET = 3

            # This metric measures meters.
            METERS = 4

            # This metric measures kilometers.
            KILOMETERS = 5

            # This metric measures miles.
            MILES = 6

            # This metric measures milliseconds.
            MILLISECONDS = 7

            # This metric measures seconds.
            SECONDS = 8

            # This metric measures minutes.
            MINUTES = 9

            # This metric measures hours.
            HOURS = 10
          end

          # The scope of this metric.
          module MetricScope
            # Scope unknown or not specified.
            METRIC_SCOPE_UNSPECIFIED = 0

            # Metric scoped to an event.
            EVENT = 1
          end
        end

        # Maximum access settings that Firebase user receive on the linked Analytics
        # property.
        module MaximumUserAccess
          # Unspecified maximum user access.
          MAXIMUM_USER_ACCESS_UNSPECIFIED = 0

          # Firebase users have no access to the Analytics property.
          NO_ACCESS = 1

          # Firebase users have Read & Analyze access to the Analytics property.
          READ_AND_ANALYZE = 2

          # Firebase users have edit access to the Analytics property, but may not
          # manage the Firebase link.
          EDITOR_WITHOUT_LINK_MANAGEMENT = 3

          # Firebase users have edit access to the Analytics property and may manage
          # the Firebase link.
          EDITOR_INCLUDING_LINK_MANAGEMENT = 4
        end

        # The category selected for this property, used for industry benchmarking.
        module IndustryCategory
          # Industry category unspecified
          INDUSTRY_CATEGORY_UNSPECIFIED = 0

          # Automotive
          AUTOMOTIVE = 1

          # Business and industrial markets
          BUSINESS_AND_INDUSTRIAL_MARKETS = 2

          # Finance
          FINANCE = 3

          # Healthcare
          HEALTHCARE = 4

          # Technology
          TECHNOLOGY = 5

          # Travel
          TRAVEL = 6

          # Other
          OTHER = 7

          # Arts and entertainment
          ARTS_AND_ENTERTAINMENT = 8

          # Beauty and fitness
          BEAUTY_AND_FITNESS = 9

          # Books and literature
          BOOKS_AND_LITERATURE = 10

          # Food and drink
          FOOD_AND_DRINK = 11

          # Games
          GAMES = 12

          # Hobbies and leisure
          HOBBIES_AND_LEISURE = 13

          # Home and garden
          HOME_AND_GARDEN = 14

          # Internet and telecom
          INTERNET_AND_TELECOM = 15

          # Law and government
          LAW_AND_GOVERNMENT = 16

          # News
          NEWS = 17

          # Online communities
          ONLINE_COMMUNITIES = 18

          # People and society
          PEOPLE_AND_SOCIETY = 19

          # Pets and animals
          PETS_AND_ANIMALS = 20

          # Real estate
          REAL_ESTATE = 21

          # Reference
          REFERENCE = 22

          # Science
          SCIENCE = 23

          # Sports
          SPORTS = 24

          # Jobs and education
          JOBS_AND_EDUCATION = 25

          # Shopping
          SHOPPING = 26
        end

        # Different kinds of actors that can make changes to Google Analytics
        # resources.
        module ActorType
          # Unknown or unspecified actor type.
          ACTOR_TYPE_UNSPECIFIED = 0

          # Changes made by the user specified in actor_email.
          USER = 1

          # Changes made by the Google Analytics system.
          SYSTEM = 2

          # Changes made by Google Analytics support team staff.
          SUPPORT = 3
        end

        # Types of actions that may change a resource.
        module ActionType
          # Action type unknown or not specified.
          ACTION_TYPE_UNSPECIFIED = 0

          # Resource was created in this change.
          CREATED = 1

          # Resource was updated in this change.
          UPDATED = 2

          # Resource was deleted in this change.
          DELETED = 3
        end

        # Types of resources whose changes may be returned from change history.
        module ChangeHistoryResourceType
          # Resource type unknown or not specified.
          CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED = 0

          # Account resource
          ACCOUNT = 1

          # Property resource
          PROPERTY = 2

          # WebDataStream resource
          WEB_DATA_STREAM = 3

          # AndroidAppDataStream resource
          ANDROID_APP_DATA_STREAM = 4

          # IosAppDataStream resource
          IOS_APP_DATA_STREAM = 5

          # FirebaseLink resource
          FIREBASE_LINK = 6

          # GoogleAdsLink resource
          GOOGLE_ADS_LINK = 7

          # GoogleSignalsSettings resource
          GOOGLE_SIGNALS_SETTINGS = 8

          # ConversionEvent resource
          CONVERSION_EVENT = 9

          # MeasurementProtocolSecret resource
          MEASUREMENT_PROTOCOL_SECRET = 10

          # CustomDimension resource
          CUSTOM_DIMENSION = 11

          # CustomMetric resource
          CUSTOM_METRIC = 12
        end

        # Status of the Google Signals settings (i.e., whether this feature has been
        # enabled for the property).
        module GoogleSignalsState
          # Google Signals status defaults to GOOGLE_SIGNALS_STATE_UNSPECIFIED to
          # represent that the user has not made an explicit choice.
          GOOGLE_SIGNALS_STATE_UNSPECIFIED = 0

          # Google Signals is enabled.
          GOOGLE_SIGNALS_ENABLED = 1

          # Google Signals is disabled.
          GOOGLE_SIGNALS_DISABLED = 2
        end

        # Consent field of the Google Signals settings (i.e., whether the user has
        # consented to the Google Signals terms of service.)
        module GoogleSignalsConsent
          # Google Signals consent value defaults to
          # GOOGLE_SIGNALS_CONSENT_UNSPECIFIED.  This will be treated as
          # GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED.
          GOOGLE_SIGNALS_CONSENT_UNSPECIFIED = 0

          # Terms of service have been accepted
          GOOGLE_SIGNALS_CONSENT_CONSENTED = 2

          # Terms of service have not been accepted
          GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED = 1
        end
      end
    end
  end
end