Package com.google.ads.googleads.v18.resources

Class UserList

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.resources.UserList
All Implemented Interfaces:
UserListOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, 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 type google.ads.googleads.v18.resources.UserList
See Also:

  • Field Details

    • RESOURCE_NAME_FIELD_NUMBER

      public static final int RESOURCE_NAME_FIELD_NUMBER
      See Also:

    • ID_FIELD_NUMBER

      public static final int ID_FIELD_NUMBER
      See Also:

    • READ_ONLY_FIELD_NUMBER

      public static final int READ_ONLY_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • MEMBERSHIP_STATUS_FIELD_NUMBER

      public static final int MEMBERSHIP_STATUS_FIELD_NUMBER
      See Also:

    • INTEGRATION_CODE_FIELD_NUMBER

      public static final int INTEGRATION_CODE_FIELD_NUMBER
      See Also:

    • MEMBERSHIP_LIFE_SPAN_FIELD_NUMBER

      public static final int MEMBERSHIP_LIFE_SPAN_FIELD_NUMBER
      See Also:

    • SIZE_FOR_DISPLAY_FIELD_NUMBER

      public static final int SIZE_FOR_DISPLAY_FIELD_NUMBER
      See Also:

    • SIZE_RANGE_FOR_DISPLAY_FIELD_NUMBER

      public static final int SIZE_RANGE_FOR_DISPLAY_FIELD_NUMBER
      See Also:

    • SIZE_FOR_SEARCH_FIELD_NUMBER

      public static final int SIZE_FOR_SEARCH_FIELD_NUMBER
      See Also:

    • SIZE_RANGE_FOR_SEARCH_FIELD_NUMBER

      public static final int SIZE_RANGE_FOR_SEARCH_FIELD_NUMBER
      See Also:

    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:

    • CLOSING_REASON_FIELD_NUMBER

      public static final int CLOSING_REASON_FIELD_NUMBER
      See Also:

    • ACCESS_REASON_FIELD_NUMBER

      public static final int ACCESS_REASON_FIELD_NUMBER
      See Also:

    • ACCOUNT_USER_LIST_STATUS_FIELD_NUMBER

      public static final int ACCOUNT_USER_LIST_STATUS_FIELD_NUMBER
      See Also:

    • ELIGIBLE_FOR_SEARCH_FIELD_NUMBER

      public static final int ELIGIBLE_FOR_SEARCH_FIELD_NUMBER
      See Also:

    • ELIGIBLE_FOR_DISPLAY_FIELD_NUMBER

      public static final int ELIGIBLE_FOR_DISPLAY_FIELD_NUMBER
      See Also:

    • MATCH_RATE_PERCENTAGE_FIELD_NUMBER

      public static final int MATCH_RATE_PERCENTAGE_FIELD_NUMBER
      See Also:

    • CRM_BASED_USER_LIST_FIELD_NUMBER

      public static final int CRM_BASED_USER_LIST_FIELD_NUMBER
      See Also:

    • SIMILAR_USER_LIST_FIELD_NUMBER

      public static final int SIMILAR_USER_LIST_FIELD_NUMBER
      See Also:

    • RULE_BASED_USER_LIST_FIELD_NUMBER

      public static final int RULE_BASED_USER_LIST_FIELD_NUMBER
      See Also:

    • LOGICAL_USER_LIST_FIELD_NUMBER

      public static final int LOGICAL_USER_LIST_FIELD_NUMBER
      See Also:

    • BASIC_USER_LIST_FIELD_NUMBER

      public static final int BASIC_USER_LIST_FIELD_NUMBER
      See Also:

    • LOOKALIKE_USER_LIST_FIELD_NUMBER

      public static final int LOOKALIKE_USER_LIST_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getUserListCase

      public UserList.UserListCase getUserListCase()
      Specified by:
      getUserListCase in interface UserListOrBuilder

    • getResourceName

      public 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:
      getResourceName in interface UserListOrBuilder
      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:
      getResourceNameBytes in interface UserListOrBuilder
      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:
      hasId in interface UserListOrBuilder
      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:
      getId in interface UserListOrBuilder
      Returns:
      The id.

    • hasReadOnly

      public boolean hasReadOnly()
       Output only. An option 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:
      hasReadOnly in interface UserListOrBuilder
      Returns:
      Whether the readOnly field is set.

    • getReadOnly

      public boolean getReadOnly()
       Output only. An option 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:
      getReadOnly in interface UserListOrBuilder
      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 (for example, if access_reason=SHARED)
      optional string name = 27;
      Specified by:
      hasName in interface UserListOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public String getName()
       Name of this user list. Depending on its access_reason, the user list name
 may not be unique (for example, if access_reason=SHARED)
      optional string name = 27;
      Specified by:
      getName in interface UserListOrBuilder
      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 (for example, if access_reason=SHARED)
      optional string name = 27;
      Specified by:
      getNameBytes in interface UserListOrBuilder
      Returns:
      The bytes for name.

    • hasDescription

      public boolean hasDescription()
       Description of this user list.
      optional string description = 28;
      Specified by:
      hasDescription in interface UserListOrBuilder
      Returns:
      Whether the description field is set.

    • getDescription

      public String getDescription()
       Description of this user list.
      optional string description = 28;
      Specified by:
      getDescription in interface UserListOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Description of this user list.
      optional string description = 28;
      Specified by:
      getDescriptionBytes in interface UserListOrBuilder
      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.v18.enums.UserListMembershipStatusEnum.UserListMembershipStatus membership_status = 6;
      Specified by:
      getMembershipStatusValue in interface UserListOrBuilder
      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.v18.enums.UserListMembershipStatusEnum.UserListMembershipStatus membership_status = 6;
      Specified by:
      getMembershipStatus in interface UserListOrBuilder
      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:
      hasIntegrationCode in interface UserListOrBuilder
      Returns:
      Whether the integrationCode field is set.

    • getIntegrationCode

      public 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:
      getIntegrationCode in interface UserListOrBuilder
      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:
      getIntegrationCodeBytes in interface UserListOrBuilder
      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. Beginning on April 7, 2025, using a value of 10000 to
 indicate no expiration will no longer be supported.

 This field is ignored for logical_user_list and rule_based_user_list types.
 Membership to lists of these types depends on the rules defined by the
 lists.
      optional int64 membership_life_span = 30;
      Specified by:
      hasMembershipLifeSpan in interface UserListOrBuilder
      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. Beginning on April 7, 2025, using a value of 10000 to
 indicate no expiration will no longer be supported.

 This field is ignored for logical_user_list and rule_based_user_list types.
 Membership to lists of these types depends on the rules defined by the
 lists.
      optional int64 membership_life_span = 30;
      Specified by:
      getMembershipLifeSpan in interface UserListOrBuilder
      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:
      hasSizeForDisplay in interface UserListOrBuilder
      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:
      getSizeForDisplay in interface UserListOrBuilder
      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.v18.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_display = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSizeRangeForDisplayValue in interface UserListOrBuilder
      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.v18.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_display = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSizeRangeForDisplay in interface UserListOrBuilder
      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:
      hasSizeForSearch in interface UserListOrBuilder
      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:
      getSizeForSearch in interface UserListOrBuilder
      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.v18.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_search = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSizeRangeForSearchValue in interface UserListOrBuilder
      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.v18.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_search = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSizeRangeForSearch in interface UserListOrBuilder
      Returns:
      The sizeRangeForSearch.

    • getTypeValue

      public int getTypeValue()
       Output only. Type of this list.

 This field is read-only.
      .google.ads.googleads.v18.enums.UserListTypeEnum.UserListType type = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTypeValue in interface UserListOrBuilder
      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.v18.enums.UserListTypeEnum.UserListType type = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getType in interface UserListOrBuilder
      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.v18.enums.UserListClosingReasonEnum.UserListClosingReason closing_reason = 14;
      Specified by:
      getClosingReasonValue in interface UserListOrBuilder
      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.v18.enums.UserListClosingReasonEnum.UserListClosingReason closing_reason = 14;
      Specified by:
      getClosingReason in interface UserListOrBuilder
      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.v18.enums.AccessReasonEnum.AccessReason access_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAccessReasonValue in interface UserListOrBuilder
      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.v18.enums.AccessReasonEnum.AccessReason access_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAccessReason in interface UserListOrBuilder
      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.v18.enums.UserListAccessStatusEnum.UserListAccessStatus account_user_list_status = 16;
      Specified by:
      getAccountUserListStatusValue in interface UserListOrBuilder
      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.v18.enums.UserListAccessStatusEnum.UserListAccessStatus account_user_list_status = 16;
      Specified by:
      getAccountUserListStatus in interface UserListOrBuilder
      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:
      hasEligibleForSearch in interface UserListOrBuilder
      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:
      getEligibleForSearch in interface UserListOrBuilder
      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:
      hasEligibleForDisplay in interface UserListOrBuilder
      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:
      getEligibleForDisplay in interface UserListOrBuilder
      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:
      hasMatchRatePercentage in interface UserListOrBuilder
      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:
      getMatchRatePercentage in interface UserListOrBuilder
      Returns:
      The matchRatePercentage.

    • hasCrmBasedUserList

      public boolean hasCrmBasedUserList()
       User list of CRM users provided by the advertiser.
      .google.ads.googleads.v18.common.CrmBasedUserListInfo crm_based_user_list = 19;
      Specified by:
      hasCrmBasedUserList in interface UserListOrBuilder
      Returns:
      Whether the crmBasedUserList field is set.

    • getCrmBasedUserList

      public CrmBasedUserListInfo getCrmBasedUserList()
       User list of CRM users provided by the advertiser.
      .google.ads.googleads.v18.common.CrmBasedUserListInfo crm_based_user_list = 19;
      Specified by:
      getCrmBasedUserList in interface UserListOrBuilder
      Returns:
      The crmBasedUserList.

    • getCrmBasedUserListOrBuilder

      public CrmBasedUserListInfoOrBuilder getCrmBasedUserListOrBuilder()
       User list of CRM users provided by the advertiser.
      .google.ads.googleads.v18.common.CrmBasedUserListInfo crm_based_user_list = 19;
      Specified by:
      getCrmBasedUserListOrBuilder in interface UserListOrBuilder

    • 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.v18.common.SimilarUserListInfo similar_user_list = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasSimilarUserList in interface UserListOrBuilder
      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.v18.common.SimilarUserListInfo similar_user_list = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSimilarUserList in interface UserListOrBuilder
      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.v18.common.SimilarUserListInfo similar_user_list = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSimilarUserListOrBuilder in interface UserListOrBuilder

    • hasRuleBasedUserList

      public boolean hasRuleBasedUserList()
       User list generated by a rule.
      .google.ads.googleads.v18.common.RuleBasedUserListInfo rule_based_user_list = 21;
      Specified by:
      hasRuleBasedUserList in interface UserListOrBuilder
      Returns:
      Whether the ruleBasedUserList field is set.

    • getRuleBasedUserList

      public RuleBasedUserListInfo getRuleBasedUserList()
       User list generated by a rule.
      .google.ads.googleads.v18.common.RuleBasedUserListInfo rule_based_user_list = 21;
      Specified by:
      getRuleBasedUserList in interface UserListOrBuilder
      Returns:
      The ruleBasedUserList.

    • getRuleBasedUserListOrBuilder

      public RuleBasedUserListInfoOrBuilder getRuleBasedUserListOrBuilder()
       User list generated by a rule.
      .google.ads.googleads.v18.common.RuleBasedUserListInfo rule_based_user_list = 21;
      Specified by:
      getRuleBasedUserListOrBuilder in interface UserListOrBuilder

    • hasLogicalUserList

      public boolean hasLogicalUserList()
       User list that is a custom combination of user lists and user interests.
      .google.ads.googleads.v18.common.LogicalUserListInfo logical_user_list = 22;
      Specified by:
      hasLogicalUserList in interface UserListOrBuilder
      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.v18.common.LogicalUserListInfo logical_user_list = 22;
      Specified by:
      getLogicalUserList in interface UserListOrBuilder
      Returns:
      The logicalUserList.

    • getLogicalUserListOrBuilder

      public LogicalUserListInfoOrBuilder getLogicalUserListOrBuilder()
       User list that is a custom combination of user lists and user interests.
      .google.ads.googleads.v18.common.LogicalUserListInfo logical_user_list = 22;
      Specified by:
      getLogicalUserListOrBuilder in interface UserListOrBuilder

    • hasBasicUserList

      public boolean hasBasicUserList()
       User list targeting as a collection of conversion or remarketing actions.
      .google.ads.googleads.v18.common.BasicUserListInfo basic_user_list = 23;
      Specified by:
      hasBasicUserList in interface UserListOrBuilder
      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.v18.common.BasicUserListInfo basic_user_list = 23;
      Specified by:
      getBasicUserList in interface UserListOrBuilder
      Returns:
      The basicUserList.

    • getBasicUserListOrBuilder

      public BasicUserListInfoOrBuilder getBasicUserListOrBuilder()
       User list targeting as a collection of conversion or remarketing actions.
      .google.ads.googleads.v18.common.BasicUserListInfo basic_user_list = 23;
      Specified by:
      getBasicUserListOrBuilder in interface UserListOrBuilder

    • hasLookalikeUserList

      public boolean hasLookalikeUserList()
       Immutable. Lookalike User List.
      .google.ads.googleads.v18.common.LookalikeUserListInfo lookalike_user_list = 36 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      hasLookalikeUserList in interface UserListOrBuilder
      Returns:
      Whether the lookalikeUserList field is set.

    • getLookalikeUserList

      public LookalikeUserListInfo getLookalikeUserList()
       Immutable. Lookalike User List.
      .google.ads.googleads.v18.common.LookalikeUserListInfo lookalike_user_list = 36 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getLookalikeUserList in interface UserListOrBuilder
      Returns:
      The lookalikeUserList.

    • getLookalikeUserListOrBuilder

      public LookalikeUserListInfoOrBuilder getLookalikeUserListOrBuilder()
       Immutable. Lookalike User List.
      .google.ads.googleads.v18.common.LookalikeUserListInfo lookalike_user_list = 36 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getLookalikeUserListOrBuilder in interface UserListOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static UserList parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserList parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UserList parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UserList parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UserList parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UserList parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UserList parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public UserList.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static UserList.Builder newBuilder()

    • newBuilder

      public static UserList.Builder newBuilder(UserList prototype)

    • toBuilder

      public UserList.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected UserList.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.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:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public UserList getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder