Update
|
|||||
|
|
||||
Updates an existing goal
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 43 input parameters
| Name | Format | Description |
|---|---|---|
accountId Required |
STRING |
Account ID to update the goal |
webPropertyId Required |
STRING |
Web property ID to update the goal |
profileId Required |
STRING |
View (Profile) ID to update the goal |
goalId Required |
STRING |
Index of the goal to be updated |
accountId |
STRING |
Account ID to which this goal belongs |
active |
BOOLEAN |
Determines whether this goal is active |
created |
DATE_TIME |
Time this goal was created |
eventDetails |
OBJECT |
Details for the goal of the type EVENT |
eventDetails.eventConditions[] |
OBJECT |
|
eventDetails.eventConditions[].comparisonType |
STRING |
Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL |
eventDetails.eventConditions[].comparisonValue |
INTEGER |
Value used for this comparison |
eventDetails.eventConditions[].expression |
STRING |
Expression used for this match |
eventDetails.eventConditions[].matchType |
STRING |
Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT |
eventDetails.eventConditions[].type |
STRING |
Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE |
eventDetails.useEventValue |
BOOLEAN |
Determines if the event value should be used as the value for this goal |
id |
STRING |
Goal ID |
internalWebPropertyId |
STRING |
Internal ID for the web property to which this goal belongs |
kind |
STRING |
Resource type for an Analytics goal |
name |
STRING |
Goal name |
parentLink |
OBJECT |
Parent link for a goal. Points to the view (profile) to which this goal belongs |
parentLink.href |
STRING |
Link to the view (profile) to which this goal belongs |
parentLink.type |
STRING |
Value is "analytics#profile" |
profileId |
STRING |
View (Profile) ID to which this goal belongs |
selfLink |
STRING |
Link for this goal |
type |
STRING |
Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT |
updated |
DATE_TIME |
Time this goal was last modified |
urlDestinationDetails |
OBJECT |
Details for the goal of the type URL_DESTINATION |
urlDestinationDetails.caseSensitive |
BOOLEAN |
Determines if the goal URL must exactly match the capitalization of visited URLs |
urlDestinationDetails.firstStepRequired |
BOOLEAN |
Determines if the first step in this goal is required |
urlDestinationDetails.matchType |
STRING |
Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX |
urlDestinationDetails.steps[] |
OBJECT |
|
urlDestinationDetails.steps[].name |
STRING |
Step name |
urlDestinationDetails.steps[].number |
INTEGER |
Step number |
urlDestinationDetails.steps[].url |
STRING |
URL for this step |
urlDestinationDetails.url |
STRING |
URL for this goal |
value |
FLOAT |
Goal value |
visitNumPagesDetails |
OBJECT |
Details for the goal of the type VISIT_NUM_PAGES |
visitNumPagesDetails.comparisonType |
STRING |
Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL |
visitNumPagesDetails.comparisonValue |
INTEGER |
Value used for this comparison |
visitTimeOnSiteDetails |
OBJECT |
Details for the goal of the type VISIT_TIME_ON_SITE |
visitTimeOnSiteDetails.comparisonType |
STRING |
Type of comparison. Possible values are LESS_THAN or GREATER_THAN |
visitTimeOnSiteDetails.comparisonValue |
INTEGER |
Value used for this comparison |
webPropertyId |
STRING |
Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY |
= Parameter name
= Format
|
accountId STRING Required Account ID to update the goal |
|
webPropertyId STRING Required Web property ID to update the goal |
|
profileId STRING Required View (Profile) ID to update the goal |
|
goalId STRING Required Index of the goal to be updated |
|
accountId STRING Account ID to which this goal belongs |
|
active BOOLEAN Determines whether this goal is active |
|
created DATE_TIME Time this goal was created |
|
eventDetails OBJECT Details for the goal of the type EVENT |
|
eventDetails.eventConditions[] OBJECT |
|
eventDetails.eventConditions[].comparisonType STRING Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL |
|
eventDetails.eventConditions[].comparisonValue INTEGER Value used for this comparison |
|
eventDetails.eventConditions[].expression STRING Expression used for this match |
|
eventDetails.eventConditions[].matchType STRING Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT |
|
eventDetails.eventConditions[].type STRING Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE |
|
eventDetails.useEventValue BOOLEAN Determines if the event value should be used as the value for this goal |
|
id STRING Goal ID |
|
internalWebPropertyId STRING Internal ID for the web property to which this goal belongs |
|
kind STRING Resource type for an Analytics goal |
|
name STRING Goal name |
|
parentLink OBJECT Parent link for a goal. Points to the view (profile) to which this goal belongs |
|
parentLink.href STRING Link to the view (profile) to which this goal belongs |
|
parentLink.type STRING Value is "analytics#profile" |
|
profileId STRING View (Profile) ID to which this goal belongs |
|
selfLink STRING Link for this goal |
|
type STRING Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT |
|
updated DATE_TIME Time this goal was last modified |
|
urlDestinationDetails OBJECT Details for the goal of the type URL_DESTINATION |
|
urlDestinationDetails.caseSensitive BOOLEAN Determines if the goal URL must exactly match the capitalization of visited URLs |
|
urlDestinationDetails.firstStepRequired BOOLEAN Determines if the first step in this goal is required |
|
urlDestinationDetails.matchType STRING Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX |
|
urlDestinationDetails.steps[] OBJECT |
|
urlDestinationDetails.steps[].name STRING Step name |
|
urlDestinationDetails.steps[].number INTEGER Step number |
|
urlDestinationDetails.steps[].url STRING URL for this step |
|
urlDestinationDetails.url STRING URL for this goal |
|
value FLOAT Goal value |
|
visitNumPagesDetails OBJECT Details for the goal of the type VISIT_NUM_PAGES |
|
visitNumPagesDetails.comparisonType STRING Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL |
|
visitNumPagesDetails.comparisonValue INTEGER Value used for this comparison |
|
visitTimeOnSiteDetails OBJECT Details for the goal of the type VISIT_TIME_ON_SITE |
|
visitTimeOnSiteDetails.comparisonType STRING Type of comparison. Possible values are LESS_THAN or GREATER_THAN |
|
visitTimeOnSiteDetails.comparisonValue INTEGER Value used for this comparison |
|
webPropertyId STRING Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY |
Output
This building block provides 39 output parameters
| Name | Format | Description |
|---|---|---|
accountId |
STRING |
Account ID to which this goal belongs |
active |
BOOLEAN |
Determines whether this goal is active |
created |
DATE_TIME |
Time this goal was created |
eventDetails |
OBJECT |
Details for the goal of the type EVENT |
eventDetails.eventConditions[] |
OBJECT |
|
eventDetails.eventConditions[].comparisonType |
STRING |
Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL |
eventDetails.eventConditions[].comparisonValue |
INTEGER |
Value used for this comparison |
eventDetails.eventConditions[].expression |
STRING |
Expression used for this match |
eventDetails.eventConditions[].matchType |
STRING |
Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT |
eventDetails.eventConditions[].type |
STRING |
Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE |
eventDetails.useEventValue |
BOOLEAN |
Determines if the event value should be used as the value for this goal |
id |
STRING |
Goal ID |
internalWebPropertyId |
STRING |
Internal ID for the web property to which this goal belongs |
kind |
STRING |
Resource type for an Analytics goal |
name |
STRING |
Goal name |
parentLink |
OBJECT |
Parent link for a goal. Points to the view (profile) to which this goal belongs |
parentLink.href |
STRING |
Link to the view (profile) to which this goal belongs |
parentLink.type |
STRING |
Value is "analytics#profile" |
profileId |
STRING |
View (Profile) ID to which this goal belongs |
selfLink |
STRING |
Link for this goal |
type |
STRING |
Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT |
updated |
DATE_TIME |
Time this goal was last modified |
urlDestinationDetails |
OBJECT |
Details for the goal of the type URL_DESTINATION |
urlDestinationDetails.caseSensitive |
BOOLEAN |
Determines if the goal URL must exactly match the capitalization of visited URLs |
urlDestinationDetails.firstStepRequired |
BOOLEAN |
Determines if the first step in this goal is required |
urlDestinationDetails.matchType |
STRING |
Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX |
urlDestinationDetails.steps[] |
OBJECT |
|
urlDestinationDetails.steps[].name |
STRING |
Step name |
urlDestinationDetails.steps[].number |
INTEGER |
Step number |
urlDestinationDetails.steps[].url |
STRING |
URL for this step |
urlDestinationDetails.url |
STRING |
URL for this goal |
value |
FLOAT |
Goal value |
visitNumPagesDetails |
OBJECT |
Details for the goal of the type VISIT_NUM_PAGES |
visitNumPagesDetails.comparisonType |
STRING |
Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL |
visitNumPagesDetails.comparisonValue |
INTEGER |
Value used for this comparison |
visitTimeOnSiteDetails |
OBJECT |
Details for the goal of the type VISIT_TIME_ON_SITE |
visitTimeOnSiteDetails.comparisonType |
STRING |
Type of comparison. Possible values are LESS_THAN or GREATER_THAN |
visitTimeOnSiteDetails.comparisonValue |
INTEGER |
Value used for this comparison |
webPropertyId |
STRING |
Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY |
= Parameter name
= Format
|
accountId STRING Account ID to which this goal belongs |
|
active BOOLEAN Determines whether this goal is active |
|
created DATE_TIME Time this goal was created |
|
eventDetails OBJECT Details for the goal of the type EVENT |
|
eventDetails.eventConditions[] OBJECT |
|
eventDetails.eventConditions[].comparisonType STRING Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL |
|
eventDetails.eventConditions[].comparisonValue INTEGER Value used for this comparison |
|
eventDetails.eventConditions[].expression STRING Expression used for this match |
|
eventDetails.eventConditions[].matchType STRING Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT |
|
eventDetails.eventConditions[].type STRING Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE |
|
eventDetails.useEventValue BOOLEAN Determines if the event value should be used as the value for this goal |
|
id STRING Goal ID |
|
internalWebPropertyId STRING Internal ID for the web property to which this goal belongs |
|
kind STRING Resource type for an Analytics goal |
|
name STRING Goal name |
|
parentLink OBJECT Parent link for a goal. Points to the view (profile) to which this goal belongs |
|
parentLink.href STRING Link to the view (profile) to which this goal belongs |
|
parentLink.type STRING Value is "analytics#profile" |
|
profileId STRING View (Profile) ID to which this goal belongs |
|
selfLink STRING Link for this goal |
|
type STRING Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT |
|
updated DATE_TIME Time this goal was last modified |
|
urlDestinationDetails OBJECT Details for the goal of the type URL_DESTINATION |
|
urlDestinationDetails.caseSensitive BOOLEAN Determines if the goal URL must exactly match the capitalization of visited URLs |
|
urlDestinationDetails.firstStepRequired BOOLEAN Determines if the first step in this goal is required |
|
urlDestinationDetails.matchType STRING Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX |
|
urlDestinationDetails.steps[] OBJECT |
|
urlDestinationDetails.steps[].name STRING Step name |
|
urlDestinationDetails.steps[].number INTEGER Step number |
|
urlDestinationDetails.steps[].url STRING URL for this step |
|
urlDestinationDetails.url STRING URL for this goal |
|
value FLOAT Goal value |
|
visitNumPagesDetails OBJECT Details for the goal of the type VISIT_NUM_PAGES |
|
visitNumPagesDetails.comparisonType STRING Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL |
|
visitNumPagesDetails.comparisonValue INTEGER Value used for this comparison |
|
visitTimeOnSiteDetails OBJECT Details for the goal of the type VISIT_TIME_ON_SITE |
|
visitTimeOnSiteDetails.comparisonType STRING Type of comparison. Possible values are LESS_THAN or GREATER_THAN |
|
visitTimeOnSiteDetails.comparisonValue INTEGER Value used for this comparison |
|
webPropertyId STRING Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY |