UserList

import type { UserList } from "https://googleapis.deno.dev/v1/realtimebidding:v1.ts";

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.

interface UserList {

description?: string;

displayName?: string;

membershipDurationDays?: bigint;

readonly name?: string;

readonly status?: "STATUS_UNSPECIFIED" | "OPEN" | "CLOSED";

urlRestriction?: UrlRestriction;

}

§Properties

description?: string

[src]

The description for the user list.

displayName?: string

[src]

Required. Display name of the user list. This must be unique across all user lists for a given account.

membershipDurationDays?: bigint

[src]

Required. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive.

readonly name?: string

[src]

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.

readonly status?: "STATUS_UNSPECIFIED" | "OPEN" | "CLOSED"

[src]

Output only. The status of the user list. A new user list starts out as open.

urlRestriction?: UrlRestriction

[src]

Required. Deprecated. This will be removed in October 2023. For more information, see the release notes: https://developers.google.com/authorized-buyers/apis/relnotes#real-time-bidding-api The URL restriction for the user list.