Class: Google::Apis::RealtimebiddingV1::UserList

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/realtimebidding_v1/classes.rb,
lib/google/apis/realtimebidding_v1/representations.rb,
lib/google/apis/realtimebidding_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UserList

Returns a new instance of UserList.



2222
2223
2224
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 2222

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#description ⇒ String

The description for the user list. Corresponds to the JSON property description

Returns:

  • (String) 


2185
2186
2187
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 2185

def description
  @description
end

#display_name ⇒ String

Required. Display name of the user list. This must be unique across all user lists for a given account. Corresponds to the JSON property displayName

Returns:

  • (String) 


2191
2192
2193
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 2191

def display_name
  @display_name
end

#membership_duration_days ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2197
2198
2199
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 2197

def membership_duration_days
  @membership_duration_days
end

#name ⇒ String

Output only. Name of the user list that must follow the pattern buyers/buyer /userLists/user_list, wherebuyerrepresents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer,buyerrepresents the account ID of the child seat buyer. user_list`is an int64 identifier assigned by Google to uniquely identify a user list. Corresponds to the JSON propertyname`

Returns:

  • (String) 


2207
2208
2209
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 2207

def name
  @name
end

#status ⇒ String

Output only. The status of the user list. A new user list starts out as open. Corresponds to the JSON property status

Returns:

  • (String) 


2212
2213
2214
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 2212

def status
  @status
end

#url_restriction ⇒ Google::Apis::RealtimebiddingV1::UrlRestriction

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 Represents the URL restriction (for the URL captured by the pixel callback) for a user list. Corresponds to the JSON property urlRestriction

Returns:



2220
2221
2222
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 2220

def url_restriction
  @url_restriction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2227
2228
2229
2230
2231
2232
2233
2234
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 2227

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @membership_duration_days = args[:membership_duration_days] if args.key?(:membership_duration_days)
  @name = args[:name] if args.key?(:name)
  @status = args[:status] if args.key?(:status)
  @url_restriction = args[:url_restriction] if args.key?(:url_restriction)
end