2024-01-17
▼ ▲ analyticsadmin.properties.calculatedMetrics.create
Flat Path: v1alpha/properties/{propertiesId}/calculatedMetrics
Description: Creates a CalculatedMetric.
Parameters:
parent
Description: Required. Format: properties/{property_id} Example: properties/1234
Type: string
Pattern: ^properties/[^/]+$
Required: Yes
Location: path
calculatedMetricId
Location: query
Description: 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}".
Type: string
Parameter Order: parent
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/analytics.edit
Path: v1alpha/{+parent}/calculatedMetrics
▼ ▲ analyticsadmin.properties.calculatedMetrics.list
HTTP Method: GET
Scopes:
Parameters:
parent
Description: Required. Example format: properties/1234
Type: string
Required: Yes
Pattern: ^properties/[^/]+$
Location: path
pageToken
Type: string
Location: query
Description: 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.
pageSize
Location: query
Format: int32
Type: integer
Description: 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).
Path: v1alpha/{+parent}/calculatedMetrics
Flat Path: v1alpha/properties/{propertiesId}/calculatedMetrics
Description: Lists CalculatedMetrics on a property.
Parameter Order: parent
▼ ▲ analyticsadmin.properties.calculatedMetrics.patch
Parameters:
name
Type: string
Pattern: ^properties/[^/]+/calculatedMetrics/[^/]+$
Location: path
Description: Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'
Required: Yes
updateMask
Type: string
Location: query
Format: google-fieldmask
Description: 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.
HTTP Method: PATCH
Parameter Order: name
Description: Updates a CalculatedMetric on a property.
Path: v1alpha/{+name}
Flat Path: v1alpha/properties/{propertiesId}/calculatedMetrics/{calculatedMetricsId}
▼ ▲ analyticsadmin.properties.calculatedMetrics.get
Parameter Order: name
Parameters:
name
Description: Required. The name of the CalculatedMetric to get. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01
Location: path
Required: Yes
Type: string
Pattern: ^properties/[^/]+/calculatedMetrics/[^/]+$
Description: Lookup for a single CalculatedMetric.
Path: v1alpha/{+name}
Scopes:
HTTP Method: GET
Flat Path: v1alpha/properties/{propertiesId}/calculatedMetrics/{calculatedMetricsId}
▼ ▲ analyticsadmin.properties.calculatedMetrics.delete
Scopes: https://www.googleapis.com/auth/analytics.edit
Description: Deletes a CalculatedMetric on a property.
Path: v1alpha/{+name}
Flat Path: v1alpha/properties/{propertiesId}/calculatedMetrics/{calculatedMetricsId}
Parameters:
name
Location: path
Required: Yes
Type: string
Description: Required. The name of the CalculatedMetric to delete. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01
Pattern: ^properties/[^/]+/calculatedMetrics/[^/]+$
HTTP Method: DELETE
Parameter Order: name