Class UserList.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderType>
-
- com.google.protobuf.GeneratedMessageV3.Builder<UserList.Builder>
-
- com.google.ads.googleads.v10.resources.UserList.Builder
-
- All Implemented Interfaces:
UserListOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,java.lang.Cloneable
- Enclosing class:
- UserList
public static final class UserList.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<UserList.Builder> implements UserListOrBuilder
A user list. This is a list of users a customer may target.
Protobuf typegoogle.ads.googleads.v10.resources.UserList
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description UserList.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)UserListbuild()UserListbuildPartial()UserList.Builderclear()UserList.BuilderclearAccessReason()Output only.UserList.BuilderclearAccountUserListStatus()Indicates if this share is still enabled.UserList.BuilderclearBasicUserList()User list targeting as a collection of conversion or remarketing actions.UserList.BuilderclearClosingReason()Indicating the reason why this user list membership status is closed.UserList.BuilderclearCrmBasedUserList()User list of CRM users provided by the advertiser.UserList.BuilderclearDescription()Description of this user list.UserList.BuilderclearEligibleForDisplay()Output only.UserList.BuilderclearEligibleForSearch()Indicates if this user list is eligible for Google Search Network.UserList.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)UserList.BuilderclearId()Output only.UserList.BuilderclearIntegrationCode()An ID from external system.UserList.BuilderclearLogicalUserList()User list that is a custom combination of user lists and user interests.UserList.BuilderclearMatchRatePercentage()Output only.UserList.BuilderclearMembershipLifeSpan()Number of days a user's cookie stays on your list since its most recent addition to the list.UserList.BuilderclearMembershipStatus()Membership status of this user list.UserList.BuilderclearName()Name of this user list.UserList.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)UserList.BuilderclearReadOnly()Output only.UserList.BuilderclearResourceName()Immutable.UserList.BuilderclearRuleBasedUserList()User list generated by a rule.UserList.BuilderclearSimilarUserList()Output only.UserList.BuilderclearSizeForDisplay()Output only.UserList.BuilderclearSizeForSearch()Output only.UserList.BuilderclearSizeRangeForDisplay()Output only.UserList.BuilderclearSizeRangeForSearch()Output only.UserList.BuilderclearType()Output only.UserList.BuilderclearUserList()UserList.Builderclone()AccessReasonEnum.AccessReasongetAccessReason()Output only.intgetAccessReasonValue()Output only.UserListAccessStatusEnum.UserListAccessStatusgetAccountUserListStatus()Indicates if this share is still enabled.intgetAccountUserListStatusValue()Indicates if this share is still enabled.BasicUserListInfogetBasicUserList()User list targeting as a collection of conversion or remarketing actions.BasicUserListInfo.BuildergetBasicUserListBuilder()User list targeting as a collection of conversion or remarketing actions.BasicUserListInfoOrBuildergetBasicUserListOrBuilder()User list targeting as a collection of conversion or remarketing actions.UserListClosingReasonEnum.UserListClosingReasongetClosingReason()Indicating the reason why this user list membership status is closed.intgetClosingReasonValue()Indicating the reason why this user list membership status is closed.CrmBasedUserListInfogetCrmBasedUserList()User list of CRM users provided by the advertiser.CrmBasedUserListInfo.BuildergetCrmBasedUserListBuilder()User list of CRM users provided by the advertiser.CrmBasedUserListInfoOrBuildergetCrmBasedUserListOrBuilder()User list of CRM users provided by the advertiser.UserListgetDefaultInstanceForType()java.lang.StringgetDescription()Description of this user list.com.google.protobuf.ByteStringgetDescriptionBytes()Description of this user list.static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()booleangetEligibleForDisplay()Output only.booleangetEligibleForSearch()Indicates if this user list is eligible for Google Search Network.longgetId()Output only.java.lang.StringgetIntegrationCode()An ID from external system.com.google.protobuf.ByteStringgetIntegrationCodeBytes()An ID from external system.LogicalUserListInfogetLogicalUserList()User list that is a custom combination of user lists and user interests.LogicalUserListInfo.BuildergetLogicalUserListBuilder()User list that is a custom combination of user lists and user interests.LogicalUserListInfoOrBuildergetLogicalUserListOrBuilder()User list that is a custom combination of user lists and user interests.intgetMatchRatePercentage()Output only.longgetMembershipLifeSpan()Number of days a user's cookie stays on your list since its most recent addition to the list.UserListMembershipStatusEnum.UserListMembershipStatusgetMembershipStatus()Membership status of this user list.intgetMembershipStatusValue()Membership status of this user list.java.lang.StringgetName()Name of this user list.com.google.protobuf.ByteStringgetNameBytes()Name of this user list.booleangetReadOnly()Output only.java.lang.StringgetResourceName()Immutable.com.google.protobuf.ByteStringgetResourceNameBytes()Immutable.RuleBasedUserListInfogetRuleBasedUserList()User list generated by a rule.RuleBasedUserListInfo.BuildergetRuleBasedUserListBuilder()User list generated by a rule.RuleBasedUserListInfoOrBuildergetRuleBasedUserListOrBuilder()User list generated by a rule.SimilarUserListInfogetSimilarUserList()Output only.SimilarUserListInfo.BuildergetSimilarUserListBuilder()Output only.SimilarUserListInfoOrBuildergetSimilarUserListOrBuilder()Output only.longgetSizeForDisplay()Output only.longgetSizeForSearch()Output only.UserListSizeRangeEnum.UserListSizeRangegetSizeRangeForDisplay()Output only.intgetSizeRangeForDisplayValue()Output only.UserListSizeRangeEnum.UserListSizeRangegetSizeRangeForSearch()Output only.intgetSizeRangeForSearchValue()Output only.UserListTypeEnum.UserListTypegetType()Output only.intgetTypeValue()Output only.UserList.UserListCasegetUserListCase()booleanhasBasicUserList()User list targeting as a collection of conversion or remarketing actions.booleanhasCrmBasedUserList()User list of CRM users provided by the advertiser.booleanhasDescription()Description of this user list.booleanhasEligibleForDisplay()Output only.booleanhasEligibleForSearch()Indicates if this user list is eligible for Google Search Network.booleanhasId()Output only.booleanhasIntegrationCode()An ID from external system.booleanhasLogicalUserList()User list that is a custom combination of user lists and user interests.booleanhasMatchRatePercentage()Output only.booleanhasMembershipLifeSpan()Number of days a user's cookie stays on your list since its most recent addition to the list.booleanhasName()Name of this user list.booleanhasReadOnly()Output only.booleanhasRuleBasedUserList()User list generated by a rule.booleanhasSimilarUserList()Output only.booleanhasSizeForDisplay()Output only.booleanhasSizeForSearch()Output only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()UserList.BuildermergeBasicUserList(BasicUserListInfo value)User list targeting as a collection of conversion or remarketing actions.UserList.BuildermergeCrmBasedUserList(CrmBasedUserListInfo value)User list of CRM users provided by the advertiser.UserList.BuildermergeFrom(UserList other)UserList.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)UserList.BuildermergeFrom(com.google.protobuf.Message other)UserList.BuildermergeLogicalUserList(LogicalUserListInfo value)User list that is a custom combination of user lists and user interests.UserList.BuildermergeRuleBasedUserList(RuleBasedUserListInfo value)User list generated by a rule.UserList.BuildermergeSimilarUserList(SimilarUserListInfo value)Output only.UserList.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)UserList.BuildersetAccessReason(AccessReasonEnum.AccessReason value)Output only.UserList.BuildersetAccessReasonValue(int value)Output only.UserList.BuildersetAccountUserListStatus(UserListAccessStatusEnum.UserListAccessStatus value)Indicates if this share is still enabled.UserList.BuildersetAccountUserListStatusValue(int value)Indicates if this share is still enabled.UserList.BuildersetBasicUserList(BasicUserListInfo value)User list targeting as a collection of conversion or remarketing actions.UserList.BuildersetBasicUserList(BasicUserListInfo.Builder builderForValue)User list targeting as a collection of conversion or remarketing actions.UserList.BuildersetClosingReason(UserListClosingReasonEnum.UserListClosingReason value)Indicating the reason why this user list membership status is closed.UserList.BuildersetClosingReasonValue(int value)Indicating the reason why this user list membership status is closed.UserList.BuildersetCrmBasedUserList(CrmBasedUserListInfo value)User list of CRM users provided by the advertiser.UserList.BuildersetCrmBasedUserList(CrmBasedUserListInfo.Builder builderForValue)User list of CRM users provided by the advertiser.UserList.BuildersetDescription(java.lang.String value)Description of this user list.UserList.BuildersetDescriptionBytes(com.google.protobuf.ByteString value)Description of this user list.UserList.BuildersetEligibleForDisplay(boolean value)Output only.UserList.BuildersetEligibleForSearch(boolean value)Indicates if this user list is eligible for Google Search Network.UserList.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)UserList.BuildersetId(long value)Output only.UserList.BuildersetIntegrationCode(java.lang.String value)An ID from external system.UserList.BuildersetIntegrationCodeBytes(com.google.protobuf.ByteString value)An ID from external system.UserList.BuildersetLogicalUserList(LogicalUserListInfo value)User list that is a custom combination of user lists and user interests.UserList.BuildersetLogicalUserList(LogicalUserListInfo.Builder builderForValue)User list that is a custom combination of user lists and user interests.UserList.BuildersetMatchRatePercentage(int value)Output only.UserList.BuildersetMembershipLifeSpan(long value)Number of days a user's cookie stays on your list since its most recent addition to the list.UserList.BuildersetMembershipStatus(UserListMembershipStatusEnum.UserListMembershipStatus value)Membership status of this user list.UserList.BuildersetMembershipStatusValue(int value)Membership status of this user list.UserList.BuildersetName(java.lang.String value)Name of this user list.UserList.BuildersetNameBytes(com.google.protobuf.ByteString value)Name of this user list.UserList.BuildersetReadOnly(boolean value)Output only.UserList.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)UserList.BuildersetResourceName(java.lang.String value)Immutable.UserList.BuildersetResourceNameBytes(com.google.protobuf.ByteString value)Immutable.UserList.BuildersetRuleBasedUserList(RuleBasedUserListInfo value)User list generated by a rule.UserList.BuildersetRuleBasedUserList(RuleBasedUserListInfo.Builder builderForValue)User list generated by a rule.UserList.BuildersetSimilarUserList(SimilarUserListInfo value)Output only.UserList.BuildersetSimilarUserList(SimilarUserListInfo.Builder builderForValue)Output only.UserList.BuildersetSizeForDisplay(long value)Output only.UserList.BuildersetSizeForSearch(long value)Output only.UserList.BuildersetSizeRangeForDisplay(UserListSizeRangeEnum.UserListSizeRange value)Output only.UserList.BuildersetSizeRangeForDisplayValue(int value)Output only.UserList.BuildersetSizeRangeForSearch(UserListSizeRangeEnum.UserListSizeRange value)Output only.UserList.BuildersetSizeRangeForSearchValue(int value)Output only.UserList.BuildersetType(UserListTypeEnum.UserListType value)Output only.UserList.BuildersetTypeValue(int value)Output only.UserList.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<UserList.Builder>
-
clear
public UserList.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<UserList.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<UserList.Builder>
-
getDefaultInstanceForType
public UserList getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public UserList build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public UserList buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public UserList.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<UserList.Builder>
-
setField
public UserList.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<UserList.Builder>
-
clearField
public UserList.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<UserList.Builder>
-
clearOneof
public UserList.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<UserList.Builder>
-
setRepeatedField
public UserList.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<UserList.Builder>
-
addRepeatedField
public UserList.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<UserList.Builder>
-
mergeFrom
public UserList.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<UserList.Builder>
-
mergeFrom
public UserList.Builder mergeFrom(UserList other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<UserList.Builder>
-
mergeFrom
public UserList.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<UserList.Builder>- Throws:
java.io.IOException
-
getUserListCase
public UserList.UserListCase getUserListCase()
- Specified by:
getUserListCasein interfaceUserListOrBuilder
-
clearUserList
public UserList.Builder clearUserList()
-
getResourceName
public java.lang.String getResourceName()
Immutable. The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}`string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }- Specified by:
getResourceNamein interfaceUserListOrBuilder- Returns:
- The resourceName.
-
getResourceNameBytes
public com.google.protobuf.ByteString getResourceNameBytes()
Immutable. The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}`string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }- Specified by:
getResourceNameBytesin interfaceUserListOrBuilder- Returns:
- The bytes for resourceName.
-
setResourceName
public UserList.Builder setResourceName(java.lang.String value)
Immutable. The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}`string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }- Parameters:
value- The resourceName to set.- Returns:
- This builder for chaining.
-
clearResourceName
public UserList.Builder clearResourceName()
Immutable. The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}`string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }- Returns:
- This builder for chaining.
-
setResourceNameBytes
public UserList.Builder setResourceNameBytes(com.google.protobuf.ByteString value)
Immutable. The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}`string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }- Parameters:
value- The bytes for resourceName to set.- Returns:
- This builder for chaining.
-
hasId
public boolean hasId()
Output only. Id of the user list.
optional int64 id = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasIdin interfaceUserListOrBuilder- Returns:
- Whether the id field is set.
-
getId
public long getId()
Output only. Id of the user list.
optional int64 id = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getIdin interfaceUserListOrBuilder- Returns:
- The id.
-
setId
public UserList.Builder setId(long value)
Output only. Id of the user list.
optional int64 id = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The id to set.- Returns:
- This builder for chaining.
-
clearId
public UserList.Builder clearId()
Output only. Id of the user list.
optional int64 id = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
hasReadOnly
public boolean hasReadOnly()
Output only. A flag 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 read-only.
optional bool read_only = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasReadOnlyin interfaceUserListOrBuilder- Returns:
- Whether the readOnly field is set.
-
getReadOnly
public boolean getReadOnly()
Output only. A flag 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 read-only.
optional bool read_only = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getReadOnlyin interfaceUserListOrBuilder- Returns:
- The readOnly.
-
setReadOnly
public UserList.Builder setReadOnly(boolean value)
Output only. A flag 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 read-only.
optional bool read_only = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The readOnly to set.- Returns:
- This builder for chaining.
-
clearReadOnly
public UserList.Builder clearReadOnly()
Output only. A flag 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 read-only.
optional bool read_only = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
hasName
public boolean hasName()
Name of this user list. Depending on its access_reason, the user list name may not be unique (e.g. if access_reason=SHARED)
optional string name = 27;- Specified by:
hasNamein interfaceUserListOrBuilder- Returns:
- Whether the name field is set.
-
getName
public java.lang.String getName()
Name of this user list. Depending on its access_reason, the user list name may not be unique (e.g. if access_reason=SHARED)
optional string name = 27;- Specified by:
getNamein interfaceUserListOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()
Name of this user list. Depending on its access_reason, the user list name may not be unique (e.g. if access_reason=SHARED)
optional string name = 27;- Specified by:
getNameBytesin interfaceUserListOrBuilder- Returns:
- The bytes for name.
-
setName
public UserList.Builder setName(java.lang.String value)
Name of this user list. Depending on its access_reason, the user list name may not be unique (e.g. if access_reason=SHARED)
optional string name = 27;- Parameters:
value- The name to set.- Returns:
- This builder for chaining.
-
clearName
public UserList.Builder clearName()
Name of this user list. Depending on its access_reason, the user list name may not be unique (e.g. if access_reason=SHARED)
optional string name = 27;- Returns:
- This builder for chaining.
-
setNameBytes
public UserList.Builder setNameBytes(com.google.protobuf.ByteString value)
Name of this user list. Depending on its access_reason, the user list name may not be unique (e.g. if access_reason=SHARED)
optional string name = 27;- Parameters:
value- The bytes for name to set.- Returns:
- This builder for chaining.
-
hasDescription
public boolean hasDescription()
Description of this user list.
optional string description = 28;- Specified by:
hasDescriptionin interfaceUserListOrBuilder- Returns:
- Whether the description field is set.
-
getDescription
public java.lang.String getDescription()
Description of this user list.
optional string description = 28;- Specified by:
getDescriptionin interfaceUserListOrBuilder- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()
Description of this user list.
optional string description = 28;- Specified by:
getDescriptionBytesin interfaceUserListOrBuilder- Returns:
- The bytes for description.
-
setDescription
public UserList.Builder setDescription(java.lang.String value)
Description of this user list.
optional string description = 28;- Parameters:
value- The description to set.- Returns:
- This builder for chaining.
-
clearDescription
public UserList.Builder clearDescription()
Description of this user list.
optional string description = 28;- Returns:
- This builder for chaining.
-
setDescriptionBytes
public UserList.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
Description of this user list.
optional string description = 28;- Parameters:
value- The bytes for description to set.- Returns:
- This builder for chaining.
-
getMembershipStatusValue
public int getMembershipStatusValue()
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.
.google.ads.googleads.v10.enums.UserListMembershipStatusEnum.UserListMembershipStatus membership_status = 6;- Specified by:
getMembershipStatusValuein interfaceUserListOrBuilder- Returns:
- The enum numeric value on the wire for membershipStatus.
-
setMembershipStatusValue
public UserList.Builder setMembershipStatusValue(int value)
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.
.google.ads.googleads.v10.enums.UserListMembershipStatusEnum.UserListMembershipStatus membership_status = 6;- Parameters:
value- The enum numeric value on the wire for membershipStatus to set.- Returns:
- This builder for chaining.
-
getMembershipStatus
public UserListMembershipStatusEnum.UserListMembershipStatus getMembershipStatus()
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.
.google.ads.googleads.v10.enums.UserListMembershipStatusEnum.UserListMembershipStatus membership_status = 6;- Specified by:
getMembershipStatusin interfaceUserListOrBuilder- Returns:
- The membershipStatus.
-
setMembershipStatus
public UserList.Builder setMembershipStatus(UserListMembershipStatusEnum.UserListMembershipStatus value)
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.
.google.ads.googleads.v10.enums.UserListMembershipStatusEnum.UserListMembershipStatus membership_status = 6;- Parameters:
value- The membershipStatus to set.- Returns:
- This builder for chaining.
-
clearMembershipStatus
public UserList.Builder clearMembershipStatus()
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.
.google.ads.googleads.v10.enums.UserListMembershipStatusEnum.UserListMembershipStatus membership_status = 6;- Returns:
- This builder for chaining.
-
hasIntegrationCode
public boolean hasIntegrationCode()
An ID from external system. It is used by user list sellers to correlate IDs on their systems.
optional string integration_code = 29;- Specified by:
hasIntegrationCodein interfaceUserListOrBuilder- Returns:
- Whether the integrationCode field is set.
-
getIntegrationCode
public java.lang.String getIntegrationCode()
An ID from external system. It is used by user list sellers to correlate IDs on their systems.
optional string integration_code = 29;- Specified by:
getIntegrationCodein interfaceUserListOrBuilder- Returns:
- The integrationCode.
-
getIntegrationCodeBytes
public com.google.protobuf.ByteString getIntegrationCodeBytes()
An ID from external system. It is used by user list sellers to correlate IDs on their systems.
optional string integration_code = 29;- Specified by:
getIntegrationCodeBytesin interfaceUserListOrBuilder- Returns:
- The bytes for integrationCode.
-
setIntegrationCode
public UserList.Builder setIntegrationCode(java.lang.String value)
An ID from external system. It is used by user list sellers to correlate IDs on their systems.
optional string integration_code = 29;- Parameters:
value- The integrationCode to set.- Returns:
- This builder for chaining.
-
clearIntegrationCode
public UserList.Builder clearIntegrationCode()
An ID from external system. It is used by user list sellers to correlate IDs on their systems.
optional string integration_code = 29;- Returns:
- This builder for chaining.
-
setIntegrationCodeBytes
public UserList.Builder setIntegrationCodeBytes(com.google.protobuf.ByteString value)
An ID from external system. It is used by user list sellers to correlate IDs on their systems.
optional string integration_code = 29;- Parameters:
value- The bytes for integrationCode to set.- Returns:
- This builder for chaining.
-
hasMembershipLifeSpan
public boolean hasMembershipLifeSpan()
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. It'll be ignored for logical_user_list.
optional int64 membership_life_span = 30;- Specified by:
hasMembershipLifeSpanin interfaceUserListOrBuilder- Returns:
- Whether the membershipLifeSpan field is set.
-
getMembershipLifeSpan
public long getMembershipLifeSpan()
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. It'll be ignored for logical_user_list.
optional int64 membership_life_span = 30;- Specified by:
getMembershipLifeSpanin interfaceUserListOrBuilder- Returns:
- The membershipLifeSpan.
-
setMembershipLifeSpan
public UserList.Builder setMembershipLifeSpan(long value)
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. It'll be ignored for logical_user_list.
optional int64 membership_life_span = 30;- Parameters:
value- The membershipLifeSpan to set.- Returns:
- This builder for chaining.
-
clearMembershipLifeSpan
public UserList.Builder clearMembershipLifeSpan()
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. It'll be ignored for logical_user_list.
optional int64 membership_life_span = 30;- Returns:
- This builder for chaining.
-
hasSizeForDisplay
public boolean hasSizeForDisplay()
Output only. Estimated number of users in this user list, on the Google Display Network. This value is null if the number of users has not yet been determined. This field is read-only.
optional int64 size_for_display = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasSizeForDisplayin interfaceUserListOrBuilder- Returns:
- Whether the sizeForDisplay field is set.
-
getSizeForDisplay
public long getSizeForDisplay()
Output only. Estimated number of users in this user list, on the Google Display Network. This value is null if the number of users has not yet been determined. This field is read-only.
optional int64 size_for_display = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSizeForDisplayin interfaceUserListOrBuilder- Returns:
- The sizeForDisplay.
-
setSizeForDisplay
public UserList.Builder setSizeForDisplay(long value)
Output only. Estimated number of users in this user list, on the Google Display Network. This value is null if the number of users has not yet been determined. This field is read-only.
optional int64 size_for_display = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The sizeForDisplay to set.- Returns:
- This builder for chaining.
-
clearSizeForDisplay
public UserList.Builder clearSizeForDisplay()
Output only. Estimated number of users in this user list, on the Google Display Network. This value is null if the number of users has not yet been determined. This field is read-only.
optional int64 size_for_display = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
getSizeRangeForDisplayValue
public int getSizeRangeForDisplayValue()
Output only. Size range in terms of number of users of the UserList, on the Google Display Network. This field is read-only.
.google.ads.googleads.v10.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_display = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSizeRangeForDisplayValuein interfaceUserListOrBuilder- Returns:
- The enum numeric value on the wire for sizeRangeForDisplay.
-
setSizeRangeForDisplayValue
public UserList.Builder setSizeRangeForDisplayValue(int value)
Output only. Size range in terms of number of users of the UserList, on the Google Display Network. This field is read-only.
.google.ads.googleads.v10.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_display = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The enum numeric value on the wire for sizeRangeForDisplay to set.- Returns:
- This builder for chaining.
-
getSizeRangeForDisplay
public UserListSizeRangeEnum.UserListSizeRange getSizeRangeForDisplay()
Output only. Size range in terms of number of users of the UserList, on the Google Display Network. This field is read-only.
.google.ads.googleads.v10.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_display = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSizeRangeForDisplayin interfaceUserListOrBuilder- Returns:
- The sizeRangeForDisplay.
-
setSizeRangeForDisplay
public UserList.Builder setSizeRangeForDisplay(UserListSizeRangeEnum.UserListSizeRange value)
Output only. Size range in terms of number of users of the UserList, on the Google Display Network. This field is read-only.
.google.ads.googleads.v10.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_display = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The sizeRangeForDisplay to set.- Returns:
- This builder for chaining.
-
clearSizeRangeForDisplay
public UserList.Builder clearSizeRangeForDisplay()
Output only. Size range in terms of number of users of the UserList, on the Google Display Network. This field is read-only.
.google.ads.googleads.v10.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_display = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
hasSizeForSearch
public boolean hasSizeForSearch()
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.
optional int64 size_for_search = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasSizeForSearchin interfaceUserListOrBuilder- Returns:
- Whether the sizeForSearch field is set.
-
getSizeForSearch
public long getSizeForSearch()
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.
optional int64 size_for_search = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSizeForSearchin interfaceUserListOrBuilder- Returns:
- The sizeForSearch.
-
setSizeForSearch
public UserList.Builder setSizeForSearch(long value)
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.
optional int64 size_for_search = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The sizeForSearch to set.- Returns:
- This builder for chaining.
-
clearSizeForSearch
public UserList.Builder clearSizeForSearch()
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.
optional int64 size_for_search = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
getSizeRangeForSearchValue
public int getSizeRangeForSearchValue()
Output only. Size range in terms of number of users of the UserList, for Search ads. This field is read-only.
.google.ads.googleads.v10.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_search = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSizeRangeForSearchValuein interfaceUserListOrBuilder- Returns:
- The enum numeric value on the wire for sizeRangeForSearch.
-
setSizeRangeForSearchValue
public UserList.Builder setSizeRangeForSearchValue(int value)
Output only. Size range in terms of number of users of the UserList, for Search ads. This field is read-only.
.google.ads.googleads.v10.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_search = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The enum numeric value on the wire for sizeRangeForSearch to set.- Returns:
- This builder for chaining.
-
getSizeRangeForSearch
public UserListSizeRangeEnum.UserListSizeRange getSizeRangeForSearch()
Output only. Size range in terms of number of users of the UserList, for Search ads. This field is read-only.
.google.ads.googleads.v10.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_search = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSizeRangeForSearchin interfaceUserListOrBuilder- Returns:
- The sizeRangeForSearch.
-
setSizeRangeForSearch
public UserList.Builder setSizeRangeForSearch(UserListSizeRangeEnum.UserListSizeRange value)
Output only. Size range in terms of number of users of the UserList, for Search ads. This field is read-only.
.google.ads.googleads.v10.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_search = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The sizeRangeForSearch to set.- Returns:
- This builder for chaining.
-
clearSizeRangeForSearch
public UserList.Builder clearSizeRangeForSearch()
Output only. Size range in terms of number of users of the UserList, for Search ads. This field is read-only.
.google.ads.googleads.v10.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_search = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
getTypeValue
public int getTypeValue()
Output only. Type of this list. This field is read-only.
.google.ads.googleads.v10.enums.UserListTypeEnum.UserListType type = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getTypeValuein interfaceUserListOrBuilder- Returns:
- The enum numeric value on the wire for type.
-
setTypeValue
public UserList.Builder setTypeValue(int value)
Output only. Type of this list. This field is read-only.
.google.ads.googleads.v10.enums.UserListTypeEnum.UserListType type = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The enum numeric value on the wire for type to set.- Returns:
- This builder for chaining.
-
getType
public UserListTypeEnum.UserListType getType()
Output only. Type of this list. This field is read-only.
.google.ads.googleads.v10.enums.UserListTypeEnum.UserListType type = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getTypein interfaceUserListOrBuilder- Returns:
- The type.
-
setType
public UserList.Builder setType(UserListTypeEnum.UserListType value)
Output only. Type of this list. This field is read-only.
.google.ads.googleads.v10.enums.UserListTypeEnum.UserListType type = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The type to set.- Returns:
- This builder for chaining.
-
clearType
public UserList.Builder clearType()
Output only. Type of this list. This field is read-only.
.google.ads.googleads.v10.enums.UserListTypeEnum.UserListType type = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
getClosingReasonValue
public int getClosingReasonValue()
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.
.google.ads.googleads.v10.enums.UserListClosingReasonEnum.UserListClosingReason closing_reason = 14;- Specified by:
getClosingReasonValuein interfaceUserListOrBuilder- Returns:
- The enum numeric value on the wire for closingReason.
-
setClosingReasonValue
public UserList.Builder setClosingReasonValue(int value)
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.
.google.ads.googleads.v10.enums.UserListClosingReasonEnum.UserListClosingReason closing_reason = 14;- Parameters:
value- The enum numeric value on the wire for closingReason to set.- Returns:
- This builder for chaining.
-
getClosingReason
public UserListClosingReasonEnum.UserListClosingReason getClosingReason()
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.
.google.ads.googleads.v10.enums.UserListClosingReasonEnum.UserListClosingReason closing_reason = 14;- Specified by:
getClosingReasonin interfaceUserListOrBuilder- Returns:
- The closingReason.
-
setClosingReason
public UserList.Builder setClosingReason(UserListClosingReasonEnum.UserListClosingReason value)
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.
.google.ads.googleads.v10.enums.UserListClosingReasonEnum.UserListClosingReason closing_reason = 14;- Parameters:
value- The closingReason to set.- Returns:
- This builder for chaining.
-
clearClosingReason
public UserList.Builder clearClosingReason()
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.
.google.ads.googleads.v10.enums.UserListClosingReasonEnum.UserListClosingReason closing_reason = 14;- Returns:
- This builder for chaining.
-
getAccessReasonValue
public int getAccessReasonValue()
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.
.google.ads.googleads.v10.enums.AccessReasonEnum.AccessReason access_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getAccessReasonValuein interfaceUserListOrBuilder- Returns:
- The enum numeric value on the wire for accessReason.
-
setAccessReasonValue
public UserList.Builder setAccessReasonValue(int value)
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.
.google.ads.googleads.v10.enums.AccessReasonEnum.AccessReason access_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The enum numeric value on the wire for accessReason to set.- Returns:
- This builder for chaining.
-
getAccessReason
public AccessReasonEnum.AccessReason getAccessReason()
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.
.google.ads.googleads.v10.enums.AccessReasonEnum.AccessReason access_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getAccessReasonin interfaceUserListOrBuilder- Returns:
- The accessReason.
-
setAccessReason
public UserList.Builder setAccessReason(AccessReasonEnum.AccessReason value)
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.
.google.ads.googleads.v10.enums.AccessReasonEnum.AccessReason access_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The accessReason to set.- Returns:
- This builder for chaining.
-
clearAccessReason
public UserList.Builder clearAccessReason()
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.
.google.ads.googleads.v10.enums.AccessReasonEnum.AccessReason access_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
getAccountUserListStatusValue
public int getAccountUserListStatusValue()
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.
.google.ads.googleads.v10.enums.UserListAccessStatusEnum.UserListAccessStatus account_user_list_status = 16;- Specified by:
getAccountUserListStatusValuein interfaceUserListOrBuilder- Returns:
- The enum numeric value on the wire for accountUserListStatus.
-
setAccountUserListStatusValue
public UserList.Builder setAccountUserListStatusValue(int value)
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.
.google.ads.googleads.v10.enums.UserListAccessStatusEnum.UserListAccessStatus account_user_list_status = 16;- Parameters:
value- The enum numeric value on the wire for accountUserListStatus to set.- Returns:
- This builder for chaining.
-
getAccountUserListStatus
public UserListAccessStatusEnum.UserListAccessStatus getAccountUserListStatus()
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.
.google.ads.googleads.v10.enums.UserListAccessStatusEnum.UserListAccessStatus account_user_list_status = 16;- Specified by:
getAccountUserListStatusin interfaceUserListOrBuilder- Returns:
- The accountUserListStatus.
-
setAccountUserListStatus
public UserList.Builder setAccountUserListStatus(UserListAccessStatusEnum.UserListAccessStatus value)
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.
.google.ads.googleads.v10.enums.UserListAccessStatusEnum.UserListAccessStatus account_user_list_status = 16;- Parameters:
value- The accountUserListStatus to set.- Returns:
- This builder for chaining.
-
clearAccountUserListStatus
public UserList.Builder clearAccountUserListStatus()
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.
.google.ads.googleads.v10.enums.UserListAccessStatusEnum.UserListAccessStatus account_user_list_status = 16;- Returns:
- This builder for chaining.
-
hasEligibleForSearch
public boolean hasEligibleForSearch()
Indicates if this user list is eligible for Google Search Network.
optional bool eligible_for_search = 33;- Specified by:
hasEligibleForSearchin interfaceUserListOrBuilder- Returns:
- Whether the eligibleForSearch field is set.
-
getEligibleForSearch
public boolean getEligibleForSearch()
Indicates if this user list is eligible for Google Search Network.
optional bool eligible_for_search = 33;- Specified by:
getEligibleForSearchin interfaceUserListOrBuilder- Returns:
- The eligibleForSearch.
-
setEligibleForSearch
public UserList.Builder setEligibleForSearch(boolean value)
Indicates if this user list is eligible for Google Search Network.
optional bool eligible_for_search = 33;- Parameters:
value- The eligibleForSearch to set.- Returns:
- This builder for chaining.
-
clearEligibleForSearch
public UserList.Builder clearEligibleForSearch()
Indicates if this user list is eligible for Google Search Network.
optional bool eligible_for_search = 33;- Returns:
- This builder for chaining.
-
hasEligibleForDisplay
public boolean hasEligibleForDisplay()
Output only. Indicates this user list is eligible for Google Display Network. This field is read-only.
optional bool eligible_for_display = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasEligibleForDisplayin interfaceUserListOrBuilder- Returns:
- Whether the eligibleForDisplay field is set.
-
getEligibleForDisplay
public boolean getEligibleForDisplay()
Output only. Indicates this user list is eligible for Google Display Network. This field is read-only.
optional bool eligible_for_display = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getEligibleForDisplayin interfaceUserListOrBuilder- Returns:
- The eligibleForDisplay.
-
setEligibleForDisplay
public UserList.Builder setEligibleForDisplay(boolean value)
Output only. Indicates this user list is eligible for Google Display Network. This field is read-only.
optional bool eligible_for_display = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The eligibleForDisplay to set.- Returns:
- This builder for chaining.
-
clearEligibleForDisplay
public UserList.Builder clearEligibleForDisplay()
Output only. Indicates this user list is eligible for Google Display Network. This field is read-only.
optional bool eligible_for_display = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
hasMatchRatePercentage
public boolean hasMatchRatePercentage()
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.
optional int32 match_rate_percentage = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasMatchRatePercentagein interfaceUserListOrBuilder- Returns:
- Whether the matchRatePercentage field is set.
-
getMatchRatePercentage
public int getMatchRatePercentage()
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.
optional int32 match_rate_percentage = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getMatchRatePercentagein interfaceUserListOrBuilder- Returns:
- The matchRatePercentage.
-
setMatchRatePercentage
public UserList.Builder setMatchRatePercentage(int value)
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.
optional int32 match_rate_percentage = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The matchRatePercentage to set.- Returns:
- This builder for chaining.
-
clearMatchRatePercentage
public UserList.Builder clearMatchRatePercentage()
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.
optional int32 match_rate_percentage = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
hasCrmBasedUserList
public boolean hasCrmBasedUserList()
User list of CRM users provided by the advertiser.
.google.ads.googleads.v10.common.CrmBasedUserListInfo crm_based_user_list = 19;- Specified by:
hasCrmBasedUserListin interfaceUserListOrBuilder- Returns:
- Whether the crmBasedUserList field is set.
-
getCrmBasedUserList
public CrmBasedUserListInfo getCrmBasedUserList()
User list of CRM users provided by the advertiser.
.google.ads.googleads.v10.common.CrmBasedUserListInfo crm_based_user_list = 19;- Specified by:
getCrmBasedUserListin interfaceUserListOrBuilder- Returns:
- The crmBasedUserList.
-
setCrmBasedUserList
public UserList.Builder setCrmBasedUserList(CrmBasedUserListInfo value)
User list of CRM users provided by the advertiser.
.google.ads.googleads.v10.common.CrmBasedUserListInfo crm_based_user_list = 19;
-
setCrmBasedUserList
public UserList.Builder setCrmBasedUserList(CrmBasedUserListInfo.Builder builderForValue)
User list of CRM users provided by the advertiser.
.google.ads.googleads.v10.common.CrmBasedUserListInfo crm_based_user_list = 19;
-
mergeCrmBasedUserList
public UserList.Builder mergeCrmBasedUserList(CrmBasedUserListInfo value)
User list of CRM users provided by the advertiser.
.google.ads.googleads.v10.common.CrmBasedUserListInfo crm_based_user_list = 19;
-
clearCrmBasedUserList
public UserList.Builder clearCrmBasedUserList()
User list of CRM users provided by the advertiser.
.google.ads.googleads.v10.common.CrmBasedUserListInfo crm_based_user_list = 19;
-
getCrmBasedUserListBuilder
public CrmBasedUserListInfo.Builder getCrmBasedUserListBuilder()
User list of CRM users provided by the advertiser.
.google.ads.googleads.v10.common.CrmBasedUserListInfo crm_based_user_list = 19;
-
getCrmBasedUserListOrBuilder
public CrmBasedUserListInfoOrBuilder getCrmBasedUserListOrBuilder()
User list of CRM users provided by the advertiser.
.google.ads.googleads.v10.common.CrmBasedUserListInfo crm_based_user_list = 19;- Specified by:
getCrmBasedUserListOrBuilderin interfaceUserListOrBuilder
-
hasSimilarUserList
public boolean hasSimilarUserList()
Output only. User list which are similar to users from another UserList. These lists are readonly and automatically created by google.
.google.ads.googleads.v10.common.SimilarUserListInfo similar_user_list = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasSimilarUserListin interfaceUserListOrBuilder- Returns:
- Whether the similarUserList field is set.
-
getSimilarUserList
public SimilarUserListInfo getSimilarUserList()
Output only. User list which are similar to users from another UserList. These lists are readonly and automatically created by google.
.google.ads.googleads.v10.common.SimilarUserListInfo similar_user_list = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSimilarUserListin interfaceUserListOrBuilder- Returns:
- The similarUserList.
-
setSimilarUserList
public UserList.Builder setSimilarUserList(SimilarUserListInfo value)
Output only. User list which are similar to users from another UserList. These lists are readonly and automatically created by google.
.google.ads.googleads.v10.common.SimilarUserListInfo similar_user_list = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
-
setSimilarUserList
public UserList.Builder setSimilarUserList(SimilarUserListInfo.Builder builderForValue)
Output only. User list which are similar to users from another UserList. These lists are readonly and automatically created by google.
.google.ads.googleads.v10.common.SimilarUserListInfo similar_user_list = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
-
mergeSimilarUserList
public UserList.Builder mergeSimilarUserList(SimilarUserListInfo value)
Output only. User list which are similar to users from another UserList. These lists are readonly and automatically created by google.
.google.ads.googleads.v10.common.SimilarUserListInfo similar_user_list = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
-
clearSimilarUserList
public UserList.Builder clearSimilarUserList()
Output only. User list which are similar to users from another UserList. These lists are readonly and automatically created by google.
.google.ads.googleads.v10.common.SimilarUserListInfo similar_user_list = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
-
getSimilarUserListBuilder
public SimilarUserListInfo.Builder getSimilarUserListBuilder()
Output only. User list which are similar to users from another UserList. These lists are readonly and automatically created by google.
.google.ads.googleads.v10.common.SimilarUserListInfo similar_user_list = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
-
getSimilarUserListOrBuilder
public SimilarUserListInfoOrBuilder getSimilarUserListOrBuilder()
Output only. User list which are similar to users from another UserList. These lists are readonly and automatically created by google.
.google.ads.googleads.v10.common.SimilarUserListInfo similar_user_list = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSimilarUserListOrBuilderin interfaceUserListOrBuilder
-
hasRuleBasedUserList
public boolean hasRuleBasedUserList()
User list generated by a rule.
.google.ads.googleads.v10.common.RuleBasedUserListInfo rule_based_user_list = 21;- Specified by:
hasRuleBasedUserListin interfaceUserListOrBuilder- Returns:
- Whether the ruleBasedUserList field is set.
-
getRuleBasedUserList
public RuleBasedUserListInfo getRuleBasedUserList()
User list generated by a rule.
.google.ads.googleads.v10.common.RuleBasedUserListInfo rule_based_user_list = 21;- Specified by:
getRuleBasedUserListin interfaceUserListOrBuilder- Returns:
- The ruleBasedUserList.
-
setRuleBasedUserList
public UserList.Builder setRuleBasedUserList(RuleBasedUserListInfo value)
User list generated by a rule.
.google.ads.googleads.v10.common.RuleBasedUserListInfo rule_based_user_list = 21;
-
setRuleBasedUserList
public UserList.Builder setRuleBasedUserList(RuleBasedUserListInfo.Builder builderForValue)
User list generated by a rule.
.google.ads.googleads.v10.common.RuleBasedUserListInfo rule_based_user_list = 21;
-
mergeRuleBasedUserList
public UserList.Builder mergeRuleBasedUserList(RuleBasedUserListInfo value)
User list generated by a rule.
.google.ads.googleads.v10.common.RuleBasedUserListInfo rule_based_user_list = 21;
-
clearRuleBasedUserList
public UserList.Builder clearRuleBasedUserList()
User list generated by a rule.
.google.ads.googleads.v10.common.RuleBasedUserListInfo rule_based_user_list = 21;
-
getRuleBasedUserListBuilder
public RuleBasedUserListInfo.Builder getRuleBasedUserListBuilder()
User list generated by a rule.
.google.ads.googleads.v10.common.RuleBasedUserListInfo rule_based_user_list = 21;
-
getRuleBasedUserListOrBuilder
public RuleBasedUserListInfoOrBuilder getRuleBasedUserListOrBuilder()
User list generated by a rule.
.google.ads.googleads.v10.common.RuleBasedUserListInfo rule_based_user_list = 21;- Specified by:
getRuleBasedUserListOrBuilderin interfaceUserListOrBuilder
-
hasLogicalUserList
public boolean hasLogicalUserList()
User list that is a custom combination of user lists and user interests.
.google.ads.googleads.v10.common.LogicalUserListInfo logical_user_list = 22;- Specified by:
hasLogicalUserListin interfaceUserListOrBuilder- Returns:
- Whether the logicalUserList field is set.
-
getLogicalUserList
public LogicalUserListInfo getLogicalUserList()
User list that is a custom combination of user lists and user interests.
.google.ads.googleads.v10.common.LogicalUserListInfo logical_user_list = 22;- Specified by:
getLogicalUserListin interfaceUserListOrBuilder- Returns:
- The logicalUserList.
-
setLogicalUserList
public UserList.Builder setLogicalUserList(LogicalUserListInfo value)
User list that is a custom combination of user lists and user interests.
.google.ads.googleads.v10.common.LogicalUserListInfo logical_user_list = 22;
-
setLogicalUserList
public UserList.Builder setLogicalUserList(LogicalUserListInfo.Builder builderForValue)
User list that is a custom combination of user lists and user interests.
.google.ads.googleads.v10.common.LogicalUserListInfo logical_user_list = 22;
-
mergeLogicalUserList
public UserList.Builder mergeLogicalUserList(LogicalUserListInfo value)
User list that is a custom combination of user lists and user interests.
.google.ads.googleads.v10.common.LogicalUserListInfo logical_user_list = 22;
-
clearLogicalUserList
public UserList.Builder clearLogicalUserList()
User list that is a custom combination of user lists and user interests.
.google.ads.googleads.v10.common.LogicalUserListInfo logical_user_list = 22;
-
getLogicalUserListBuilder
public LogicalUserListInfo.Builder getLogicalUserListBuilder()
User list that is a custom combination of user lists and user interests.
.google.ads.googleads.v10.common.LogicalUserListInfo logical_user_list = 22;
-
getLogicalUserListOrBuilder
public LogicalUserListInfoOrBuilder getLogicalUserListOrBuilder()
User list that is a custom combination of user lists and user interests.
.google.ads.googleads.v10.common.LogicalUserListInfo logical_user_list = 22;- Specified by:
getLogicalUserListOrBuilderin interfaceUserListOrBuilder
-
hasBasicUserList
public boolean hasBasicUserList()
User list targeting as a collection of conversion or remarketing actions.
.google.ads.googleads.v10.common.BasicUserListInfo basic_user_list = 23;- Specified by:
hasBasicUserListin interfaceUserListOrBuilder- Returns:
- Whether the basicUserList field is set.
-
getBasicUserList
public BasicUserListInfo getBasicUserList()
User list targeting as a collection of conversion or remarketing actions.
.google.ads.googleads.v10.common.BasicUserListInfo basic_user_list = 23;- Specified by:
getBasicUserListin interfaceUserListOrBuilder- Returns:
- The basicUserList.
-
setBasicUserList
public UserList.Builder setBasicUserList(BasicUserListInfo value)
User list targeting as a collection of conversion or remarketing actions.
.google.ads.googleads.v10.common.BasicUserListInfo basic_user_list = 23;
-
setBasicUserList
public UserList.Builder setBasicUserList(BasicUserListInfo.Builder builderForValue)
User list targeting as a collection of conversion or remarketing actions.
.google.ads.googleads.v10.common.BasicUserListInfo basic_user_list = 23;
-
mergeBasicUserList
public UserList.Builder mergeBasicUserList(BasicUserListInfo value)
User list targeting as a collection of conversion or remarketing actions.
.google.ads.googleads.v10.common.BasicUserListInfo basic_user_list = 23;
-
clearBasicUserList
public UserList.Builder clearBasicUserList()
User list targeting as a collection of conversion or remarketing actions.
.google.ads.googleads.v10.common.BasicUserListInfo basic_user_list = 23;
-
getBasicUserListBuilder
public BasicUserListInfo.Builder getBasicUserListBuilder()
User list targeting as a collection of conversion or remarketing actions.
.google.ads.googleads.v10.common.BasicUserListInfo basic_user_list = 23;
-
getBasicUserListOrBuilder
public BasicUserListInfoOrBuilder getBasicUserListOrBuilder()
User list targeting as a collection of conversion or remarketing actions.
.google.ads.googleads.v10.common.BasicUserListInfo basic_user_list = 23;- Specified by:
getBasicUserListOrBuilderin interfaceUserListOrBuilder
-
setUnknownFields
public final UserList.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<UserList.Builder>
-
mergeUnknownFields
public final UserList.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<UserList.Builder>
-
-