list_profiles: Views (Profiles)

In artemklevtsov/RGA: A Google Analytics API V3 Client

Description

Lists views (profiles) to which the user has access.

Usage

list_profiles(accountId = "~all", webPropertyId = "~all",
  start.index = NULL, max.results = NULL, token)

Arguments

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

Value

The Profiles collection is a set of Profile resources, each of which describes the profile of an authenticated user.

id	View (Profile) ID.
kind	Resource type for Analytics view (profile).
accountId	Account ID to which this view (profile) belongs.
webPropertyId	Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
internalWebPropertyId	Internal ID for the web property to which this view (profile) belongs.
name	Name of this view (profile).
currency	The currency type associated with this view (profile), defaults to USD. The supported values are: USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
timezone	Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
websiteUrl	Website URL for this view (profile).
defaultPage	Default page for this view (profile).
excludeQueryParameters	The query parameters that are excluded from this view (profile).
siteSearchQueryParameters	The site search query parameters for this view (profile).
stripSiteSearchQueryParameters	Whether or not Analytics will strip search query parameters from the URLs in your reports.
siteSearchCategoryParameters	Site search category parameters for this view (profile).
stripSiteSearchCategoryParameters	Whether or not Analytics will strip search category parameters from the URLs in your reports.
type	View (Profile) type. Supported types: WEB or APP.
permissions	Permissions the user has for this view (profile).
created	Time this view (profile) was created.
updated	Time this view (profile) was last modified.
eCommerceTracking	Indicates whether ecommerce tracking is enabled for this view (profile).
enhancedECommerceTracking	Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. This property cannot be set on insert.
botFilteringEnabled	Indicates whether bot filtering is enabled for this view (profile).
starred	Indicates whether this view (profile) is starred or not.
permissions	All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.

References

Management API - Views (Profiles) Overview

See Also

Other Management API: get_custom_dimension, get_custom_metric, get_experiment, get_filter, get_goal, get_profile, get_remarketing_audience, get_unsampled_report, get_upload, get_webproperty, list_accounts, list_custom_data_sources, list_custom_dimensions, list_custom_metrics, list_experiments, list_filters, list_goals, list_remarketing_audiences, list_segments, list_unsampled_reports, list_uploads, list_webproperties

artemklevtsov/RGA documentation built on May 10, 2019, 1:50 p.m.