Package com.google.analytics.admin.v1alpha

Interface CalculatedMetricOrBuilder

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

  • Method Details

    • getName

      String getName()
       Identifier. Resource name for this CalculatedMetric.
 Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Identifier. Resource name for this CalculatedMetric.
 Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.

    • getDescription

      String getDescription()
       Optional. Description for this calculated metric.
 Max length of 4096 characters.
      string description = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description for this calculated metric.
 Max length of 4096 characters.
      string description = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.

    • getDisplayName

      String getDisplayName()
       Required. Display name for this calculated metric as shown in the
 Google Analytics UI. Max length 82 characters.
      string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Required. Display name for this calculated metric as shown in the
 Google Analytics UI. Max length 82 characters.
      string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for displayName.

    • getCalculatedMetricId

      String getCalculatedMetricId()
       Output only. The ID to use for the calculated metric. In the UI, this is
 referred to as the "API name."

 The calculated_metric_id is used when referencing this calculated metric
 from external APIs. For example, "calcMetric:{calculated_metric_id}".
      string calculated_metric_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The calculatedMetricId.

    • getCalculatedMetricIdBytes

      com.google.protobuf.ByteString getCalculatedMetricIdBytes()
       Output only. The ID to use for the calculated metric. In the UI, this is
 referred to as the "API name."

 The calculated_metric_id is used when referencing this calculated metric
 from external APIs. For example, "calcMetric:{calculated_metric_id}".
      string calculated_metric_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for calculatedMetricId.

    • getMetricUnitValue

      int getMetricUnitValue()
       Required. The type for the calculated metric's value.
      .google.analytics.admin.v1alpha.CalculatedMetric.MetricUnit metric_unit = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The enum numeric value on the wire for metricUnit.

    • getMetricUnit

      CalculatedMetric.MetricUnit getMetricUnit()
       Required. The type for the calculated metric's value.
      .google.analytics.admin.v1alpha.CalculatedMetric.MetricUnit metric_unit = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The metricUnit.

    • getRestrictedMetricTypeList

      List<CalculatedMetric.RestrictedMetricType> getRestrictedMetricTypeList()
       Output only. Types of restricted data that this metric contains.
      repeated .google.analytics.admin.v1alpha.CalculatedMetric.RestrictedMetricType restricted_metric_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the restrictedMetricType.

    • getRestrictedMetricTypeCount

      int getRestrictedMetricTypeCount()
       Output only. Types of restricted data that this metric contains.
      repeated .google.analytics.admin.v1alpha.CalculatedMetric.RestrictedMetricType restricted_metric_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The count of restrictedMetricType.

    • getRestrictedMetricType

      CalculatedMetric.RestrictedMetricType getRestrictedMetricType(int index)
       Output only. Types of restricted data that this metric contains.
      repeated .google.analytics.admin.v1alpha.CalculatedMetric.RestrictedMetricType restricted_metric_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the element to return.
      Returns:
      The restrictedMetricType at the given index.

    • getRestrictedMetricTypeValueList

      List<Integer> getRestrictedMetricTypeValueList()
       Output only. Types of restricted data that this metric contains.
      repeated .google.analytics.admin.v1alpha.CalculatedMetric.RestrictedMetricType restricted_metric_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the enum numeric values on the wire for restrictedMetricType.

    • getRestrictedMetricTypeValue

      int getRestrictedMetricTypeValue(int index)
       Output only. Types of restricted data that this metric contains.
      repeated .google.analytics.admin.v1alpha.CalculatedMetric.RestrictedMetricType restricted_metric_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of restrictedMetricType at the given index.

    • getFormula

      String getFormula()
       Required. The calculated metric's definition. Maximum number of unique
 referenced custom metrics is 5. Formulas supports the following operations:
 + (addition),  - (subtraction), - (negative),  * (multiplication), /
 (division), () (parenthesis). Any valid real numbers are acceptable that
 fit in a Long (64bit integer) or a Double (64 bit floating point number).
 Example formula:
 "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0"
      string formula = 7 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The formula.

    • getFormulaBytes

      com.google.protobuf.ByteString getFormulaBytes()
       Required. The calculated metric's definition. Maximum number of unique
 referenced custom metrics is 5. Formulas supports the following operations:
 + (addition),  - (subtraction), - (negative),  * (multiplication), /
 (division), () (parenthesis). Any valid real numbers are acceptable that
 fit in a Long (64bit integer) or a Double (64 bit floating point number).
 Example formula:
 "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0"
      string formula = 7 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for formula.

    • getInvalidMetricReference

      boolean getInvalidMetricReference()
       Output only. If true, this calculated metric has a invalid metric
 reference. Anything using a calculated metric with invalid_metric_reference
 set to true may fail, produce warnings, or produce unexpected results.
      bool invalid_metric_reference = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The invalidMetricReference.