| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.profileFilterLinks.html">profileFilterLinks</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(accountId, webPropertyId, profileId, linkId)</a></code></p> |
| <p class="firstline">Delete a profile filter link.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(accountId, webPropertyId, profileId, linkId)</a></code></p> |
| <p class="firstline">Returns a single profile filter link.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(accountId, webPropertyId, profileId, body=None)</a></code></p> |
| <p class="firstline">Create a new profile filter link.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(accountId, webPropertyId, profileId, start_index=None, max_results=None)</a></code></p> |
| <p class="firstline">Lists all profile filter links for a profile.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(accountId, webPropertyId, profileId, linkId, body=None)</a></code></p> |
| <p class="firstline">Update an existing profile filter link. This method supports patch semantics.</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(accountId, webPropertyId, profileId, linkId, body=None)</a></code></p> |
| <p class="firstline">Update an existing profile filter link.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="delete">delete(accountId, webPropertyId, profileId, linkId)</code> |
| <pre>Delete a profile filter link. |
| |
| Args: |
| accountId: string, Account ID to which the profile filter link belongs. (required) |
| webPropertyId: string, Web property Id to which the profile filter link belongs. (required) |
| profileId: string, Profile ID to which the filter link belongs. (required) |
| linkId: string, ID of the profile filter link to delete. (required) |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(accountId, webPropertyId, profileId, linkId)</code> |
| <pre>Returns a single profile filter link. |
| |
| Args: |
| accountId: string, Account ID to retrieve profile filter link for. (required) |
| webPropertyId: string, Web property Id to retrieve profile filter link for. (required) |
| profileId: string, Profile ID to retrieve filter link for. (required) |
| linkId: string, ID of the profile filter link. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { # JSON template for an Analytics profile filter link. |
| "filterRef": { # JSON template for a profile filter link. # Filter for this link. |
| "kind": "analytics#filterRef", # Kind value for filter reference. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "name": "A String", # Name of this filter. |
| "href": "A String", # Link for this filter. |
| "id": "A String", # Filter ID. |
| }, |
| "rank": 42, # 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. |
| "kind": "analytics#profileFilterLink", # Resource type for Analytics filter. |
| "id": "A String", # Profile filter link ID. |
| "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. |
| "id": "A String", # View (Profile) ID. |
| "name": "A String", # Name of this view (profile). |
| "kind": "analytics#profileRef", # Analytics view (profile) reference. |
| "accountId": "A String", # Account ID to which this view (profile) belongs. |
| "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| "href": "A String", # Link for this view (profile). |
| "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| }, |
| "selfLink": "A String", # Link for this profile filter link. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(accountId, webPropertyId, profileId, body=None)</code> |
| <pre>Create a new profile filter link. |
| |
| Args: |
| accountId: string, Account ID to create profile filter link for. (required) |
| webPropertyId: string, Web property Id to create profile filter link for. (required) |
| profileId: string, Profile ID to create filter link for. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # JSON template for an Analytics profile filter link. |
| "filterRef": { # JSON template for a profile filter link. # Filter for this link. |
| "kind": "analytics#filterRef", # Kind value for filter reference. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "name": "A String", # Name of this filter. |
| "href": "A String", # Link for this filter. |
| "id": "A String", # Filter ID. |
| }, |
| "rank": 42, # 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. |
| "kind": "analytics#profileFilterLink", # Resource type for Analytics filter. |
| "id": "A String", # Profile filter link ID. |
| "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. |
| "id": "A String", # View (Profile) ID. |
| "name": "A String", # Name of this view (profile). |
| "kind": "analytics#profileRef", # Analytics view (profile) reference. |
| "accountId": "A String", # Account ID to which this view (profile) belongs. |
| "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| "href": "A String", # Link for this view (profile). |
| "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| }, |
| "selfLink": "A String", # Link for this profile filter link. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { # JSON template for an Analytics profile filter link. |
| "filterRef": { # JSON template for a profile filter link. # Filter for this link. |
| "kind": "analytics#filterRef", # Kind value for filter reference. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "name": "A String", # Name of this filter. |
| "href": "A String", # Link for this filter. |
| "id": "A String", # Filter ID. |
| }, |
| "rank": 42, # 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. |
| "kind": "analytics#profileFilterLink", # Resource type for Analytics filter. |
| "id": "A String", # Profile filter link ID. |
| "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. |
| "id": "A String", # View (Profile) ID. |
| "name": "A String", # Name of this view (profile). |
| "kind": "analytics#profileRef", # Analytics view (profile) reference. |
| "accountId": "A String", # Account ID to which this view (profile) belongs. |
| "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| "href": "A String", # Link for this view (profile). |
| "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| }, |
| "selfLink": "A String", # Link for this profile filter link. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(accountId, webPropertyId, profileId, start_index=None, max_results=None)</code> |
| <pre>Lists all profile filter links for a profile. |
| |
| Args: |
| accountId: string, Account ID to retrieve profile filter links for. (required) |
| webPropertyId: string, Web property Id for profile filter links for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. (required) |
| profileId: string, Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. (required) |
| start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| max_results: integer, The maximum number of profile filter links to include in this response. |
| |
| Returns: |
| An object of the form: |
| |
| { # A profile filter link collection lists profile filter links between profiles and filters. Each resource in the collection corresponds to a profile filter link. |
| "username": "A String", # Email ID of the authenticated user |
| "kind": "analytics#profileFilterLinks", # Collection type. |
| "items": [ # A list of profile filter links. |
| { # JSON template for an Analytics profile filter link. |
| "filterRef": { # JSON template for a profile filter link. # Filter for this link. |
| "kind": "analytics#filterRef", # Kind value for filter reference. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "name": "A String", # Name of this filter. |
| "href": "A String", # Link for this filter. |
| "id": "A String", # Filter ID. |
| }, |
| "rank": 42, # 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. |
| "kind": "analytics#profileFilterLink", # Resource type for Analytics filter. |
| "id": "A String", # Profile filter link ID. |
| "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. |
| "id": "A String", # View (Profile) ID. |
| "name": "A String", # Name of this view (profile). |
| "kind": "analytics#profileRef", # Analytics view (profile) reference. |
| "accountId": "A String", # Account ID to which this view (profile) belongs. |
| "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| "href": "A String", # Link for this view (profile). |
| "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| }, |
| "selfLink": "A String", # Link for this profile filter link. |
| }, |
| ], |
| "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response. |
| "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. |
| "previousLink": "A String", # Link to previous page for this profile filter link collection. |
| "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. |
| "nextLink": "A String", # Link to next page for this profile filter link collection. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(accountId, webPropertyId, profileId, linkId, body=None)</code> |
| <pre>Update an existing profile filter link. This method supports patch semantics. |
| |
| Args: |
| accountId: string, Account ID to which profile filter link belongs. (required) |
| webPropertyId: string, Web property Id to which profile filter link belongs (required) |
| profileId: string, Profile ID to which filter link belongs (required) |
| linkId: string, ID of the profile filter link to be updated. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # JSON template for an Analytics profile filter link. |
| "filterRef": { # JSON template for a profile filter link. # Filter for this link. |
| "kind": "analytics#filterRef", # Kind value for filter reference. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "name": "A String", # Name of this filter. |
| "href": "A String", # Link for this filter. |
| "id": "A String", # Filter ID. |
| }, |
| "rank": 42, # 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. |
| "kind": "analytics#profileFilterLink", # Resource type for Analytics filter. |
| "id": "A String", # Profile filter link ID. |
| "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. |
| "id": "A String", # View (Profile) ID. |
| "name": "A String", # Name of this view (profile). |
| "kind": "analytics#profileRef", # Analytics view (profile) reference. |
| "accountId": "A String", # Account ID to which this view (profile) belongs. |
| "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| "href": "A String", # Link for this view (profile). |
| "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| }, |
| "selfLink": "A String", # Link for this profile filter link. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { # JSON template for an Analytics profile filter link. |
| "filterRef": { # JSON template for a profile filter link. # Filter for this link. |
| "kind": "analytics#filterRef", # Kind value for filter reference. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "name": "A String", # Name of this filter. |
| "href": "A String", # Link for this filter. |
| "id": "A String", # Filter ID. |
| }, |
| "rank": 42, # 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. |
| "kind": "analytics#profileFilterLink", # Resource type for Analytics filter. |
| "id": "A String", # Profile filter link ID. |
| "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. |
| "id": "A String", # View (Profile) ID. |
| "name": "A String", # Name of this view (profile). |
| "kind": "analytics#profileRef", # Analytics view (profile) reference. |
| "accountId": "A String", # Account ID to which this view (profile) belongs. |
| "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| "href": "A String", # Link for this view (profile). |
| "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| }, |
| "selfLink": "A String", # Link for this profile filter link. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(accountId, webPropertyId, profileId, linkId, body=None)</code> |
| <pre>Update an existing profile filter link. |
| |
| Args: |
| accountId: string, Account ID to which profile filter link belongs. (required) |
| webPropertyId: string, Web property Id to which profile filter link belongs (required) |
| profileId: string, Profile ID to which filter link belongs (required) |
| linkId: string, ID of the profile filter link to be updated. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # JSON template for an Analytics profile filter link. |
| "filterRef": { # JSON template for a profile filter link. # Filter for this link. |
| "kind": "analytics#filterRef", # Kind value for filter reference. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "name": "A String", # Name of this filter. |
| "href": "A String", # Link for this filter. |
| "id": "A String", # Filter ID. |
| }, |
| "rank": 42, # 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. |
| "kind": "analytics#profileFilterLink", # Resource type for Analytics filter. |
| "id": "A String", # Profile filter link ID. |
| "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. |
| "id": "A String", # View (Profile) ID. |
| "name": "A String", # Name of this view (profile). |
| "kind": "analytics#profileRef", # Analytics view (profile) reference. |
| "accountId": "A String", # Account ID to which this view (profile) belongs. |
| "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| "href": "A String", # Link for this view (profile). |
| "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| }, |
| "selfLink": "A String", # Link for this profile filter link. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { # JSON template for an Analytics profile filter link. |
| "filterRef": { # JSON template for a profile filter link. # Filter for this link. |
| "kind": "analytics#filterRef", # Kind value for filter reference. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "name": "A String", # Name of this filter. |
| "href": "A String", # Link for this filter. |
| "id": "A String", # Filter ID. |
| }, |
| "rank": 42, # 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. |
| "kind": "analytics#profileFilterLink", # Resource type for Analytics filter. |
| "id": "A String", # Profile filter link ID. |
| "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. |
| "id": "A String", # View (Profile) ID. |
| "name": "A String", # Name of this view (profile). |
| "kind": "analytics#profileRef", # Analytics view (profile) reference. |
| "accountId": "A String", # Account ID to which this view (profile) belongs. |
| "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| "href": "A String", # Link for this view (profile). |
| "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| }, |
| "selfLink": "A String", # Link for this profile filter link. |
| }</pre> |
| </div> |
| |
| </body></html> |
