target.apidocs.com.google.api.services.analytics.model.Profile.html Maven / Gradle / Ivy
Profile (Google Analytics API v3-rev20190807-1.31.0)
com.google.api.services.analytics.model
Class Profile
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.analytics.model.Profile
-
public final class Profile
extends 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
GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
Profile()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Profile
clone()
String
getAccountId()
Account ID to which this view (profile) belongs.
Boolean
getBotFilteringEnabled()
Indicates whether bot filtering is enabled for this view (profile).
Profile.ChildLink
getChildLink()
Child link for this view (profile).
DateTime
getCreated()
Time this view (profile) was created.
String
getCurrency()
The currency type associated with this view (profile), defaults to USD.
String
getDefaultPage()
Default page for this view (profile).
Boolean
getECommerceTracking()
Indicates whether ecommerce tracking is enabled for this view (profile).
Boolean
getEnhancedECommerceTracking()
Indicates whether enhanced ecommerce tracking is enabled for this view (profile).
String
getExcludeQueryParameters()
The query parameters that are excluded from this view (profile).
String
getId()
View (Profile) ID.
String
getInternalWebPropertyId()
Internal ID for the web property to which this view (profile) belongs.
String
getKind()
Resource type for Analytics view (profile).
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).
String
getSelfLink()
Link for this view (profile).
String
getSiteSearchCategoryParameters()
Site search category parameters for this view (profile).
String
getSiteSearchQueryParameters()
The site search query parameters for this view (profile).
Boolean
getStarred()
Indicates whether this view (profile) is starred or not.
Boolean
getStripSiteSearchCategoryParameters()
Whether or not Analytics will strip search category parameters from the URLs in your reports.
Boolean
getStripSiteSearchQueryParameters()
Whether or not Analytics will strip search query parameters from the URLs in your reports.
String
getTimezone()
Time zone for which this view (profile) has been configured.
String
getType()
View (Profile) type.
DateTime
getUpdated()
Time this view (profile) was last modified.
String
getWebPropertyId()
Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
String
getWebsiteUrl()
Website URL for this view (profile).
Profile
set(String fieldName,
Object value)
Profile
setAccountId(String accountId)
Account ID to which this view (profile) belongs.
Profile
setBotFilteringEnabled(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(DateTime created)
Time this view (profile) was created.
Profile
setCurrency(String currency)
The currency type associated with this view (profile), defaults to USD.
Profile
setDefaultPage(String defaultPage)
Default page for this view (profile).
Profile
setECommerceTracking(Boolean eCommerceTracking)
Indicates whether ecommerce tracking is enabled for this view (profile).
Profile
setEnhancedECommerceTracking(Boolean enhancedECommerceTracking)
Indicates whether enhanced ecommerce tracking is enabled for this view (profile).
Profile
setExcludeQueryParameters(String excludeQueryParameters)
The query parameters that are excluded from this view (profile).
Profile
setId(String id)
View (Profile) ID.
Profile
setInternalWebPropertyId(String internalWebPropertyId)
Internal ID for the web property to which this view (profile) belongs.
Profile
setKind(String kind)
Resource type for Analytics view (profile).
Profile
setName(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(String selfLink)
Link for this view (profile).
Profile
setSiteSearchCategoryParameters(String siteSearchCategoryParameters)
Site search category parameters for this view (profile).
Profile
setSiteSearchQueryParameters(String siteSearchQueryParameters)
The site search query parameters for this view (profile).
Profile
setStarred(Boolean starred)
Indicates whether this view (profile) is starred or not.
Profile
setStripSiteSearchCategoryParameters(Boolean stripSiteSearchCategoryParameters)
Whether or not Analytics will strip search category parameters from the URLs in your reports.
Profile
setStripSiteSearchQueryParameters(Boolean stripSiteSearchQueryParameters)
Whether or not Analytics will strip search query parameters from the URLs in your reports.
Profile
setTimezone(String timezone)
Time zone for which this view (profile) has been configured.
Profile
setType(String type)
View (Profile) type.
Profile
setUpdated(DateTime updated)
Time this view (profile) was last modified.
Profile
setWebPropertyId(String webPropertyId)
Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
Profile
setWebsiteUrl(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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, 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
-
-
Method Detail
-
getAccountId
public String getAccountId()
Account ID to which this view (profile) belongs.
- Returns:
- value or
null
for none
-
setAccountId
public Profile setAccountId(String accountId)
Account ID to which this view (profile) belongs.
- Parameters:
accountId
- accountId or null
for none
-
getBotFilteringEnabled
public Boolean getBotFilteringEnabled()
Indicates whether bot filtering is enabled for this view (profile).
- Returns:
- value or
null
for none
-
setBotFilteringEnabled
public Profile setBotFilteringEnabled(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 DateTime getCreated()
Time this view (profile) was created.
- Returns:
- value or
null
for none
-
setCreated
public Profile setCreated(DateTime created)
Time this view (profile) was created.
- Parameters:
created
- created or null
for none
-
getCurrency
public 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(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 String getDefaultPage()
Default page for this view (profile).
- Returns:
- value or
null
for none
-
setDefaultPage
public Profile setDefaultPage(String defaultPage)
Default page for this view (profile).
- Parameters:
defaultPage
- defaultPage or null
for none
-
getECommerceTracking
public Boolean getECommerceTracking()
Indicates whether ecommerce tracking is enabled for this view (profile).
- Returns:
- value or
null
for none
-
setECommerceTracking
public Profile setECommerceTracking(Boolean eCommerceTracking)
Indicates whether ecommerce tracking is enabled for this view (profile).
- Parameters:
eCommerceTracking
- eCommerceTracking or null
for none
-
getEnhancedECommerceTracking
public 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(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 String getExcludeQueryParameters()
The query parameters that are excluded from this view (profile).
- Returns:
- value or
null
for none
-
setExcludeQueryParameters
public Profile setExcludeQueryParameters(String excludeQueryParameters)
The query parameters that are excluded from this view (profile).
- Parameters:
excludeQueryParameters
- excludeQueryParameters or null
for none
-
getId
public String getId()
View (Profile) ID.
- Returns:
- value or
null
for none
-
getInternalWebPropertyId
public String getInternalWebPropertyId()
Internal ID for the web property to which this view (profile) belongs.
- Returns:
- value or
null
for none
-
setInternalWebPropertyId
public Profile setInternalWebPropertyId(String internalWebPropertyId)
Internal ID for the web property to which this view (profile) belongs.
- Parameters:
internalWebPropertyId
- internalWebPropertyId or null
for none
-
getKind
public String getKind()
Resource type for Analytics view (profile).
- Returns:
- value or
null
for none
-
setKind
public Profile setKind(String kind)
Resource type for Analytics view (profile).
- Parameters:
kind
- kind or null
for none
-
getName
public String getName()
Name of this view (profile).
- Returns:
- value or
null
for none
-
setName
public Profile setName(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 String getSelfLink()
Link for this view (profile).
- Returns:
- value or
null
for none
-
setSelfLink
public Profile setSelfLink(String selfLink)
Link for this view (profile).
- Parameters:
selfLink
- selfLink or null
for none
-
getSiteSearchCategoryParameters
public String getSiteSearchCategoryParameters()
Site search category parameters for this view (profile).
- Returns:
- value or
null
for none
-
setSiteSearchCategoryParameters
public Profile setSiteSearchCategoryParameters(String siteSearchCategoryParameters)
Site search category parameters for this view (profile).
- Parameters:
siteSearchCategoryParameters
- siteSearchCategoryParameters or null
for none
-
getSiteSearchQueryParameters
public String getSiteSearchQueryParameters()
The site search query parameters for this view (profile).
- Returns:
- value or
null
for none
-
setSiteSearchQueryParameters
public Profile setSiteSearchQueryParameters(String siteSearchQueryParameters)
The site search query parameters for this view (profile).
- Parameters:
siteSearchQueryParameters
- siteSearchQueryParameters or null
for none
-
getStarred
public Boolean getStarred()
Indicates whether this view (profile) is starred or not.
- Returns:
- value or
null
for none
-
setStarred
public Profile setStarred(Boolean starred)
Indicates whether this view (profile) is starred or not.
- Parameters:
starred
- starred or null
for none
-
getStripSiteSearchCategoryParameters
public 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(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 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(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 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(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 String getType()
View (Profile) type. Supported types: WEB or APP.
- Returns:
- value or
null
for none
-
setType
public Profile setType(String type)
View (Profile) type. Supported types: WEB or APP.
- Parameters:
type
- type or null
for none
-
getUpdated
public DateTime getUpdated()
Time this view (profile) was last modified.
- Returns:
- value or
null
for none
-
setUpdated
public Profile setUpdated(DateTime updated)
Time this view (profile) was last modified.
- Parameters:
updated
- updated or null
for none
-
getWebPropertyId
public 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(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 String getWebsiteUrl()
Website URL for this view (profile).
- Returns:
- value or
null
for none
-
setWebsiteUrl
public Profile setWebsiteUrl(String websiteUrl)
Website URL for this view (profile).
- Parameters:
websiteUrl
- websiteUrl or null
for none
-
set
public Profile set(String fieldName,
Object value)
- Overrides:
set
in class GenericJson
-
clone
public Profile clone()
- Overrides:
clone
in class GenericJson
Copyright © 2011–2020 Google. All rights reserved.