com.segment.analytics

Class AnalyticsContext.Campaign

java.lang.Object

com.segment.analytics.ValueMap

com.segment.analytics.AnalyticsContext.Campaign

All Implemented Interfaces:

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

Enclosing class:

AnalyticsContext

public static class AnalyticsContext.Campaign
extends ValueMap

Information about the campaign that resulted in the API call, containing name, source, medium, term and content. This maps directly to the common UTM campaign parameters.

See Also:

UTM parameters

Nested Class Summary

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Campaign()

Method Summary

Modifier and Type	Method and Description
java.lang.String	content()
java.lang.String	medium()
java.lang.String	name()
AnalyticsContext.Campaign	putContent(java.lang.String content) Set the UTM campaign content.
AnalyticsContext.Campaign	putMedium(java.lang.String medium) Set the UTM campaign medium.
AnalyticsContext.Campaign	putName(java.lang.String name) Set the UTM campaign name.
AnalyticsContext.Campaign	putSource(java.lang.String source) Set the UTM campaign source.
AnalyticsContext.Campaign	putTerm(java.lang.String term) Set the UTM campaign term.
AnalyticsContext.Campaign	putValue(java.lang.String key, java.lang.Object value) Helper method to be able to chain put methods.
java.lang.String	source()
java.lang.String	term()
java.lang.String	tern() Deprecated. Use term() instead.

Methods inherited from class com.segment.analytics.ValueMap

clear, containsKey, containsValue, entrySet, equals, get, getBoolean, getChar, getDouble, getEnum, getFloat, getInt, getList, getLong, getString, getValueMap, getValueMap, hashCode, isEmpty, keySet, put, putAll, remove, size, toJsonObject, toString, toStringMap, values

Methods inherited from class java.lang.Object

clone, 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

Campaign

public Campaign()

Method Detail

putValue

public AnalyticsContext.Campaign putValue(java.lang.String key,
                                          java.lang.Object value)

Description copied from class: ValueMap

Helper method to be able to chain put methods.

Overrides:

putValue in class ValueMap

putName

public AnalyticsContext.Campaign putName(java.lang.String name)

Set the UTM campaign name.

name

public java.lang.String name()

putSource

public AnalyticsContext.Campaign putSource(java.lang.String source)

Set the UTM campaign source.

source

public java.lang.String source()

putMedium

public AnalyticsContext.Campaign putMedium(java.lang.String medium)

Set the UTM campaign medium.

medium

public java.lang.String medium()

putTerm

public AnalyticsContext.Campaign putTerm(java.lang.String term)

Set the UTM campaign term.

tern

public java.lang.String tern()

Deprecated. Use term() instead.

term

public java.lang.String term()

putContent

public AnalyticsContext.Campaign putContent(java.lang.String content)

Set the UTM campaign content.

content

public java.lang.String content()