Google Analytics API v3 (revision 41)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.google.api.services.analytics.model
Class Goal

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
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: http://code.google.com/p/google-api-java-client/wiki/Json

Author:: Google, Inc.

Nested Class Summary
`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
`Goal()`

Method Summary
`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()` 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)` 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, 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`

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 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 profile to which this goal belongs.

Parameters:: parentLink - parentLink or null for none

getProfileId

public String getProfileId()

Profile ID to which this goal belongs.

Returns:: value or null for none

setProfileId

public Goal setProfileId(String profileId)