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.



3341
3342
3343
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3341

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

Instance Attribute Details

#account ⇒ String

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

Returns:

  • (String) 


3264
3265
3266
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3264

def 
  @account
end

#create_time ⇒ String

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

Returns:

  • (String) 


3269
3270
3271
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3269

def create_time
  @create_time
end

#currency_code ⇒ String

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) 


3275
3276
3277
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3275

def currency_code
  @currency_code
end

#delete_time ⇒ String

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) 


3281
3282
3283
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3281

def delete_time
  @delete_time
end

#display_name ⇒ String

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) 


3287
3288
3289
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3287

def display_name
  @display_name
end

#expire_time ⇒ String

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) 


3294
3295
3296
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3294

def expire_time
  @expire_time
end

#industry_category ⇒ String

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

Returns:

  • (String) 


3299
3300
3301
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3299

def industry_category
  @industry_category
end

#name ⇒ String

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

Returns:

  • (String) 


3305
3306
3307
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3305

def name
  @name
end

#parent ⇒ 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, properties/property Example: "accounts/100", "properties/101" Corresponds to the JSON property parent

Returns:

  • (String) 


3312
3313
3314
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3312

def parent
  @parent
end

#property_type ⇒ String

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) 


3320
3321
3322
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3320

def property_type
  @property_type
end

#service_level ⇒ String

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

Returns:

  • (String) 


3325
3326
3327
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3325

def service_level
  @service_level
end

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

Returns:

  • (String) 


3334
3335
3336
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3334

def time_zone
  @time_zone
end

#update_time ⇒ String

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

Returns:

  • (String) 


3339
3340
3341
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3339

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3346

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