1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<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> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#delete">delete(accountId, webPropertyId, profileId, linkId)</a></code></p> 79<p class="firstline">Delete a profile filter link.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(accountId, webPropertyId, profileId, linkId)</a></code></p> 82<p class="firstline">Returns a single profile filter link.</p> 83<p class="toc_element"> 84 <code><a href="#insert">insert(accountId, webPropertyId, profileId, body)</a></code></p> 85<p class="firstline">Create a new profile filter link.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</a></code></p> 88<p class="firstline">Lists all profile filter links for a profile.</p> 89<p class="toc_element"> 90 <code><a href="#patch">patch(accountId, webPropertyId, profileId, linkId, body)</a></code></p> 91<p class="firstline">Update an existing profile filter link. This method supports patch semantics.</p> 92<p class="toc_element"> 93 <code><a href="#update">update(accountId, webPropertyId, profileId, linkId, body)</a></code></p> 94<p class="firstline">Update an existing profile filter link.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="delete">delete(accountId, webPropertyId, profileId, linkId)</code> 98 <pre>Delete a profile filter link. 99 100Args: 101 accountId: string, Account ID to which the profile filter link belongs. (required) 102 webPropertyId: string, Web property Id to which the profile filter link belongs. (required) 103 profileId: string, Profile ID to which the filter link belongs. (required) 104 linkId: string, ID of the profile filter link to delete. (required) 105</pre> 106</div> 107 108<div class="method"> 109 <code class="details" id="get">get(accountId, webPropertyId, profileId, linkId)</code> 110 <pre>Returns a single profile filter link. 111 112Args: 113 accountId: string, Account ID to retrieve profile filter link for. (required) 114 webPropertyId: string, Web property Id to retrieve profile filter link for. (required) 115 profileId: string, Profile ID to retrieve filter link for. (required) 116 linkId: string, ID of the profile filter link. (required) 117 118Returns: 119 An object of the form: 120 121 { # JSON template for an Analytics profile filter link. 122 "kind": "analytics#profileFilterLink", # Resource type for Analytics filter. 123 "rank": 42, # The rank of this profile filter link relative to the other filters linked to the same profile. 124 # For readonly (i.e., list and get) operations, the rank always starts at 1. 125 # 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. 126 "filterRef": { # JSON template for a profile filter link. # Filter for this link. 127 "kind": "analytics#filterRef", # Kind value for filter reference. 128 "href": "A String", # Link for this filter. 129 "id": "A String", # Filter ID. 130 "name": "A String", # Name of this filter. 131 "accountId": "A String", # Account ID to which this filter belongs. 132 }, 133 "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. 134 "kind": "analytics#profileRef", # Analytics view (profile) reference. 135 "name": "A String", # Name of this view (profile). 136 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. 137 "href": "A String", # Link for this view (profile). 138 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. 139 "id": "A String", # View (Profile) ID. 140 "accountId": "A String", # Account ID to which this view (profile) belongs. 141 }, 142 "id": "A String", # Profile filter link ID. 143 "selfLink": "A String", # Link for this profile filter link. 144 }</pre> 145</div> 146 147<div class="method"> 148 <code class="details" id="insert">insert(accountId, webPropertyId, profileId, body)</code> 149 <pre>Create a new profile filter link. 150 151Args: 152 accountId: string, Account ID to create profile filter link for. (required) 153 webPropertyId: string, Web property Id to create profile filter link for. (required) 154 profileId: string, Profile ID to create filter link for. (required) 155 body: object, The request body. (required) 156 The object takes the form of: 157 158{ # JSON template for an Analytics profile filter link. 159 "kind": "analytics#profileFilterLink", # Resource type for Analytics filter. 160 "rank": 42, # The rank of this profile filter link relative to the other filters linked to the same profile. 161 # For readonly (i.e., list and get) operations, the rank always starts at 1. 162 # 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. 163 "filterRef": { # JSON template for a profile filter link. # Filter for this link. 164 "kind": "analytics#filterRef", # Kind value for filter reference. 165 "href": "A String", # Link for this filter. 166 "id": "A String", # Filter ID. 167 "name": "A String", # Name of this filter. 168 "accountId": "A String", # Account ID to which this filter belongs. 169 }, 170 "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. 171 "kind": "analytics#profileRef", # Analytics view (profile) reference. 172 "name": "A String", # Name of this view (profile). 173 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. 174 "href": "A String", # Link for this view (profile). 175 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. 176 "id": "A String", # View (Profile) ID. 177 "accountId": "A String", # Account ID to which this view (profile) belongs. 178 }, 179 "id": "A String", # Profile filter link ID. 180 "selfLink": "A String", # Link for this profile filter link. 181 } 182 183 184Returns: 185 An object of the form: 186 187 { # JSON template for an Analytics profile filter link. 188 "kind": "analytics#profileFilterLink", # Resource type for Analytics filter. 189 "rank": 42, # The rank of this profile filter link relative to the other filters linked to the same profile. 190 # For readonly (i.e., list and get) operations, the rank always starts at 1. 191 # 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. 192 "filterRef": { # JSON template for a profile filter link. # Filter for this link. 193 "kind": "analytics#filterRef", # Kind value for filter reference. 194 "href": "A String", # Link for this filter. 195 "id": "A String", # Filter ID. 196 "name": "A String", # Name of this filter. 197 "accountId": "A String", # Account ID to which this filter belongs. 198 }, 199 "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. 200 "kind": "analytics#profileRef", # Analytics view (profile) reference. 201 "name": "A String", # Name of this view (profile). 202 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. 203 "href": "A String", # Link for this view (profile). 204 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. 205 "id": "A String", # View (Profile) ID. 206 "accountId": "A String", # Account ID to which this view (profile) belongs. 207 }, 208 "id": "A String", # Profile filter link ID. 209 "selfLink": "A String", # Link for this profile filter link. 210 }</pre> 211</div> 212 213<div class="method"> 214 <code class="details" id="list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</code> 215 <pre>Lists all profile filter links for a profile. 216 217Args: 218 accountId: string, Account ID to retrieve profile filter links for. (required) 219 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) 220 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) 221 max_results: integer, The maximum number of profile filter links to include in this response. 222 start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. 223 224Returns: 225 An object of the form: 226 227 { # A profile filter link collection lists profile filter links between profiles and filters. Each resource in the collection corresponds to a profile filter link. 228 "username": "A String", # Email ID of the authenticated user 229 "kind": "analytics#profileFilterLinks", # Collection type. 230 "items": [ # A list of profile filter links. 231 { # JSON template for an Analytics profile filter link. 232 "kind": "analytics#profileFilterLink", # Resource type for Analytics filter. 233 "rank": 42, # The rank of this profile filter link relative to the other filters linked to the same profile. 234 # For readonly (i.e., list and get) operations, the rank always starts at 1. 235 # 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. 236 "filterRef": { # JSON template for a profile filter link. # Filter for this link. 237 "kind": "analytics#filterRef", # Kind value for filter reference. 238 "href": "A String", # Link for this filter. 239 "id": "A String", # Filter ID. 240 "name": "A String", # Name of this filter. 241 "accountId": "A String", # Account ID to which this filter belongs. 242 }, 243 "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. 244 "kind": "analytics#profileRef", # Analytics view (profile) reference. 245 "name": "A String", # Name of this view (profile). 246 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. 247 "href": "A String", # Link for this view (profile). 248 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. 249 "id": "A String", # View (Profile) ID. 250 "accountId": "A String", # Account ID to which this view (profile) belongs. 251 }, 252 "id": "A String", # Profile filter link ID. 253 "selfLink": "A String", # Link for this profile filter link. 254 }, 255 ], 256 "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. 257 "previousLink": "A String", # Link to previous page for this profile filter link collection. 258 "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. 259 "nextLink": "A String", # Link to next page for this profile filter link collection. 260 "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response. 261 }</pre> 262</div> 263 264<div class="method"> 265 <code class="details" id="patch">patch(accountId, webPropertyId, profileId, linkId, body)</code> 266 <pre>Update an existing profile filter link. This method supports patch semantics. 267 268Args: 269 accountId: string, Account ID to which profile filter link belongs. (required) 270 webPropertyId: string, Web property Id to which profile filter link belongs (required) 271 profileId: string, Profile ID to which filter link belongs (required) 272 linkId: string, ID of the profile filter link to be updated. (required) 273 body: object, The request body. (required) 274 The object takes the form of: 275 276{ # JSON template for an Analytics profile filter link. 277 "kind": "analytics#profileFilterLink", # Resource type for Analytics filter. 278 "rank": 42, # The rank of this profile filter link relative to the other filters linked to the same profile. 279 # For readonly (i.e., list and get) operations, the rank always starts at 1. 280 # 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. 281 "filterRef": { # JSON template for a profile filter link. # Filter for this link. 282 "kind": "analytics#filterRef", # Kind value for filter reference. 283 "href": "A String", # Link for this filter. 284 "id": "A String", # Filter ID. 285 "name": "A String", # Name of this filter. 286 "accountId": "A String", # Account ID to which this filter belongs. 287 }, 288 "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. 289 "kind": "analytics#profileRef", # Analytics view (profile) reference. 290 "name": "A String", # Name of this view (profile). 291 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. 292 "href": "A String", # Link for this view (profile). 293 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. 294 "id": "A String", # View (Profile) ID. 295 "accountId": "A String", # Account ID to which this view (profile) belongs. 296 }, 297 "id": "A String", # Profile filter link ID. 298 "selfLink": "A String", # Link for this profile filter link. 299 } 300 301 302Returns: 303 An object of the form: 304 305 { # JSON template for an Analytics profile filter link. 306 "kind": "analytics#profileFilterLink", # Resource type for Analytics filter. 307 "rank": 42, # The rank of this profile filter link relative to the other filters linked to the same profile. 308 # For readonly (i.e., list and get) operations, the rank always starts at 1. 309 # 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. 310 "filterRef": { # JSON template for a profile filter link. # Filter for this link. 311 "kind": "analytics#filterRef", # Kind value for filter reference. 312 "href": "A String", # Link for this filter. 313 "id": "A String", # Filter ID. 314 "name": "A String", # Name of this filter. 315 "accountId": "A String", # Account ID to which this filter belongs. 316 }, 317 "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. 318 "kind": "analytics#profileRef", # Analytics view (profile) reference. 319 "name": "A String", # Name of this view (profile). 320 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. 321 "href": "A String", # Link for this view (profile). 322 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. 323 "id": "A String", # View (Profile) ID. 324 "accountId": "A String", # Account ID to which this view (profile) belongs. 325 }, 326 "id": "A String", # Profile filter link ID. 327 "selfLink": "A String", # Link for this profile filter link. 328 }</pre> 329</div> 330 331<div class="method"> 332 <code class="details" id="update">update(accountId, webPropertyId, profileId, linkId, body)</code> 333 <pre>Update an existing profile filter link. 334 335Args: 336 accountId: string, Account ID to which profile filter link belongs. (required) 337 webPropertyId: string, Web property Id to which profile filter link belongs (required) 338 profileId: string, Profile ID to which filter link belongs (required) 339 linkId: string, ID of the profile filter link to be updated. (required) 340 body: object, The request body. (required) 341 The object takes the form of: 342 343{ # JSON template for an Analytics profile filter link. 344 "kind": "analytics#profileFilterLink", # Resource type for Analytics filter. 345 "rank": 42, # The rank of this profile filter link relative to the other filters linked to the same profile. 346 # For readonly (i.e., list and get) operations, the rank always starts at 1. 347 # 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. 348 "filterRef": { # JSON template for a profile filter link. # Filter for this link. 349 "kind": "analytics#filterRef", # Kind value for filter reference. 350 "href": "A String", # Link for this filter. 351 "id": "A String", # Filter ID. 352 "name": "A String", # Name of this filter. 353 "accountId": "A String", # Account ID to which this filter belongs. 354 }, 355 "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. 356 "kind": "analytics#profileRef", # Analytics view (profile) reference. 357 "name": "A String", # Name of this view (profile). 358 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. 359 "href": "A String", # Link for this view (profile). 360 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. 361 "id": "A String", # View (Profile) ID. 362 "accountId": "A String", # Account ID to which this view (profile) belongs. 363 }, 364 "id": "A String", # Profile filter link ID. 365 "selfLink": "A String", # Link for this profile filter link. 366 } 367 368 369Returns: 370 An object of the form: 371 372 { # JSON template for an Analytics profile filter link. 373 "kind": "analytics#profileFilterLink", # Resource type for Analytics filter. 374 "rank": 42, # The rank of this profile filter link relative to the other filters linked to the same profile. 375 # For readonly (i.e., list and get) operations, the rank always starts at 1. 376 # 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. 377 "filterRef": { # JSON template for a profile filter link. # Filter for this link. 378 "kind": "analytics#filterRef", # Kind value for filter reference. 379 "href": "A String", # Link for this filter. 380 "id": "A String", # Filter ID. 381 "name": "A String", # Name of this filter. 382 "accountId": "A String", # Account ID to which this filter belongs. 383 }, 384 "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. 385 "kind": "analytics#profileRef", # Analytics view (profile) reference. 386 "name": "A String", # Name of this view (profile). 387 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. 388 "href": "A String", # Link for this view (profile). 389 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. 390 "id": "A String", # View (Profile) ID. 391 "accountId": "A String", # Account ID to which this view (profile) belongs. 392 }, 393 "id": "A String", # Profile filter link ID. 394 "selfLink": "A String", # Link for this profile filter link. 395 }</pre> 396</div> 397 398</body></html>