Class UserListDirectLicense (0.8.0)

public final class UserListDirectLicense extends GeneratedMessage implements UserListDirectLicenseOrBuilder

A user list direct license.

This feature is only available to data partners.

Protobuf type google.ads.datamanager.v1.UserListDirectLicense

Static Fields

CLIENT_ACCOUNT_DISPLAY_NAME_FIELD_NUMBER

public static final int CLIENT_ACCOUNT_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

CLIENT_ACCOUNT_ID_FIELD_NUMBER

public static final int CLIENT_ACCOUNT_ID_FIELD_NUMBER
Field Value
Type Description
int

CLIENT_ACCOUNT_TYPE_FIELD_NUMBER

public static final int CLIENT_ACCOUNT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

HISTORICAL_PRICINGS_FIELD_NUMBER

public static final int HISTORICAL_PRICINGS_FIELD_NUMBER
Field Value
Type Description
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PRICING_FIELD_NUMBER

public static final int PRICING_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

USER_LIST_DISPLAY_NAME_FIELD_NUMBER

public static final int USER_LIST_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

USER_LIST_ID_FIELD_NUMBER

public static final int USER_LIST_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UserListDirectLicense getDefaultInstance()
Returns
Type Description
UserListDirectLicense

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static UserListDirectLicense.Builder newBuilder()
Returns
Type Description
UserListDirectLicense.Builder

newBuilder(UserListDirectLicense prototype)

public static UserListDirectLicense.Builder newBuilder(UserListDirectLicense prototype)
Parameter
Name Description
prototype UserListDirectLicense
Returns
Type Description
UserListDirectLicense.Builder

parseDelimitedFrom(InputStream input)

public static UserListDirectLicense parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UserListDirectLicense
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserListDirectLicense parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserListDirectLicense
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static UserListDirectLicense parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
UserListDirectLicense
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UserListDirectLicense parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserListDirectLicense
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UserListDirectLicense parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
UserListDirectLicense
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UserListDirectLicense parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserListDirectLicense
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UserListDirectLicense parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UserListDirectLicense
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UserListDirectLicense parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserListDirectLicense
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static UserListDirectLicense parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UserListDirectLicense
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserListDirectLicense parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserListDirectLicense
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static UserListDirectLicense parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UserListDirectLicense
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UserListDirectLicense parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserListDirectLicense
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<UserListDirectLicense> parser()
Returns
Type Description
Parser<UserListDirectLicense>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getClientAccountDisplayName()

public String getClientAccountDisplayName()

Output only. Name of client customer which the user list is being licensed to.

This field is read-only.

string client_account_display_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The clientAccountDisplayName.

getClientAccountDisplayNameBytes()

public ByteString getClientAccountDisplayNameBytes()

Output only. Name of client customer which the user list is being licensed to.

This field is read-only.

string client_account_display_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for clientAccountDisplayName.

getClientAccountId()

public long getClientAccountId()

Immutable. ID of client customer which the user list is being licensed to.

optional int64 client_account_id = 5 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
long

The clientAccountId.

getClientAccountType()

public UserListLicenseClientAccountType getClientAccountType()

Immutable. Account type of client customer which the user list is being licensed to.

optional .google.ads.datamanager.v1.UserListLicenseClientAccountType client_account_type = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
UserListLicenseClientAccountType

The clientAccountType.

getClientAccountTypeValue()

public int getClientAccountTypeValue()

Immutable. Account type of client customer which the user list is being licensed to.

optional .google.ads.datamanager.v1.UserListLicenseClientAccountType client_account_type = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for clientAccountType.

getDefaultInstanceForType()

public UserListDirectLicense getDefaultInstanceForType()
Returns
Type Description
UserListDirectLicense

getHistoricalPricings(int index)

public UserListLicensePricing getHistoricalPricings(int index)

Output only. Pricing history of this user list license.

This field is read-only.

repeated .google.ads.datamanager.v1.UserListLicensePricing historical_pricings = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
UserListLicensePricing

getHistoricalPricingsCount()

public int getHistoricalPricingsCount()

Output only. Pricing history of this user list license.

This field is read-only.

repeated .google.ads.datamanager.v1.UserListLicensePricing historical_pricings = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getHistoricalPricingsList()

public List<UserListLicensePricing> getHistoricalPricingsList()

Output only. Pricing history of this user list license.

This field is read-only.

repeated .google.ads.datamanager.v1.UserListLicensePricing historical_pricings = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<UserListLicensePricing>

getHistoricalPricingsOrBuilder(int index)

public UserListLicensePricingOrBuilder getHistoricalPricingsOrBuilder(int index)

Output only. Pricing history of this user list license.

This field is read-only.

repeated .google.ads.datamanager.v1.UserListLicensePricing historical_pricings = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
UserListLicensePricingOrBuilder

getHistoricalPricingsOrBuilderList()

public List<? extends UserListLicensePricingOrBuilder> getHistoricalPricingsOrBuilderList()

Output only. Pricing history of this user list license.

This field is read-only.

repeated .google.ads.datamanager.v1.UserListLicensePricing historical_pricings = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.ads.datamanager.v1.UserListLicensePricingOrBuilder>

getMetrics()

public UserListLicenseMetrics getMetrics()

Output only. Metrics related to this license

This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call

.google.ads.datamanager.v1.UserListLicenseMetrics metrics = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
UserListLicenseMetrics

The metrics.

getMetricsOrBuilder()

public UserListLicenseMetricsOrBuilder getMetricsOrBuilder()

Output only. Metrics related to this license

This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call

.google.ads.datamanager.v1.UserListLicenseMetrics metrics = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
UserListLicenseMetricsOrBuilder

getName()

public String getName()

Identifier. The resource name of the user list direct license.

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 direct license.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<UserListDirectLicense> getParserForType()
Returns
Type Description
Parser<UserListDirectLicense>
Overrides

getPricing()

public UserListLicensePricing getPricing()

Optional. UserListDirectLicense pricing.

.google.ads.datamanager.v1.UserListLicensePricing pricing = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UserListLicensePricing

The pricing.

getPricingOrBuilder()

public UserListLicensePricingOrBuilder getPricingOrBuilder()

Optional. UserListDirectLicense pricing.

.google.ads.datamanager.v1.UserListLicensePricing pricing = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UserListLicensePricingOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public UserListLicenseStatus getStatus()

Optional. Status of UserListDirectLicense - ENABLED or DISABLED.

optional .google.ads.datamanager.v1.UserListLicenseStatus status = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UserListLicenseStatus

The status.

getStatusValue()

public int getStatusValue()

Optional. Status of UserListDirectLicense - ENABLED or DISABLED.

optional .google.ads.datamanager.v1.UserListLicenseStatus status = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for status.

getUserListDisplayName()

public String getUserListDisplayName()

Output only. Name of the user list being licensed.

This field is read-only.

string user_list_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The userListDisplayName.

getUserListDisplayNameBytes()

public ByteString getUserListDisplayNameBytes()

Output only. Name of the user list being licensed.

This field is read-only.

string user_list_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for userListDisplayName.

getUserListId()

public long getUserListId()

Immutable. ID of the user list being licensed.

optional int64 user_list_id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
long

The userListId.

hasClientAccountId()

public boolean hasClientAccountId()

Immutable. ID of client customer which the user list is being licensed to.

optional int64 client_account_id = 5 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the clientAccountId field is set.

hasClientAccountType()

public boolean hasClientAccountType()

Immutable. Account type of client customer which the user list is being licensed to.

optional .google.ads.datamanager.v1.UserListLicenseClientAccountType client_account_type = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the clientAccountType field is set.

hasMetrics()

public boolean hasMetrics()

Output only. Metrics related to this license

This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call

.google.ads.datamanager.v1.UserListLicenseMetrics metrics = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the metrics field is set.

hasPricing()

public boolean hasPricing()

Optional. UserListDirectLicense pricing.

.google.ads.datamanager.v1.UserListLicensePricing pricing = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the pricing field is set.

hasStatus()

public boolean hasStatus()

Optional. Status of UserListDirectLicense - ENABLED or DISABLED.

optional .google.ads.datamanager.v1.UserListLicenseStatus status = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the status field is set.

hasUserListId()

public boolean hasUserListId()

Immutable. ID of the user list being licensed.

optional int64 user_list_id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the userListId field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public UserListDirectLicense.Builder newBuilderForType()
Returns
Type Description
UserListDirectLicense.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected UserListDirectLicense.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UserListDirectLicense.Builder
Overrides

toBuilder()

public UserListDirectLicense.Builder toBuilder()
Returns
Type Description
UserListDirectLicense.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException