Class: Google::Apis::AnalyticsV3::CustomDimension

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

Overview

JSON template for Analytics Custom Dimension.

Defined Under Namespace

Classes: ParentLink

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CustomDimension

Returns a new instance of CustomDimension.



925
926
927
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 925

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

Instance Attribute Details

#account_id ⇒ String

Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


865
866
867
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 865

def 
  @account_id
end

#active ⇒ Boolean Also known as: active?

Boolean indicating whether the custom dimension is active. Corresponds to the JSON property active

Returns:

  • (Boolean) 


870
871
872
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 870

def active
  @active
end

#created ⇒ DateTime

Time the custom dimension was created. Corresponds to the JSON property created

Returns:

  • (DateTime) 


876
877
878
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 876

def created
  @created
end

#id ⇒ String

Custom dimension ID. Corresponds to the JSON property id

Returns:

  • (String) 


881
882
883
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 881

def id
  @id
end

#index ⇒ Fixnum

Index of the custom dimension. Corresponds to the JSON property index

Returns:

  • (Fixnum) 


886
887
888
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 886

def index
  @index
end

#kind ⇒ String

Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. Corresponds to the JSON property kind

Returns:

  • (String) 


892
893
894
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 892

def kind
  @kind
end

#name ⇒ String

Name of the custom dimension. Corresponds to the JSON property name

Returns:

  • (String) 


897
898
899
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 897

def name
  @name
end

#parent_link ⇒ Google::Apis::AnalyticsV3::CustomDimension::ParentLink

Parent link for the custom dimension. Points to the property to which the custom dimension belongs. Corresponds to the JSON property parentLink

Returns:



903
904
905
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 903

def parent_link
  @parent_link
end

#scope ⇒ String

Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. Corresponds to the JSON property scope

Returns:

  • (String) 


908
909
910
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 908

def scope
  @scope
end

#self_link ⇒ String

Link for the custom dimension Corresponds to the JSON property selfLink

Returns:

  • (String) 


913
914
915
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 913

def self_link
  @self_link
end

#updated ⇒ DateTime

Time the custom dimension was last modified. Corresponds to the JSON property updated

Returns:

  • (DateTime) 


918
919
920
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 918

def updated
  @updated
end

#web_property_id ⇒ String

Property ID. Corresponds to the JSON property webPropertyId

Returns:

  • (String) 


923
924
925
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 923

def web_property_id
  @web_property_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



930
931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 930

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @active = args[:active] if args.key?(:active)
  @created = args[:created] if args.key?(:created)
  @id = args[:id] if args.key?(:id)
  @index = args[:index] if args.key?(:index)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @parent_link = args[:parent_link] if args.key?(:parent_link)
  @scope = args[:scope] if args.key?(:scope)
  @self_link = args[:self_link] if args.key?(:self_link)
  @updated = args[:updated] if args.key?(:updated)
  @web_property_id = args[:web_property_id] if args.key?(:web_property_id)
end