Requires authorization
Create a new profile filter link. Try it now or see an example.
Request
HTTP request
POST https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
accountId |
string |
Account ID to create profile filter link for. |
profileId |
string |
Profile ID to create filter link for. |
webPropertyId |
string |
Web property Id to create profile filter link for. |
Authorization
This request requires authorization with the following scope (read more about authentication and authorization).
Scope |
---|
https://www.googleapis.com/auth/analytics.edit |
Request body
In the request body, supply a Profile Filter Links resource with the following properties:
Property name | Value | Description | Notes |
---|---|---|---|
Required Properties | |||
filterRef.id |
string |
Filter ID. | writable |
Optional Properties | |||
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. |
writable |
Response
If successful, this method returns a Profile Filter Links resource in the response body.
Examples
Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).
Java
Uses the Java client library.
/* * Note: This code assumes you have an authorized Analytics service object. * See the Filters Developer Guide for details. */ /* * This request creates a new profile filter link. */ // Construct the filter reference. FilterRef filterRef = new FilterRef(); filterRef.setId("1223334444"); // Construct the body of the request. ProfileFilterLink body = new ProfileFilterLink(); body.setFilterRef(filterRef); try { analytics.management().profileFilterLinks().insert("123456", "UA-123456-1", "7654321", body).execute(); } catch (GoogleJsonResponseException e) { System.err.println("There was a service error: " + e.getDetails().getCode() + " : " + e.getDetails().getMessage()); }
Python
Uses the Python client library.
# Note: This code assumes you have an authorized Analytics service object. # See the Filters Developer Guide for details. # This request creates a new profile filter link. try: analytics.management().profileFilterLinks().insert( accountId='123456', webPropertyId='UA-123456-1', profileId='7654321', body={ 'filterRef': { 'id': '1223334444' } } ).execute() except TypeError, error: # Handle errors in constructing a query. print 'There was an error in constructing your query : %s' % error except HttpError, error: # Handle API errors. print ('There was an API error : %s : %s' % (error.resp.status, error.resp.reason))
Try it!
Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.