All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.ads.googleads.v17.resources.UserListOrBuilder Maven / Gradle / Ivy

The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/resources/user_list.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.resources;

public interface UserListOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.UserList)
    com.google.protobuf.MessageOrBuilder {

  /**
   * 
   * 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) = { ... } * @return The resourceName. */ 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) = { ... } * @return The bytes for resourceName. */ com.google.protobuf.ByteString getResourceNameBytes(); /** *
   * Output only. Id of the user list.
   * 
* * optional int64 id = 25 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return Whether the id field is set. */ boolean hasId(); /** *
   * Output only. Id of the user list.
   * 
* * optional int64 id = 25 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return The id. */ long getId(); /** *
   * 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]; * @return Whether the readOnly field is set. */ 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]; * @return The readOnly. */ boolean getReadOnly(); /** *
   * 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; * @return Whether the name field is set. */ 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; * @return The name. */ java.lang.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; * @return The bytes for name. */ com.google.protobuf.ByteString getNameBytes(); /** *
   * Description of this user list.
   * 
* * optional string description = 28; * @return Whether the description field is set. */ boolean hasDescription(); /** *
   * Description of this user list.
   * 
* * optional string description = 28; * @return The description. */ java.lang.String getDescription(); /** *
   * Description of this user list.
   * 
* * optional string description = 28; * @return The bytes for description. */ com.google.protobuf.ByteString getDescriptionBytes(); /** *
   * 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.v17.enums.UserListMembershipStatusEnum.UserListMembershipStatus membership_status = 6; * @return The enum numeric value on the wire for membershipStatus. */ 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.v17.enums.UserListMembershipStatusEnum.UserListMembershipStatus membership_status = 6; * @return The membershipStatus. */ com.google.ads.googleads.v17.enums.UserListMembershipStatusEnum.UserListMembershipStatus getMembershipStatus(); /** *
   * An ID from external system. It is used by user list sellers to correlate
   * IDs on their systems.
   * 
* * optional string integration_code = 29; * @return Whether the integrationCode field is set. */ 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; * @return The integrationCode. */ 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; * @return The bytes for integrationCode. */ com.google.protobuf.ByteString getIntegrationCodeBytes(); /** *
   * 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.
   *
   * 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; * @return Whether the membershipLifeSpan field is set. */ 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.
   *
   * 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; * @return The membershipLifeSpan. */ long getMembershipLifeSpan(); /** *
   * 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]; * @return Whether the sizeForDisplay field is set. */ 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]; * @return The sizeForDisplay. */ long getSizeForDisplay(); /** *
   * 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.v17.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_display = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return The enum numeric value on the wire for sizeRangeForDisplay. */ 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.v17.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_display = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return The sizeRangeForDisplay. */ com.google.ads.googleads.v17.enums.UserListSizeRangeEnum.UserListSizeRange getSizeRangeForDisplay(); /** *
   * 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]; * @return Whether the sizeForSearch field is set. */ 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]; * @return The sizeForSearch. */ long getSizeForSearch(); /** *
   * Output only. Size range in terms of number of users of the UserList, for
   * Search ads.
   *
   * This field is read-only.
   * 
* * .google.ads.googleads.v17.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_search = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return The enum numeric value on the wire for sizeRangeForSearch. */ 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.v17.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_search = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return The sizeRangeForSearch. */ com.google.ads.googleads.v17.enums.UserListSizeRangeEnum.UserListSizeRange getSizeRangeForSearch(); /** *
   * Output only. Type of this list.
   *
   * This field is read-only.
   * 
* * .google.ads.googleads.v17.enums.UserListTypeEnum.UserListType type = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return The enum numeric value on the wire for type. */ int getTypeValue(); /** *
   * Output only. Type of this list.
   *
   * This field is read-only.
   * 
* * .google.ads.googleads.v17.enums.UserListTypeEnum.UserListType type = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return The type. */ com.google.ads.googleads.v17.enums.UserListTypeEnum.UserListType getType(); /** *
   * 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.v17.enums.UserListClosingReasonEnum.UserListClosingReason closing_reason = 14; * @return The enum numeric value on the wire for closingReason. */ 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.v17.enums.UserListClosingReasonEnum.UserListClosingReason closing_reason = 14; * @return The closingReason. */ com.google.ads.googleads.v17.enums.UserListClosingReasonEnum.UserListClosingReason getClosingReason(); /** *
   * 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.v17.enums.AccessReasonEnum.AccessReason access_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return The enum numeric value on the wire for accessReason. */ 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.v17.enums.AccessReasonEnum.AccessReason access_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return The accessReason. */ com.google.ads.googleads.v17.enums.AccessReasonEnum.AccessReason getAccessReason(); /** *
   * 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.v17.enums.UserListAccessStatusEnum.UserListAccessStatus account_user_list_status = 16; * @return The enum numeric value on the wire for accountUserListStatus. */ 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.v17.enums.UserListAccessStatusEnum.UserListAccessStatus account_user_list_status = 16; * @return The accountUserListStatus. */ com.google.ads.googleads.v17.enums.UserListAccessStatusEnum.UserListAccessStatus getAccountUserListStatus(); /** *
   * Indicates if this user list is eligible for Google Search Network.
   * 
* * optional bool eligible_for_search = 33; * @return Whether the eligibleForSearch field is set. */ boolean hasEligibleForSearch(); /** *
   * Indicates if this user list is eligible for Google Search Network.
   * 
* * optional bool eligible_for_search = 33; * @return The eligibleForSearch. */ boolean getEligibleForSearch(); /** *
   * 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]; * @return Whether the eligibleForDisplay field is set. */ 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]; * @return The eligibleForDisplay. */ boolean getEligibleForDisplay(); /** *
   * 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]; * @return Whether the matchRatePercentage field is set. */ 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]; * @return The matchRatePercentage. */ int getMatchRatePercentage(); /** *
   * User list of CRM users provided by the advertiser.
   * 
* * .google.ads.googleads.v17.common.CrmBasedUserListInfo crm_based_user_list = 19; * @return Whether the crmBasedUserList field is set. */ boolean hasCrmBasedUserList(); /** *
   * User list of CRM users provided by the advertiser.
   * 
* * .google.ads.googleads.v17.common.CrmBasedUserListInfo crm_based_user_list = 19; * @return The crmBasedUserList. */ com.google.ads.googleads.v17.common.CrmBasedUserListInfo getCrmBasedUserList(); /** *
   * User list of CRM users provided by the advertiser.
   * 
* * .google.ads.googleads.v17.common.CrmBasedUserListInfo crm_based_user_list = 19; */ com.google.ads.googleads.v17.common.CrmBasedUserListInfoOrBuilder getCrmBasedUserListOrBuilder(); /** *
   * Output only. User list which are similar to users from another UserList.
   * These lists are readonly and automatically created by google.
   * 
* * .google.ads.googleads.v17.common.SimilarUserListInfo similar_user_list = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return Whether the similarUserList field is set. */ 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.v17.common.SimilarUserListInfo similar_user_list = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return The similarUserList. */ com.google.ads.googleads.v17.common.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.v17.common.SimilarUserListInfo similar_user_list = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ com.google.ads.googleads.v17.common.SimilarUserListInfoOrBuilder getSimilarUserListOrBuilder(); /** *
   * User list generated by a rule.
   * 
* * .google.ads.googleads.v17.common.RuleBasedUserListInfo rule_based_user_list = 21; * @return Whether the ruleBasedUserList field is set. */ boolean hasRuleBasedUserList(); /** *
   * User list generated by a rule.
   * 
* * .google.ads.googleads.v17.common.RuleBasedUserListInfo rule_based_user_list = 21; * @return The ruleBasedUserList. */ com.google.ads.googleads.v17.common.RuleBasedUserListInfo getRuleBasedUserList(); /** *
   * User list generated by a rule.
   * 
* * .google.ads.googleads.v17.common.RuleBasedUserListInfo rule_based_user_list = 21; */ com.google.ads.googleads.v17.common.RuleBasedUserListInfoOrBuilder getRuleBasedUserListOrBuilder(); /** *
   * User list that is a custom combination of user lists and user interests.
   * 
* * .google.ads.googleads.v17.common.LogicalUserListInfo logical_user_list = 22; * @return Whether the logicalUserList field is set. */ boolean hasLogicalUserList(); /** *
   * User list that is a custom combination of user lists and user interests.
   * 
* * .google.ads.googleads.v17.common.LogicalUserListInfo logical_user_list = 22; * @return The logicalUserList. */ com.google.ads.googleads.v17.common.LogicalUserListInfo getLogicalUserList(); /** *
   * User list that is a custom combination of user lists and user interests.
   * 
* * .google.ads.googleads.v17.common.LogicalUserListInfo logical_user_list = 22; */ com.google.ads.googleads.v17.common.LogicalUserListInfoOrBuilder getLogicalUserListOrBuilder(); /** *
   * User list targeting as a collection of conversion or remarketing actions.
   * 
* * .google.ads.googleads.v17.common.BasicUserListInfo basic_user_list = 23; * @return Whether the basicUserList field is set. */ boolean hasBasicUserList(); /** *
   * User list targeting as a collection of conversion or remarketing actions.
   * 
* * .google.ads.googleads.v17.common.BasicUserListInfo basic_user_list = 23; * @return The basicUserList. */ com.google.ads.googleads.v17.common.BasicUserListInfo getBasicUserList(); /** *
   * User list targeting as a collection of conversion or remarketing actions.
   * 
* * .google.ads.googleads.v17.common.BasicUserListInfo basic_user_list = 23; */ com.google.ads.googleads.v17.common.BasicUserListInfoOrBuilder getBasicUserListOrBuilder(); /** *
   * Immutable. Lookalike User List.
   * 
* * .google.ads.googleads.v17.common.LookalikeUserListInfo lookalike_user_list = 36 [(.google.api.field_behavior) = IMMUTABLE]; * @return Whether the lookalikeUserList field is set. */ boolean hasLookalikeUserList(); /** *
   * Immutable. Lookalike User List.
   * 
* * .google.ads.googleads.v17.common.LookalikeUserListInfo lookalike_user_list = 36 [(.google.api.field_behavior) = IMMUTABLE]; * @return The lookalikeUserList. */ com.google.ads.googleads.v17.common.LookalikeUserListInfo getLookalikeUserList(); /** *
   * Immutable. Lookalike User List.
   * 
* * .google.ads.googleads.v17.common.LookalikeUserListInfo lookalike_user_list = 36 [(.google.api.field_behavior) = IMMUTABLE]; */ com.google.ads.googleads.v17.common.LookalikeUserListInfoOrBuilder getLookalikeUserListOrBuilder(); com.google.ads.googleads.v17.resources.UserList.UserListCase getUserListCase(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy