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="dfareporting_v2_7.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_7.remarketingLists.html">remarketingLists</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#get">get(profileId, id)</a></code></p> 79<p class="firstline">Gets one remarketing list by ID.</p> 80<p class="toc_element"> 81 <code><a href="#insert">insert(profileId, body)</a></code></p> 82<p class="firstline">Inserts a new remarketing list.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(profileId, advertiserId, name=None, pageToken=None, sortField=None, floodlightActivityId=None, maxResults=None, active=None, sortOrder=None)</a></code></p> 85<p class="firstline">Retrieves a list of remarketing lists, possibly filtered. This method supports paging.</p> 86<p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88<p class="firstline">Retrieves the next page of results.</p> 89<p class="toc_element"> 90 <code><a href="#patch">patch(profileId, id, body)</a></code></p> 91<p class="firstline">Updates an existing remarketing list. This method supports patch semantics.</p> 92<p class="toc_element"> 93 <code><a href="#update">update(profileId, body)</a></code></p> 94<p class="firstline">Updates an existing remarketing list.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="get">get(profileId, id)</code> 98 <pre>Gets one remarketing list by ID. 99 100Args: 101 profileId: string, User profile ID associated with this request. (required) 102 id: string, Remarketing list ID. (required) 103 104Returns: 105 An object of the form: 106 107 { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. 108 "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users. 109 "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. 110 "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank. 111 "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. 112 { # A group clause made up of list population terms representing constraints joined by ORs. 113 "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. 114 { # Remarketing List Population Rule Term. 115 "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. 116 "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. 117 "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 118 "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 119 "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. 120 "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 121 "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. 122 "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. 123 }, 124 ], 125 }, 126 ], 127 }, 128 "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". 129 "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. 130 "description": "A String", # Remarketing list description. 131 "listSize": "A String", # Number of users currently in the list. This is a read-only field. 132 "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. 133 "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. 134 "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field. 135 "listSource": "A String", # Product from which this remarketing list was originated. 136 "active": True or False, # Whether this remarketing list is active. 137 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 138 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 139 "value": "A String", # The value of the dimension. 140 "dimensionName": "A String", # The name of the dimension. 141 "etag": "A String", # The eTag of this response for caching purposes. 142 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 143 "id": "A String", # The ID associated with the value if available. 144 }, 145 "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field. 146 "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. 147 }</pre> 148</div> 149 150<div class="method"> 151 <code class="details" id="insert">insert(profileId, body)</code> 152 <pre>Inserts a new remarketing list. 153 154Args: 155 profileId: string, User profile ID associated with this request. (required) 156 body: object, The request body. (required) 157 The object takes the form of: 158 159{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. 160 "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users. 161 "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. 162 "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank. 163 "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. 164 { # A group clause made up of list population terms representing constraints joined by ORs. 165 "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. 166 { # Remarketing List Population Rule Term. 167 "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. 168 "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. 169 "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 170 "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 171 "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. 172 "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 173 "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. 174 "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. 175 }, 176 ], 177 }, 178 ], 179 }, 180 "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". 181 "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. 182 "description": "A String", # Remarketing list description. 183 "listSize": "A String", # Number of users currently in the list. This is a read-only field. 184 "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. 185 "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. 186 "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field. 187 "listSource": "A String", # Product from which this remarketing list was originated. 188 "active": True or False, # Whether this remarketing list is active. 189 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 190 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 191 "value": "A String", # The value of the dimension. 192 "dimensionName": "A String", # The name of the dimension. 193 "etag": "A String", # The eTag of this response for caching purposes. 194 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 195 "id": "A String", # The ID associated with the value if available. 196 }, 197 "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field. 198 "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. 199 } 200 201 202Returns: 203 An object of the form: 204 205 { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. 206 "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users. 207 "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. 208 "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank. 209 "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. 210 { # A group clause made up of list population terms representing constraints joined by ORs. 211 "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. 212 { # Remarketing List Population Rule Term. 213 "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. 214 "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. 215 "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 216 "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 217 "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. 218 "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 219 "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. 220 "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. 221 }, 222 ], 223 }, 224 ], 225 }, 226 "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". 227 "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. 228 "description": "A String", # Remarketing list description. 229 "listSize": "A String", # Number of users currently in the list. This is a read-only field. 230 "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. 231 "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. 232 "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field. 233 "listSource": "A String", # Product from which this remarketing list was originated. 234 "active": True or False, # Whether this remarketing list is active. 235 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 236 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 237 "value": "A String", # The value of the dimension. 238 "dimensionName": "A String", # The name of the dimension. 239 "etag": "A String", # The eTag of this response for caching purposes. 240 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 241 "id": "A String", # The ID associated with the value if available. 242 }, 243 "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field. 244 "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. 245 }</pre> 246</div> 247 248<div class="method"> 249 <code class="details" id="list">list(profileId, advertiserId, name=None, pageToken=None, sortField=None, floodlightActivityId=None, maxResults=None, active=None, sortOrder=None)</code> 250 <pre>Retrieves a list of remarketing lists, possibly filtered. This method supports paging. 251 252Args: 253 profileId: string, User profile ID associated with this request. (required) 254 advertiserId: string, Select only remarketing lists owned by this advertiser. (required) 255 name: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". 256 pageToken: string, Value of the nextPageToken from the previous result page. 257 sortField: string, Field by which to sort the list. 258 Allowed values 259 ID - 260 NAME - 261 floodlightActivityId: string, Select only remarketing lists that have this floodlight activity ID. 262 maxResults: integer, Maximum number of results to return. 263 active: boolean, Select only active or only inactive remarketing lists. 264 sortOrder: string, Order of sorted results. 265 Allowed values 266 ASCENDING - 267 DESCENDING - 268 269Returns: 270 An object of the form: 271 272 { # Remarketing list response 273 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 274 "remarketingLists": [ # Remarketing list collection. 275 { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. 276 "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users. 277 "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. 278 "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank. 279 "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. 280 { # A group clause made up of list population terms representing constraints joined by ORs. 281 "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. 282 { # Remarketing List Population Rule Term. 283 "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. 284 "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. 285 "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 286 "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 287 "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. 288 "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 289 "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. 290 "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. 291 }, 292 ], 293 }, 294 ], 295 }, 296 "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". 297 "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. 298 "description": "A String", # Remarketing list description. 299 "listSize": "A String", # Number of users currently in the list. This is a read-only field. 300 "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. 301 "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. 302 "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field. 303 "listSource": "A String", # Product from which this remarketing list was originated. 304 "active": True or False, # Whether this remarketing list is active. 305 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 306 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 307 "value": "A String", # The value of the dimension. 308 "dimensionName": "A String", # The name of the dimension. 309 "etag": "A String", # The eTag of this response for caching purposes. 310 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 311 "id": "A String", # The ID associated with the value if available. 312 }, 313 "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field. 314 "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. 315 }, 316 ], 317 "kind": "dfareporting#remarketingListsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse". 318 }</pre> 319</div> 320 321<div class="method"> 322 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 323 <pre>Retrieves the next page of results. 324 325Args: 326 previous_request: The request for the previous page. (required) 327 previous_response: The response from the request for the previous page. (required) 328 329Returns: 330 A request object that you can call 'execute()' on to request the next 331 page. Returns None if there are no more items in the collection. 332 </pre> 333</div> 334 335<div class="method"> 336 <code class="details" id="patch">patch(profileId, id, body)</code> 337 <pre>Updates an existing remarketing list. This method supports patch semantics. 338 339Args: 340 profileId: string, User profile ID associated with this request. (required) 341 id: string, Remarketing list ID. (required) 342 body: object, The request body. (required) 343 The object takes the form of: 344 345{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. 346 "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users. 347 "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. 348 "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank. 349 "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. 350 { # A group clause made up of list population terms representing constraints joined by ORs. 351 "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. 352 { # Remarketing List Population Rule Term. 353 "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. 354 "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. 355 "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 356 "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 357 "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. 358 "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 359 "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. 360 "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. 361 }, 362 ], 363 }, 364 ], 365 }, 366 "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". 367 "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. 368 "description": "A String", # Remarketing list description. 369 "listSize": "A String", # Number of users currently in the list. This is a read-only field. 370 "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. 371 "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. 372 "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field. 373 "listSource": "A String", # Product from which this remarketing list was originated. 374 "active": True or False, # Whether this remarketing list is active. 375 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 376 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 377 "value": "A String", # The value of the dimension. 378 "dimensionName": "A String", # The name of the dimension. 379 "etag": "A String", # The eTag of this response for caching purposes. 380 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 381 "id": "A String", # The ID associated with the value if available. 382 }, 383 "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field. 384 "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. 385 } 386 387 388Returns: 389 An object of the form: 390 391 { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. 392 "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users. 393 "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. 394 "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank. 395 "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. 396 { # A group clause made up of list population terms representing constraints joined by ORs. 397 "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. 398 { # Remarketing List Population Rule Term. 399 "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. 400 "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. 401 "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 402 "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 403 "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. 404 "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 405 "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. 406 "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. 407 }, 408 ], 409 }, 410 ], 411 }, 412 "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". 413 "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. 414 "description": "A String", # Remarketing list description. 415 "listSize": "A String", # Number of users currently in the list. This is a read-only field. 416 "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. 417 "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. 418 "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field. 419 "listSource": "A String", # Product from which this remarketing list was originated. 420 "active": True or False, # Whether this remarketing list is active. 421 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 422 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 423 "value": "A String", # The value of the dimension. 424 "dimensionName": "A String", # The name of the dimension. 425 "etag": "A String", # The eTag of this response for caching purposes. 426 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 427 "id": "A String", # The ID associated with the value if available. 428 }, 429 "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field. 430 "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. 431 }</pre> 432</div> 433 434<div class="method"> 435 <code class="details" id="update">update(profileId, body)</code> 436 <pre>Updates an existing remarketing list. 437 438Args: 439 profileId: string, User profile ID associated with this request. (required) 440 body: object, The request body. (required) 441 The object takes the form of: 442 443{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. 444 "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users. 445 "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. 446 "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank. 447 "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. 448 { # A group clause made up of list population terms representing constraints joined by ORs. 449 "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. 450 { # Remarketing List Population Rule Term. 451 "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. 452 "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. 453 "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 454 "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 455 "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. 456 "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 457 "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. 458 "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. 459 }, 460 ], 461 }, 462 ], 463 }, 464 "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". 465 "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. 466 "description": "A String", # Remarketing list description. 467 "listSize": "A String", # Number of users currently in the list. This is a read-only field. 468 "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. 469 "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. 470 "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field. 471 "listSource": "A String", # Product from which this remarketing list was originated. 472 "active": True or False, # Whether this remarketing list is active. 473 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 474 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 475 "value": "A String", # The value of the dimension. 476 "dimensionName": "A String", # The name of the dimension. 477 "etag": "A String", # The eTag of this response for caching purposes. 478 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 479 "id": "A String", # The ID associated with the value if available. 480 }, 481 "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field. 482 "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. 483 } 484 485 486Returns: 487 An object of the form: 488 489 { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. 490 "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users. 491 "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. 492 "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank. 493 "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. 494 { # A group clause made up of list population terms representing constraints joined by ORs. 495 "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. 496 { # Remarketing List Population Rule Term. 497 "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. 498 "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. 499 "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 500 "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 501 "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. 502 "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. 503 "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. 504 "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. 505 }, 506 ], 507 }, 508 ], 509 }, 510 "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". 511 "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. 512 "description": "A String", # Remarketing list description. 513 "listSize": "A String", # Number of users currently in the list. This is a read-only field. 514 "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. 515 "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. 516 "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field. 517 "listSource": "A String", # Product from which this remarketing list was originated. 518 "active": True or False, # Whether this remarketing list is active. 519 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 520 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 521 "value": "A String", # The value of the dimension. 522 "dimensionName": "A String", # The name of the dimension. 523 "etag": "A String", # The eTag of this response for caching purposes. 524 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 525 "id": "A String", # The ID associated with the value if available. 526 }, 527 "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field. 528 "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. 529 }</pre> 530</div> 531 532</body></html>