GoogleApi.RealTimeBidding.V1.Model.UserList (google_api_real_time_bidding v0.13.2)

View Source

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.

Attributes

  • description (type: String.t, default: nil) - The description for the user list.
  • displayName (type: String.t, default: nil) - Required. Display name of the user list. This must be unique across all user lists for a given account.
  • membershipDurationDays (type: String.t, default: nil) - Required. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive.
  • name (type: String.t, default: nil) - 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 (type: String.t, default: nil) - Output only. The status of the user list. A new user list starts out as open.
  • urlRestriction (type: GoogleApi.RealTimeBidding.V1.Model.UrlRestriction.t, default: nil) - 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.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.RealTimeBidding.V1.Model.UserList{
  description: String.t() | nil,
  displayName: String.t() | nil,
  membershipDurationDays: String.t() | nil,
  name: String.t() | nil,
  status: String.t() | nil,
  urlRestriction: GoogleApi.RealTimeBidding.V1.Model.UrlRestriction.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.