Class: Google::Apis::AnalyticsV3::Goals
- Inherits:
-
Object
- Object
- Google::Apis::AnalyticsV3::Goals
- 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
A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.
Instance Attribute Summary collapse
-
#items ⇒ Array<Google::Apis::AnalyticsV3::Goal>
A list of goals.
-
#items_per_page ⇒ Fixnum
The maximum number of resources the response can contain, regardless of the actual number of resources returned.
-
#kind ⇒ String
Collection type.
-
#next_link ⇒ String
Link to next page for this goal collection.
-
#previous_link ⇒ String
Link to previous page for this goal collection.
-
#start_index ⇒ Fixnum
The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
-
#total_results ⇒ Fixnum
The total number of results for the query, regardless of the number of resources in the result.
-
#username ⇒ String
Email ID of the authenticated user Corresponds to the JSON property
username
.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Goals
constructor
A new instance of Goals.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Goals
Returns a new instance of Goals.
3179 3180 3181 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 3179 def initialize(**args) update!(**args) end |
Instance Attribute Details
#items ⇒ Array<Google::Apis::AnalyticsV3::Goal>
A list of goals.
Corresponds to the JSON property items
3137 3138 3139 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 3137 def items @items end |
#items_per_page ⇒ Fixnum
The maximum number of resources the response can contain, regardless of the
actual number of resources returned. Its value ranges from 1 to 1000 with a
value of 1000 by default, or otherwise specified by the max-results query
parameter.
Corresponds to the JSON property itemsPerPage
3145 3146 3147 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 3145 def items_per_page @items_per_page end |
#kind ⇒ String
Collection type.
Corresponds to the JSON property kind
3150 3151 3152 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 3150 def kind @kind end |
#next_link ⇒ String
Link to next page for this goal collection.
Corresponds to the JSON property nextLink
3155 3156 3157 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 3155 def next_link @next_link end |
#previous_link ⇒ String
Link to previous page for this goal collection.
Corresponds to the JSON property previousLink
3160 3161 3162 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 3160 def previous_link @previous_link end |
#start_index ⇒ Fixnum
The starting index of the resources, which is 1 by default or otherwise
specified by the start-index query parameter.
Corresponds to the JSON property startIndex
3166 3167 3168 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 3166 def start_index @start_index end |
#total_results ⇒ Fixnum
The total number of results for the query, regardless of the number of
resources in the result.
Corresponds to the JSON property totalResults
3172 3173 3174 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 3172 def total_results @total_results end |
#username ⇒ String
Email ID of the authenticated user
Corresponds to the JSON property username
3177 3178 3179 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 3177 def username @username end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 3184 def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) @username = args[:username] if args.key?(:username) end |