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.



1910
1911
1912
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1910

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) 


1833
1834
1835
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1833

def 
  @account
end

#create_time ⇒ String

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

Returns:

  • (String) 


1838
1839
1840
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1838

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) 


1844
1845
1846
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1844

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) 


1850
1851
1852
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1850

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) 


1856
1857
1858
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1856

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) 


1863
1864
1865
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1863

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) 


1868
1869
1870
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1868

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) 


1874
1875
1876
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1874

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) 


1881
1882
1883
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1881

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) 


1889
1890
1891
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1889

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) 


1894
1895
1896
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1894

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) 


1903
1904
1905
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1903

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) 


1908
1909
1910
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1908

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1915

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