Goal (Google Analytics API v3-rev20190807-2.0.0)

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.Goal

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Goal
extends GenericJson
```
JSON template for Analytics goal resource.
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`	`Goal.EventDetails` Details for the goal of the type EVENT.
`static class`	`Goal.ParentLink` Parent link for a goal.
`static class`	`Goal.UrlDestinationDetails` Details for the goal of the type URL_DESTINATION.
`static class`	`Goal.VisitNumPagesDetails` Details for the goal of the type VISIT_NUM_PAGES.
`static class`	`Goal.VisitTimeOnSiteDetails` Details for the goal of the type VISIT_TIME_ON_SITE.

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>

Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Goal()

Constructors
Constructor and Description
`Goal()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Goal`	`clone()`
`String`	`getAccountId()` Account ID to which this goal belongs.
`Boolean`	`getActive()` Determines whether this goal is active.
`DateTime`	`getCreated()` Time this goal was created.
`Goal.EventDetails`	`getEventDetails()` Details for the goal of the type EVENT.
`String`	`getId()` Goal ID.
`String`	`getInternalWebPropertyId()` Internal ID for the web property to which this goal belongs.
`String`	`getKind()` Resource type for an Analytics goal.
`String`	`getName()` Goal name.
`Goal.ParentLink`	`getParentLink()` Parent link for a goal.
`String`	`getProfileId()` View (Profile) ID to which this goal belongs.
`String`	`getSelfLink()` Link for this goal.
`String`	`getType()` Goal type.
`DateTime`	`getUpdated()` Time this goal was last modified.
`Goal.UrlDestinationDetails`	`getUrlDestinationDetails()` Details for the goal of the type URL_DESTINATION.
`Float`	`getValue()` Goal value.
`Goal.VisitNumPagesDetails`	`getVisitNumPagesDetails()` Details for the goal of the type VISIT_NUM_PAGES.
`Goal.VisitTimeOnSiteDetails`	`getVisitTimeOnSiteDetails()` Details for the goal of the type VISIT_TIME_ON_SITE.
`String`	`getWebPropertyId()` Web property ID to which this goal belongs.
`Goal`	`set(String fieldName, Object value)`
`Goal`	`setAccountId(String accountId)` Account ID to which this goal belongs.
`Goal`	`setActive(Boolean active)` Determines whether this goal is active.
`Goal`	`setCreated(DateTime created)` Time this goal was created.
`Goal`	`setEventDetails(Goal.EventDetails eventDetails)` Details for the goal of the type EVENT.
`Goal`	`setId(String id)` Goal ID.
`Goal`	`setInternalWebPropertyId(String internalWebPropertyId)` Internal ID for the web property to which this goal belongs.
`Goal`	`setKind(String kind)` Resource type for an Analytics goal.
`Goal`	`setName(String name)` Goal name.
`Goal`	`setParentLink(Goal.ParentLink parentLink)` Parent link for a goal.
`Goal`	`setProfileId(String profileId)` View (Profile) ID to which this goal belongs.
`Goal`	`setSelfLink(String selfLink)` Link for this goal.
`Goal`	`setType(String type)` Goal type.
`Goal`	`setUpdated(DateTime updated)` Time this goal was last modified.
`Goal`	`setUrlDestinationDetails(Goal.UrlDestinationDetails urlDestinationDetails)` Details for the goal of the type URL_DESTINATION.
`Goal`	`setValue(Float value)` Goal value.
`Goal`	`setVisitNumPagesDetails(Goal.VisitNumPagesDetails visitNumPagesDetails)` Details for the goal of the type VISIT_NUM_PAGES.
`Goal`	`setVisitTimeOnSiteDetails(Goal.VisitTimeOnSiteDetails visitTimeOnSiteDetails)` Details for the goal of the type VISIT_TIME_ON_SITE.
`Goal`	`setWebPropertyId(String webPropertyId)` Web property ID to which this goal belongs.

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

- Constructor Detail
  - Goal
```
public Goal()
```
- Method Detail
  - getAccountId
```
public String getAccountId()
```
    Account ID to which this goal belongs.
    
    Returns:
    
    value or null for none
  - setAccountId
```
public Goal setAccountId(String accountId)
```
    Account ID to which this goal belongs.
    
    Parameters:
    
    accountId - accountId or null for none
  - getActive
```
public Boolean getActive()
```
    Determines whether this goal is active.
    
    Returns:
    
    value or null for none
  - setActive
```
public Goal setActive(Boolean active)
```
    Determines whether this goal is active.
    
    Parameters:
    
    active - active or null for none
  - getCreated
```
public DateTime getCreated()
```
    Time this goal was created.
    
    Returns:
    
    value or null for none
  - setCreated
```
public Goal setCreated(DateTime created)
```
    Time this goal was created.
    
    Parameters:
    
    created - created or null for none
  - getEventDetails
```
public Goal.EventDetails getEventDetails()
```
    Details for the goal of the type EVENT.
    
    Returns:
    
    value or null for none
  - setEventDetails
```
public Goal setEventDetails(Goal.EventDetails eventDetails)
```
    Details for the goal of the type EVENT.
    
    Parameters:
    
    eventDetails - eventDetails or null for none
  - getId
```
public String getId()
```
    Goal ID.
    
    Returns:
    
    value or null for none
  - setId
```
public Goal setId(String id)
```
    Goal ID.
    
    Parameters:
    
    id - id or null for none
  - getInternalWebPropertyId
```
public String getInternalWebPropertyId()
```
    Internal ID for the web property to which this goal belongs.
    
    Returns:
    
    value or null for none
  - setInternalWebPropertyId
```
public Goal setInternalWebPropertyId(String internalWebPropertyId)
```
    Internal ID for the web property to which this goal belongs.
    
    Parameters:
    
    internalWebPropertyId - internalWebPropertyId or null for none
  - getKind
```
public String getKind()
```
    Resource type for an Analytics goal.
    
    Returns:
    
    value or null for none
  - setKind
```
public Goal setKind(String kind)
```
    Resource type for an Analytics goal.
    
    Parameters:
    
    kind - kind or null for none
  - getName
```
public String getName()
```
    Goal name.
    
    Returns:
    
    value or null for none
  - setName
```
public Goal setName(String name)
```
    Goal name.
    
    Parameters:
    
    name - name or null for none
  - getParentLink
```
public Goal.ParentLink getParentLink()
```
    Parent link for a goal. Points to the view (profile) to which this goal belongs.
    
    Returns:
    
    value or null for none
  - setParentLink
```
public Goal setParentLink(Goal.ParentLink parentLink)
```
    Parent link for a goal. Points to the view (profile) to which this goal belongs.
    
    Parameters:
    
    parentLink - parentLink or null for none
  - getProfileId
```
public String getProfileId()
```
    View (Profile) ID to which this goal belongs.
    
    Returns:
    
    value or null for none
  - setProfileId
```
public Goal setProfileId(String profileId)
```
    View (Profile) ID to which this goal belongs.
    
    Parameters:
    
    profileId - profileId or null for none
  - getSelfLink
```
public String getSelfLink()
```
    Link for this goal.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public Goal setSelfLink(String selfLink)
```
    Link for this goal.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getType
```
public String getType()
```
    Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
    
    Returns:
    
    value or null for none
  - setType
```
public Goal setType(String type)
```
    Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
    
    Parameters:
    
    type - type or null for none
  - getUpdated
```
public DateTime getUpdated()
```
    Time this goal was last modified.
    
    Returns:
    
    value or null for none
  - setUpdated
```
public Goal setUpdated(DateTime updated)
```
    Time this goal was last modified.
    
    Parameters:
    
    updated - updated or null for none
  - getUrlDestinationDetails
```
public Goal.UrlDestinationDetails getUrlDestinationDetails()
```
    Details for the goal of the type URL_DESTINATION.
    
    Returns:
    
    value or null for none
  - setUrlDestinationDetails
```
public Goal setUrlDestinationDetails(Goal.UrlDestinationDetails urlDestinationDetails)
```
    Details for the goal of the type URL_DESTINATION.
    
    Parameters:
    
    urlDestinationDetails - urlDestinationDetails or null for none
  - getValue
```
public Float getValue()
```
    Goal value.
    
    Returns:
    
    value or null for none
  - setValue
```
public Goal setValue(Float value)
```
    Goal value.
    
    Parameters:
    
    value - value or null for none
  - getVisitNumPagesDetails
```
public Goal.VisitNumPagesDetails getVisitNumPagesDetails()
```
    Details for the goal of the type VISIT_NUM_PAGES.
    
    Returns:
    
    value or null for none
  - setVisitNumPagesDetails
```
public Goal setVisitNumPagesDetails(Goal.VisitNumPagesDetails visitNumPagesDetails)
```
    Details for the goal of the type VISIT_NUM_PAGES.
    
    Parameters:
    
    visitNumPagesDetails - visitNumPagesDetails or null for none
  - getVisitTimeOnSiteDetails
```
public Goal.VisitTimeOnSiteDetails getVisitTimeOnSiteDetails()
```
    Details for the goal of the type VISIT_TIME_ON_SITE.
    
    Returns:
    
    value or null for none
  - setVisitTimeOnSiteDetails
```
public Goal setVisitTimeOnSiteDetails(Goal.VisitTimeOnSiteDetails visitTimeOnSiteDetails)
```
    Details for the goal of the type VISIT_TIME_ON_SITE.
    
    Parameters:
    
    visitTimeOnSiteDetails - visitTimeOnSiteDetails or null for none
  - getWebPropertyId
```
public String getWebPropertyId()
```
    Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
    
    Returns:
    
    value or null for none
  - setWebPropertyId
```
public Goal setWebPropertyId(String webPropertyId)
```
    Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
    
    Parameters:
    
    webPropertyId - webPropertyId or null for none
  - set
```
public Goal set(String fieldName,
                Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Goal clone()
```
    Overrides:
    
    clone in class GenericJson

Class Goal

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Goal

Method Detail

getAccountId

setAccountId

getActive

setActive

getCreated

setCreated

getEventDetails

setEventDetails

getId

setId

getInternalWebPropertyId

setInternalWebPropertyId

getKind

setKind

getName

setName

getParentLink

setParentLink

getProfileId

setProfileId

getSelfLink

setSelfLink

getType

setType

getUpdated

setUpdated

getUrlDestinationDetails

setUrlDestinationDetails

getValue

setValue

getVisitNumPagesDetails

setVisitNumPagesDetails

getVisitTimeOnSiteDetails

setVisitTimeOnSiteDetails

getWebPropertyId

setWebPropertyId

set

clone