Class CustomMetric (0.58.0)

public final class CustomMetric extends GeneratedMessageV3 implements CustomMetricOrBuilder

A definition for a custom metric.

Protobuf type google.analytics.admin.v1beta.CustomMetric

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

MEASUREMENT_UNIT_FIELD_NUMBER

public static final int MEASUREMENT_UNIT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PARAMETER_NAME_FIELD_NUMBER

public static final int PARAMETER_NAME_FIELD_NUMBER
Field Value
Type Description
int

RESTRICTED_METRIC_TYPE_FIELD_NUMBER

public static final int RESTRICTED_METRIC_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CustomMetric getDefaultInstance()
Returns
Type Description
CustomMetric

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CustomMetric.Builder newBuilder()
Returns
Type Description
CustomMetric.Builder

newBuilder(CustomMetric prototype)

public static CustomMetric.Builder newBuilder(CustomMetric prototype)
Parameter
Name Description
prototype CustomMetric
Returns
Type Description
CustomMetric.Builder

parseDelimitedFrom(InputStream input)

public static CustomMetric parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomMetric
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomMetric parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomMetric
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CustomMetric parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CustomMetric
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomMetric parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomMetric
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CustomMetric parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CustomMetric
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomMetric parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomMetric
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CustomMetric parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CustomMetric
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomMetric parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomMetric
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CustomMetric parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomMetric
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomMetric parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomMetric
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CustomMetric parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CustomMetric
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomMetric parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomMetric
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CustomMetric> parser()
Returns
Type Description
Parser<CustomMetric>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CustomMetric getDefaultInstanceForType()
Returns
Type Description
CustomMetric

getDescription()

public String getDescription()

Optional. Description for this custom dimension. Max length of 150 characters.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description for this custom dimension. Max length of 150 characters.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.

string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.

string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getMeasurementUnit()

public CustomMetric.MeasurementUnit getMeasurementUnit()

Required. The type for the custom metric's value.

.google.analytics.admin.v1beta.CustomMetric.MeasurementUnit measurement_unit = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CustomMetric.MeasurementUnit

The measurementUnit.

getMeasurementUnitValue()

public int getMeasurementUnitValue()

Required. The type for the custom metric's value.

.google.analytics.admin.v1beta.CustomMetric.MeasurementUnit measurement_unit = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for measurementUnit.

getName()

public String getName()

Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParameterName()

public String getParameterName()

Required. Immutable. Tagging name for this custom metric.

If this is an event-scoped metric, then this is the event parameter name.

May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.

string parameter_name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The parameterName.

getParameterNameBytes()

public ByteString getParameterNameBytes()

Required. Immutable. Tagging name for this custom metric.

If this is an event-scoped metric, then this is the event parameter name.

May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.

string parameter_name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for parameterName.

getParserForType()

public Parser<CustomMetric> getParserForType()
Returns
Type Description
Parser<CustomMetric>
Overrides

getRestrictedMetricType(int index)

public CustomMetric.RestrictedMetricType getRestrictedMetricType(int index)

Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.

repeated .google.analytics.admin.v1beta.CustomMetric.RestrictedMetricType restricted_metric_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
CustomMetric.RestrictedMetricType

The restrictedMetricType at the given index.

getRestrictedMetricTypeCount()

public int getRestrictedMetricTypeCount()

Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.

repeated .google.analytics.admin.v1beta.CustomMetric.RestrictedMetricType restricted_metric_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of restrictedMetricType.

getRestrictedMetricTypeList()

public List<CustomMetric.RestrictedMetricType> getRestrictedMetricTypeList()

Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.

repeated .google.analytics.admin.v1beta.CustomMetric.RestrictedMetricType restricted_metric_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<RestrictedMetricType>

A list containing the restrictedMetricType.

getRestrictedMetricTypeValue(int index)

public int getRestrictedMetricTypeValue(int index)

Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.

repeated .google.analytics.admin.v1beta.CustomMetric.RestrictedMetricType restricted_metric_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of restrictedMetricType at the given index.

getRestrictedMetricTypeValueList()

public List<Integer> getRestrictedMetricTypeValueList()

Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.

repeated .google.analytics.admin.v1beta.CustomMetric.RestrictedMetricType restricted_metric_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for restrictedMetricType.

getScope()

public CustomMetric.MetricScope getScope()

Required. Immutable. The scope of this custom metric.

.google.analytics.admin.v1beta.CustomMetric.MetricScope scope = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
CustomMetric.MetricScope

The scope.

getScopeValue()

public int getScopeValue()

Required. Immutable. The scope of this custom metric.

.google.analytics.admin.v1beta.CustomMetric.MetricScope scope = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for scope.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CustomMetric.Builder newBuilderForType()
Returns
Type Description
CustomMetric.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CustomMetric.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CustomMetric.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CustomMetric.Builder toBuilder()
Returns
Type Description
CustomMetric.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException