Class UserList.Builder (0.8.0)

0.8.0 (latest) 0.6.0 0.4.0 0.3.0 0.2.0 0.1.0

public static final class UserList.Builder extends GeneratedMessage.Builder<UserList.Builder> implements UserListOrBuilder

A user list resource.

Protobuf type google.ads.datamanager.v1.UserList

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > UserList.Builder

Implements

UserListOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public UserList build()

Returns
Type	Description
UserList

buildPartial()

public UserList buildPartial()

Returns
Type	Description
UserList

clear()

public UserList.Builder clear()

Returns
Type	Description
UserList.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAccessReason()

public UserList.Builder clearAccessReason()

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.Builder	This builder for chaining.

clearAccountAccessStatus()

public UserList.Builder clearAccountAccessStatus()

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.Builder	This builder for chaining.

clearClosingReason()

public UserList.Builder clearClosingReason()

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.Builder	This builder for chaining.

clearDescription()

public UserList.Builder clearDescription()

Optional. A description of the user list.

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

Returns
Type	Description
UserList.Builder	This builder for chaining.

clearDisplayName()

public UserList.Builder clearDisplayName()

Required. The display name of the user list.

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

Returns
Type	Description
UserList.Builder	This builder for chaining.

clearId()

public UserList.Builder clearId()

Output only. The unique ID of the user list.

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

Returns
Type	Description
UserList.Builder	This builder for chaining.

clearIngestedUserListInfo()

public UserList.Builder clearIngestedUserListInfo()

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
UserList.Builder

clearIntegrationCode()

public UserList.Builder clearIntegrationCode()

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
UserList.Builder	This builder for chaining.

clearMembershipDuration()

public UserList.Builder clearMembershipDuration()

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
UserList.Builder

clearMembershipStatus()

public UserList.Builder clearMembershipStatus()

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.Builder	This builder for chaining.

clearName()

public UserList.Builder clearName()

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
UserList.Builder	This builder for chaining.

clearReadOnly()

public UserList.Builder clearReadOnly()

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
UserList.Builder	This builder for chaining.

clearSizeInfo()

public UserList.Builder clearSizeInfo()

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
UserList.Builder

clearTargetNetworkInfo()

public UserList.Builder clearTargetNetworkInfo()

Optional. Eligibility information for different target networks.

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

Returns
Type	Description
UserList.Builder

clearUserListInfo()

public UserList.Builder clearUserListInfo()

Returns
Type	Description
UserList.Builder

getAccessReason()

public 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 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 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 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 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 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.

getDefaultInstanceForType()

public UserList getDefaultInstanceForType()

Returns
Type	Description
UserList

getDescription()

public 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 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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public 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 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 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 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.

getIngestedUserListInfoBuilder()

public IngestedUserListInfo.Builder getIngestedUserListInfoBuilder()

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.Builder

getIngestedUserListInfoOrBuilder()

public 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 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 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 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.

getMembershipDurationBuilder()

public Duration.Builder getMembershipDurationBuilder()

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
Builder

getMembershipDurationOrBuilder()

public 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 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 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 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 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 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 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.

getSizeInfoBuilder()

public SizeInfo.Builder getSizeInfoBuilder()

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.Builder

getSizeInfoOrBuilder()

public 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 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.

getTargetNetworkInfoBuilder()

public TargetNetworkInfo.Builder getTargetNetworkInfoBuilder()

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.Builder

getTargetNetworkInfoOrBuilder()

public 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 UserList.UserListInfoCase getUserListInfoCase()

Returns
Type	Description
UserList.UserListInfoCase

hasAccountAccessStatus()

public 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 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 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 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 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 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(UserList other)

public UserList.Builder mergeFrom(UserList other)

Parameter
Name	Description
other	UserList

Returns
Type	Description
UserList.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UserList.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
UserList.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public UserList.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
UserList.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeIngestedUserListInfo(IngestedUserListInfo value)

public UserList.Builder mergeIngestedUserListInfo(IngestedUserListInfo value)

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];

Parameter
Name	Description
value	IngestedUserListInfo

Returns
Type	Description
UserList.Builder

mergeMembershipDuration(Duration value)

public UserList.Builder mergeMembershipDuration(Duration value)

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];

Parameter
Name	Description
value	Duration

Returns
Type	Description
UserList.Builder

mergeSizeInfo(SizeInfo value)

public UserList.Builder mergeSizeInfo(SizeInfo value)

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];

Parameter
Name	Description
value	SizeInfo

Returns
Type	Description
UserList.Builder

mergeTargetNetworkInfo(TargetNetworkInfo value)

public UserList.Builder mergeTargetNetworkInfo(TargetNetworkInfo value)

Optional. Eligibility information for different target networks.

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

Parameter
Name	Description
value	TargetNetworkInfo

Returns
Type	Description
UserList.Builder

setAccessReason(UserList.AccessReason value)

public UserList.Builder setAccessReason(UserList.AccessReason value)

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];

Parameter
Name	Description
value	UserList.AccessReason The accessReason to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setAccessReasonValue(int value)

public UserList.Builder setAccessReasonValue(int value)

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];

Parameter
Name	Description
value	int The enum numeric value on the wire for accessReason to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setAccountAccessStatus(UserList.AccessStatus value)

public UserList.Builder setAccountAccessStatus(UserList.AccessStatus value)

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];

Parameter
Name	Description
value	UserList.AccessStatus The accountAccessStatus to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setAccountAccessStatusValue(int value)

public UserList.Builder setAccountAccessStatusValue(int value)

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];

Parameter
Name	Description
value	int The enum numeric value on the wire for accountAccessStatus to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setClosingReason(UserList.ClosingReason value)

public UserList.Builder setClosingReason(UserList.ClosingReason value)

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];

Parameter
Name	Description
value	UserList.ClosingReason The closingReason to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setClosingReasonValue(int value)

public UserList.Builder setClosingReasonValue(int value)

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];

Parameter
Name	Description
value	int The enum numeric value on the wire for closingReason to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setDescription(String value)

public UserList.Builder setDescription(String value)

Optional. A description of the user list.

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

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public UserList.Builder setDescriptionBytes(ByteString value)

Optional. A description of the user list.

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

Parameter
Name	Description
value	ByteString The bytes for description to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setDisplayName(String value)

public UserList.Builder setDisplayName(String value)

Required. The display name of the user list.

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

Parameter
Name	Description
value	String The displayName to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public UserList.Builder setDisplayNameBytes(ByteString value)

Required. The display name of the user list.

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

Parameter
Name	Description
value	ByteString The bytes for displayName to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setId(long value)

public UserList.Builder setId(long value)

Output only. The unique ID of the user list.

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

Parameter
Name	Description
value	long The id to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setIngestedUserListInfo(IngestedUserListInfo value)

public UserList.Builder setIngestedUserListInfo(IngestedUserListInfo value)

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];

Parameter
Name	Description
value	IngestedUserListInfo

Returns
Type	Description
UserList.Builder

setIngestedUserListInfo(IngestedUserListInfo.Builder builderForValue)

public UserList.Builder setIngestedUserListInfo(IngestedUserListInfo.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	IngestedUserListInfo.Builder

Returns
Type	Description
UserList.Builder

setIntegrationCode(String value)

public UserList.Builder setIntegrationCode(String value)

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];

Parameter
Name	Description
value	String The integrationCode to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setIntegrationCodeBytes(ByteString value)

public UserList.Builder setIntegrationCodeBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for integrationCode to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setMembershipDuration(Duration value)

public UserList.Builder setMembershipDuration(Duration value)

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];

Parameter
Name	Description
value	Duration

Returns
Type	Description
UserList.Builder

setMembershipDuration(Duration.Builder builderForValue)

public UserList.Builder setMembershipDuration(Duration.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
UserList.Builder

setMembershipStatus(UserList.MembershipStatus value)

public UserList.Builder setMembershipStatus(UserList.MembershipStatus value)

Optional. Membership status of this user list.

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

Parameter
Name	Description
value	UserList.MembershipStatus The membershipStatus to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setMembershipStatusValue(int value)

public UserList.Builder setMembershipStatusValue(int value)

Optional. Membership status of this user list.

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

Parameter
Name	Description
value	int The enum numeric value on the wire for membershipStatus to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setName(String value)

public UserList.Builder setName(String value)

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];

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setNameBytes(ByteString value)

public UserList.Builder setNameBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setReadOnly(boolean value)

public UserList.Builder setReadOnly(boolean value)

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

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

Parameter
Name	Description
value	boolean The readOnly to set.

Returns
Type	Description
UserList.Builder	This builder for chaining.

setSizeInfo(SizeInfo value)

public UserList.Builder setSizeInfo(SizeInfo value)

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];

Parameter
Name	Description
value	SizeInfo

Returns
Type	Description
UserList.Builder

setSizeInfo(SizeInfo.Builder builderForValue)

public UserList.Builder setSizeInfo(SizeInfo.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	SizeInfo.Builder

Returns
Type	Description
UserList.Builder

setTargetNetworkInfo(TargetNetworkInfo value)

public UserList.Builder setTargetNetworkInfo(TargetNetworkInfo value)

Optional. Eligibility information for different target networks.

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

Parameter
Name	Description
value	TargetNetworkInfo

Returns
Type	Description
UserList.Builder

setTargetNetworkInfo(TargetNetworkInfo.Builder builderForValue)

public UserList.Builder setTargetNetworkInfo(TargetNetworkInfo.Builder builderForValue)

Optional. Eligibility information for different target networks.

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

Parameter
Name	Description
builderForValue	TargetNetworkInfo.Builder

Returns
Type	Description
UserList.Builder