create(parent, body=None, calculatedMetricId=None, x__xgafv=None)

Creates a CalculatedMetric.

Args:
  parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
  body: object, The request body.
    The object takes the form of:

{ # A definition for a calculated metric.
  "calculatedMetricId": "A String", # 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}".
  "description": "A String", # Optional. Description for this calculated metric. Max length of 4096 characters.
  "displayName": "A String", # Required. Display name for this calculated metric as shown in the Google Analytics UI. Max length 82 characters.
  "formula": "A String", # 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"
  "invalidMetricReference": True or False, # 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.
  "metricUnit": "A String", # Required. The type for the calculated metric's value.
  "name": "A String", # Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'
  "restrictedMetricType": [ # Output only. Types of restricted data that this metric contains.
    "A String",
  ],
}

  calculatedMetricId: string, Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name. This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, "calcMetric:{calculated_metric_id}".
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A definition for a calculated metric.
  "calculatedMetricId": "A String", # 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}".
  "description": "A String", # Optional. Description for this calculated metric. Max length of 4096 characters.
  "displayName": "A String", # Required. Display name for this calculated metric as shown in the Google Analytics UI. Max length 82 characters.
  "formula": "A String", # 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"
  "invalidMetricReference": True or False, # 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.
  "metricUnit": "A String", # Required. The type for the calculated metric's value.
  "name": "A String", # Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'
  "restrictedMetricType": [ # Output only. Types of restricted data that this metric contains.
    "A String",
  ],
}

delete(name, x__xgafv=None)

Deletes a CalculatedMetric on a property.

Args:
  name: string, Required. The name of the CalculatedMetric to delete. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01 (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Lookup for a single CalculatedMetric.

Args:
  name: string, Required. The name of the CalculatedMetric to get. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01 (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A definition for a calculated metric.
  "calculatedMetricId": "A String", # 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}".
  "description": "A String", # Optional. Description for this calculated metric. Max length of 4096 characters.
  "displayName": "A String", # Required. Display name for this calculated metric as shown in the Google Analytics UI. Max length 82 characters.
  "formula": "A String", # 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"
  "invalidMetricReference": True or False, # 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.
  "metricUnit": "A String", # Required. The type for the calculated metric's value.
  "name": "A String", # Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'
  "restrictedMetricType": [ # Output only. Types of restricted data that this metric contains.
    "A String",
  ],
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists CalculatedMetrics on a property.

Args:
  parent: string, Required. Example format: properties/1234 (required)
  pageSize: integer, Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
  pageToken: string, Optional. A page token, received from a previous `ListCalculatedMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCalculatedMetrics` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListCalculatedMetrics RPC.
  "calculatedMetrics": [ # List of CalculatedMetrics.
    { # A definition for a calculated metric.
      "calculatedMetricId": "A String", # 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}".
      "description": "A String", # Optional. Description for this calculated metric. Max length of 4096 characters.
      "displayName": "A String", # Required. Display name for this calculated metric as shown in the Google Analytics UI. Max length 82 characters.
      "formula": "A String", # 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"
      "invalidMetricReference": True or False, # 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.
      "metricUnit": "A String", # Required. The type for the calculated metric's value.
      "name": "A String", # Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'
      "restrictedMetricType": [ # Output only. Types of restricted data that this metric contains.
        "A String",
      ],
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a CalculatedMetric on a property.

Args:
  name: string, Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' (required)
  body: object, The request body.
    The object takes the form of:

{ # A definition for a calculated metric.
  "calculatedMetricId": "A String", # 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}".
  "description": "A String", # Optional. Description for this calculated metric. Max length of 4096 characters.
  "displayName": "A String", # Required. Display name for this calculated metric as shown in the Google Analytics UI. Max length 82 characters.
  "formula": "A String", # 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"
  "invalidMetricReference": True or False, # 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.
  "metricUnit": "A String", # Required. The type for the calculated metric's value.
  "name": "A String", # Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'
  "restrictedMetricType": [ # Output only. Types of restricted data that this metric contains.
    "A String",
  ],
}

  updateMask: string, Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A definition for a calculated metric.
  "calculatedMetricId": "A String", # 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}".
  "description": "A String", # Optional. Description for this calculated metric. Max length of 4096 characters.
  "displayName": "A String", # Required. Display name for this calculated metric as shown in the Google Analytics UI. Max length 82 characters.
  "formula": "A String", # 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"
  "invalidMetricReference": True or False, # 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.
  "metricUnit": "A String", # Required. The type for the calculated metric's value.
  "name": "A String", # Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'
  "restrictedMetricType": [ # Output only. Types of restricted data that this metric contains.
    "A String",
  ],
}

Google Analytics Admin API . properties . calculatedMetrics

Instance Methods

Method Details