- 0.63.0 (latest)
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
public static final class Metric.Builder extends GeneratedMessageV3.Builder<Metric.Builder> implements MetricOrBuilder The quantitative measurements of a report. For example, the metric
eventCount is the total number of events. Requests are allowed up to 10
metrics.
Protobuf type google.analytics.data.v1beta.Metric
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Metric.BuilderImplements
MetricOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Metric.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | |
build()
public Metric build()| Returns | |
|---|---|
| Type | Description |
Metric | |
buildPartial()
public Metric buildPartial()| Returns | |
|---|---|
| Type | Description |
Metric | |
clear()
public Metric.Builder clear()| Returns | |
|---|---|
| Type | Description |
Metric.Builder | |
clearExpression()
public Metric.Builder clearExpression() A mathematical expression for derived metrics. For example, the metric
Event count per user is eventCount/totalUsers.
string expression = 2;
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Metric.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | |
clearInvisible()
public Metric.Builder clearInvisible() 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.
bool invisible = 3;
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | This builder for chaining. |
clearName()
public Metric.Builder clearName() The name of the metric. See the API
Metrics
for the list of metric names supported by core reporting methods such
as runReport and batchRunReports. See
Realtime
Metrics
for the list of metric names supported by the runRealtimeReport
method. See
Funnel
Metrics
for the list of metric names supported by the runFunnelReport
method.
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.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Metric.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | |
clone()
public Metric.Builder clone()| Returns | |
|---|---|
| Type | Description |
Metric.Builder | |
getDefaultInstanceForType()
public Metric getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Metric | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getExpression()
public String getExpression() A mathematical expression for derived metrics. For example, the metric
Event count per user is eventCount/totalUsers.
string expression = 2;
| Returns | |
|---|---|
| Type | Description |
String | The expression. |
getExpressionBytes()
public ByteString getExpressionBytes() A mathematical expression for derived metrics. For example, the metric
Event count per user is eventCount/totalUsers.
string expression = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for expression. |
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.
bool invisible = 3;
| Returns | |
|---|---|
| Type | Description |
boolean | The invisible. |
getName()
public String getName() The name of the metric. See the API
Metrics
for the list of metric names supported by core reporting methods such
as runReport and batchRunReports. See
Realtime
Metrics
for the list of metric names supported by the runRealtimeReport
method. See
Funnel
Metrics
for the list of metric names supported by the runFunnelReport
method.
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.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes() The name of the metric. See the API
Metrics
for the list of metric names supported by core reporting methods such
as runReport and batchRunReports. See
Realtime
Metrics
for the list of metric names supported by the runRealtimeReport
method. See
Funnel
Metrics
for the list of metric names supported by the runFunnelReport
method.
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.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(Metric other)
public Metric.Builder mergeFrom(Metric other)| Parameter | |
|---|---|
| Name | Description |
other | Metric |
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Metric.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Metric.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Metric.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | |
setExpression(String value)
public Metric.Builder setExpression(String value) A mathematical expression for derived metrics. For example, the metric
Event count per user is eventCount/totalUsers.
string expression = 2;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe expression to set. |
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | This builder for chaining. |
setExpressionBytes(ByteString value)
public Metric.Builder setExpressionBytes(ByteString value) A mathematical expression for derived metrics. For example, the metric
Event count per user is eventCount/totalUsers.
string expression = 2;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for expression to set. |
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Metric.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | |
setInvisible(boolean value)
public Metric.Builder setInvisible(boolean value) 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.
bool invisible = 3;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe invisible to set. |
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | This builder for chaining. |
setName(String value)
public Metric.Builder setName(String value) The name of the metric. See the API
Metrics
for the list of metric names supported by core reporting methods such
as runReport and batchRunReports. See
Realtime
Metrics
for the list of metric names supported by the runRealtimeReport
method. See
Funnel
Metrics
for the list of metric names supported by the runFunnelReport
method.
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.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Metric.Builder setNameBytes(ByteString value) The name of the metric. See the API
Metrics
for the list of metric names supported by core reporting methods such
as runReport and batchRunReports. See
Realtime
Metrics
for the list of metric names supported by the runRealtimeReport
method. See
Funnel
Metrics
for the list of metric names supported by the runFunnelReport
method.
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.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Metric.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final Metric.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Metric.Builder | |