Real-time Bidding API . buyers . userLists

Instance Methods

close(name, body=None, x__xgafv=None)

Change the status of a user list to CLOSED. This prevents new users from

create(parent, body=None, x__xgafv=None)

Create a new user list.

get(name, x__xgafv=None)

Gets a user list by its name.

getRemarketingTag(name, x__xgafv=None)

Gets remarketing tag for a buyer. A remarketing tag is a piece of

list(parent, pageToken=None, pageSize=None, x__xgafv=None)

Lists the user lists visible to the current user.

list_next(previous_request, previous_response)

Retrieves the next page of results.

open(name, body=None, x__xgafv=None)

Change the status of a user list to OPEN. This allows new users to be added

update(name, body=None, x__xgafv=None)

Update the given user list. Only user lists with URLRestrictions can be

Method Details

close(name, body=None, x__xgafv=None)
Change the status of a user list to CLOSED. This prevents new users from
being added to the user list.

Args:
  name: string, Required. The name of the user list to close.
See UserList.name (required)
  body: object, The request body.
    The object takes the form of:

{ # A request to close a specified user list.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
      "description": "A String", # The description for the user list.
      "displayName": "A String", # Required. Display name of the user list. This must be unique across all user lists
          # for a given account.
      "status": "A String", # Output only. The status of the user list. A new user list starts out as open.
      "urlRestriction": { # Represents the URL restriction (for the URL captured by the pixel callback) # Required. The URL restriction for the user list.
          # for a user list.
        "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Start date (if specified) of the URL restriction.
            # and time zone are either specified elsewhere or are not significant. The date
            # is relative to the Proleptic Gregorian Calendar. This can represent:
            #
            # * A full date, with non-zero year, month and day values
            # * A month and day value, with a zero year, e.g. an anniversary
            # * A year on its own, with zero month and day values
            # * A year and month value, with a zero day, e.g. a credit card expiration date
            #
            # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
          "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
              # month and day.
          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
              # a year.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
              # if specifying a year by itself or a year and month where the day is not
              # significant.
        },
        "url": "A String", # Required. The URL to use for applying the restriction on the user list.
        "restrictionType": "A String", # The restriction type for the specified URL.
        "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # End date (if specified) of the URL restriction.
            # End date should be later than the start date for the date range to be
            # valid.
            # and time zone are either specified elsewhere or are not significant. The date
            # is relative to the Proleptic Gregorian Calendar. This can represent:
            #
            # * A full date, with non-zero year, month and day values
            # * A month and day value, with a zero year, e.g. an anniversary
            # * A year on its own, with zero month and day values
            # * A year and month value, with a zero day, e.g. a credit card expiration date
            #
            # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
          "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
              # month and day.
          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
              # a year.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
              # if specifying a year by itself or a year and month where the day is not
              # significant.
        },
      },
      "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.
      "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.
    }
create(parent, body=None, x__xgafv=None)
Create a new user list.

Args:
  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)
  body: object, The request body.
    The object takes the form of:

{ # 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.
    "description": "A String", # The description for the user list.
    "displayName": "A String", # Required. Display name of the user list. This must be unique across all user lists
        # for a given account.
    "status": "A String", # Output only. The status of the user list. A new user list starts out as open.
    "urlRestriction": { # Represents the URL restriction (for the URL captured by the pixel callback) # Required. The URL restriction for the user list.
        # for a user list.
      "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Start date (if specified) of the URL restriction.
          # and time zone are either specified elsewhere or are not significant. The date
          # is relative to the Proleptic Gregorian Calendar. This can represent:
          #
          # * A full date, with non-zero year, month and day values
          # * A month and day value, with a zero year, e.g. an anniversary
          # * A year on its own, with zero month and day values
          # * A year and month value, with a zero day, e.g. a credit card expiration date
          #
          # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
        "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
            # month and day.
        "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
            # a year.
        "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
            # if specifying a year by itself or a year and month where the day is not
            # significant.
      },
      "url": "A String", # Required. The URL to use for applying the restriction on the user list.
      "restrictionType": "A String", # The restriction type for the specified URL.
      "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # End date (if specified) of the URL restriction.
          # End date should be later than the start date for the date range to be
          # valid.
          # and time zone are either specified elsewhere or are not significant. The date
          # is relative to the Proleptic Gregorian Calendar. This can represent:
          #
          # * A full date, with non-zero year, month and day values
          # * A month and day value, with a zero year, e.g. an anniversary
          # * A year on its own, with zero month and day values
          # * A year and month value, with a zero day, e.g. a credit card expiration date
          #
          # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
        "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
            # month and day.
        "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
            # a year.
        "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
            # if specifying a year by itself or a year and month where the day is not
            # significant.
      },
    },
    "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.
    "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.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
      "description": "A String", # The description for the user list.
      "displayName": "A String", # Required. Display name of the user list. This must be unique across all user lists
          # for a given account.
      "status": "A String", # Output only. The status of the user list. A new user list starts out as open.
      "urlRestriction": { # Represents the URL restriction (for the URL captured by the pixel callback) # Required. The URL restriction for the user list.
          # for a user list.
        "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Start date (if specified) of the URL restriction.
            # and time zone are either specified elsewhere or are not significant. The date
            # is relative to the Proleptic Gregorian Calendar. This can represent:
            #
            # * A full date, with non-zero year, month and day values
            # * A month and day value, with a zero year, e.g. an anniversary
            # * A year on its own, with zero month and day values
            # * A year and month value, with a zero day, e.g. a credit card expiration date
            #
            # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
          "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
              # month and day.
          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
              # a year.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
              # if specifying a year by itself or a year and month where the day is not
              # significant.
        },
        "url": "A String", # Required. The URL to use for applying the restriction on the user list.
        "restrictionType": "A String", # The restriction type for the specified URL.
        "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # End date (if specified) of the URL restriction.
            # End date should be later than the start date for the date range to be
            # valid.
            # and time zone are either specified elsewhere or are not significant. The date
            # is relative to the Proleptic Gregorian Calendar. This can represent:
            #
            # * A full date, with non-zero year, month and day values
            # * A month and day value, with a zero year, e.g. an anniversary
            # * A year on its own, with zero month and day values
            # * A year and month value, with a zero day, e.g. a credit card expiration date
            #
            # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
          "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
              # month and day.
          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
              # a year.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
              # if specifying a year by itself or a year and month where the day is not
              # significant.
        },
      },
      "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.
      "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.
    }
get(name, x__xgafv=None)
Gets a user list by its name.

Args:
  name: string, Required. The name of the user list to be retrieved. See
UserList.name. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
      "description": "A String", # The description for the user list.
      "displayName": "A String", # Required. Display name of the user list. This must be unique across all user lists
          # for a given account.
      "status": "A String", # Output only. The status of the user list. A new user list starts out as open.
      "urlRestriction": { # Represents the URL restriction (for the URL captured by the pixel callback) # Required. The URL restriction for the user list.
          # for a user list.
        "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Start date (if specified) of the URL restriction.
            # and time zone are either specified elsewhere or are not significant. The date
            # is relative to the Proleptic Gregorian Calendar. This can represent:
            #
            # * A full date, with non-zero year, month and day values
            # * A month and day value, with a zero year, e.g. an anniversary
            # * A year on its own, with zero month and day values
            # * A year and month value, with a zero day, e.g. a credit card expiration date
            #
            # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
          "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
              # month and day.
          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
              # a year.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
              # if specifying a year by itself or a year and month where the day is not
              # significant.
        },
        "url": "A String", # Required. The URL to use for applying the restriction on the user list.
        "restrictionType": "A String", # The restriction type for the specified URL.
        "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # End date (if specified) of the URL restriction.
            # End date should be later than the start date for the date range to be
            # valid.
            # and time zone are either specified elsewhere or are not significant. The date
            # is relative to the Proleptic Gregorian Calendar. This can represent:
            #
            # * A full date, with non-zero year, month and day values
            # * A month and day value, with a zero year, e.g. an anniversary
            # * A year on its own, with zero month and day values
            # * A year and month value, with a zero day, e.g. a credit card expiration date
            #
            # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
          "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
              # month and day.
          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
              # a year.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
              # if specifying a year by itself or a year and month where the day is not
              # significant.
        },
      },
      "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.
      "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.
    }
getRemarketingTag(name, x__xgafv=None)
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.

Args:
  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)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for a request to get remarketing tag.
    "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).
  }
list(parent, pageToken=None, pageSize=None, x__xgafv=None)
Lists the user lists visible to the current user.

Args:
  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)
  pageToken: string, Continuation page token (as received from a previous response).
  pageSize: integer, The number of results to return per page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The list user list response.
    "userLists": [ # List of user lists from the search.
      { # 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.
          "description": "A String", # The description for the user list.
          "displayName": "A String", # Required. Display name of the user list. This must be unique across all user lists
              # for a given account.
          "status": "A String", # Output only. The status of the user list. A new user list starts out as open.
          "urlRestriction": { # Represents the URL restriction (for the URL captured by the pixel callback) # Required. The URL restriction for the user list.
              # for a user list.
            "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Start date (if specified) of the URL restriction.
                # and time zone are either specified elsewhere or are not significant. The date
                # is relative to the Proleptic Gregorian Calendar. This can represent:
                #
                # * A full date, with non-zero year, month and day values
                # * A month and day value, with a zero year, e.g. an anniversary
                # * A year on its own, with zero month and day values
                # * A year and month value, with a zero day, e.g. a credit card expiration date
                #
                # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
              "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
                  # month and day.
              "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
                  # a year.
              "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
                  # if specifying a year by itself or a year and month where the day is not
                  # significant.
            },
            "url": "A String", # Required. The URL to use for applying the restriction on the user list.
            "restrictionType": "A String", # The restriction type for the specified URL.
            "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # End date (if specified) of the URL restriction.
                # End date should be later than the start date for the date range to be
                # valid.
                # and time zone are either specified elsewhere or are not significant. The date
                # is relative to the Proleptic Gregorian Calendar. This can represent:
                #
                # * A full date, with non-zero year, month and day values
                # * A month and day value, with a zero year, e.g. an anniversary
                # * A year on its own, with zero month and day values
                # * A year and month value, with a zero day, e.g. a credit card expiration date
                #
                # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
              "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
                  # month and day.
              "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
                  # a year.
              "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
                  # if specifying a year by itself or a year and month where the day is not
                  # significant.
            },
          },
          "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.
          "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.
        },
    ],
    "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).
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
open(name, body=None, x__xgafv=None)
Change the status of a user list to OPEN. This allows new users to be added
to the user list.

Args:
  name: string, Required. The name of the user list to open.
See UserList.name (required)
  body: object, The request body.
    The object takes the form of:

{ # A request to open a specified user list.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
      "description": "A String", # The description for the user list.
      "displayName": "A String", # Required. Display name of the user list. This must be unique across all user lists
          # for a given account.
      "status": "A String", # Output only. The status of the user list. A new user list starts out as open.
      "urlRestriction": { # Represents the URL restriction (for the URL captured by the pixel callback) # Required. The URL restriction for the user list.
          # for a user list.
        "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Start date (if specified) of the URL restriction.
            # and time zone are either specified elsewhere or are not significant. The date
            # is relative to the Proleptic Gregorian Calendar. This can represent:
            #
            # * A full date, with non-zero year, month and day values
            # * A month and day value, with a zero year, e.g. an anniversary
            # * A year on its own, with zero month and day values
            # * A year and month value, with a zero day, e.g. a credit card expiration date
            #
            # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
          "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
              # month and day.
          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
              # a year.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
              # if specifying a year by itself or a year and month where the day is not
              # significant.
        },
        "url": "A String", # Required. The URL to use for applying the restriction on the user list.
        "restrictionType": "A String", # The restriction type for the specified URL.
        "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # End date (if specified) of the URL restriction.
            # End date should be later than the start date for the date range to be
            # valid.
            # and time zone are either specified elsewhere or are not significant. The date
            # is relative to the Proleptic Gregorian Calendar. This can represent:
            #
            # * A full date, with non-zero year, month and day values
            # * A month and day value, with a zero year, e.g. an anniversary
            # * A year on its own, with zero month and day values
            # * A year and month value, with a zero day, e.g. a credit card expiration date
            #
            # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
          "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
              # month and day.
          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
              # a year.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
              # if specifying a year by itself or a year and month where the day is not
              # significant.
        },
      },
      "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.
      "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.
    }
update(name, body=None, x__xgafv=None)
Update the given user list. Only user lists with URLRestrictions can be
updated.

Args:
  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)
  body: object, The request body.
    The object takes the form of:

{ # 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.
    "description": "A String", # The description for the user list.
    "displayName": "A String", # Required. Display name of the user list. This must be unique across all user lists
        # for a given account.
    "status": "A String", # Output only. The status of the user list. A new user list starts out as open.
    "urlRestriction": { # Represents the URL restriction (for the URL captured by the pixel callback) # Required. The URL restriction for the user list.
        # for a user list.
      "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Start date (if specified) of the URL restriction.
          # and time zone are either specified elsewhere or are not significant. The date
          # is relative to the Proleptic Gregorian Calendar. This can represent:
          #
          # * A full date, with non-zero year, month and day values
          # * A month and day value, with a zero year, e.g. an anniversary
          # * A year on its own, with zero month and day values
          # * A year and month value, with a zero day, e.g. a credit card expiration date
          #
          # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
        "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
            # month and day.
        "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
            # a year.
        "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
            # if specifying a year by itself or a year and month where the day is not
            # significant.
      },
      "url": "A String", # Required. The URL to use for applying the restriction on the user list.
      "restrictionType": "A String", # The restriction type for the specified URL.
      "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # End date (if specified) of the URL restriction.
          # End date should be later than the start date for the date range to be
          # valid.
          # and time zone are either specified elsewhere or are not significant. The date
          # is relative to the Proleptic Gregorian Calendar. This can represent:
          #
          # * A full date, with non-zero year, month and day values
          # * A month and day value, with a zero year, e.g. an anniversary
          # * A year on its own, with zero month and day values
          # * A year and month value, with a zero day, e.g. a credit card expiration date
          #
          # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
        "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
            # month and day.
        "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
            # a year.
        "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
            # if specifying a year by itself or a year and month where the day is not
            # significant.
      },
    },
    "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.
    "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.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
      "description": "A String", # The description for the user list.
      "displayName": "A String", # Required. Display name of the user list. This must be unique across all user lists
          # for a given account.
      "status": "A String", # Output only. The status of the user list. A new user list starts out as open.
      "urlRestriction": { # Represents the URL restriction (for the URL captured by the pixel callback) # Required. The URL restriction for the user list.
          # for a user list.
        "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # Start date (if specified) of the URL restriction.
            # and time zone are either specified elsewhere or are not significant. The date
            # is relative to the Proleptic Gregorian Calendar. This can represent:
            #
            # * A full date, with non-zero year, month and day values
            # * A month and day value, with a zero year, e.g. an anniversary
            # * A year on its own, with zero month and day values
            # * A year and month value, with a zero day, e.g. a credit card expiration date
            #
            # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
          "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
              # month and day.
          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
              # a year.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
              # if specifying a year by itself or a year and month where the day is not
              # significant.
        },
        "url": "A String", # Required. The URL to use for applying the restriction on the user list.
        "restrictionType": "A String", # The restriction type for the specified URL.
        "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # End date (if specified) of the URL restriction.
            # End date should be later than the start date for the date range to be
            # valid.
            # and time zone are either specified elsewhere or are not significant. The date
            # is relative to the Proleptic Gregorian Calendar. This can represent:
            #
            # * A full date, with non-zero year, month and day values
            # * A month and day value, with a zero year, e.g. an anniversary
            # * A year on its own, with zero month and day values
            # * A year and month value, with a zero day, e.g. a credit card expiration date
            #
            # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
          "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
              # month and day.
          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
              # a year.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
              # if specifying a year by itself or a year and month where the day is not
              # significant.
        },
      },
      "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.
      "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.
    }