com.google.api.services.analytics.model

Class Profile

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.analytics.model.Profile

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class Profile
extends com.google.api.client.json.GenericJson

JSON template for an Analytics view (profile).

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Analytics API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Profile.ChildLink Child link for this view (profile).
static class	Profile.ParentLink Parent link for this view (profile).
static class	Profile.Permissions Permissions the user has for this view (profile).

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Profile()

Method Summary

Modifier and Type	Method and Description
Profile	clone()
java.lang.String	getAccountId() Account ID to which this view (profile) belongs.
java.lang.Boolean	getBotFilteringEnabled() Indicates whether bot filtering is enabled for this view (profile).
Profile.ChildLink	getChildLink() Child link for this view (profile).
com.google.api.client.util.DateTime	getCreated() Time this view (profile) was created.
java.lang.String	getCurrency() The currency type associated with this view (profile), defaults to USD.
java.lang.String	getDefaultPage() Default page for this view (profile).
java.lang.Boolean	getECommerceTracking() Indicates whether ecommerce tracking is enabled for this view (profile).
java.lang.Boolean	getEnhancedECommerceTracking() Indicates whether enhanced ecommerce tracking is enabled for this view (profile).
java.lang.String	getExcludeQueryParameters() The query parameters that are excluded from this view (profile).
java.lang.String	getId() View (Profile) ID.
java.lang.String	getInternalWebPropertyId() Internal ID for the web property to which this view (profile) belongs.
java.lang.String	getKind() Resource type for Analytics view (profile).
java.lang.String	getName() Name of this view (profile).
Profile.ParentLink	getParentLink() Parent link for this view (profile).
Profile.Permissions	getPermissions() Permissions the user has for this view (profile).
java.lang.String	getSelfLink() Link for this view (profile).
java.lang.String	getSiteSearchCategoryParameters() Site search category parameters for this view (profile).
java.lang.String	getSiteSearchQueryParameters() The site search query parameters for this view (profile).
java.lang.Boolean	getStarred() Indicates whether this view (profile) is starred or not.
java.lang.Boolean	getStripSiteSearchCategoryParameters() Whether or not Analytics will strip search category parameters from the URLs in your reports.
java.lang.Boolean	getStripSiteSearchQueryParameters() Whether or not Analytics will strip search query parameters from the URLs in your reports.
java.lang.String	getTimezone() Time zone for which this view (profile) has been configured.
java.lang.String	getType() View (Profile) type.
com.google.api.client.util.DateTime	getUpdated() Time this view (profile) was last modified.
java.lang.String	getWebPropertyId() Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
java.lang.String	getWebsiteUrl() Website URL for this view (profile).
Profile	set(java.lang.String fieldName, java.lang.Object value)
Profile	setAccountId(java.lang.String accountId) Account ID to which this view (profile) belongs.
Profile	setBotFilteringEnabled(java.lang.Boolean botFilteringEnabled) Indicates whether bot filtering is enabled for this view (profile).
Profile	setChildLink(Profile.ChildLink childLink) Child link for this view (profile).
Profile	setCreated(com.google.api.client.util.DateTime created) Time this view (profile) was created.
Profile	setCurrency(java.lang.String currency) The currency type associated with this view (profile), defaults to USD.
Profile	setDefaultPage(java.lang.String defaultPage) Default page for this view (profile).
Profile	setECommerceTracking(java.lang.Boolean eCommerceTracking) Indicates whether ecommerce tracking is enabled for this view (profile).
Profile	setEnhancedECommerceTracking(java.lang.Boolean enhancedECommerceTracking) Indicates whether enhanced ecommerce tracking is enabled for this view (profile).
Profile	setExcludeQueryParameters(java.lang.String excludeQueryParameters) The query parameters that are excluded from this view (profile).
Profile	setId(java.lang.String id) View (Profile) ID.
Profile	setInternalWebPropertyId(java.lang.String internalWebPropertyId) Internal ID for the web property to which this view (profile) belongs.
Profile	setKind(java.lang.String kind) Resource type for Analytics view (profile).
Profile	setName(java.lang.String name) Name of this view (profile).
Profile	setParentLink(Profile.ParentLink parentLink) Parent link for this view (profile).
Profile	setPermissions(Profile.Permissions permissions) Permissions the user has for this view (profile).
Profile	setSelfLink(java.lang.String selfLink) Link for this view (profile).
Profile	setSiteSearchCategoryParameters(java.lang.String siteSearchCategoryParameters) Site search category parameters for this view (profile).
Profile	setSiteSearchQueryParameters(java.lang.String siteSearchQueryParameters) The site search query parameters for this view (profile).
Profile	setStarred(java.lang.Boolean starred) Indicates whether this view (profile) is starred or not.
Profile	setStripSiteSearchCategoryParameters(java.lang.Boolean stripSiteSearchCategoryParameters) Whether or not Analytics will strip search category parameters from the URLs in your reports.
Profile	setStripSiteSearchQueryParameters(java.lang.Boolean stripSiteSearchQueryParameters) Whether or not Analytics will strip search query parameters from the URLs in your reports.
Profile	setTimezone(java.lang.String timezone) Time zone for which this view (profile) has been configured.
Profile	setType(java.lang.String type) View (Profile) type.
Profile	setUpdated(com.google.api.client.util.DateTime updated) Time this view (profile) was last modified.
Profile	setWebPropertyId(java.lang.String webPropertyId) Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
Profile	setWebsiteUrl(java.lang.String websiteUrl) Website URL for this view (profile).

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Profile

public Profile()

Method Detail

getAccountId

public java.lang.String getAccountId()

Account ID to which this view (profile) belongs.

Returns:

value or null for none

setAccountId

public Profile setAccountId(java.lang.String accountId)

Account ID to which this view (profile) belongs.

Parameters:

accountId - accountId or null for none

getBotFilteringEnabled

public java.lang.Boolean getBotFilteringEnabled()

Indicates whether bot filtering is enabled for this view (profile).

Returns:

value or null for none

setBotFilteringEnabled

public Profile setBotFilteringEnabled(java.lang.Boolean botFilteringEnabled)

Indicates whether bot filtering is enabled for this view (profile).

Parameters:

botFilteringEnabled - botFilteringEnabled or null for none

getChildLink

public Profile.ChildLink getChildLink()

Child link for this view (profile). Points to the list of goals for this view (profile).

Returns:

value or null for none

setChildLink

public Profile setChildLink(Profile.ChildLink childLink)

Child link for this view (profile). Points to the list of goals for this view (profile).

Parameters:

childLink - childLink or null for none

getCreated

public com.google.api.client.util.DateTime getCreated()

Time this view (profile) was created.

Returns:

value or null for none

setCreated

public Profile setCreated(com.google.api.client.util.DateTime created)

Time this view (profile) was created.

Parameters:

created - created or null for none

getCurrency

public java.lang.String getCurrency()

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

Returns:

value or null for none

setCurrency

public Profile setCurrency(java.lang.String 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

Parameters:

currency - currency or null for none

getDefaultPage

public java.lang.String getDefaultPage()

Default page for this view (profile).

Returns:

value or null for none

setDefaultPage

public Profile setDefaultPage(java.lang.String defaultPage)

Default page for this view (profile).

Parameters:

defaultPage - defaultPage or null for none

getECommerceTracking

public java.lang.Boolean getECommerceTracking()

Indicates whether ecommerce tracking is enabled for this view (profile).

Returns:

value or null for none

setECommerceTracking

public Profile setECommerceTracking(java.lang.Boolean eCommerceTracking)

Indicates whether ecommerce tracking is enabled for this view (profile).

Parameters:

eCommerceTracking - eCommerceTracking or null for none

getEnhancedECommerceTracking

public java.lang.Boolean getEnhancedECommerceTracking()

Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.

Returns:

value or null for none

setEnhancedECommerceTracking

public Profile setEnhancedECommerceTracking(java.lang.Boolean enhancedECommerceTracking)

Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.

Parameters:

enhancedECommerceTracking - enhancedECommerceTracking or null for none

getExcludeQueryParameters

public java.lang.String getExcludeQueryParameters()

The query parameters that are excluded from this view (profile).

Returns:

value or null for none

setExcludeQueryParameters

public Profile setExcludeQueryParameters(java.lang.String excludeQueryParameters)

The query parameters that are excluded from this view (profile).

Parameters:

excludeQueryParameters - excludeQueryParameters or null for none

getId

public java.lang.String getId()

View (Profile) ID.

Returns:

value or null for none

setId

public Profile setId(java.lang.String id)

View (Profile) ID.

Parameters:

id - id or null for none

getInternalWebPropertyId

public java.lang.String getInternalWebPropertyId()

Internal ID for the web property to which this view (profile) belongs.

Returns:

value or null for none

setInternalWebPropertyId

public Profile setInternalWebPropertyId(java.lang.String internalWebPropertyId)

Internal ID for the web property to which this view (profile) belongs.

Parameters:

internalWebPropertyId - internalWebPropertyId or null for none

getKind

public java.lang.String getKind()

Resource type for Analytics view (profile).

Returns:

value or null for none

setKind

public Profile setKind(java.lang.String kind)

Resource type for Analytics view (profile).

Parameters:

kind - kind or null for none

getName

public java.lang.String getName()

Name of this view (profile).

Returns:

value or null for none

setName

public Profile setName(java.lang.String name)

Name of this view (profile).

Parameters:

name - name or null for none

getParentLink

public Profile.ParentLink getParentLink()

Parent link for this view (profile). Points to the web property to which this view (profile) belongs.

Returns:

value or null for none

setParentLink

public Profile setParentLink(Profile.ParentLink parentLink)

Parent link for this view (profile). Points to the web property to which this view (profile) belongs.

Parameters:

parentLink - parentLink or null for none

getPermissions

public Profile.Permissions getPermissions()

Permissions the user has for this view (profile).

Returns:

value or null for none

setPermissions

public Profile setPermissions(Profile.Permissions permissions)

Permissions the user has for this view (profile).

Parameters:

permissions - permissions or null for none

getSelfLink

public java.lang.String getSelfLink()

Link for this view (profile).

Returns:

value or null for none

setSelfLink

public Profile setSelfLink(java.lang.String selfLink)

Link for this view (profile).

Parameters:

selfLink - selfLink or null for none

getSiteSearchCategoryParameters

public java.lang.String getSiteSearchCategoryParameters()

Site search category parameters for this view (profile).

Returns:

value or null for none

setSiteSearchCategoryParameters

public Profile setSiteSearchCategoryParameters(java.lang.String siteSearchCategoryParameters)

Site search category parameters for this view (profile).

Parameters:

siteSearchCategoryParameters - siteSearchCategoryParameters or null for none

getSiteSearchQueryParameters

public java.lang.String getSiteSearchQueryParameters()

The site search query parameters for this view (profile).

Returns:

value or null for none

setSiteSearchQueryParameters

public Profile setSiteSearchQueryParameters(java.lang.String siteSearchQueryParameters)

The site search query parameters for this view (profile).

Parameters:

siteSearchQueryParameters - siteSearchQueryParameters or null for none

getStarred

public java.lang.Boolean getStarred()

Indicates whether this view (profile) is starred or not.

Returns:

value or null for none

setStarred

public Profile setStarred(java.lang.Boolean starred)

Indicates whether this view (profile) is starred or not.

Parameters:

starred - starred or null for none

getStripSiteSearchCategoryParameters

public java.lang.Boolean getStripSiteSearchCategoryParameters()

Whether or not Analytics will strip search category parameters from the URLs in your reports.

Returns:

value or null for none

setStripSiteSearchCategoryParameters

public Profile setStripSiteSearchCategoryParameters(java.lang.Boolean stripSiteSearchCategoryParameters)

Whether or not Analytics will strip search category parameters from the URLs in your reports.

Parameters:

stripSiteSearchCategoryParameters - stripSiteSearchCategoryParameters or null for none

getStripSiteSearchQueryParameters

public java.lang.Boolean getStripSiteSearchQueryParameters()

Whether or not Analytics will strip search query parameters from the URLs in your reports.

Returns:

value or null for none

setStripSiteSearchQueryParameters

public Profile setStripSiteSearchQueryParameters(java.lang.Boolean stripSiteSearchQueryParameters)

Whether or not Analytics will strip search query parameters from the URLs in your reports.

Parameters:

stripSiteSearchQueryParameters - stripSiteSearchQueryParameters or null for none

getTimezone

public java.lang.String getTimezone()

Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.

Returns:

value or null for none

setTimezone

public Profile setTimezone(java.lang.String timezone)

Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.

Parameters:

timezone - timezone or null for none

getType

public java.lang.String getType()

View (Profile) type. Supported types: WEB or APP.

Returns:

value or null for none

setType

public Profile setType(java.lang.String type)

View (Profile) type. Supported types: WEB or APP.

Parameters:

type - type or null for none

getUpdated

public com.google.api.client.util.DateTime getUpdated()

Time this view (profile) was last modified.

Returns:

value or null for none

setUpdated

public Profile setUpdated(com.google.api.client.util.DateTime updated)

Time this view (profile) was last modified.

Parameters:

updated - updated or null for none

getWebPropertyId

public java.lang.String getWebPropertyId()

Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

Returns:

value or null for none

setWebPropertyId

public Profile setWebPropertyId(java.lang.String webPropertyId)

Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

Parameters:

webPropertyId - webPropertyId or null for none

getWebsiteUrl

public java.lang.String getWebsiteUrl()

Website URL for this view (profile).

Returns:

value or null for none

setWebsiteUrl

public Profile setWebsiteUrl(java.lang.String websiteUrl)

Website URL for this view (profile).

Parameters:

websiteUrl - websiteUrl or null for none

set

public Profile set(java.lang.String fieldName,
                   java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Profile clone()

Overrides:

clone in class com.google.api.client.json.GenericJson