Updates the given user list. Only user lists with URLRestrictions can be updated.

Scopes

You will need authorization for the https://www.googleapis.com/auth/realtime-bidding scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/realtime-bidding. You can set the scope for this method like this: realtimebidding1 --scope <scope> buyers user-lists-update ...

Required Scalar Argument

  • <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 Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

UserList:
  description: string
  display-name: string
  membership-duration-days: string
  name: string
  status: string
  url-restriction:
    end-date:
      day: integer
      month: integer
      year: integer
    restriction-type: string
    start-date:
      day: integer
      month: integer
      year: integer
    url: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . description=nonumy
    • The description for the user list.
  • display-name=rebum.
    • Required. Display name of the user list. This must be unique across all user lists for a given account.
  • membership-duration-days=tempor
    • Required. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive.
  • name=dolore
    • 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.
  • status=eos
    • Output only. The status of the user list. A new user list starts out as open.
  • url-restriction.end-date day=49
    • 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.
  • month=17
    • Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

  • year=4

    • Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

  • .. restriction-type=ut

    • The restriction type for the specified URL.
  • start-date day=74
    • 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.
  • month=48
    • Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

  • year=25

    • Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

  • .. url=duo

    • Required. The URL to use for applying the restriction on the user list.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").