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

Class Metric

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Metric
extends GenericJson

[Metrics](https://support.google.com/analytics/answer/1033861) are the quantitative measurements. For example, the metric `ga:users` indicates the total number of users for the requested time period.

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

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

Constructors

Constructor and Description
Metric()

Method Summary

Modifier and Type	Method and Description
Metric	clone()
String	getAlias() An alias for the metric expression is an alternate name for the expression.
String	getExpression() A metric expression in the request.
String	getFormattingType() Specifies how the metric expression should be formatted, for example `INTEGER`.
Metric	set(String fieldName, Object value)
Metric	setAlias(String alias) An alias for the metric expression is an alternate name for the expression.
Metric	setExpression(String expression) A metric expression in the request.
Metric	setFormattingType(String formattingType) Specifies how the metric expression should be formatted, for example `INTEGER`.

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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Metric

public Metric()

Method Detail

getAlias

public String getAlias()

An alias for the metric expression is an alternate name for the expression. The alias can be used for filtering and sorting. This field is optional and is useful if the expression is not a single metric but a complex expression which cannot be used in filtering and sorting. The alias is also used in the response column header.

Returns:

value or null for none

setAlias

public Metric setAlias(String alias)

An alias for the metric expression is an alternate name for the expression. The alias can be used for filtering and sorting. This field is optional and is useful if the expression is not a single metric but a complex expression which cannot be used in filtering and sorting. The alias is also used in the response column header.

Parameters:

alias - alias or null for none

getExpression

public String getExpression()

A metric expression in the request. An expression is constructed from one or more metrics and numbers. Accepted operators include: Plus (+), Minus (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis, Positive cardinal numbers (0-9), can include decimals and is limited to 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the metric expression is just a single metric name like `ga:users`. Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics will result in unexpected results.

Returns:

value or null for none

setExpression

public Metric setExpression(String expression)

A metric expression in the request. An expression is constructed from one or more metrics and numbers. Accepted operators include: Plus (+), Minus (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis, Positive cardinal numbers (0-9), can include decimals and is limited to 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the metric expression is just a single metric name like `ga:users`. Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics will result in unexpected results.

Parameters:

expression - expression or null for none

getFormattingType

public String getFormattingType()

Specifies how the metric expression should be formatted, for example `INTEGER`.

Returns:

value or null for none

setFormattingType

public Metric setFormattingType(String formattingType)

Specifies how the metric expression should be formatted, for example `INTEGER`.

Parameters:

formattingType - formattingType or null for none

set

public Metric set(String fieldName,
                  Object value)

Overrides:

set in class GenericJson

clone

public Metric clone()

Overrides:

clone in class GenericJson