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 Segments

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

All Implemented Interfaces:: Cloneable, Map<String,Object>

public final class Segments
extends GenericJson
extends GenericJson

An advanced segment collection lists Analytics advanced segments that the user has access to. Each resource in the collection corresponds to a single Analytics advanced segment.

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

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
`Segments()`

Method Summary
`Segments`	`clone()`
`List<Segment>`	`getItems()` A list of advanced segments.
`Integer`	`getItemsPerPage()` The maximum number of resources the response can contain, regardless of the actual number of resources returned.
`String`	`getKind()` Collection type for advanced segments.
`String`	`getNextLink()` Link to next page for this advanced segment collection.
`String`	`getPreviousLink()` Link to previous page for this advanced segment collection.
`Integer`	`getStartIndex()` The starting index of the resources, which is 1 by default or otherwise specified by the start- index query parameter.
`Integer`	`getTotalResults()` The total number of results for the query, regardless of the number of results in the response.
`String`	`getUsername()` Email ID of the authenticated user
`Segments`	`set(String fieldName, Object value)`
`Segments`	`setItems(List<Segment> items)` A list of advanced segments.
`Segments`	`setItemsPerPage(Integer itemsPerPage)` The maximum number of resources the response can contain, regardless of the actual number of resources returned.
`Segments`	`setKind(String kind)` Collection type for advanced segments.
`Segments`	`setNextLink(String nextLink)` Link to next page for this advanced segment collection.
`Segments`	`setPreviousLink(String previousLink)` Link to previous page for this advanced segment collection.
`Segments`	`setStartIndex(Integer startIndex)` The starting index of the resources, which is 1 by default or otherwise specified by the start- index query parameter.
`Segments`	`setTotalResults(Integer totalResults)` The total number of results for the query, regardless of the number of results in the response.
`Segments`	`setUsername(String username)` Email ID of the authenticated user

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

Segments

public Segments()

Method Detail

getItems

public List<Segment> getItems()

A list of advanced segments.

Returns:: value or null for none

setItems

public Segments setItems(List<Segment> items)

A list of advanced segments.

Parameters:: items - items or null for none

getItemsPerPage

public Integer getItemsPerPage()

The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

Returns:: value or null for none

setItemsPerPage

public Segments setItemsPerPage(Integer itemsPerPage)

Parameters:: itemsPerPage - itemsPerPage or null for none

getKind

public String getKind()

Collection type for advanced segments.

Returns:: value or null for none

setKind

public Segments setKind(String kind)

Collection type for advanced segments.

Parameters:: kind - kind or null for none

getNextLink

public String getNextLink()

Link to next page for this advanced segment collection.

Returns:: value or null for none

setNextLink

public Segments setNextLink(String nextLink)