public final class MetricMetadata extends GeneratedMessageV3 implements MetricMetadataOrBuilder
Explains a metric.
Protobuf type google.analytics.data.v1beta.MetricMetadata
Static Fields
public static final int API_NAME_FIELD_NUMBER
Field Value
public static final int BLOCKED_REASONS_FIELD_NUMBER
Field Value
public static final int CATEGORY_FIELD_NUMBER
Field Value
public static final int CUSTOM_DEFINITION_FIELD_NUMBER
Field Value
public static final int DEPRECATED_API_NAMES_FIELD_NUMBER
Field Value
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
public static final int EXPRESSION_FIELD_NUMBER
Field Value
public static final int TYPE_FIELD_NUMBER
Field Value
public static final int UI_NAME_FIELD_NUMBER
Field Value
Static Methods
public static MetricMetadata getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static MetricMetadata.Builder newBuilder()
Returns
public static MetricMetadata.Builder newBuilder(MetricMetadata prototype)
Parameter
Returns
public static MetricMetadata parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static MetricMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static MetricMetadata parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static MetricMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static MetricMetadata parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static MetricMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static MetricMetadata parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static MetricMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static MetricMetadata parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static MetricMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static MetricMetadata parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static MetricMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<MetricMetadata> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public String getApiName()
A metric name. Useable in Metric's name. For example,
eventCount.
string api_name = 1;
| Type | Description |
| String | The apiName.
|
public ByteString getApiNameBytes()
A metric name. Useable in Metric's name. For example,
eventCount.
string api_name = 1;
public MetricMetadata.BlockedReason getBlockedReasons(int index)
If reasons are specified, your access is blocked to this metric for this
property. API requests from you to this property for this metric will
succeed; however, the report will contain only zeros for this metric. API
requests with metric filters on blocked metrics will fail. If reasons are
empty, you have access to this metric.
To learn more, see Access and data-restriction
management.
repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;
| Name | Description |
| index | int
The index of the element to return.
|
Returns
public int getBlockedReasonsCount()
If reasons are specified, your access is blocked to this metric for this
property. API requests from you to this property for this metric will
succeed; however, the report will contain only zeros for this metric. API
requests with metric filters on blocked metrics will fail. If reasons are
empty, you have access to this metric.
To learn more, see Access and data-restriction
management.
repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;
| Type | Description |
| int | The count of blockedReasons.
|
public List<MetricMetadata.BlockedReason> getBlockedReasonsList()
If reasons are specified, your access is blocked to this metric for this
property. API requests from you to this property for this metric will
succeed; however, the report will contain only zeros for this metric. API
requests with metric filters on blocked metrics will fail. If reasons are
empty, you have access to this metric.
To learn more, see Access and data-restriction
management.
repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;
public int getBlockedReasonsValue(int index)
If reasons are specified, your access is blocked to this metric for this
property. API requests from you to this property for this metric will
succeed; however, the report will contain only zeros for this metric. API
requests with metric filters on blocked metrics will fail. If reasons are
empty, you have access to this metric.
To learn more, see Access and data-restriction
management.
repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| int | The enum numeric value on the wire of blockedReasons at the given index.
|
public List<Integer> getBlockedReasonsValueList()
If reasons are specified, your access is blocked to this metric for this
property. API requests from you to this property for this metric will
succeed; however, the report will contain only zeros for this metric. API
requests with metric filters on blocked metrics will fail. If reasons are
empty, you have access to this metric.
To learn more, see Access and data-restriction
management.
repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;
| Type | Description |
| List<Integer> | A list containing the enum numeric values on the wire for blockedReasons.
|
public String getCategory()
The display name of the category that this metrics belongs to. Similar
dimensions and metrics are categorized together.
string category = 10;
| Type | Description |
| String | The category.
|
public ByteString getCategoryBytes()
The display name of the category that this metrics belongs to. Similar
dimensions and metrics are categorized together.
string category = 10;
public boolean getCustomDefinition()
True if the metric is a custom metric for this property.
bool custom_definition = 7;
| Type | Description |
| boolean | The customDefinition.
|
public MetricMetadata getDefaultInstanceForType()
Returns
public String getDeprecatedApiNames(int index)
Still usable but deprecated names for this metric. If populated, this
metric is available by either apiName or one of deprecatedApiNames
for a period of time. After the deprecation period, the metric will be
available only by apiName.
repeated string deprecated_api_names = 4;
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| String | The deprecatedApiNames at the given index.
|
public ByteString getDeprecatedApiNamesBytes(int index)
Still usable but deprecated names for this metric. If populated, this
metric is available by either apiName or one of deprecatedApiNames
for a period of time. After the deprecation period, the metric will be
available only by apiName.
repeated string deprecated_api_names = 4;
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| ByteString | The bytes of the deprecatedApiNames at the given index.
|
public int getDeprecatedApiNamesCount()
Still usable but deprecated names for this metric. If populated, this
metric is available by either apiName or one of deprecatedApiNames
for a period of time. After the deprecation period, the metric will be
available only by apiName.
repeated string deprecated_api_names = 4;
| Type | Description |
| int | The count of deprecatedApiNames.
|
public ProtocolStringList getDeprecatedApiNamesList()
Still usable but deprecated names for this metric. If populated, this
metric is available by either apiName or one of deprecatedApiNames
for a period of time. After the deprecation period, the metric will be
available only by apiName.
repeated string deprecated_api_names = 4;
public String getDescription()
Description of how this metric is used and calculated.
string description = 3;
| Type | Description |
| String | The description.
|
public ByteString getDescriptionBytes()
Description of how this metric is used and calculated.
string description = 3;
| Type | Description |
| ByteString | The bytes for description.
|
public String getExpression()
The mathematical expression for this derived metric. Can be used in
Metric's expression field for equivalent reports. Most metrics
are not expressions, and for non-expressions, this field is empty.
string expression = 6;
| Type | Description |
| String | The expression.
|
public ByteString getExpressionBytes()
The mathematical expression for this derived metric. Can be used in
Metric's expression field for equivalent reports. Most metrics
are not expressions, and for non-expressions, this field is empty.
string expression = 6;
| Type | Description |
| ByteString | The bytes for expression.
|
public Parser<MetricMetadata> getParserForType()
Returns
Overrides
public int getSerializedSize()
Returns
Overrides
public MetricType getType()
The type of this metric.
.google.analytics.data.v1beta.MetricType type = 5;
public int getTypeValue()
The type of this metric.
.google.analytics.data.v1beta.MetricType type = 5;
| Type | Description |
| int | The enum numeric value on the wire for type.
|
public String getUiName()
This metric's name within the Google Analytics user interface. For example,
Event count.
string ui_name = 2;
| Type | Description |
| String | The uiName.
|
public ByteString getUiNameBytes()
This metric's name within the Google Analytics user interface. For example,
Event count.
string ui_name = 2;
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public MetricMetadata.Builder newBuilderForType()
Returns
protected MetricMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public MetricMetadata.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
