Interface UserListLicensePricingOrBuilder (0.8.0)

public interface UserListLicensePricingOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBuyerApprovalState()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getEndTime()

public abstract 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 abstract 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 abstract 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.

getPricingActive()

public abstract 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 abstract 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.

getStartTime()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.