get_filter: Gets a filter to which the user has access to

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

Description

Gets a filter to which the user has access to

Usage

get_filter(account.id, filter.id, token)

Arguments

account.id	integer or character. Account ID to retrieve filters for.
filter.id	integer or character. Filter ID to retrieve filters for.
token	Token2.0 class object with a valid authorization data.

Value

An Analytics account filter.

id	Filter ID.
kind	Resource type for Analytics filter.
self.link	Link for this filter.
account.id	Account ID to which this filter belongs.
name	Name of this filter.
type	Type of this filter.
created	Time this filter was created.
updated	Time this filter was last modified.
parent.link.type	Value is "analytics#account".
parent.link.href	Link to the account to which this filter belongs.
include.details.kind	Kind value for filter expression
include.details.field	Field to filter.
include.details.match.type	Match type for this filter.
include.details.expression.value	Filter expression value
include.details.case.sensitive	Determines if the filter is case sensitive.
exclude.details.kind	Kind value for filter expression
exclude.details.field	Field to filter.
exclude.details.match.type	Match type for this filter.
exclude.details.expression.value	Filter expression value
exclude.details.case.sensitive	Determines if the filter is case sensitive.
lowercase.details.field	Field to use in the filter.
uppercase.details.field	Field to use in the filter.
search.and.replace.details.field	Field to use in the filter.
search.and.replace.details.search.string	Term to search.
search.and.replace.details.replace.string	Term to replace the search term with.
search.and.replace.details.case.sensitive	Determines if the filter is case sensitive.
advanced.details.field.a	Field A.
advanced.details.extract.a	Expression to extract from field A.
advanced.details.field.b	Field B.
advanced.details.extract.b	Expression to extract from field B.
advanced.details.output.to.field	Output field.
advanced.details.output.constructor	Expression used to construct the output value.
advanced.details.field.aRequired	Indicates if field A is required to match.
advanced.details.field.bRequired	Indicates if field B is required to match.
advanced.details.override.output.field	Indicates if the existing value of the output field, if any, should be overridden by the output expression.
advanced.details.case.sensitive	Indicates if the filter expressions are case sensitive.

References

Management API - Filters

See Also

authorize

Other Management API: get_custom_dimension; get_custom_metric; get_experiment; 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_goals; list_profiles; list_segments; list_unsampled_reports; list_webproperties

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