Class UserListLicensePricing (0.8.0)

public final class UserListLicensePricing extends GeneratedMessage implements UserListLicensePricingOrBuilder

A user list license pricing.

Protobuf type google.ads.datamanager.v1.UserListLicensePricing

Static Fields

BUYER_APPROVAL_STATE_FIELD_NUMBER

public static final int BUYER_APPROVAL_STATE_FIELD_NUMBER
Field Value
Type Description
int

COST_MICROS_FIELD_NUMBER

public static final int COST_MICROS_FIELD_NUMBER
Field Value
Type Description
int

COST_TYPE_FIELD_NUMBER

public static final int COST_TYPE_FIELD_NUMBER
Field Value
Type Description
int

CURRENCY_CODE_FIELD_NUMBER

public static final int CURRENCY_CODE_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

MAX_COST_MICROS_FIELD_NUMBER

public static final int MAX_COST_MICROS_FIELD_NUMBER
Field Value
Type Description
int

PRICING_ACTIVE_FIELD_NUMBER

public static final int PRICING_ACTIVE_FIELD_NUMBER
Field Value
Type Description
int

PRICING_ID_FIELD_NUMBER

public static final int PRICING_ID_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UserListLicensePricing getDefaultInstance()
Returns
Type Description
UserListLicensePricing

getDescriptor()

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

newBuilder()

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

newBuilder(UserListLicensePricing prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBuyerApprovalState()

public UserListLicensePricing.UserListPricingBuyerApprovalState getBuyerApprovalState()

Output only. The buyer approval state of this pricing.

This field is read-only.

.google.ads.datamanager.v1.UserListLicensePricing.UserListPricingBuyerApprovalState buyer_approval_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
UserListLicensePricing.UserListPricingBuyerApprovalState

The buyerApprovalState.

getBuyerApprovalStateValue()

public int getBuyerApprovalStateValue()

Output only. The buyer approval state of this pricing.

This field is read-only.

.google.ads.datamanager.v1.UserListLicensePricing.UserListPricingBuyerApprovalState buyer_approval_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for buyerApprovalState.

getCostMicros()

public long getCostMicros()

Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if currency_code is USD.

optional int64 cost_micros = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The costMicros.

getCostType()

public UserListLicensePricing.UserListPricingCostType getCostType()

Immutable. The cost type of this pricing.

Can be set only in the create operation. Can't be updated for an existing license.

optional .google.ads.datamanager.v1.UserListLicensePricing.UserListPricingCostType cost_type = 7 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
UserListLicensePricing.UserListPricingCostType

The costType.

getCostTypeValue()

public int getCostTypeValue()

Immutable. The cost type of this pricing.

Can be set only in the create operation. Can't be updated for an existing license.

optional .google.ads.datamanager.v1.UserListLicensePricing.UserListPricingCostType cost_type = 7 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for costType.

getCurrencyCode()

public String getCurrencyCode()

Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.

optional string currency_code = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The currencyCode.

getCurrencyCodeBytes()

public ByteString getCurrencyCodeBytes()

Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.

optional string currency_code = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for currencyCode.

getDefaultInstanceForType()

public UserListLicensePricing getDefaultInstanceForType()
Returns
Type Description
UserListLicensePricing

getEndTime()

public Timestamp getEndTime()

Optional. End time of the pricing.

.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Optional. End time of the pricing.

.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getMaxCostMicros()

public long getMaxCostMicros()

Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if currency_code is USD.

This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to0, there is no cap.

optional int64 max_cost_micros = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The maxCostMicros.

getParserForType()

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

getPricingActive()

public boolean getPricingActive()

Output only. Whether this pricing is active.

bool pricing_active = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The pricingActive.

getPricingId()

public long getPricingId()

Output only. The ID of this pricing.

int64 pricing_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The pricingId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

Output only. Start time of the pricing.

.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. Start time of the pricing.

.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCostMicros()

public boolean hasCostMicros()

Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if currency_code is USD.

optional int64 cost_micros = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the costMicros field is set.

hasCostType()

public boolean hasCostType()

Immutable. The cost type of this pricing.

Can be set only in the create operation. Can't be updated for an existing license.

optional .google.ads.datamanager.v1.UserListLicensePricing.UserListPricingCostType cost_type = 7 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the costType field is set.

hasCurrencyCode()

public boolean hasCurrencyCode()

Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.

optional string currency_code = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the currencyCode field is set.

hasEndTime()

public boolean hasEndTime()

Optional. End time of the pricing.

.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the endTime field is set.

hasMaxCostMicros()

public boolean hasMaxCostMicros()

Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if currency_code is USD.

This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to0, there is no cap.

optional int64 max_cost_micros = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the maxCostMicros field is set.

hasStartTime()

public boolean hasStartTime()

Output only. Start time of the pricing.

.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the startTime 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 UserListLicensePricing.Builder newBuilderForType()
Returns
Type Description
UserListLicensePricing.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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