Patch
|
|||||
|
|
Update an existing profile filter link. This method supports patch semantics
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 22 input parameters
Name | Format | Description |
---|---|---|
accountId Required |
STRING |
Account ID to which profile filter link belongs |
webPropertyId Required |
STRING |
Web property Id to which profile filter link belongs |
profileId Required |
STRING |
Profile ID to which filter link belongs |
linkId Required |
STRING |
ID of the profile filter link to be updated |
filterRef |
OBJECT |
JSON template for a profile filter link |
filterRef.accountId |
STRING |
Account ID to which this filter belongs |
filterRef.href |
STRING |
Link for this filter |
filterRef.id |
STRING |
Filter ID |
filterRef.kind |
STRING |
Kind value for filter reference |
filterRef.name |
STRING |
Name of this filter |
id |
STRING |
Profile filter link ID |
kind |
STRING |
Resource type for Analytics filter |
profileRef |
OBJECT |
JSON template for a linked view (profile) |
profileRef.accountId |
STRING |
Account ID to which this view (profile) belongs |
profileRef.href |
STRING |
Link for this view (profile) |
profileRef.id |
STRING |
View (Profile) ID |
profileRef.internalWebPropertyId |
STRING |
Internal ID for the web property to which this view (profile) belongs |
profileRef.kind |
STRING |
Analytics view (profile) reference |
profileRef.name |
STRING |
Name of this view (profile) |
profileRef.webPropertyId |
STRING |
Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs |
rank |
INTEGER |
The rank of this profile filter link relative to the other filters linked to the same profile. For readonly (i.e., list and get) operations, the rank always starts at 1. For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1 |
selfLink |
STRING |
Link for this profile filter link |
= Parameter name
= Format
accountId STRING Required Account ID to which profile filter link belongs |
webPropertyId STRING Required Web property Id to which profile filter link belongs |
profileId STRING Required Profile ID to which filter link belongs |
linkId STRING Required ID of the profile filter link to be updated |
filterRef OBJECT JSON template for a profile filter link |
filterRef.accountId STRING Account ID to which this filter belongs |
filterRef.href STRING Link for this filter |
filterRef.id STRING Filter ID |
filterRef.kind STRING Kind value for filter reference |
filterRef.name STRING Name of this filter |
id STRING Profile filter link ID |
kind STRING Resource type for Analytics filter |
profileRef OBJECT JSON template for a linked view (profile) |
profileRef.accountId STRING Account ID to which this view (profile) belongs |
profileRef.href STRING Link for this view (profile) |
profileRef.id STRING View (Profile) ID |
profileRef.internalWebPropertyId STRING Internal ID for the web property to which this view (profile) belongs |
profileRef.kind STRING Analytics view (profile) reference |
profileRef.name STRING Name of this view (profile) |
profileRef.webPropertyId STRING Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs |
rank INTEGER The rank of this profile filter link relative to the other filters linked to the same profile. For readonly (i.e., list and get) operations, the rank always starts at 1. For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1 |
selfLink STRING Link for this profile filter link |
Output
This building block provides 18 output parameters
Name | Format | Description |
---|---|---|
filterRef |
OBJECT |
JSON template for a profile filter link |
filterRef.accountId |
STRING |
Account ID to which this filter belongs |
filterRef.href |
STRING |
Link for this filter |
filterRef.id |
STRING |
Filter ID |
filterRef.kind |
STRING |
Kind value for filter reference |
filterRef.name |
STRING |
Name of this filter |
id |
STRING |
Profile filter link ID |
kind |
STRING |
Resource type for Analytics filter |
profileRef |
OBJECT |
JSON template for a linked view (profile) |
profileRef.accountId |
STRING |
Account ID to which this view (profile) belongs |
profileRef.href |
STRING |
Link for this view (profile) |
profileRef.id |
STRING |
View (Profile) ID |
profileRef.internalWebPropertyId |
STRING |
Internal ID for the web property to which this view (profile) belongs |
profileRef.kind |
STRING |
Analytics view (profile) reference |
profileRef.name |
STRING |
Name of this view (profile) |
profileRef.webPropertyId |
STRING |
Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs |
rank |
INTEGER |
The rank of this profile filter link relative to the other filters linked to the same profile. For readonly (i.e., list and get) operations, the rank always starts at 1. For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1 |
selfLink |
STRING |
Link for this profile filter link |
= Parameter name
= Format
filterRef OBJECT JSON template for a profile filter link |
filterRef.accountId STRING Account ID to which this filter belongs |
filterRef.href STRING Link for this filter |
filterRef.id STRING Filter ID |
filterRef.kind STRING Kind value for filter reference |
filterRef.name STRING Name of this filter |
id STRING Profile filter link ID |
kind STRING Resource type for Analytics filter |
profileRef OBJECT JSON template for a linked view (profile) |
profileRef.accountId STRING Account ID to which this view (profile) belongs |
profileRef.href STRING Link for this view (profile) |
profileRef.id STRING View (Profile) ID |
profileRef.internalWebPropertyId STRING Internal ID for the web property to which this view (profile) belongs |
profileRef.kind STRING Analytics view (profile) reference |
profileRef.name STRING Name of this view (profile) |
profileRef.webPropertyId STRING Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs |
rank INTEGER The rank of this profile filter link relative to the other filters linked to the same profile. For readonly (i.e., list and get) operations, the rank always starts at 1. For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1 |
selfLink STRING Link for this profile filter link |