Update
|
|||||
|
|
||||
Updates an existing custom metric
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Edit Google Analytics management entities
Input
This building block consumes 21 input parameters
| Name | Format | Description |
|---|---|---|
accountId Required |
STRING |
Account ID for the custom metric to update |
webPropertyId Required |
STRING |
Web property ID for the custom metric to update |
customMetricId Required |
STRING |
Custom metric ID for the custom metric to update |
ignoreCustomDataSourceLinks |
BOOLEAN |
Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set |
accountId |
STRING |
Account ID |
active |
BOOLEAN |
Boolean indicating whether the custom metric is active |
created |
DATE_TIME |
Time the custom metric was created |
id |
STRING |
Custom metric ID |
index |
INTEGER |
Index of the custom metric |
kind |
STRING |
Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field |
max_value |
STRING |
Max value of custom metric |
min_value |
STRING |
Min value of custom metric |
name |
STRING |
Name of the custom metric |
parentLink |
OBJECT |
Parent link for the custom metric. Points to the property to which the custom metric belongs |
parentLink.href |
STRING |
Link to the property to which the custom metric belongs |
parentLink.type |
STRING |
Type of the parent link. Set to "analytics#webproperty" |
scope |
STRING |
Scope of the custom metric: HIT or PRODUCT |
selfLink |
STRING |
Link for the custom metric |
type |
STRING |
Data type of custom metric |
updated |
DATE_TIME |
Time the custom metric was last modified |
webPropertyId |
STRING |
Property ID |
= Parameter name
= Format
|
accountId STRING Required Account ID for the custom metric to update |
|
webPropertyId STRING Required Web property ID for the custom metric to update |
|
customMetricId STRING Required Custom metric ID for the custom metric to update |
|
ignoreCustomDataSourceLinks BOOLEAN Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set |
|
accountId STRING Account ID |
|
active BOOLEAN Boolean indicating whether the custom metric is active |
|
created DATE_TIME Time the custom metric was created |
|
id STRING Custom metric ID |
|
index INTEGER Index of the custom metric |
|
kind STRING Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field |
|
max_value STRING Max value of custom metric |
|
min_value STRING Min value of custom metric |
|
name STRING Name of the custom metric |
|
parentLink OBJECT Parent link for the custom metric. Points to the property to which the custom metric belongs |
|
parentLink.href STRING Link to the property to which the custom metric belongs |
|
parentLink.type STRING Type of the parent link. Set to "analytics#webproperty" |
|
scope STRING Scope of the custom metric: HIT or PRODUCT |
|
selfLink STRING Link for the custom metric |
|
type STRING Data type of custom metric |
|
updated DATE_TIME Time the custom metric was last modified |
|
webPropertyId STRING Property ID |
Output
This building block provides 17 output parameters
| Name | Format | Description |
|---|---|---|
accountId |
STRING |
Account ID |
active |
BOOLEAN |
Boolean indicating whether the custom metric is active |
created |
DATE_TIME |
Time the custom metric was created |
id |
STRING |
Custom metric ID |
index |
INTEGER |
Index of the custom metric |
kind |
STRING |
Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field |
max_value |
STRING |
Max value of custom metric |
min_value |
STRING |
Min value of custom metric |
name |
STRING |
Name of the custom metric |
parentLink |
OBJECT |
Parent link for the custom metric. Points to the property to which the custom metric belongs |
parentLink.href |
STRING |
Link to the property to which the custom metric belongs |
parentLink.type |
STRING |
Type of the parent link. Set to "analytics#webproperty" |
scope |
STRING |
Scope of the custom metric: HIT or PRODUCT |
selfLink |
STRING |
Link for the custom metric |
type |
STRING |
Data type of custom metric |
updated |
DATE_TIME |
Time the custom metric was last modified |
webPropertyId |
STRING |
Property ID |
= Parameter name
= Format
|
accountId STRING Account ID |
|
active BOOLEAN Boolean indicating whether the custom metric is active |
|
created DATE_TIME Time the custom metric was created |
|
id STRING Custom metric ID |
|
index INTEGER Index of the custom metric |
|
kind STRING Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field |
|
max_value STRING Max value of custom metric |
|
min_value STRING Min value of custom metric |
|
name STRING Name of the custom metric |
|
parentLink OBJECT Parent link for the custom metric. Points to the property to which the custom metric belongs |
|
parentLink.href STRING Link to the property to which the custom metric belongs |
|
parentLink.type STRING Type of the parent link. Set to "analytics#webproperty" |
|
scope STRING Scope of the custom metric: HIT or PRODUCT |
|
selfLink STRING Link for the custom metric |
|
type STRING Data type of custom metric |
|
updated DATE_TIME Time the custom metric was last modified |
|
webPropertyId STRING Property ID |