Interface UserListOrBuilder (0.8.0)

0.8.0 (latest) 0.6.0 0.4.0 0.3.0 0.2.0 0.1.0

public interface UserListOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAccessReason()

public abstract UserList.AccessReason getAccessReason()

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

.google.ads.datamanager.v1.UserList.AccessReason access_reason = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
UserList.AccessReason	The accessReason.

getAccessReasonValue()

public abstract int getAccessReasonValue()

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

.google.ads.datamanager.v1.UserList.AccessReason access_reason = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for accessReason.

getAccountAccessStatus()

public abstract UserList.AccessStatus getAccountAccessStatus()

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.

optional .google.ads.datamanager.v1.UserList.AccessStatus account_access_status = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserList.AccessStatus	The accountAccessStatus.

getAccountAccessStatusValue()

public abstract int getAccountAccessStatusValue()

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.

optional .google.ads.datamanager.v1.UserList.AccessStatus account_access_status = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for accountAccessStatus.

getClosingReason()

public abstract UserList.ClosingReason getClosingReason()

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

optional .google.ads.datamanager.v1.UserList.ClosingReason closing_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
UserList.ClosingReason	The closingReason.

getClosingReasonValue()

public abstract int getClosingReasonValue()

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

optional .google.ads.datamanager.v1.UserList.ClosingReason closing_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for closingReason.

getDescription()

public abstract String getDescription()

Optional. A description of the user list.

optional string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. A description of the user list.

optional string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Required. The display name of the user list.

optional string display_name = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The display name of the user list.

optional string display_name = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for displayName.

getId()

public abstract long getId()

Output only. The unique ID of the user list.

int64 id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
long	The id.

getIngestedUserListInfo()

public abstract IngestedUserListInfo getIngestedUserListInfo()

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

.google.ads.datamanager.v1.IngestedUserListInfo ingested_user_list_info = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
IngestedUserListInfo	The ingestedUserListInfo.

getIngestedUserListInfoOrBuilder()

public abstract IngestedUserListInfoOrBuilder getIngestedUserListInfoOrBuilder()

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

.google.ads.datamanager.v1.IngestedUserListInfo ingested_user_list_info = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
IngestedUserListInfoOrBuilder

getIntegrationCode()

public abstract String getIntegrationCode()

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

optional string integration_code = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The integrationCode.

getIntegrationCodeBytes()

public abstract ByteString getIntegrationCodeBytes()

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

optional string integration_code = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for integrationCode.

getMembershipDuration()

public abstract Duration getMembershipDuration()

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.

.google.protobuf.Duration membership_duration = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Duration	The membershipDuration.

getMembershipDurationOrBuilder()

public abstract DurationOrBuilder getMembershipDurationOrBuilder()

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.

.google.protobuf.Duration membership_duration = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DurationOrBuilder

getMembershipStatus()

public abstract UserList.MembershipStatus getMembershipStatus()

Optional. Membership status of this user list.

optional .google.ads.datamanager.v1.UserList.MembershipStatus membership_status = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserList.MembershipStatus	The membershipStatus.

getMembershipStatusValue()

public abstract int getMembershipStatusValue()

Optional. Membership status of this user list.

optional .google.ads.datamanager.v1.UserList.MembershipStatus membership_status = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for membershipStatus.

getName()

public abstract String getName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

getReadOnly()

public abstract boolean getReadOnly()

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

bool read_only = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The readOnly.

getSizeInfo()

public abstract SizeInfo getSizeInfo()

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

.google.ads.datamanager.v1.SizeInfo size_info = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SizeInfo	The sizeInfo.

getSizeInfoOrBuilder()

public abstract SizeInfoOrBuilder getSizeInfoOrBuilder()

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

.google.ads.datamanager.v1.SizeInfo size_info = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SizeInfoOrBuilder

getTargetNetworkInfo()

public abstract TargetNetworkInfo getTargetNetworkInfo()

Optional. Eligibility information for different target networks.

.google.ads.datamanager.v1.TargetNetworkInfo target_network_info = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TargetNetworkInfo	The targetNetworkInfo.

getTargetNetworkInfoOrBuilder()

public abstract TargetNetworkInfoOrBuilder getTargetNetworkInfoOrBuilder()

Optional. Eligibility information for different target networks.

.google.ads.datamanager.v1.TargetNetworkInfo target_network_info = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TargetNetworkInfoOrBuilder

getUserListInfoCase()

public abstract UserList.UserListInfoCase getUserListInfoCase()

Returns
Type	Description
UserList.UserListInfoCase

hasAccountAccessStatus()

public abstract boolean hasAccountAccessStatus()

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.

optional .google.ads.datamanager.v1.UserList.AccessStatus account_access_status = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the accountAccessStatus field is set.

hasClosingReason()

public abstract boolean hasClosingReason()

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

optional .google.ads.datamanager.v1.UserList.ClosingReason closing_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the closingReason field is set.

hasDescription()

public abstract boolean hasDescription()

Optional. A description of the user list.

optional string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the description field is set.

hasDisplayName()

public abstract boolean hasDisplayName()

Required. The display name of the user list.

optional string display_name = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the displayName field is set.

hasIngestedUserListInfo()

public abstract boolean hasIngestedUserListInfo()

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

.google.ads.datamanager.v1.IngestedUserListInfo ingested_user_list_info = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the ingestedUserListInfo field is set.

hasIntegrationCode()

public abstract boolean hasIntegrationCode()

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

optional string integration_code = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the integrationCode field is set.

hasMembershipDuration()

public abstract boolean hasMembershipDuration()

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.

.google.protobuf.Duration membership_duration = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the membershipDuration field is set.

hasMembershipStatus()

public abstract boolean hasMembershipStatus()

Optional. Membership status of this user list.

optional .google.ads.datamanager.v1.UserList.MembershipStatus membership_status = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the membershipStatus field is set.

hasSizeInfo()

public abstract boolean hasSizeInfo()

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

.google.ads.datamanager.v1.SizeInfo size_info = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the sizeInfo field is set.

hasTargetNetworkInfo()

public abstract boolean hasTargetNetworkInfo()

Optional. Eligibility information for different target networks.

.google.ads.datamanager.v1.TargetNetworkInfo target_network_info = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the targetNetworkInfo field is set.