com.google.api.services.analyticsdata.v1beta.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.analyticsdata.v1beta.model.Metric

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. Requests are allowed up to 10 metrics.

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

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	getExpression() A mathematical expression for derived metrics.
Boolean	getInvisible() Indicates if a metric is invisible in the report response.
String	getName() The name of the metric.
Metric	set(String fieldName, Object value)
Metric	setExpression(String expression) A mathematical expression for derived metrics.
Metric	setInvisible(Boolean invisible) Indicates if a metric is invisible in the report response.
Metric	setName(String name) The name of the metric.

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

getExpression

public String getExpression()

A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`.

Returns:

value or null for none

setExpression

public Metric setExpression(String expression)

A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`.

Parameters:

expression - expression or null for none

getInvisible

public Boolean getInvisible()

Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in `metricFilter`, `orderBys`, or a metric `expression`.

Returns:

value or null for none

setInvisible

public Metric setInvisible(Boolean invisible)

Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in `metricFilter`, `orderBys`, or a metric `expression`.

Parameters:

invisible - invisible or null for none

getName

public String getName()

The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api- schema#metrics) for the list of metric names. If `expression` is specified, `name` can be any string that you would like within the allowed character set. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metric names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.

Returns:

value or null for none

setName

public Metric setName(String name)

The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api- schema#metrics) for the list of metric names. If `expression` is specified, `name` can be any string that you would like within the allowed character set. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metric names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.

Parameters:

name - name or null for none

set

public Metric set(String fieldName,
                  Object value)

Overrides:

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

clone

public Metric clone()

Overrides:

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