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

Interface UserListOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
UserList, UserList.Builder
public interface UserListOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getResourceName

      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) = { ... }
      Returns:
      The resourceName.

    • getResourceNameBytes

      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) = { ... }
      Returns:
      The bytes for resourceName.

    • hasId

      boolean hasId()
       Output only. Id of the user list.
      optional int64 id = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the id field is set.

    • getId

      long getId()
       Output only. Id of the user list.
      optional int64 id = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The id.

    • hasReadOnly

      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];
      Returns:
      Whether the readOnly field is set.

    • getReadOnly

      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];
      Returns:
      The readOnly.

    • hasName

      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;
      Returns:
      Whether the name field is set.

    • getName

      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;
      Returns:
      The name.

    • getNameBytes

      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;
      Returns:
      The bytes for name.

    • hasDescription

      boolean hasDescription()
       Description of this user list.
      optional string description = 28;
      Returns:
      Whether the description field is set.

    • getDescription

      String getDescription()
       Description of this user list.
      optional string description = 28;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Description of this user list.
      optional string description = 28;
      Returns:
      The bytes for description.

    • getMembershipStatusValue

      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;
      Returns:
      The enum numeric value on the wire for membershipStatus.

    • getMembershipStatus

      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;
      Returns:
      The membershipStatus.

    • hasIntegrationCode

      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;
      Returns:
      Whether the integrationCode field is set.

    • getIntegrationCode

      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;
      Returns:
      The integrationCode.

    • getIntegrationCodeBytes

      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;
      Returns:
      The bytes for integrationCode.

    • hasMembershipLifeSpan

      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;
      Returns:
      Whether the membershipLifeSpan field is set.

    • getMembershipLifeSpan

      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;
      Returns:
      The membershipLifeSpan.

    • hasSizeForDisplay

      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];
      Returns:
      Whether the sizeForDisplay field is set.

    • getSizeForDisplay

      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];
      Returns:
      The sizeForDisplay.

    • getSizeRangeForDisplayValue

      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];
      Returns:
      The enum numeric value on the wire for sizeRangeForDisplay.

    • getSizeRangeForDisplay

      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];
      Returns:
      The sizeRangeForDisplay.

    • hasSizeForSearch

      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];
      Returns:
      Whether the sizeForSearch field is set.

    • getSizeForSearch

      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];
      Returns:
      The sizeForSearch.

    • getSizeRangeForSearchValue

      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];
      Returns:
      The enum numeric value on the wire for sizeRangeForSearch.

    • getSizeRangeForSearch

      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];
      Returns:
      The sizeRangeForSearch.

    • getTypeValue

      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];
      Returns:
      The enum numeric value on the wire for type.

    • getType

      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];
      Returns:
      The type.

    • getClosingReasonValue

      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;
      Returns:
      The enum numeric value on the wire for closingReason.

    • getClosingReason

      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;
      Returns:
      The closingReason.

    • getAccessReasonValue

      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];
      Returns:
      The enum numeric value on the wire for accessReason.

    • getAccessReason

      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];
      Returns:
      The accessReason.

    • getAccountUserListStatusValue

      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;
      Returns:
      The enum numeric value on the wire for accountUserListStatus.

    • getAccountUserListStatus

      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;
      Returns:
      The accountUserListStatus.

    • hasEligibleForSearch

      boolean hasEligibleForSearch()
       Indicates if this user list is eligible for Google Search Network.
      optional bool eligible_for_search = 33;
      Returns:
      Whether the eligibleForSearch field is set.

    • getEligibleForSearch

      boolean getEligibleForSearch()
       Indicates if this user list is eligible for Google Search Network.
      optional bool eligible_for_search = 33;
      Returns:
      The eligibleForSearch.

    • hasEligibleForDisplay

      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];
      Returns:
      Whether the eligibleForDisplay field is set.

    • getEligibleForDisplay

      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];
      Returns:
      The eligibleForDisplay.

    • hasMatchRatePercentage

      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];
      Returns:
      Whether the matchRatePercentage field is set.

    • getMatchRatePercentage

      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];
      Returns:
      The matchRatePercentage.

    • hasCrmBasedUserList

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

    • getCrmBasedUserList

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

    • getCrmBasedUserListOrBuilder

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

    • hasSimilarUserList

      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];
      Returns:
      Whether the similarUserList field is set.

    • getSimilarUserList

      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];
      Returns:
      The similarUserList.

    • getSimilarUserListOrBuilder

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

    • hasRuleBasedUserList

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

    • getRuleBasedUserList

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

    • getRuleBasedUserListOrBuilder

      RuleBasedUserListInfoOrBuilder getRuleBasedUserListOrBuilder()
       User list generated by a rule.
      .google.ads.googleads.v18.common.RuleBasedUserListInfo rule_based_user_list = 21;

    • hasLogicalUserList

      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;
      Returns:
      Whether the logicalUserList field is set.

    • getLogicalUserList

      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;
      Returns:
      The logicalUserList.

    • getLogicalUserListOrBuilder

      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;

    • hasBasicUserList

      boolean hasBasicUserList()
       User list targeting as a collection of conversion or remarketing actions.
      .google.ads.googleads.v18.common.BasicUserListInfo basic_user_list = 23;
      Returns:
      Whether the basicUserList field is set.

    • getBasicUserList

      BasicUserListInfo getBasicUserList()
       User list targeting as a collection of conversion or remarketing actions.
      .google.ads.googleads.v18.common.BasicUserListInfo basic_user_list = 23;
      Returns:
      The basicUserList.

    • getBasicUserListOrBuilder

      BasicUserListInfoOrBuilder getBasicUserListOrBuilder()
       User list targeting as a collection of conversion or remarketing actions.
      .google.ads.googleads.v18.common.BasicUserListInfo basic_user_list = 23;

    • hasLookalikeUserList

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

    • getLookalikeUserList

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

    • getLookalikeUserListOrBuilder

      LookalikeUserListInfoOrBuilder getLookalikeUserListOrBuilder()
       Immutable. Lookalike User List.
      .google.ads.googleads.v18.common.LookalikeUserListInfo lookalike_user_list = 36 [(.google.api.field_behavior) = IMMUTABLE];

    • getUserListCase

      UserList.UserListCase getUserListCase()