Package com.google.analytics.data.v1beta

Interface MetricMetadataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
MetricMetadata, MetricMetadata.Builder
@Generated public interface MetricMetadataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getApiName()
    A metric name.
    com.google.protobuf.ByteString
    getApiNameBytes()
    A metric name.
    MetricMetadata.BlockedReason
    getBlockedReasons(int index)
    If reasons are specified, your access is blocked to this metric for this property.
    int
    getBlockedReasonsCount()
    If reasons are specified, your access is blocked to this metric for this property.
    List<MetricMetadata.BlockedReason>
    getBlockedReasonsList()
    If reasons are specified, your access is blocked to this metric for this property.
    int
    getBlockedReasonsValue(int index)
    If reasons are specified, your access is blocked to this metric for this property.
    List<Integer>
    getBlockedReasonsValueList()
    If reasons are specified, your access is blocked to this metric for this property.
    String
    getCategory()
    The display name of the category that this metrics belongs to.
    com.google.protobuf.ByteString
    getCategoryBytes()
    The display name of the category that this metrics belongs to.
    boolean
    getCustomDefinition()
    True if the metric is a custom metric for this property.
    String
    getDeprecatedApiNames(int index)
    Still usable but deprecated names for this metric.
    com.google.protobuf.ByteString
    getDeprecatedApiNamesBytes(int index)
    Still usable but deprecated names for this metric.
    int
    getDeprecatedApiNamesCount()
    Still usable but deprecated names for this metric.
    List<String>
    getDeprecatedApiNamesList()
    Still usable but deprecated names for this metric.
    String
    getDescription()
    Description of how this metric is used and calculated.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Description of how this metric is used and calculated.
    String
    getExpression()
    The mathematical expression for this derived metric.
    com.google.protobuf.ByteString
    getExpressionBytes()
    The mathematical expression for this derived metric.
    MetricType
    getType()
    The type of this metric.
    int
    getTypeValue()
    The type of this metric.
    String
    getUiName()
    This metric's name within the Google Analytics user interface.
    com.google.protobuf.ByteString
    getUiNameBytes()
    This metric's name within the Google Analytics user interface.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getApiName

      String getApiName()
       A metric name. Useable in [Metric](#Metric)'s `name`. For example,
 `eventCount`.
      string api_name = 1;
      Returns:
      The apiName.

    • getApiNameBytes

      com.google.protobuf.ByteString getApiNameBytes()
       A metric name. Useable in [Metric](#Metric)'s `name`. For example,
 `eventCount`.
      string api_name = 1;
      Returns:
      The bytes for apiName.

    • getUiName

      String getUiName()
       This metric's name within the Google Analytics user interface. For example,
 `Event count`.
      string ui_name = 2;
      Returns:
      The uiName.

    • getUiNameBytes

      com.google.protobuf.ByteString getUiNameBytes()
       This metric's name within the Google Analytics user interface. For example,
 `Event count`.
      string ui_name = 2;
      Returns:
      The bytes for uiName.

    • getDescription

      String getDescription()
       Description of how this metric is used and calculated.
      string description = 3;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Description of how this metric is used and calculated.
      string description = 3;
      Returns:
      The bytes for description.

    • getDeprecatedApiNamesList

      List<String> 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;
      Returns:
      A list containing the deprecatedApiNames.

    • getDeprecatedApiNamesCount

      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;
      Returns:
      The count of deprecatedApiNames.

    • getDeprecatedApiNames

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The deprecatedApiNames at the given index.

    • getDeprecatedApiNamesBytes

      com.google.protobuf.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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the deprecatedApiNames at the given index.

    • getTypeValue

      int getTypeValue()
       The type of this metric.
      .google.analytics.data.v1beta.MetricType type = 5;
      Returns:
      The enum numeric value on the wire for type.

    • getType

      MetricType getType()
       The type of this metric.
      .google.analytics.data.v1beta.MetricType type = 5;
      Returns:
      The type.

    • getExpression

      String getExpression()
       The mathematical expression for this derived metric. Can be used in
 [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
 are not expressions, and for non-expressions, this field is empty.
      string expression = 6;
      Returns:
      The expression.

    • getExpressionBytes

      com.google.protobuf.ByteString getExpressionBytes()
       The mathematical expression for this derived metric. Can be used in
 [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
 are not expressions, and for non-expressions, this field is empty.
      string expression = 6;
      Returns:
      The bytes for expression.

    • getCustomDefinition

      boolean getCustomDefinition()
       True if the metric is a custom metric for this property.
      bool custom_definition = 7;
      Returns:
      The customDefinition.

    • getBlockedReasonsList

      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](https://support.google.com/analytics/answer/10851388).
      repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;
      Returns:
      A list containing the blockedReasons.

    • getBlockedReasonsCount

      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](https://support.google.com/analytics/answer/10851388).
      repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;
      Returns:
      The count of blockedReasons.

    • getBlockedReasons

      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](https://support.google.com/analytics/answer/10851388).
      repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;
      Parameters:
      index - The index of the element to return.
      Returns:
      The blockedReasons at the given index.

    • getBlockedReasonsValueList

      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](https://support.google.com/analytics/answer/10851388).
      repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;
      Returns:
      A list containing the enum numeric values on the wire for blockedReasons.

    • getBlockedReasonsValue

      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](https://support.google.com/analytics/answer/10851388).
      repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of blockedReasons at the given index.

    • getCategory

      String getCategory()
       The display name of the category that this metrics belongs to. Similar
 dimensions and metrics are categorized together.
      string category = 10;
      Returns:
      The category.

    • getCategoryBytes

      com.google.protobuf.ByteString getCategoryBytes()
       The display name of the category that this metrics belongs to. Similar
 dimensions and metrics are categorized together.
      string category = 10;
      Returns:
      The bytes for category.