public final class UserList extends GeneratedMessage implements UserListOrBuilder
A user list resource.
Protobuf type google.ads.datamanager.v1.UserList
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
ACCESS_REASON_FIELD_NUMBER
public static final int ACCESS_REASON_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ACCOUNT_ACCESS_STATUS_FIELD_NUMBER
public static final int ACCOUNT_ACCESS_STATUS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CLOSING_REASON_FIELD_NUMBER
public static final int CLOSING_REASON_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INGESTED_USER_LIST_INFO_FIELD_NUMBER
public static final int INGESTED_USER_LIST_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INTEGRATION_CODE_FIELD_NUMBER
public static final int INTEGRATION_CODE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MEMBERSHIP_DURATION_FIELD_NUMBER
public static final int MEMBERSHIP_DURATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MEMBERSHIP_STATUS_FIELD_NUMBER
public static final int MEMBERSHIP_STATUS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
READ_ONLY_FIELD_NUMBER
public static final int READ_ONLY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SIZE_INFO_FIELD_NUMBER
public static final int SIZE_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TARGET_NETWORK_INFO_FIELD_NUMBER
public static final int TARGET_NETWORK_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static UserList getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static UserList.Builder newBuilder()
newBuilder(UserList prototype)
public static UserList.Builder newBuilder(UserList prototype)
| Parameter |
| Name |
Description |
prototype |
UserList
|
public static UserList parseDelimitedFrom(InputStream input)
public static UserList parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static UserList parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UserList parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static UserList parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UserList parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UserList parseFrom(CodedInputStream input)
public static UserList parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static UserList parseFrom(InputStream input)
public static UserList parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static UserList parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UserList parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<UserList> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAccessReason()
public UserList.AccessReason getAccessReason()
Output only. The reason this account has been granted access to the list.
.google.ads.datamanager.v1.UserList.AccessReason access_reason = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getAccessReasonValue()
public int getAccessReasonValue()
Output only. The reason this account has been granted access to the list.
.google.ads.datamanager.v1.UserList.AccessReason access_reason = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for accessReason.
|
getAccountAccessStatus()
public UserList.AccessStatus getAccountAccessStatus()
Optional. Indicates if this share is still enabled. When a user list is
shared with the account this field is set to ENABLED. Later the user list
owner can decide to revoke the share and make it DISABLED.
optional .google.ads.datamanager.v1.UserList.AccessStatus account_access_status = 11 [(.google.api.field_behavior) = OPTIONAL];
getAccountAccessStatusValue()
public int getAccountAccessStatusValue()
Optional. Indicates if this share is still enabled. When a user list is
shared with the account this field is set to ENABLED. Later the user list
owner can decide to revoke the share and make it DISABLED.
optional .google.ads.datamanager.v1.UserList.AccessStatus account_access_status = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for accountAccessStatus.
|
getClosingReason()
public UserList.ClosingReason getClosingReason()
Output only. The reason why this user list membership status is closed.
optional .google.ads.datamanager.v1.UserList.ClosingReason closing_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getClosingReasonValue()
public int getClosingReasonValue()
Output only. The reason why this user list membership status is closed.
optional .google.ads.datamanager.v1.UserList.ClosingReason closing_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for closingReason.
|
getDefaultInstanceForType()
public UserList getDefaultInstanceForType()
getDescription()
public String getDescription()
Optional. A description of the user list.
optional string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. A description of the user list.
optional string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getDisplayName()
public String getDisplayName()
Required. The display name of the user list.
optional string display_name = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Required. The display name of the user list.
optional string display_name = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getId()
Output only. The unique ID of the user list.
int64 id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
long |
The id.
|
getIngestedUserListInfo()
public IngestedUserListInfo getIngestedUserListInfo()
Optional. Represents a user list that is populated by user ingested data.
.google.ads.datamanager.v1.IngestedUserListInfo ingested_user_list_info = 14 [(.google.api.field_behavior) = OPTIONAL];
getIngestedUserListInfoOrBuilder()
public IngestedUserListInfoOrBuilder getIngestedUserListInfoOrBuilder()
Optional. Represents a user list that is populated by user ingested data.
.google.ads.datamanager.v1.IngestedUserListInfo ingested_user_list_info = 14 [(.google.api.field_behavior) = OPTIONAL];
getIntegrationCode()
public String getIntegrationCode()
Optional. An ID from external system. It is used by user list sellers to
correlate IDs on their systems.
optional string integration_code = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The integrationCode.
|
getIntegrationCodeBytes()
public ByteString getIntegrationCodeBytes()
Optional. An ID from external system. It is used by user list sellers to
correlate IDs on their systems.
optional string integration_code = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for integrationCode.
|
getMembershipDuration()
public Duration getMembershipDuration()
Optional. The duration a user remains in the user list.
Valid durations are exact multiples of 24 hours (86400 seconds).
Providing a value that is not an exact multiple of 24 hours will result in
an INVALID_ARGUMENT error.
.google.protobuf.Duration membership_duration = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Duration |
The membershipDuration.
|
getMembershipDurationOrBuilder()
public DurationOrBuilder getMembershipDurationOrBuilder()
Optional. The duration a user remains in the user list.
Valid durations are exact multiples of 24 hours (86400 seconds).
Providing a value that is not an exact multiple of 24 hours will result in
an INVALID_ARGUMENT error.
.google.protobuf.Duration membership_duration = 8 [(.google.api.field_behavior) = OPTIONAL];
getMembershipStatus()
public UserList.MembershipStatus getMembershipStatus()
Optional. Membership status of this user list.
optional .google.ads.datamanager.v1.UserList.MembershipStatus membership_status = 6 [(.google.api.field_behavior) = OPTIONAL];
getMembershipStatusValue()
public int getMembershipStatusValue()
Optional. Membership status of this user list.
optional .google.ads.datamanager.v1.UserList.MembershipStatus membership_status = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for membershipStatus.
|
getName()
Identifier. The resource name of the user list.
Format:
accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Identifier. The resource name of the user list.
Format:
accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<UserList> getParserForType()
Overrides
getReadOnly()
public boolean getReadOnly()
Output only. An option that indicates if a user may edit a list.
bool read_only = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
The readOnly.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSizeInfo()
public SizeInfo getSizeInfo()
Output only. Estimated number of members in this user list in different
target networks.
.google.ads.datamanager.v1.SizeInfo size_info = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
SizeInfo |
The sizeInfo.
|
getSizeInfoOrBuilder()
public SizeInfoOrBuilder getSizeInfoOrBuilder()
Output only. Estimated number of members in this user list in different
target networks.
.google.ads.datamanager.v1.SizeInfo size_info = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getTargetNetworkInfo()
public TargetNetworkInfo getTargetNetworkInfo()
Optional. Eligibility information for different target networks.
.google.ads.datamanager.v1.TargetNetworkInfo target_network_info = 13 [(.google.api.field_behavior) = OPTIONAL];
getTargetNetworkInfoOrBuilder()
public TargetNetworkInfoOrBuilder getTargetNetworkInfoOrBuilder()
Optional. Eligibility information for different target networks.
.google.ads.datamanager.v1.TargetNetworkInfo target_network_info = 13 [(.google.api.field_behavior) = OPTIONAL];
getUserListInfoCase()
public UserList.UserListInfoCase getUserListInfoCase()
hasAccountAccessStatus()
public boolean hasAccountAccessStatus()
Optional. Indicates if this share is still enabled. When a user list is
shared with the account this field is set to ENABLED. Later the user list
owner can decide to revoke the share and make it DISABLED.
optional .google.ads.datamanager.v1.UserList.AccessStatus account_access_status = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the accountAccessStatus field is set.
|
hasClosingReason()
public boolean hasClosingReason()
Output only. The reason why this user list membership status is closed.
optional .google.ads.datamanager.v1.UserList.ClosingReason closing_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the closingReason field is set.
|
hasDescription()
public boolean hasDescription()
Optional. A description of the user list.
optional string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the description field is set.
|
hasDisplayName()
public boolean hasDisplayName()
Required. The display name of the user list.
optional string display_name = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the displayName field is set.
|
hasIngestedUserListInfo()
public boolean hasIngestedUserListInfo()
Optional. Represents a user list that is populated by user ingested data.
.google.ads.datamanager.v1.IngestedUserListInfo ingested_user_list_info = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the ingestedUserListInfo field is set.
|
hasIntegrationCode()
public boolean hasIntegrationCode()
Optional. An ID from external system. It is used by user list sellers to
correlate IDs on their systems.
optional string integration_code = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the integrationCode field is set.
|
hasMembershipDuration()
public boolean hasMembershipDuration()
Optional. The duration a user remains in the user list.
Valid durations are exact multiples of 24 hours (86400 seconds).
Providing a value that is not an exact multiple of 24 hours will result in
an INVALID_ARGUMENT error.
.google.protobuf.Duration membership_duration = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the membershipDuration field is set.
|
hasMembershipStatus()
public boolean hasMembershipStatus()
Optional. Membership status of this user list.
optional .google.ads.datamanager.v1.UserList.MembershipStatus membership_status = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the membershipStatus field is set.
|
hasSizeInfo()
public boolean hasSizeInfo()
Output only. Estimated number of members in this user list in different
target networks.
.google.ads.datamanager.v1.SizeInfo size_info = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the sizeInfo field is set.
|
hasTargetNetworkInfo()
public boolean hasTargetNetworkInfo()
Optional. Eligibility information for different target networks.
.google.ads.datamanager.v1.TargetNetworkInfo target_network_info = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the targetNetworkInfo field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public UserList.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected UserList.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public UserList.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides