Class: Google::Apis::AnalyticsV3::Segment

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

Overview

JSON template for an Analytics segment.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Segment

Returns a new instance of Segment.



4857
4858
4859
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4857

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

Instance Attribute Details

#created ⇒ DateTime

Time the segment was created. Corresponds to the JSON property created

Returns:

  • (DateTime) 


4815
4816
4817
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4815

def created
  @created
end

#definition ⇒ String

Segment definition. Corresponds to the JSON property definition

Returns:

  • (String) 


4820
4821
4822
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4820

def definition
  @definition
end

#id ⇒ String

Segment ID. Corresponds to the JSON property id

Returns:

  • (String) 


4825
4826
4827
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4825

def id
  @id
end

#kind ⇒ String

Resource type for Analytics segment. Corresponds to the JSON property kind

Returns:

  • (String) 


4830
4831
4832
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4830

def kind
  @kind
end

#name ⇒ String

Segment name. Corresponds to the JSON property name

Returns:

  • (String) 


4835
4836
4837
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4835

def name
  @name
end

#segment_id ⇒ String

Segment ID. Can be used with the 'segment' parameter in Core Reporting API. Corresponds to the JSON property segmentId

Returns:

  • (String) 


4840
4841
4842
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4840

def segment_id
  @segment_id
end

#self_link ⇒ String

Link for this segment. Corresponds to the JSON property selfLink

Returns:

  • (String) 


4845
4846
4847
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4845

def self_link
  @self_link
end

#type ⇒ String

Type for a segment. Possible values are "BUILT_IN" or "CUSTOM". Corresponds to the JSON property type

Returns:

  • (String) 


4850
4851
4852
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4850

def type
  @type
end

#updated ⇒ DateTime

Time the segment was last modified. Corresponds to the JSON property updated

Returns:

  • (DateTime) 


4855
4856
4857
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4855

def updated
  @updated
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4862

def update!(**args)
  @created = args[:created] if args.key?(:created)
  @definition = args[:definition] if args.key?(:definition)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @segment_id = args[:segment_id] if args.key?(:segment_id)
  @self_link = args[:self_link] if args.key?(:self_link)
  @type = args[:type] if args.key?(:type)
  @updated = args[:updated] if args.key?(:updated)
end