list_goals: Lists goals which the user has access to

In jdeboer/RGA-1: A Google Analytics API Client

Description

Lists goals which the user has access to

Usage

list_goals(account.id = "~all", webproperty.id = "~all",
  profile.id = "~all", start.index = NULL, max.results = NULL, token)

Arguments

account.id	integer or character. The account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.
webproperty.id	character. Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. Requires specified account.id.
profile.id	ineger or character. View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to. Requires specified account.id and webproperty.id.
start.index	integer. An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
max.results	integer. The maximum number of goals to include in this response.
token	Token2.0 class object with a valid authorization data.

Value

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.

id	Goal ID (number).
account.id	Account ID which this goal belongs to.
webproperty.id	Web property ID which this goal belongs to. The web property ID is of the form UA-XXXXX-YY.
profile.id	View (Profile) ID to which this goal belongs.
name	Goal name.
value	Goal value.
active	Determines whether this goal is active.
type	Goal type. Acceptable values are: "EVENT", "URL_DESTINATION", "VISIT_NUM_PAGES", "VISIT_TIME_ON_SITE"
created	Time this goal was created.
updated	Time this goal was last modified.

References

Management API - Goals

See Also

authorize

Other Management API: get_custom_dimension; get_custom_metric; get_experiment; get_filter; get_goal; get_profile; get_unsampled_report; get_webproperty; list_accounts; list_custom_dimensions; list_custom_metrics; list_custom_sources; list_experiments; list_filters; list_profiles; list_segments; list_unsampled_reports; list_webproperties

jdeboer/RGA-1 documentation built on May 18, 2019, 11:29 p.m.