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

Class SegmentFilter

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

All Implemented Interfaces:

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

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

SegmentFilter defines the segment to be either a simple or a sequence segment. A simple segment condition contains dimension and metric conditions to select the sessions or users. A sequence segment condition can be used to select users or sessions based on sequential conditions.

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
SegmentFilter()

Method Summary

Methods

Modifier and Type	Method and Description
SegmentFilter	clone()
java.lang.Boolean	getNot() If true, match the complement of simple or sequence segment.
SequenceSegment	getSequenceSegment() Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions.
SimpleSegment	getSimpleSegment() A Simple segment conditions consist of one or more dimension/metric conditions that can be combined
SegmentFilter	set(java.lang.String fieldName, java.lang.Object value)
SegmentFilter	setNot(java.lang.Boolean not) If true, match the complement of simple or sequence segment.
SegmentFilter	setSequenceSegment(SequenceSegment sequenceSegment) Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions.
SegmentFilter	setSimpleSegment(SimpleSegment simpleSegment) A Simple segment conditions consist of one or more dimension/metric conditions that can be combined

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

SegmentFilter

public SegmentFilter()

Method Detail

getNot

public java.lang.Boolean getNot()

If true, match the complement of simple or sequence segment. For example, to match all visits not from "New York", we can define the segment as follows: "sessionSegment": { "segmentFilters": [{ "simpleSegment" :{ "orFiltersForSegment": [{ "segmentFilterClauses":[{ "dimensionFilter": { "dimensionName": "ga:city", "expressions": ["New York"] } }] }] }, "not": "True" }] },

Returns:

value or null for none

setNot

public SegmentFilter setNot(java.lang.Boolean not)

If true, match the complement of simple or sequence segment. For example, to match all visits not from "New York", we can define the segment as follows: "sessionSegment": { "segmentFilters": [{ "simpleSegment" :{ "orFiltersForSegment": [{ "segmentFilterClauses":[{ "dimensionFilter": { "dimensionName": "ga:city", "expressions": ["New York"] } }] }] }, "not": "True" }] },

Parameters:

not - not or null for none

getSequenceSegment

public SequenceSegment getSequenceSegment()

Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with special sequence operators.

Returns:

value or null for none

setSequenceSegment

public SegmentFilter setSequenceSegment(SequenceSegment sequenceSegment)

Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with special sequence operators.

Parameters:

sequenceSegment - sequenceSegment or null for none

getSimpleSegment

public SimpleSegment getSimpleSegment()

A Simple segment conditions consist of one or more dimension/metric conditions that can be combined

Returns:

value or null for none

setSimpleSegment

public SegmentFilter setSimpleSegment(SimpleSegment simpleSegment)

A Simple segment conditions consist of one or more dimension/metric conditions that can be combined

Parameters:

simpleSegment - simpleSegment or null for none

set

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

Overrides:

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

clone

public SegmentFilter clone()

Overrides:

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