com.google.api.services.analyticsreporting.v4.model

Class Segment

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.analyticsreporting.v4.model.Segment

All Implemented Interfaces:

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

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

The segment definition, if the report needs to be segmented. A Segment is a subset of the Analytics data. For example, of the entire set of users, one Segment might be users from a particular country or city.

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 Reporting 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/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
Segment()

Method Summary

Methods

Modifier and Type	Method and Description
Segment	clone()
DynamicSegment	getDynamicSegment() A dynamic segment definition in the request.
java.lang.String	getSegmentId() The segment ID of a built-in or custom segment, for example `gaid::-3`.
Segment	set(java.lang.String fieldName, java.lang.Object value)
Segment	setDynamicSegment(DynamicSegment dynamicSegment) A dynamic segment definition in the request.
Segment	setSegmentId(java.lang.String segmentId) The segment ID of a built-in or custom segment, for example `gaid::-3`.

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

Segment

public Segment()

Method Detail

getDynamicSegment

public DynamicSegment getDynamicSegment()

A dynamic segment definition in the request.

Returns:

value or null for none

setDynamicSegment

public Segment setDynamicSegment(DynamicSegment dynamicSegment)

A dynamic segment definition in the request.

Parameters:

dynamicSegment - dynamicSegment or null for none

getSegmentId

public java.lang.String getSegmentId()

The segment ID of a built-in or custom segment, for example `gaid::-3`.

Returns:

value or null for none

setSegmentId

public Segment setSegmentId(java.lang.String segmentId)

The segment ID of a built-in or custom segment, for example `gaid::-3`.

Parameters:

segmentId - segmentId or null for none

set

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

Overrides:

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

clone

public Segment clone()

Overrides:

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