Class UserList
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.ads.googleads.v10.resources.UserList
-
- All Implemented Interfaces:
UserListOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,java.io.Serializable
public final class UserList extends com.google.protobuf.GeneratedMessageV3 implements UserListOrBuilder
A user list. This is a list of users a customer may target.
Protobuf typegoogle.ads.googleads.v10.resources.UserList- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classUserList.BuilderA user list.static classUserList.UserListCase-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)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.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.CrmBasedUserListInfoOrBuildergetCrmBasedUserListOrBuilder()User list of CRM users provided by the advertiser.static UserListgetDefaultInstance()UserListgetDefaultInstanceForType()java.lang.StringgetDescription()Description of this user list.com.google.protobuf.ByteStringgetDescriptionBytes()Description of this user list.static com.google.protobuf.Descriptors.DescriptorgetDescriptor()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.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.com.google.protobuf.Parser<UserList>getParserForType()booleangetReadOnly()Output only.java.lang.StringgetResourceName()Immutable.com.google.protobuf.ByteStringgetResourceNameBytes()Immutable.RuleBasedUserListInfogetRuleBasedUserList()User list generated by a rule.RuleBasedUserListInfoOrBuildergetRuleBasedUserListOrBuilder()User list generated by a rule.intgetSerializedSize()SimilarUserListInfogetSimilarUserList()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.com.google.protobuf.UnknownFieldSetgetUnknownFields()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.inthashCode()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()static UserList.BuildernewBuilder()static UserList.BuildernewBuilder(UserList prototype)UserList.BuildernewBuilderForType()protected UserList.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected java.lang.ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static UserListparseDelimitedFrom(java.io.InputStream input)static UserListparseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static UserListparseFrom(byte[] data)static UserListparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static UserListparseFrom(com.google.protobuf.ByteString data)static UserListparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static UserListparseFrom(com.google.protobuf.CodedInputStream input)static UserListparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static UserListparseFrom(java.io.InputStream input)static UserListparseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static UserListparseFrom(java.nio.ByteBuffer data)static UserListparseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<UserList>parser()UserList.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
RESOURCE_NAME_FIELD_NUMBER
public static final int RESOURCE_NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
READ_ONLY_FIELD_NUMBER
public static final int READ_ONLY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MEMBERSHIP_STATUS_FIELD_NUMBER
public static final int MEMBERSHIP_STATUS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
INTEGRATION_CODE_FIELD_NUMBER
public static final int INTEGRATION_CODE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MEMBERSHIP_LIFE_SPAN_FIELD_NUMBER
public static final int MEMBERSHIP_LIFE_SPAN_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SIZE_FOR_DISPLAY_FIELD_NUMBER
public static final int SIZE_FOR_DISPLAY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SIZE_RANGE_FOR_DISPLAY_FIELD_NUMBER
public static final int SIZE_RANGE_FOR_DISPLAY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SIZE_FOR_SEARCH_FIELD_NUMBER
public static final int SIZE_FOR_SEARCH_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SIZE_RANGE_FOR_SEARCH_FIELD_NUMBER
public static final int SIZE_RANGE_FOR_SEARCH_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CLOSING_REASON_FIELD_NUMBER
public static final int CLOSING_REASON_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ACCESS_REASON_FIELD_NUMBER
public static final int ACCESS_REASON_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ACCOUNT_USER_LIST_STATUS_FIELD_NUMBER
public static final int ACCOUNT_USER_LIST_STATUS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ELIGIBLE_FOR_SEARCH_FIELD_NUMBER
public static final int ELIGIBLE_FOR_SEARCH_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ELIGIBLE_FOR_DISPLAY_FIELD_NUMBER
public static final int ELIGIBLE_FOR_DISPLAY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MATCH_RATE_PERCENTAGE_FIELD_NUMBER
public static final int MATCH_RATE_PERCENTAGE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CRM_BASED_USER_LIST_FIELD_NUMBER
public static final int CRM_BASED_USER_LIST_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SIMILAR_USER_LIST_FIELD_NUMBER
public static final int SIMILAR_USER_LIST_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RULE_BASED_USER_LIST_FIELD_NUMBER
public static final int RULE_BASED_USER_LIST_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LOGICAL_USER_LIST_FIELD_NUMBER
public static final int LOGICAL_USER_LIST_FIELD_NUMBER
- See Also:
- Constant Field Values
-
BASIC_USER_LIST_FIELD_NUMBER
public static final int BASIC_USER_LIST_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3
-
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
-
getUserListCase
public UserList.UserListCase getUserListCase()
- Specified by:
getUserListCasein interfaceUserListOrBuilder
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static UserList parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static UserList parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static UserList parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static UserList parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static UserList parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static UserList parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static UserList parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static UserList parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static UserList parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static UserList parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static UserList parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static UserList parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public UserList.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static UserList.Builder newBuilder()
-
newBuilder
public static UserList.Builder newBuilder(UserList prototype)
-
toBuilder
public UserList.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected UserList.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static UserList getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<UserList> parser()
-
getParserForType
public com.google.protobuf.Parser<UserList> getParserForType()
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public UserList getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-