| Package | com.google.analytics.v4 |
| Class | public class Configuration |
| Property | Defined by | ||
|---|---|---|---|
| allowAnchor : Boolean = false
Enable use of anchors for campaigns.
| Configuration | ||
| allowDomainHash : Boolean = true
Unique domain hash for cookies.
| Configuration | ||
| allowLinker : Boolean = false
Enable linker functionality.
| Configuration | ||
| allowLocalTracking : Boolean = true
To be able to track in local mode (when protocol is file://)
| Configuration | ||
| bucketCapacity : Number = 10
Capacity of the token bucket.
| Configuration | ||
| campaignKey : CampaignKey
The campaign key value of the application.
| Configuration | ||
| campaignTracking : Boolean = true
Track campaign information flag.
| Configuration | ||
| conversionTimeout : Number
Default cookie expiration time in seconds.
| Configuration | ||
| cookieName : String [read-only]
Indicates the name of the cookie.
| Configuration | ||
| cookiePath : String = "/"
Default cookie path to set in document header.
| Configuration | ||
| detectClientInfo : Boolean = true
Detect client browser information flag.
| Configuration | ||
| detectFlash : Boolean = true
Flash version detection option.
| Configuration | ||
| detectTitle : Boolean = true
Set document title detection option.
| Configuration | ||
| domain : Domain
[read-only]
Domain name for cookies.
| Configuration | ||
| domainName : String = ""
The domain name value.
| Configuration | ||
| hasSiteOverlay : Boolean = false
Indicates if has site overlay.
| Configuration | ||
| idleLoop : Number = 30
Default idle timer loop time in seconds (30 seconds).
| Configuration | ||
| idleTimeout : Number = 60
Default idle timer inactivity time in seconds (1 minute).
| Configuration | ||
| isTrackOutboundSubdomains : Boolean = false
Boolean flag to indicate if outbound links for subdomains of the current domain
needs to be considered as outbound links.
| Configuration | ||
| localGIFpath : String = "/__utm.gif"
Local service mode GIF url.
| Configuration | ||
| maxOutboundLinkExamined : Number = 1000
Upper limit for number of href anchor tags to examine.
| Configuration | ||
| organic : Organic
[read-only]
Indicates the Organic reference.
| Configuration | ||
| remoteGIFpath : String = "http://www.google-analytics.com/__utm.gif"
The remote service mode GIF url.
| Configuration | ||
| sampleRate : Number
Indicates the sample rate value of the application.
| Configuration | ||
| secureRemoteGIFpath : String = "https://ssl.google-analytics.com/__utm.gif"
The secure remote service mode GIF url.
| Configuration | ||
| serverMode : ServerOperationMode
Actual service model.
| Configuration | ||
| sessionTimeout : Number
Default inactive session timeout in seconds (30 minutes).
| Configuration | ||
| tokenCliff : int = 10
The number of tokens available at the start of the session.
| Configuration | ||
| tokenRate : Number = 0.20
The rate of token being released into the token bucket.
| Configuration | ||
| trackingLimitPerSession : int [read-only]
This is the max number of tracking requests to the backend
allowed per session.
| Configuration | ||
| transactionFieldDelim : String = "|"
Delimiter for e-commerce transaction fields.
| Configuration | ||
| version : String [read-only]
Indicates the version String representation of the application.
| Configuration | ||
| Method | Defined by | ||
|---|---|---|---|
|
Configuration(debug:DebugConfiguration = null)
Creates a new Configuration instance.
| Configuration | ||
|
addOrganicSource(engine:String, keyword:String):void
Adds a new organic source.
| Configuration | ||
| allowAnchor | property |
public var allowAnchor:Boolean = falseEnable use of anchors for campaigns.
| allowDomainHash | property |
public var allowDomainHash:Boolean = trueUnique domain hash for cookies.
| allowLinker | property |
public var allowLinker:Boolean = falseEnable linker functionality.
| allowLocalTracking | property |
public var allowLocalTracking:Boolean = trueTo be able to track in local mode (when protocol is file://)
| bucketCapacity | property |
public var bucketCapacity:Number = 10Capacity of the token bucket.
| campaignKey | property |
| campaignTracking | property |
public var campaignTracking:Boolean = trueTrack campaign information flag.
| conversionTimeout | property |
public var conversionTimeout:NumberDefault cookie expiration time in seconds. (6 months).
| cookieName | property |
cookieName:String [read-only]Indicates the name of the cookie.
Implementation public function get cookieName():String
| cookiePath | property |
public var cookiePath:String = "/"Default cookie path to set in document header.
| detectClientInfo | property |
public var detectClientInfo:Boolean = trueDetect client browser information flag.
| detectFlash | property |
public var detectFlash:Boolean = trueFlash version detection option.
| detectTitle | property |
public var detectTitle:Boolean = trueSet document title detection option.
| domain | property |
domain:Domain [read-only]Domain name for cookies. (auto | none | domain) If this variable is set to "auto", then we will try to resolve the domain name based on the HTMLDocument object. note: for Flash we try to auto detect the domain name by using the URL info if we are in HTTP or HTTPS if we can not detect the protocol or find file:// then the "auto" domain is none.
Implementation public function get domain():Domain
| domainName | property |
public var domainName:String = ""The domain name value.
| hasSiteOverlay | property |
public var hasSiteOverlay:Boolean = falseIndicates if has site overlay.
| idleLoop | property |
public var idleLoop:Number = 30Default idle timer loop time in seconds (30 seconds).
| idleTimeout | property |
public var idleTimeout:Number = 60Default idle timer inactivity time in seconds (1 minute).
| isTrackOutboundSubdomains | property |
public var isTrackOutboundSubdomains:Boolean = falseBoolean flag to indicate if outbound links for subdomains of the current domain needs to be considered as outbound links. Default value is false.
| localGIFpath | property |
public var localGIFpath:String = "/__utm.gif"Local service mode GIF url.
| maxOutboundLinkExamined | property |
public var maxOutboundLinkExamined:Number = 1000Upper limit for number of href anchor tags to examine.
If this number is set to -1, then we will examine all the href anchor tags.
In other words, a -1 value indicates that there is no upper limit.
Note: maybe use Number.INFINITY instead of -1
| organic | property |
organic:Organic [read-only]Indicates the Organic reference.
Implementation public function get organic():Organic
| remoteGIFpath | property |
public var remoteGIFpath:String = "http://www.google-analytics.com/__utm.gif"The remote service mode GIF url.
| sampleRate | property |
sampleRate:Number [read-write]Indicates the sample rate value of the application.
Implementation public function get sampleRate():Number
public function set sampleRate(value:Number):void
| secureRemoteGIFpath | property |
public var secureRemoteGIFpath:String = "https://ssl.google-analytics.com/__utm.gif"The secure remote service mode GIF url.
| serverMode | property |
public var serverMode:ServerOperationModeActual service model.
Note : "service" is wrong we name it server
| sessionTimeout | property |
public var sessionTimeout:NumberDefault inactive session timeout in seconds (30 minutes).
| tokenCliff | property |
public var tokenCliff:int = 10The number of tokens available at the start of the session.
| tokenRate | property |
public var tokenRate:Number = 0.20The rate of token being released into the token bucket. Unit for this parameter is number of token released per second. This is set to 0.20 right now, which translates to 1 token released every 5 seconds.
| trackingLimitPerSession | property |
trackingLimitPerSession:int [read-only]This is the max number of tracking requests to the backend allowed per session.
Implementation public function get trackingLimitPerSession():int
| transactionFieldDelim | property |
public var transactionFieldDelim:String = "|"Delimiter for e-commerce transaction fields.
| version | property |
version:String [read-only]Indicates the version String representation of the application.
Implementation public function get version():String
| Configuration | () | constructor |
public function Configuration(debug:DebugConfiguration = null)Creates a new Configuration instance.
Parametersdebug:DebugConfiguration (default = null) |
| addOrganicSource | () | method |
public function addOrganicSource(engine:String, keyword:String):voidAdds a new organic source.
Parametersengine:String — The engine value.
|
|
keyword:String — The keyword of the specified engine value.
|