Show / Hide Table of Contents

Class UserList

A user list resource.

Inheritance
object
UserList
Implements
IMessage<UserList>
IEquatable<UserList>
IDeepCloneable<UserList>
IBufferMessage
IMessage
Inherited Members
object.GetHashCode()
object.GetType()
object.ToString()
Namespace: Google.Ads.DataManager.V1
Assembly: Google.Ads.DataManager.V1.dll
Syntax
public sealed class UserList : IMessage<UserList>, IEquatable<UserList>, IDeepCloneable<UserList>, IBufferMessage, IMessage

Constructors

UserList()

Declaration
public UserList()

UserList(UserList)

Declaration
public UserList(UserList other)
Parameters
Type Name Description
UserList other

Properties

AccessReason

Output only. The reason this account has been granted access to the list.

Declaration
public UserList.Types.AccessReason AccessReason { get; set; }
Property Value
Type Description
UserList.Types.AccessReason

AccountAccessStatus

Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to ENABLED. Later the user list owner can decide to revoke the share and make it DISABLED.

Declaration
public UserList.Types.AccessStatus AccountAccessStatus { get; set; }
Property Value
Type Description
UserList.Types.AccessStatus

ClosingReason

Output only. The reason why this user list membership status is closed.

Declaration
public UserList.Types.ClosingReason ClosingReason { get; set; }
Property Value
Type Description
UserList.Types.ClosingReason

Description

Optional. A description of the user list.

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

DisplayName

Required. The display name of the user list.

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

HasAccountAccessStatus

Gets whether the "account_access_status" field is set

Declaration
public bool HasAccountAccessStatus { get; }
Property Value
Type Description
bool

HasClosingReason

Gets whether the "closing_reason" field is set

Declaration
public bool HasClosingReason { get; }
Property Value
Type Description
bool

HasDescription

Gets whether the "description" field is set

Declaration
public bool HasDescription { get; }
Property Value
Type Description
bool

HasDisplayName

Gets whether the "display_name" field is set

Declaration
public bool HasDisplayName { get; }
Property Value
Type Description
bool

HasIntegrationCode

Gets whether the "integration_code" field is set

Declaration
public bool HasIntegrationCode { get; }
Property Value
Type Description
bool

HasMembershipStatus

Gets whether the "membership_status" field is set

Declaration
public bool HasMembershipStatus { get; }
Property Value
Type Description
bool

Id

Output only. The unique ID of the user list.

Declaration
public long Id { get; set; }
Property Value
Type Description
long

IngestedUserListInfo

Optional. Represents a user list that is populated by user ingested data.

Declaration
public IngestedUserListInfo IngestedUserListInfo { get; set; }
Property Value
Type Description
IngestedUserListInfo

IntegrationCode

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

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

MembershipDuration

Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error.

Declaration
public Duration MembershipDuration { get; set; }
Property Value
Type Description
Duration

MembershipStatus

Optional. Membership status of this user list.

Declaration
public UserList.Types.MembershipStatus MembershipStatus { get; set; }
Property Value
Type Description
UserList.Types.MembershipStatus

Name

Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

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

ReadOnly

Output only. An option that indicates if a user may edit a list.

Declaration
public bool ReadOnly { get; set; }
Property Value
Type Description
bool

SizeInfo

Output only. Estimated number of members in this user list in different target networks.

Declaration
public SizeInfo SizeInfo { get; set; }
Property Value
Type Description
SizeInfo

TargetNetworkInfo

Optional. Eligibility information for different target networks.

Declaration
public TargetNetworkInfo TargetNetworkInfo { get; set; }
Property Value
Type Description
TargetNetworkInfo

UserListInfoCase

Declaration
public UserList.UserListInfoOneofCase UserListInfoCase { get; }
Property Value
Type Description
UserList.UserListInfoOneofCase

UserListName

UserListName-typed view over the Name resource name property.

Declaration
public UserListName UserListName { get; set; }
Property Value
Type Description
UserListName
In this article
Back to top Generated by DocFX