Send feedback
Class CustomMetric (0.31.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.31.0 keyboard_arrow_down
public final class CustomMetric extends GeneratedMessageV3 implements CustomMetricOrBuilder
A definition for a custom metric.
Protobuf type google.analytics.admin.v1beta.CustomMetric
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static CustomMetric . Builder newBuilder ()
newBuilder(CustomMetric prototype)
public static CustomMetric . Builder newBuilder ( CustomMetric prototype )
public static CustomMetric parseDelimitedFrom ( InputStream input )
public static CustomMetric parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static CustomMetric parseFrom ( byte [] data )
Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CustomMetric parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static CustomMetric parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CustomMetric parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static CustomMetric parseFrom ( CodedInputStream input )
public static CustomMetric parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static CustomMetric parseFrom ( InputStream input )
public static CustomMetric parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static CustomMetric parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CustomMetric parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<CustomMetric> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description objObject
Overrides
getDefaultInstanceForType()
public CustomMetric getDefaultInstanceForType ()
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];
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()
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 ()
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 indexint The index of the element to return.
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];
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 indexint 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];
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()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public CustomMetric . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CustomMetric . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public CustomMetric . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-21 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-21 UTC."],[[["This page provides documentation for the `CustomMetric` class within the Google Analytics Admin v1beta Java library, detailing its structure and functionality as a definition for custom metrics."],["The `CustomMetric` class extends `GeneratedMessageV3` and implements `CustomMetricOrBuilder`, leveraging protocol buffers for data serialization and offering a comprehensive set of methods for data management."],["The document outlines the different versions of the Google Analytics Admin library, ranging from version 0.14.0 to the latest version 0.70.0, indicating ongoing updates and development of the library."],["Key properties of the `CustomMetric` class include `name`, `parameter_name`, `display_name`, `description`, `measurement_unit`, `scope`, and `restricted_metric_type`, all of which are detailed with their respective data types and constraints."],["The document provides static methods to get default instance, parser, descriptor, and builder, as well as many parse methods, while also providing instance methods to get and write to, as well as many other helper methods."]]],[]]
