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="realtimebidding_v1.html">Real-time Bidding API</a> . <a href="realtimebidding_v1.buyers.html">buyers</a> . <a href="realtimebidding_v1.buyers.userLists.html">userLists</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close(name, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Change the status of a user list to CLOSED. This prevents new users from being added to the user list.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Create a new user list.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets a user list by its name.</p> 86<p class="toc_element"> 87 <code><a href="#getRemarketingTag">getRemarketingTag(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists the user lists visible to the current user.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#open">open(name, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Change the status of a user list to OPEN. This allows new users to be added to the user list.</p> 98<p class="toc_element"> 99 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Update the given user list. Only user lists with URLRestrictions can be updated.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="close">close(name, body=None, x__xgafv=None)</code> 104 <pre>Change the status of a user list to CLOSED. This prevents new users from being added to the user list. 105 106Args: 107 name: string, Required. The name of the user list to close. See UserList.name (required) 108 body: object, The request body. 109 The object takes the form of: 110 111{ # A request to close a specified user list. 112} 113 114 x__xgafv: string, V1 error format. 115 Allowed values 116 1 - v1 error format 117 2 - v2 error format 118 119Returns: 120 An object of the form: 121 122 { # Represents an Authorized Buyers user list. Authorized Buyers can create/update/list user lists. Once a user list is created in the system, Authorized Buyers can add users to the user list using the bulk uploader API. Alternatively, users can be added by hosting a tag on the advertiser's page. 123 "description": "A String", # The description for the user list. 124 "displayName": "A String", # Required. Display name of the user list. This must be unique across all user lists for a given account. 125 "membershipDurationDays": "A String", # Required. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive. 126 "name": "A String", # Output only. Name of the user list that must follow the pattern `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, `{buyer}` represents the account ID of the child seat buyer. `{user_list}` is an int64 identifier assigned by Google to uniquely identify a user list. 127 "status": "A String", # Output only. The status of the user list. A new user list starts out as open. 128 "urlRestriction": { # Represents the URL restriction (for the URL captured by the pixel callback) for a user list. # Required. The URL restriction for the user list. 129 "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # End date (if specified) of the URL restriction. End date should be later than the start date for the date range to be valid. 130 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 131 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 132 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 133 }, 134 "restrictionType": "A String", # The restriction type for the specified URL. 135 "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Start date (if specified) of the URL restriction. 136 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 137 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 138 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 139 }, 140 "url": "A String", # Required. The URL to use for applying the restriction on the user list. 141 }, 142}</pre> 143</div> 144 145<div class="method"> 146 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 147 <pre>Create a new user list. 148 149Args: 150 parent: string, Required. The name of the parent buyer of the user list to be retrieved that must follow the pattern `buyers/{buyerAccountId}`, where `{buyerAccountId}` represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer , `{buyerAccountId}` should represent the account ID of the child seat buyer. (required) 151 body: object, The request body. 152 The object takes the form of: 153 154{ # Represents an Authorized Buyers user list. Authorized Buyers can create/update/list user lists. Once a user list is created in the system, Authorized Buyers can add users to the user list using the bulk uploader API. Alternatively, users can be added by hosting a tag on the advertiser's page. 155 "description": "A String", # The description for the user list. 156 "displayName": "A String", # Required. Display name of the user list. This must be unique across all user lists for a given account. 157 "membershipDurationDays": "A String", # Required. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive. 158 "name": "A String", # Output only. Name of the user list that must follow the pattern `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, `{buyer}` represents the account ID of the child seat buyer. `{user_list}` is an int64 identifier assigned by Google to uniquely identify a user list. 159 "status": "A String", # Output only. The status of the user list. A new user list starts out as open. 160 "urlRestriction": { # Represents the URL restriction (for the URL captured by the pixel callback) for a user list. # Required. The URL restriction for the user list. 161 "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # End date (if specified) of the URL restriction. End date should be later than the start date for the date range to be valid. 162 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 163 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 164 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 165 }, 166 "restrictionType": "A String", # The restriction type for the specified URL. 167 "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Start date (if specified) of the URL restriction. 168 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 169 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 170 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 171 }, 172 "url": "A String", # Required. The URL to use for applying the restriction on the user list. 173 }, 174} 175 176 x__xgafv: string, V1 error format. 177 Allowed values 178 1 - v1 error format 179 2 - v2 error format 180 181Returns: 182 An object of the form: 183 184 { # Represents an Authorized Buyers user list. Authorized Buyers can create/update/list user lists. Once a user list is created in the system, Authorized Buyers can add users to the user list using the bulk uploader API. Alternatively, users can be added by hosting a tag on the advertiser's page. 185 "description": "A String", # The description for the user list. 186 "displayName": "A String", # Required. Display name of the user list. This must be unique across all user lists for a given account. 187 "membershipDurationDays": "A String", # Required. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive. 188 "name": "A String", # Output only. Name of the user list that must follow the pattern `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, `{buyer}` represents the account ID of the child seat buyer. `{user_list}` is an int64 identifier assigned by Google to uniquely identify a user list. 189 "status": "A String", # Output only. The status of the user list. A new user list starts out as open. 190 "urlRestriction": { # Represents the URL restriction (for the URL captured by the pixel callback) for a user list. # Required. The URL restriction for the user list. 191 "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # End date (if specified) of the URL restriction. End date should be later than the start date for the date range to be valid. 192 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 193 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 194 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 195 }, 196 "restrictionType": "A String", # The restriction type for the specified URL. 197 "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Start date (if specified) of the URL restriction. 198 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 199 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 200 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 201 }, 202 "url": "A String", # Required. The URL to use for applying the restriction on the user list. 203 }, 204}</pre> 205</div> 206 207<div class="method"> 208 <code class="details" id="get">get(name, x__xgafv=None)</code> 209 <pre>Gets a user list by its name. 210 211Args: 212 name: string, Required. The name of the user list to be retrieved. See UserList.name. (required) 213 x__xgafv: string, V1 error format. 214 Allowed values 215 1 - v1 error format 216 2 - v2 error format 217 218Returns: 219 An object of the form: 220 221 { # Represents an Authorized Buyers user list. Authorized Buyers can create/update/list user lists. Once a user list is created in the system, Authorized Buyers can add users to the user list using the bulk uploader API. Alternatively, users can be added by hosting a tag on the advertiser's page. 222 "description": "A String", # The description for the user list. 223 "displayName": "A String", # Required. Display name of the user list. This must be unique across all user lists for a given account. 224 "membershipDurationDays": "A String", # Required. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive. 225 "name": "A String", # Output only. Name of the user list that must follow the pattern `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, `{buyer}` represents the account ID of the child seat buyer. `{user_list}` is an int64 identifier assigned by Google to uniquely identify a user list. 226 "status": "A String", # Output only. The status of the user list. A new user list starts out as open. 227 "urlRestriction": { # Represents the URL restriction (for the URL captured by the pixel callback) for a user list. # Required. The URL restriction for the user list. 228 "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # End date (if specified) of the URL restriction. End date should be later than the start date for the date range to be valid. 229 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 230 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 231 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 232 }, 233 "restrictionType": "A String", # The restriction type for the specified URL. 234 "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Start date (if specified) of the URL restriction. 235 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 236 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 237 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 238 }, 239 "url": "A String", # Required. The URL to use for applying the restriction on the user list. 240 }, 241}</pre> 242</div> 243 244<div class="method"> 245 <code class="details" id="getRemarketingTag">getRemarketingTag(name, x__xgafv=None)</code> 246 <pre>Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list. 247 248Args: 249 name: string, Required. To fetch remarketing tag for an account, name must follow the pattern `buyers/{accountId}` where `{accountId}` represents ID of a buyer that owns the remarketing tag. For a bidder accessing remarketing tag on behalf of a child seat buyer, `{accountId}` should represent the ID of the child seat buyer. To fetch remarketing tag for a specific user list, name must follow the pattern `buyers/{accountId}/userLists/{userListId}`. See UserList.name. (required) 250 x__xgafv: string, V1 error format. 251 Allowed values 252 1 - v1 error format 253 2 - v2 error format 254 255Returns: 256 An object of the form: 257 258 { # Response for a request to get remarketing tag. 259 "snippet": "A String", # A HTML tag that can be placed on the advertiser's page to add users to a user list. For more information and code samples on using snippet on your website refer to [Tag your site for remarketing]( https://support.google.com/google-ads/answer/2476688). 260}</pre> 261</div> 262 263<div class="method"> 264 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 265 <pre>Lists the user lists visible to the current user. 266 267Args: 268 parent: string, Required. The name of the parent buyer for the user lists to be returned that must follow the pattern `buyers/{buyerAccountId}`, where `{buyerAccountId}` represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer , `{buyerAccountId}` should represent the account ID of the child seat buyer. (required) 269 pageSize: integer, The number of results to return per page. 270 pageToken: string, Continuation page token (as received from a previous response). 271 x__xgafv: string, V1 error format. 272 Allowed values 273 1 - v1 error format 274 2 - v2 error format 275 276Returns: 277 An object of the form: 278 279 { # The list user list response. 280 "nextPageToken": "A String", # The continuation page token to send back to the server in a subsequent request. Due to a currently known issue, it is recommended that the caller keep invoking the list method till the time a next page token is not returned (even if the result set is empty). 281 "userLists": [ # List of user lists from the search. 282 { # Represents an Authorized Buyers user list. Authorized Buyers can create/update/list user lists. Once a user list is created in the system, Authorized Buyers can add users to the user list using the bulk uploader API. Alternatively, users can be added by hosting a tag on the advertiser's page. 283 "description": "A String", # The description for the user list. 284 "displayName": "A String", # Required. Display name of the user list. This must be unique across all user lists for a given account. 285 "membershipDurationDays": "A String", # Required. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive. 286 "name": "A String", # Output only. Name of the user list that must follow the pattern `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, `{buyer}` represents the account ID of the child seat buyer. `{user_list}` is an int64 identifier assigned by Google to uniquely identify a user list. 287 "status": "A String", # Output only. The status of the user list. A new user list starts out as open. 288 "urlRestriction": { # Represents the URL restriction (for the URL captured by the pixel callback) for a user list. # Required. The URL restriction for the user list. 289 "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # End date (if specified) of the URL restriction. End date should be later than the start date for the date range to be valid. 290 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 291 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 292 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 293 }, 294 "restrictionType": "A String", # The restriction type for the specified URL. 295 "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Start date (if specified) of the URL restriction. 296 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 297 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 298 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 299 }, 300 "url": "A String", # Required. The URL to use for applying the restriction on the user list. 301 }, 302 }, 303 ], 304}</pre> 305</div> 306 307<div class="method"> 308 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 309 <pre>Retrieves the next page of results. 310 311Args: 312 previous_request: The request for the previous page. (required) 313 previous_response: The response from the request for the previous page. (required) 314 315Returns: 316 A request object that you can call 'execute()' on to request the next 317 page. Returns None if there are no more items in the collection. 318 </pre> 319</div> 320 321<div class="method"> 322 <code class="details" id="open">open(name, body=None, x__xgafv=None)</code> 323 <pre>Change the status of a user list to OPEN. This allows new users to be added to the user list. 324 325Args: 326 name: string, Required. The name of the user list to open. See UserList.name (required) 327 body: object, The request body. 328 The object takes the form of: 329 330{ # A request to open a specified user list. 331} 332 333 x__xgafv: string, V1 error format. 334 Allowed values 335 1 - v1 error format 336 2 - v2 error format 337 338Returns: 339 An object of the form: 340 341 { # Represents an Authorized Buyers user list. Authorized Buyers can create/update/list user lists. Once a user list is created in the system, Authorized Buyers can add users to the user list using the bulk uploader API. Alternatively, users can be added by hosting a tag on the advertiser's page. 342 "description": "A String", # The description for the user list. 343 "displayName": "A String", # Required. Display name of the user list. This must be unique across all user lists for a given account. 344 "membershipDurationDays": "A String", # Required. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive. 345 "name": "A String", # Output only. Name of the user list that must follow the pattern `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, `{buyer}` represents the account ID of the child seat buyer. `{user_list}` is an int64 identifier assigned by Google to uniquely identify a user list. 346 "status": "A String", # Output only. The status of the user list. A new user list starts out as open. 347 "urlRestriction": { # Represents the URL restriction (for the URL captured by the pixel callback) for a user list. # Required. The URL restriction for the user list. 348 "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # End date (if specified) of the URL restriction. End date should be later than the start date for the date range to be valid. 349 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 350 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 351 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 352 }, 353 "restrictionType": "A String", # The restriction type for the specified URL. 354 "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Start date (if specified) of the URL restriction. 355 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 356 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 357 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 358 }, 359 "url": "A String", # Required. The URL to use for applying the restriction on the user list. 360 }, 361}</pre> 362</div> 363 364<div class="method"> 365 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code> 366 <pre>Update the given user list. Only user lists with URLRestrictions can be updated. 367 368Args: 369 name: string, Output only. Name of the user list that must follow the pattern `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, `{buyer}` represents the account ID of the child seat buyer. `{user_list}` is an int64 identifier assigned by Google to uniquely identify a user list. (required) 370 body: object, The request body. 371 The object takes the form of: 372 373{ # Represents an Authorized Buyers user list. Authorized Buyers can create/update/list user lists. Once a user list is created in the system, Authorized Buyers can add users to the user list using the bulk uploader API. Alternatively, users can be added by hosting a tag on the advertiser's page. 374 "description": "A String", # The description for the user list. 375 "displayName": "A String", # Required. Display name of the user list. This must be unique across all user lists for a given account. 376 "membershipDurationDays": "A String", # Required. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive. 377 "name": "A String", # Output only. Name of the user list that must follow the pattern `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, `{buyer}` represents the account ID of the child seat buyer. `{user_list}` is an int64 identifier assigned by Google to uniquely identify a user list. 378 "status": "A String", # Output only. The status of the user list. A new user list starts out as open. 379 "urlRestriction": { # Represents the URL restriction (for the URL captured by the pixel callback) for a user list. # Required. The URL restriction for the user list. 380 "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # End date (if specified) of the URL restriction. End date should be later than the start date for the date range to be valid. 381 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 382 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 383 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 384 }, 385 "restrictionType": "A String", # The restriction type for the specified URL. 386 "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Start date (if specified) of the URL restriction. 387 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 388 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 389 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 390 }, 391 "url": "A String", # Required. The URL to use for applying the restriction on the user list. 392 }, 393} 394 395 x__xgafv: string, V1 error format. 396 Allowed values 397 1 - v1 error format 398 2 - v2 error format 399 400Returns: 401 An object of the form: 402 403 { # Represents an Authorized Buyers user list. Authorized Buyers can create/update/list user lists. Once a user list is created in the system, Authorized Buyers can add users to the user list using the bulk uploader API. Alternatively, users can be added by hosting a tag on the advertiser's page. 404 "description": "A String", # The description for the user list. 405 "displayName": "A String", # Required. Display name of the user list. This must be unique across all user lists for a given account. 406 "membershipDurationDays": "A String", # Required. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive. 407 "name": "A String", # Output only. Name of the user list that must follow the pattern `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, `{buyer}` represents the account ID of the child seat buyer. `{user_list}` is an int64 identifier assigned by Google to uniquely identify a user list. 408 "status": "A String", # Output only. The status of the user list. A new user list starts out as open. 409 "urlRestriction": { # Represents the URL restriction (for the URL captured by the pixel callback) for a user list. # Required. The URL restriction for the user list. 410 "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # End date (if specified) of the URL restriction. End date should be later than the start date for the date range to be valid. 411 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 412 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 413 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 414 }, 415 "restrictionType": "A String", # The restriction type for the specified URL. 416 "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Start date (if specified) of the URL restriction. 417 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 418 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 419 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 420 }, 421 "url": "A String", # Required. The URL to use for applying the restriction on the user list. 422 }, 423}</pre> 424</div> 425 426</body></html>