Class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/analyticsadmin_v1alpha/classes.rb,
lib/google/apis/analyticsadmin_v1alpha/representations.rb,
lib/google/apis/analyticsadmin_v1alpha/representations.rb

Overview

A resource message representing a Google Analytics GA4 property.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAnalyticsAdminV1alphaProperty

Returns a new instance of GoogleAnalyticsAdminV1alphaProperty.



3094
3095
3096
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3094

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#accountString

Immutable. The resource name of the parent account Format: accounts/ account_id Example: "accounts/123" Corresponds to the JSON property account

Returns:

  • (String)


3017
3018
3019
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3017

def 
  @account
end

#create_timeString

Output only. Time when the entity was originally created. Corresponds to the JSON property createTime

Returns:

  • (String)


3022
3023
3024
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3022

def create_time
  @create_time
end

#currency_codeString

The currency type used in reports involving monetary values. Format: https:// en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY" Corresponds to the JSON property currencyCode

Returns:

  • (String)


3028
3029
3030
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3028

def currency_code
  @currency_code
end

#delete_timeString

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. Corresponds to the JSON property deleteTime

Returns:

  • (String)


3034
3035
3036
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3034

def delete_time
  @delete_time
end

#display_nameString

Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. Corresponds to the JSON property displayName

Returns:

  • (String)


3040
3041
3042
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3040

def display_name
  @display_name
end

#expire_timeString

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. Corresponds to the JSON property expireTime

Returns:

  • (String)


3047
3048
3049
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3047

def expire_time
  @expire_time
end

#industry_categoryString

Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK Corresponds to the JSON property industryCategory

Returns:

  • (String)


3052
3053
3054
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3052

def industry_category
  @industry_category
end

#nameString

Output only. Resource name of this property. Format: properties/property_id Example: "properties/1000" Corresponds to the JSON property name

Returns:

  • (String)


3058
3059
3060
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3058

def name
  @name
end

#parentString

Immutable. Resource name of this property's logical parent. Note: The Property- Moving UI can be used to change the parent. Format: accounts/account, properties/property Example: "accounts/100", "properties/101" Corresponds to the JSON property parent

Returns:

  • (String)


3065
3066
3067
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3065

def parent
  @parent
end

#property_typeString

Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created via Google Analytics Admin API. Corresponds to the JSON property propertyType

Returns:

  • (String)


3073
3074
3075
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3073

def property_type
  @property_type
end

#service_levelString

Output only. The Google Analytics service level that applies to this property. Corresponds to the JSON property serviceLevel

Returns:

  • (String)


3078
3079
3080
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3078

def service_level
  @service_level
end

#time_zoneString

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" Corresponds to the JSON property timeZone

Returns:

  • (String)


3087
3088
3089
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3087

def time_zone
  @time_zone
end

#update_timeString

Output only. Time when entity payload fields were last updated. Corresponds to the JSON property updateTime

Returns:

  • (String)


3092
3093
3094
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3092

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3099

def update!(**args)
  @account = args[:account] if args.key?(:account)
  @create_time = args[:create_time] if args.key?(:create_time)
  @currency_code = args[:currency_code] if args.key?(:currency_code)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @industry_category = args[:industry_category] if args.key?(:industry_category)
  @name = args[:name] if args.key?(:name)
  @parent = args[:parent] if args.key?(:parent)
  @property_type = args[:property_type] if args.key?(:property_type)
  @service_level = args[:service_level] if args.key?(:service_level)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @update_time = args[:update_time] if args.key?(:update_time)
end