Class: Google::Apis::AnalyticsV3::Goal

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 Analytics goal resource.

Defined Under Namespace

Classes: EventDetails, ParentLink, UrlDestinationDetails, VisitNumPagesDetails, VisitTimeOnSiteDetails

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Goal

Returns a new instance of Goal



2883
2884
2885
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2883

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

Instance Attribute Details

#account_id ⇒ String

Account ID to which this goal belongs. Corresponds to the JSON property accountId

Returns:

  • (String) 


2792
2793
2794
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2792

def 
  @account_id
end

#active ⇒ Boolean Also known as: active?

Determines whether this goal is active. Corresponds to the JSON property active

Returns:

  • (Boolean) 


2797
2798
2799
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2797

def active
  @active
end

#created ⇒ DateTime

Time this goal was created. Corresponds to the JSON property created

Returns:

  • (DateTime) 


2803
2804
2805
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2803

def created
  @created
end

#event_details ⇒ Google::Apis::AnalyticsV3::Goal::EventDetails

Details for the goal of the type EVENT. Corresponds to the JSON property eventDetails

Returns:



2808
2809
2810
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2808

def event_details
  @event_details
end

#id ⇒ String

Goal ID. Corresponds to the JSON property id

Returns:

  • (String) 


2813
2814
2815
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2813

def id
  @id
end

#internal_web_property_id ⇒ String

Internal ID for the web property to which this goal belongs. Corresponds to the JSON property internalWebPropertyId

Returns:

  • (String) 


2818
2819
2820
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2818

def internal_web_property_id
  @internal_web_property_id
end

#kind ⇒ String

Resource type for an Analytics goal. Corresponds to the JSON property kind

Returns:

  • (String) 


2823
2824
2825
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2823

def kind
  @kind
end

#name ⇒ String

Goal name. Corresponds to the JSON property name

Returns:

  • (String) 


2828
2829
2830
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2828

def name
  @name
end

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

Parent link for a goal. Points to the view (profile) to which this goal belongs. Corresponds to the JSON property parentLink

Returns:



2834
2835
2836
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2834

def parent_link
  @parent_link
end

#profile_id ⇒ String

View (Profile) ID to which this goal belongs. Corresponds to the JSON property profileId

Returns:

  • (String) 


2839
2840
2841
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2839

def profile_id
  @profile_id
end

#self_link ⇒ String

Link for this goal. Corresponds to the JSON property selfLink

Returns:

  • (String) 


2844
2845
2846
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2844

def self_link
  @self_link
end

#type ⇒ String

Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT. Corresponds to the JSON property type

Returns:

  • (String) 


2850
2851
2852
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2850

def type
  @type
end

#updated ⇒ DateTime

Time this goal was last modified. Corresponds to the JSON property updated

Returns:

  • (DateTime) 


2855
2856
2857
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2855

def updated
  @updated
end

#url_destination_details ⇒ Google::Apis::AnalyticsV3::Goal::UrlDestinationDetails

Details for the goal of the type URL_DESTINATION. Corresponds to the JSON property urlDestinationDetails

Returns:



2860
2861
2862
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2860

def url_destination_details
  @url_destination_details
end

#value ⇒ Float

Goal value. Corresponds to the JSON property value

Returns:

  • (Float) 


2865
2866
2867
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2865

def value
  @value
end

#visit_num_pages_details ⇒ Google::Apis::AnalyticsV3::Goal::VisitNumPagesDetails

Details for the goal of the type VISIT_NUM_PAGES. Corresponds to the JSON property visitNumPagesDetails

Returns:



2870
2871
2872
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2870

def visit_num_pages_details
  @visit_num_pages_details
end

#visit_time_on_site_details ⇒ Google::Apis::AnalyticsV3::Goal::VisitTimeOnSiteDetails

Details for the goal of the type VISIT_TIME_ON_SITE. Corresponds to the JSON property visitTimeOnSiteDetails

Returns:



2875
2876
2877
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2875

def visit_time_on_site_details
  @visit_time_on_site_details
end

#web_property_id ⇒ String

Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY. Corresponds to the JSON property webPropertyId

Returns:

  • (String) 


2881
2882
2883
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2881

def web_property_id
  @web_property_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2888

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)
  @event_details = args[:event_details] if args.key?(:event_details)
  @id = args[:id] if args.key?(:id)
  @internal_web_property_id = args[:internal_web_property_id] if args.key?(:internal_web_property_id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @parent_link = args[:parent_link] if args.key?(:parent_link)
  @profile_id = args[:profile_id] if args.key?(:profile_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)
  @url_destination_details = args[:url_destination_details] if args.key?(:url_destination_details)
  @value = args[:value] if args.key?(:value)
  @visit_num_pages_details = args[:visit_num_pages_details] if args.key?(:visit_num_pages_details)
  @visit_time_on_site_details = args[:visit_time_on_site_details] if args.key?(:visit_time_on_site_details)
  @web_property_id = args[:web_property_id] if args.key?(:web_property_id)
end