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.remarketingAudience.html">remarketingAudience</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(accountId, webPropertyId, remarketingAudienceId)</a></code></p> 82<p class="firstline">Delete a remarketing audience.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(accountId, webPropertyId, remarketingAudienceId)</a></code></p> 85<p class="firstline">Gets a remarketing audience to which the user has access.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(accountId, webPropertyId, body=None)</a></code></p> 88<p class="firstline">Creates a new remarketing audience.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=None, type=None)</a></code></p> 91<p class="firstline">Lists remarketing audiences to which the user has access.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(accountId, webPropertyId, remarketingAudienceId, body=None)</a></code></p> 94<p class="firstline">Updates an existing remarketing audience. This method supports patch semantics.</p> 95<p class="toc_element"> 96 <code><a href="#update">update(accountId, webPropertyId, remarketingAudienceId, body=None)</a></code></p> 97<p class="firstline">Updates an existing remarketing audience.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="delete">delete(accountId, webPropertyId, remarketingAudienceId)</code> 106 <pre>Delete a remarketing audience. 107 108Args: 109 accountId: string, Account ID to which the remarketing audience belongs. (required) 110 webPropertyId: string, Web property ID to which the remarketing audience belongs. (required) 111 remarketingAudienceId: string, The ID of the remarketing audience to delete. (required) 112</pre> 113</div> 114 115<div class="method"> 116 <code class="details" id="get">get(accountId, webPropertyId, remarketingAudienceId)</code> 117 <pre>Gets a remarketing audience to which the user has access. 118 119Args: 120 accountId: string, The account ID of the remarketing audience to retrieve. (required) 121 webPropertyId: string, The web property ID of the remarketing audience to retrieve. (required) 122 remarketingAudienceId: string, The ID of the remarketing audience to retrieve. (required) 123 124Returns: 125 An object of the form: 126 127 { # JSON template for an Analytics remarketing audience. 128 "accountId": "A String", # Account ID to which this remarketing audience belongs. 129 "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience. 130 "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. 131 "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. 132 "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 133 "kind": "analytics#includeConditions", # Resource type for include conditions. 134 "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. 135 "segment": "A String", # The segment condition that will cause a user to be added to an audience. 136 }, 137 }, 138 "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED. 139 "created": "A String", # Time this remarketing audience was created. 140 "description": "A String", # The description of this remarketing audience. 141 "id": "A String", # Remarketing Audience ID. 142 "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs. 143 "kind": "analytics#remarketingAudience", # Collection type. 144 "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. 145 { # JSON template for an Analytics Remarketing Audience Foreign Link. 146 "accountId": "A String", # Account ID to which this linked foreign account belongs. 147 "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search. 148 "id": "A String", # Entity ad account link ID. 149 "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs. 150 "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account. 151 "linkedAccountId": "A String", # The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX. 152 "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs. 153 "status": "A String", # The status of this foreign account link. 154 "type": "A String", # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`. 155 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. 156 }, 157 ], 158 "linkedViews": [ # The views (profiles) that this remarketing audience is linked to. 159 "A String", 160 ], 161 "name": "A String", # The name of this remarketing audience. 162 "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience. 163 "excludeConditions": { # Defines the conditions to exclude users from the audience. 164 "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT. 165 "segment": "A String", # The segment condition that will cause a user to be removed from an audience. 166 }, 167 "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. 168 "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. 169 "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 170 "kind": "analytics#includeConditions", # Resource type for include conditions. 171 "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. 172 "segment": "A String", # The segment condition that will cause a user to be added to an audience. 173 }, 174 }, 175 "updated": "A String", # Time this remarketing audience was last modified. 176 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. 177}</pre> 178</div> 179 180<div class="method"> 181 <code class="details" id="insert">insert(accountId, webPropertyId, body=None)</code> 182 <pre>Creates a new remarketing audience. 183 184Args: 185 accountId: string, The account ID for which to create the remarketing audience. (required) 186 webPropertyId: string, Web property ID for which to create the remarketing audience. (required) 187 body: object, The request body. 188 The object takes the form of: 189 190{ # JSON template for an Analytics remarketing audience. 191 "accountId": "A String", # Account ID to which this remarketing audience belongs. 192 "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience. 193 "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. 194 "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. 195 "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 196 "kind": "analytics#includeConditions", # Resource type for include conditions. 197 "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. 198 "segment": "A String", # The segment condition that will cause a user to be added to an audience. 199 }, 200 }, 201 "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED. 202 "created": "A String", # Time this remarketing audience was created. 203 "description": "A String", # The description of this remarketing audience. 204 "id": "A String", # Remarketing Audience ID. 205 "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs. 206 "kind": "analytics#remarketingAudience", # Collection type. 207 "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. 208 { # JSON template for an Analytics Remarketing Audience Foreign Link. 209 "accountId": "A String", # Account ID to which this linked foreign account belongs. 210 "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search. 211 "id": "A String", # Entity ad account link ID. 212 "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs. 213 "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account. 214 "linkedAccountId": "A String", # The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX. 215 "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs. 216 "status": "A String", # The status of this foreign account link. 217 "type": "A String", # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`. 218 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. 219 }, 220 ], 221 "linkedViews": [ # The views (profiles) that this remarketing audience is linked to. 222 "A String", 223 ], 224 "name": "A String", # The name of this remarketing audience. 225 "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience. 226 "excludeConditions": { # Defines the conditions to exclude users from the audience. 227 "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT. 228 "segment": "A String", # The segment condition that will cause a user to be removed from an audience. 229 }, 230 "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. 231 "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. 232 "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 233 "kind": "analytics#includeConditions", # Resource type for include conditions. 234 "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. 235 "segment": "A String", # The segment condition that will cause a user to be added to an audience. 236 }, 237 }, 238 "updated": "A String", # Time this remarketing audience was last modified. 239 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. 240} 241 242 243Returns: 244 An object of the form: 245 246 { # JSON template for an Analytics remarketing audience. 247 "accountId": "A String", # Account ID to which this remarketing audience belongs. 248 "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience. 249 "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. 250 "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. 251 "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 252 "kind": "analytics#includeConditions", # Resource type for include conditions. 253 "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. 254 "segment": "A String", # The segment condition that will cause a user to be added to an audience. 255 }, 256 }, 257 "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED. 258 "created": "A String", # Time this remarketing audience was created. 259 "description": "A String", # The description of this remarketing audience. 260 "id": "A String", # Remarketing Audience ID. 261 "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs. 262 "kind": "analytics#remarketingAudience", # Collection type. 263 "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. 264 { # JSON template for an Analytics Remarketing Audience Foreign Link. 265 "accountId": "A String", # Account ID to which this linked foreign account belongs. 266 "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search. 267 "id": "A String", # Entity ad account link ID. 268 "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs. 269 "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account. 270 "linkedAccountId": "A String", # The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX. 271 "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs. 272 "status": "A String", # The status of this foreign account link. 273 "type": "A String", # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`. 274 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. 275 }, 276 ], 277 "linkedViews": [ # The views (profiles) that this remarketing audience is linked to. 278 "A String", 279 ], 280 "name": "A String", # The name of this remarketing audience. 281 "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience. 282 "excludeConditions": { # Defines the conditions to exclude users from the audience. 283 "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT. 284 "segment": "A String", # The segment condition that will cause a user to be removed from an audience. 285 }, 286 "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. 287 "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. 288 "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 289 "kind": "analytics#includeConditions", # Resource type for include conditions. 290 "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. 291 "segment": "A String", # The segment condition that will cause a user to be added to an audience. 292 }, 293 }, 294 "updated": "A String", # Time this remarketing audience was last modified. 295 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. 296}</pre> 297</div> 298 299<div class="method"> 300 <code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=None, type=None)</code> 301 <pre>Lists remarketing audiences to which the user has access. 302 303Args: 304 accountId: string, The account ID of the remarketing audiences to retrieve. (required) 305 webPropertyId: string, The web property ID of the remarketing audiences to retrieve. (required) 306 max_results: integer, The maximum number of remarketing audiences to include in this response. 307 start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. 308 type: string, A parameter 309 310Returns: 311 An object of the form: 312 313 { # A remarketing audience collection lists Analytics remarketing audiences to which the user has access. Each resource in the collection corresponds to a single Analytics remarketing audience. 314 "items": [ # A list of remarketing audiences. 315 { # JSON template for an Analytics remarketing audience. 316 "accountId": "A String", # Account ID to which this remarketing audience belongs. 317 "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience. 318 "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. 319 "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. 320 "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 321 "kind": "analytics#includeConditions", # Resource type for include conditions. 322 "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. 323 "segment": "A String", # The segment condition that will cause a user to be added to an audience. 324 }, 325 }, 326 "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED. 327 "created": "A String", # Time this remarketing audience was created. 328 "description": "A String", # The description of this remarketing audience. 329 "id": "A String", # Remarketing Audience ID. 330 "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs. 331 "kind": "analytics#remarketingAudience", # Collection type. 332 "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. 333 { # JSON template for an Analytics Remarketing Audience Foreign Link. 334 "accountId": "A String", # Account ID to which this linked foreign account belongs. 335 "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search. 336 "id": "A String", # Entity ad account link ID. 337 "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs. 338 "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account. 339 "linkedAccountId": "A String", # The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX. 340 "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs. 341 "status": "A String", # The status of this foreign account link. 342 "type": "A String", # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`. 343 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. 344 }, 345 ], 346 "linkedViews": [ # The views (profiles) that this remarketing audience is linked to. 347 "A String", 348 ], 349 "name": "A String", # The name of this remarketing audience. 350 "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience. 351 "excludeConditions": { # Defines the conditions to exclude users from the audience. 352 "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT. 353 "segment": "A String", # The segment condition that will cause a user to be removed from an audience. 354 }, 355 "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. 356 "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. 357 "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 358 "kind": "analytics#includeConditions", # Resource type for include conditions. 359 "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. 360 "segment": "A String", # The segment condition that will cause a user to be added to an audience. 361 }, 362 }, 363 "updated": "A String", # Time this remarketing audience was last modified. 364 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. 365 }, 366 ], 367 "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 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. 368 "kind": "analytics#remarketingAudiences", # Collection type. 369 "nextLink": "A String", # Link to next page for this remarketing audience collection. 370 "previousLink": "A String", # Link to previous page for this view (profile) collection. 371 "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. 372 "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response. 373 "username": "A String", # Email ID of the authenticated user 374}</pre> 375</div> 376 377<div class="method"> 378 <code class="details" id="patch">patch(accountId, webPropertyId, remarketingAudienceId, body=None)</code> 379 <pre>Updates an existing remarketing audience. This method supports patch semantics. 380 381Args: 382 accountId: string, The account ID of the remarketing audience to update. (required) 383 webPropertyId: string, The web property ID of the remarketing audience to update. (required) 384 remarketingAudienceId: string, The ID of the remarketing audience to update. (required) 385 body: object, The request body. 386 The object takes the form of: 387 388{ # JSON template for an Analytics remarketing audience. 389 "accountId": "A String", # Account ID to which this remarketing audience belongs. 390 "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience. 391 "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. 392 "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. 393 "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 394 "kind": "analytics#includeConditions", # Resource type for include conditions. 395 "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. 396 "segment": "A String", # The segment condition that will cause a user to be added to an audience. 397 }, 398 }, 399 "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED. 400 "created": "A String", # Time this remarketing audience was created. 401 "description": "A String", # The description of this remarketing audience. 402 "id": "A String", # Remarketing Audience ID. 403 "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs. 404 "kind": "analytics#remarketingAudience", # Collection type. 405 "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. 406 { # JSON template for an Analytics Remarketing Audience Foreign Link. 407 "accountId": "A String", # Account ID to which this linked foreign account belongs. 408 "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search. 409 "id": "A String", # Entity ad account link ID. 410 "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs. 411 "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account. 412 "linkedAccountId": "A String", # The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX. 413 "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs. 414 "status": "A String", # The status of this foreign account link. 415 "type": "A String", # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`. 416 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. 417 }, 418 ], 419 "linkedViews": [ # The views (profiles) that this remarketing audience is linked to. 420 "A String", 421 ], 422 "name": "A String", # The name of this remarketing audience. 423 "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience. 424 "excludeConditions": { # Defines the conditions to exclude users from the audience. 425 "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT. 426 "segment": "A String", # The segment condition that will cause a user to be removed from an audience. 427 }, 428 "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. 429 "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. 430 "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 431 "kind": "analytics#includeConditions", # Resource type for include conditions. 432 "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. 433 "segment": "A String", # The segment condition that will cause a user to be added to an audience. 434 }, 435 }, 436 "updated": "A String", # Time this remarketing audience was last modified. 437 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. 438} 439 440 441Returns: 442 An object of the form: 443 444 { # JSON template for an Analytics remarketing audience. 445 "accountId": "A String", # Account ID to which this remarketing audience belongs. 446 "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience. 447 "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. 448 "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. 449 "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 450 "kind": "analytics#includeConditions", # Resource type for include conditions. 451 "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. 452 "segment": "A String", # The segment condition that will cause a user to be added to an audience. 453 }, 454 }, 455 "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED. 456 "created": "A String", # Time this remarketing audience was created. 457 "description": "A String", # The description of this remarketing audience. 458 "id": "A String", # Remarketing Audience ID. 459 "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs. 460 "kind": "analytics#remarketingAudience", # Collection type. 461 "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. 462 { # JSON template for an Analytics Remarketing Audience Foreign Link. 463 "accountId": "A String", # Account ID to which this linked foreign account belongs. 464 "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search. 465 "id": "A String", # Entity ad account link ID. 466 "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs. 467 "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account. 468 "linkedAccountId": "A String", # The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX. 469 "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs. 470 "status": "A String", # The status of this foreign account link. 471 "type": "A String", # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`. 472 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. 473 }, 474 ], 475 "linkedViews": [ # The views (profiles) that this remarketing audience is linked to. 476 "A String", 477 ], 478 "name": "A String", # The name of this remarketing audience. 479 "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience. 480 "excludeConditions": { # Defines the conditions to exclude users from the audience. 481 "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT. 482 "segment": "A String", # The segment condition that will cause a user to be removed from an audience. 483 }, 484 "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. 485 "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. 486 "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 487 "kind": "analytics#includeConditions", # Resource type for include conditions. 488 "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. 489 "segment": "A String", # The segment condition that will cause a user to be added to an audience. 490 }, 491 }, 492 "updated": "A String", # Time this remarketing audience was last modified. 493 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. 494}</pre> 495</div> 496 497<div class="method"> 498 <code class="details" id="update">update(accountId, webPropertyId, remarketingAudienceId, body=None)</code> 499 <pre>Updates an existing remarketing audience. 500 501Args: 502 accountId: string, The account ID of the remarketing audience to update. (required) 503 webPropertyId: string, The web property ID of the remarketing audience to update. (required) 504 remarketingAudienceId: string, The ID of the remarketing audience to update. (required) 505 body: object, The request body. 506 The object takes the form of: 507 508{ # JSON template for an Analytics remarketing audience. 509 "accountId": "A String", # Account ID to which this remarketing audience belongs. 510 "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience. 511 "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. 512 "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. 513 "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 514 "kind": "analytics#includeConditions", # Resource type for include conditions. 515 "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. 516 "segment": "A String", # The segment condition that will cause a user to be added to an audience. 517 }, 518 }, 519 "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED. 520 "created": "A String", # Time this remarketing audience was created. 521 "description": "A String", # The description of this remarketing audience. 522 "id": "A String", # Remarketing Audience ID. 523 "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs. 524 "kind": "analytics#remarketingAudience", # Collection type. 525 "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. 526 { # JSON template for an Analytics Remarketing Audience Foreign Link. 527 "accountId": "A String", # Account ID to which this linked foreign account belongs. 528 "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search. 529 "id": "A String", # Entity ad account link ID. 530 "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs. 531 "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account. 532 "linkedAccountId": "A String", # The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX. 533 "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs. 534 "status": "A String", # The status of this foreign account link. 535 "type": "A String", # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`. 536 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. 537 }, 538 ], 539 "linkedViews": [ # The views (profiles) that this remarketing audience is linked to. 540 "A String", 541 ], 542 "name": "A String", # The name of this remarketing audience. 543 "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience. 544 "excludeConditions": { # Defines the conditions to exclude users from the audience. 545 "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT. 546 "segment": "A String", # The segment condition that will cause a user to be removed from an audience. 547 }, 548 "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. 549 "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. 550 "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 551 "kind": "analytics#includeConditions", # Resource type for include conditions. 552 "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. 553 "segment": "A String", # The segment condition that will cause a user to be added to an audience. 554 }, 555 }, 556 "updated": "A String", # Time this remarketing audience was last modified. 557 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. 558} 559 560 561Returns: 562 An object of the form: 563 564 { # JSON template for an Analytics remarketing audience. 565 "accountId": "A String", # Account ID to which this remarketing audience belongs. 566 "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience. 567 "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. 568 "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. 569 "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 570 "kind": "analytics#includeConditions", # Resource type for include conditions. 571 "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. 572 "segment": "A String", # The segment condition that will cause a user to be added to an audience. 573 }, 574 }, 575 "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED. 576 "created": "A String", # Time this remarketing audience was created. 577 "description": "A String", # The description of this remarketing audience. 578 "id": "A String", # Remarketing Audience ID. 579 "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs. 580 "kind": "analytics#remarketingAudience", # Collection type. 581 "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. 582 { # JSON template for an Analytics Remarketing Audience Foreign Link. 583 "accountId": "A String", # Account ID to which this linked foreign account belongs. 584 "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search. 585 "id": "A String", # Entity ad account link ID. 586 "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs. 587 "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account. 588 "linkedAccountId": "A String", # The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX. 589 "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs. 590 "status": "A String", # The status of this foreign account link. 591 "type": "A String", # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`. 592 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. 593 }, 594 ], 595 "linkedViews": [ # The views (profiles) that this remarketing audience is linked to. 596 "A String", 597 ], 598 "name": "A String", # The name of this remarketing audience. 599 "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience. 600 "excludeConditions": { # Defines the conditions to exclude users from the audience. 601 "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT. 602 "segment": "A String", # The segment condition that will cause a user to be removed from an audience. 603 }, 604 "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. 605 "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. 606 "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 607 "kind": "analytics#includeConditions", # Resource type for include conditions. 608 "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. 609 "segment": "A String", # The segment condition that will cause a user to be added to an audience. 610 }, 611 }, 612 "updated": "A String", # Time this remarketing audience was last modified. 613 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. 614}</pre> 615</div> 616 617</body></html>