Class: Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ResourcesUserList

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

Overview

A user list. This is a list of users a customer may target. The unique key of a user list consists of the following fields: id. Note that the name must also be unique for user lists owned by a given customer, except in some cases where access_reason is set to SHARED. Violating the unique name constraint produces error: UserListError.INVALID_NAME.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V23ResourcesUserList

Returns a new instance of GoogleAdsSearchads360V23ResourcesUserList.



34536
34537
34538
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34536

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

Instance Attribute Details

#access_reason ⇒ String

Output only. Indicates the reason this account has been granted access to the list. The reason can be SHARED, OWNED, LICENSED or SUBSCRIBED. This field is read-only. Corresponds to the JSON property accessReason

Returns:

  • (String) 


34382
34383
34384
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34382

def access_reason
  @access_reason
end

#account_user_list_status ⇒ String

Indicates if this share is still enabled. When a UserList is shared with the user this field is set to ENABLED. Later the userList owner can decide to revoke the share and make it DISABLED. The default value of this field is set to ENABLED. Corresponds to the JSON property accountUserListStatus

Returns:

  • (String) 


34390
34391
34392
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34390

def 
  @account_user_list_status
end

#basic_user_list ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonBasicUserListInfo

User list targeting as a collection of conversion or remarketing actions. Corresponds to the JSON property basicUserList

Returns:



34395
34396
34397
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34395

def basic_user_list
  @basic_user_list
end

#closing_reason ⇒ String

Indicating the reason why this user list membership status is closed. It is only populated on lists that were automatically closed due to inactivity, and will be cleared once the list membership status becomes open. Corresponds to the JSON property closingReason

Returns:

  • (String) 


34402
34403
34404
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34402

def closing_reason
  @closing_reason
end

#crm_based_user_list ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonCrmBasedUserListInfo

UserList of CRM users provided by the advertiser. Corresponds to the JSON property crmBasedUserList

Returns:



34407
34408
34409
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34407

def crm_based_user_list
  @crm_based_user_list
end

#description ⇒ String

Description of this user list. Corresponds to the JSON property description

Returns:

  • (String) 


34412
34413
34414
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34412

def description
  @description
end

#eligible_for_display ⇒ Boolean Also known as: eligible_for_display?

Output only. Indicates this user list is eligible for Google Display Network. This field is read-only. Corresponds to the JSON property eligibleForDisplay

Returns:

  • (Boolean) 


34418
34419
34420
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34418

def eligible_for_display
  @eligible_for_display
end

#eligible_for_search ⇒ Boolean Also known as: eligible_for_search?

Indicates if this user list is eligible for Google Search Network. Corresponds to the JSON property eligibleForSearch

Returns:

  • (Boolean) 


34424
34425
34426
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34424

def eligible_for_search
  @eligible_for_search
end

#id ⇒ Fixnum

Output only. Id of the user list. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


34430
34431
34432
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34430

def id
  @id
end

#integration_code ⇒ String

An ID from external system. It is used by user list sellers to correlate IDs on their systems. Corresponds to the JSON property integrationCode

Returns:

  • (String) 


34436
34437
34438
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34436

def integration_code
  @integration_code
end

#logical_user_list ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonLogicalUserListInfo

Represents a user list that is a custom combination of user lists. Corresponds to the JSON property logicalUserList

Returns:



34441
34442
34443
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34441

def logical_user_list
  @logical_user_list
end

#lookalike_user_list ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonLookalikeUserListInfo

LookalikeUserlist, composed of users similar to those of a configurable seed ( set of UserLists) Corresponds to the JSON property lookalikeUserList

Returns:



34447
34448
34449
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34447

def lookalike_user_list
  @lookalike_user_list
end

#match_rate_percentage ⇒ Fixnum

Output only. Indicates match rate for Customer Match lists. The range of this field is [0-100]. This will be null for other list types or when it's not possible to calculate the match rate. This field is read-only. Corresponds to the JSON property matchRatePercentage

Returns:

  • (Fixnum) 


34454
34455
34456
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34454

def match_rate_percentage
  @match_rate_percentage
end

#membership_life_span ⇒ Fixnum

Number of days a user's cookie stays on your list since its most recent addition to the list. This field must be between 0 and 540 inclusive. However, for CRM based userlists, this field can be set to 10000 which means no expiration. Beginning on April 7, 2025, using a value of 10000 to indicate no expiration will no longer be supported. This field is ignored for logical_user_list and rule_based_user_list types. Membership to lists of these types depends on the rules defined by the lists. Corresponds to the JSON property membershipLifeSpan

Returns:

  • (Fixnum) 


34465
34466
34467
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34465

def membership_life_span
  @membership_life_span
end

#membership_status ⇒ String

Membership status of this user list. Indicates whether a user list is open or active. Only open user lists can accumulate more users and can be targeted to. Corresponds to the JSON property membershipStatus

Returns:

  • (String) 


34471
34472
34473
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34471

def membership_status
  @membership_status
end

#name ⇒ String

Name of this user list. Unique per user list, except in some cases where a user list of the same name has access_reason set to SHARED. Corresponds to the JSON property name

Returns:

  • (String) 


34477
34478
34479
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34477

def name
  @name
end

#read_only ⇒ Boolean Also known as: read_only?

Output only. An option that indicates if a user may edit a list. Depends on the list ownership and list type. For example, external remarketing user lists are not editable. This field is -only. Corresponds to the JSON property readOnly

Returns:

  • (Boolean) 


34484
34485
34486
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34484

def read_only
  @read_only
end

#resource_name ⇒ String

Immutable. The resource name of the user list. User list resource names have the form: customers/customer_id/userLists/user_list_id` Corresponds to the JSON propertyresourceName`

Returns:

  • (String) 


34491
34492
34493
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34491

def resource_name
  @resource_name
end

#rule_based_user_list ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonRuleBasedUserListInfo

Representation of a userlist that is generated by a rule. Corresponds to the JSON property ruleBasedUserList

Returns:



34496
34497
34498
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34496

def rule_based_user_list
  @rule_based_user_list
end

#similar_user_list ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonSimilarUserListInfo

SimilarUserList is a list of users which are similar to users from another UserList. These lists are read-only and automatically created by Google. Corresponds to the JSON property similarUserList

Returns:



34502
34503
34504
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34502

def similar_user_list
  @similar_user_list
end

#size_for_display ⇒ Fixnum

Output only. Estimated number of users in this user list, on the Google Display Network. This value is if the number of users has not yet been determined. This field is -only. Corresponds to the JSON property sizeForDisplay

Returns:

  • (Fixnum) 


34509
34510
34511
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34509

def size_for_display
  @size_for_display
end

#size_for_search ⇒ Fixnum

Output only. Estimated number of users in this user list in the google.com domain. These are the users available for targeting in Search campaigns. This value is null if the number of users has not yet been determined. This field is read-only. Corresponds to the JSON property sizeForSearch

Returns:

  • (Fixnum) 


34517
34518
34519
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34517

def size_for_search
  @size_for_search
end

#size_range_for_display ⇒ String

Output only. Size range in terms of number of users of the UserList, on the Google Display Network. This field is read-only. Corresponds to the JSON property sizeRangeForDisplay

Returns:

  • (String) 


34523
34524
34525
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34523

def size_range_for_display
  @size_range_for_display
end

#size_range_for_search ⇒ String

Output only. Size range in terms of number of users of the UserList, for Search ads. This field is read-only. Corresponds to the JSON property sizeRangeForSearch

Returns:

  • (String) 


34529
34530
34531
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34529

def size_range_for_search
  @size_range_for_search
end

#type ⇒ String

Output only. Type of this list. This field is read-only. Corresponds to the JSON property type

Returns:

  • (String) 


34534
34535
34536
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34534

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



34541
34542
34543
34544
34545
34546
34547
34548
34549
34550
34551
34552
34553
34554
34555
34556
34557
34558
34559
34560
34561
34562
34563
34564
34565
34566
34567
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34541

def update!(**args)
  @access_reason = args[:access_reason] if args.key?(:access_reason)
  @account_user_list_status = args[:account_user_list_status] if args.key?(:account_user_list_status)
  @basic_user_list = args[:basic_user_list] if args.key?(:basic_user_list)
  @closing_reason = args[:closing_reason] if args.key?(:closing_reason)
  @crm_based_user_list = args[:crm_based_user_list] if args.key?(:crm_based_user_list)
  @description = args[:description] if args.key?(:description)
  @eligible_for_display = args[:eligible_for_display] if args.key?(:eligible_for_display)
  @eligible_for_search = args[:eligible_for_search] if args.key?(:eligible_for_search)
  @id = args[:id] if args.key?(:id)
  @integration_code = args[:integration_code] if args.key?(:integration_code)
  @logical_user_list = args[:logical_user_list] if args.key?(:logical_user_list)
  @lookalike_user_list = args[:lookalike_user_list] if args.key?(:lookalike_user_list)
  @match_rate_percentage = args[:match_rate_percentage] if args.key?(:match_rate_percentage)
  @membership_life_span = args[:membership_life_span] if args.key?(:membership_life_span)
  @membership_status = args[:membership_status] if args.key?(:membership_status)
  @name = args[:name] if args.key?(:name)
  @read_only = args[:read_only] if args.key?(:read_only)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @rule_based_user_list = args[:rule_based_user_list] if args.key?(:rule_based_user_list)
  @similar_user_list = args[:similar_user_list] if args.key?(:similar_user_list)
  @size_for_display = args[:size_for_display] if args.key?(:size_for_display)
  @size_for_search = args[:size_for_search] if args.key?(:size_for_search)
  @size_range_for_display = args[:size_range_for_display] if args.key?(:size_range_for_display)
  @size_range_for_search = args[:size_range_for_search] if args.key?(:size_range_for_search)
  @type = args[:type] if args.key?(:type)
end