Class GoogleAdsSearchads360V23ResourcesUserList

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.

Inheritance
object
GoogleAdsSearchads360V23ResourcesUserList
Implements
Inherited Members
Namespace: Google.Apis.SA360.v23.Data
Assembly: Google.Apis.SA360.v23.dll
Syntax
public class GoogleAdsSearchads360V23ResourcesUserList : IDirectResponseSchema

Properties

AccessReason

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.

Declaration
[JsonProperty("accessReason")]
public virtual string AccessReason { get; set; }
Property Value
Type Description
string

AccountUserListStatus

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.

Declaration
[JsonProperty("accountUserListStatus")]
public virtual string AccountUserListStatus { get; set; }
Property Value
Type Description
string

BasicUserList

User list targeting as a collection of conversion or remarketing actions.

Declaration
[JsonProperty("basicUserList")]
public virtual GoogleAdsSearchads360V23CommonBasicUserListInfo BasicUserList { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23CommonBasicUserListInfo

ClosingReason

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.

Declaration
[JsonProperty("closingReason")]
public virtual string ClosingReason { get; set; }
Property Value
Type Description
string

CrmBasedUserList

User list of CRM users provided by the advertiser.

Declaration
[JsonProperty("crmBasedUserList")]
public virtual GoogleAdsSearchads360V23CommonCrmBasedUserListInfo CrmBasedUserList { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23CommonCrmBasedUserListInfo

Description

Description of this user list.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EligibleForDisplay

Output only. Indicates this user list is eligible for Google Display Network. This field is read-only.

Declaration
[JsonProperty("eligibleForDisplay")]
public virtual bool? EligibleForDisplay { get; set; }
Property Value
Type Description
bool?

EligibleForSearch

Indicates if this user list is eligible for Google Search Network.

Declaration
[JsonProperty("eligibleForSearch")]
public virtual bool? EligibleForSearch { get; set; }
Property Value
Type Description
bool?

Id

Output only. Id of the user list.

Declaration
[JsonProperty("id")]
public virtual long? Id { get; set; }
Property Value
Type Description
long?

IntegrationCode

An ID from external system. It is used by user list sellers to correlate IDs on their systems.

Declaration
[JsonProperty("integrationCode")]
public virtual string IntegrationCode { get; set; }
Property Value
Type Description
string

LogicalUserList

User list that is a custom combination of user lists.

Declaration
[JsonProperty("logicalUserList")]
public virtual GoogleAdsSearchads360V23CommonLogicalUserListInfo LogicalUserList { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23CommonLogicalUserListInfo

LookalikeUserList

Immutable. Lookalike User List.

Declaration
[JsonProperty("lookalikeUserList")]
public virtual GoogleAdsSearchads360V23CommonLookalikeUserListInfo LookalikeUserList { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23CommonLookalikeUserListInfo

MatchRatePercentage

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.

Declaration
[JsonProperty("matchRatePercentage")]
public virtual int? MatchRatePercentage { get; set; }
Property Value
Type Description
int?

MembershipLifeSpan

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.

Declaration
[JsonProperty("membershipLifeSpan")]
public virtual long? MembershipLifeSpan { get; set; }
Property Value
Type Description
long?

MembershipStatus

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.

Declaration
[JsonProperty("membershipStatus")]
public virtual string MembershipStatus { get; set; }
Property Value
Type Description
string

Name

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

ReadOnly__

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.

Declaration
[JsonProperty("readOnly")]
public virtual bool? ReadOnly__ { get; set; }
Property Value
Type Description
bool?

ResourceName

Immutable. The resource name of the user list. User list resource names have the form: customers/{customer_id}/userLists/{user_list_id}

Declaration
[JsonProperty("resourceName")]
public virtual string ResourceName { get; set; }
Property Value
Type Description
string

RuleBasedUserList

User list generated by a rule.

Declaration
[JsonProperty("ruleBasedUserList")]
public virtual GoogleAdsSearchads360V23CommonRuleBasedUserListInfo RuleBasedUserList { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23CommonRuleBasedUserListInfo

SimilarUserList

Output only. User list which are similar to users from another UserList. These lists are readonly and automatically created by google.

Declaration
[JsonProperty("similarUserList")]
public virtual GoogleAdsSearchads360V23CommonSimilarUserListInfo SimilarUserList { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23CommonSimilarUserListInfo

SizeForDisplay

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.

Declaration
[JsonProperty("sizeForDisplay")]
public virtual long? SizeForDisplay { get; set; }
Property Value
Type Description
long?

SizeForSearch

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.

Declaration
[JsonProperty("sizeForSearch")]
public virtual long? SizeForSearch { get; set; }
Property Value
Type Description
long?

SizeRangeForDisplay

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

Declaration
[JsonProperty("sizeRangeForDisplay")]
public virtual string SizeRangeForDisplay { get; set; }
Property Value
Type Description
string

SizeRangeForSearch

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

Declaration
[JsonProperty("sizeRangeForSearch")]
public virtual string SizeRangeForSearch { get; set; }
Property Value
Type Description
string

Type

Output only. Type of this list. This field is read-only.

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

Implements