public static final class UserListLicensePricing.Builder extends GeneratedMessage.Builder<UserListLicensePricing.Builder> implements UserListLicensePricingOrBuilderA user list license pricing.
Protobuf type google.ads.datamanager.v1.UserListLicensePricing
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > UserListLicensePricing.BuilderImplements
UserListLicensePricingOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public UserListLicensePricing build()| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing |
|
buildPartial()
public UserListLicensePricing buildPartial()| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing |
|
clear()
public UserListLicensePricing.Builder clear()| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
|
clearBuyerApprovalState()
public UserListLicensePricing.Builder clearBuyerApprovalState()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.Builder |
This builder for chaining. |
clearCostMicros()
public UserListLicensePricing.Builder clearCostMicros() 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 |
UserListLicensePricing.Builder |
This builder for chaining. |
clearCostType()
public UserListLicensePricing.Builder clearCostType()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.Builder |
This builder for chaining. |
clearCurrencyCode()
public UserListLicensePricing.Builder clearCurrencyCode()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 |
UserListLicensePricing.Builder |
This builder for chaining. |
clearEndTime()
public UserListLicensePricing.Builder clearEndTime()Optional. End time of the pricing.
.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
|
clearMaxCostMicros()
public UserListLicensePricing.Builder clearMaxCostMicros() 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 |
UserListLicensePricing.Builder |
This builder for chaining. |
clearPricingActive()
public UserListLicensePricing.Builder clearPricingActive()Output only. Whether this pricing is active.
bool pricing_active = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
This builder for chaining. |
clearPricingId()
public UserListLicensePricing.Builder clearPricingId()Output only. The ID of this pricing.
int64 pricing_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
This builder for chaining. |
clearStartTime()
public UserListLicensePricing.Builder clearStartTime()Output only. Start time of the pricing.
.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getEndTimeBuilder()
public Timestamp.Builder getEndTimeBuilder()Optional. End time of the pricing.
.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
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. |
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. |
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. |
getStartTimeBuilder()
public Timestamp.Builder getStartTimeBuilder()Output only. Start time of the pricing.
.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeEndTime(Timestamp value)
public UserListLicensePricing.Builder mergeEndTime(Timestamp value)Optional. End time of the pricing.
.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
|
mergeFrom(UserListLicensePricing other)
public UserListLicensePricing.Builder mergeFrom(UserListLicensePricing other)| Parameter | |
|---|---|
| Name | Description |
other |
UserListLicensePricing |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public UserListLicensePricing.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public UserListLicensePricing.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
|
mergeStartTime(Timestamp value)
public UserListLicensePricing.Builder mergeStartTime(Timestamp value)Output only. Start time of the pricing.
.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
|
setBuyerApprovalState(UserListLicensePricing.UserListPricingBuyerApprovalState value)
public UserListLicensePricing.Builder setBuyerApprovalState(UserListLicensePricing.UserListPricingBuyerApprovalState value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
UserListLicensePricing.UserListPricingBuyerApprovalStateThe buyerApprovalState to set. |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
This builder for chaining. |
setBuyerApprovalStateValue(int value)
public UserListLicensePricing.Builder setBuyerApprovalStateValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for buyerApprovalState to set. |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
This builder for chaining. |
setCostMicros(long value)
public UserListLicensePricing.Builder setCostMicros(long value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe costMicros to set. |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
This builder for chaining. |
setCostType(UserListLicensePricing.UserListPricingCostType value)
public UserListLicensePricing.Builder setCostType(UserListLicensePricing.UserListPricingCostType value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
UserListLicensePricing.UserListPricingCostTypeThe costType to set. |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
This builder for chaining. |
setCostTypeValue(int value)
public UserListLicensePricing.Builder setCostTypeValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for costType to set. |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
This builder for chaining. |
setCurrencyCode(String value)
public UserListLicensePricing.Builder setCurrencyCode(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe currencyCode to set. |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
This builder for chaining. |
setCurrencyCodeBytes(ByteString value)
public UserListLicensePricing.Builder setCurrencyCodeBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for currencyCode to set. |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
This builder for chaining. |
setEndTime(Timestamp value)
public UserListLicensePricing.Builder setEndTime(Timestamp value)Optional. End time of the pricing.
.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
|
setEndTime(Timestamp.Builder builderForValue)
public UserListLicensePricing.Builder setEndTime(Timestamp.Builder builderForValue)Optional. End time of the pricing.
.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
|
setMaxCostMicros(long value)
public UserListLicensePricing.Builder setMaxCostMicros(long value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe maxCostMicros to set. |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
This builder for chaining. |
setPricingActive(boolean value)
public UserListLicensePricing.Builder setPricingActive(boolean value)Output only. Whether this pricing is active.
bool pricing_active = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe pricingActive to set. |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
This builder for chaining. |
setPricingId(long value)
public UserListLicensePricing.Builder setPricingId(long value)Output only. The ID of this pricing.
int64 pricing_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe pricingId to set. |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
This builder for chaining. |
setStartTime(Timestamp value)
public UserListLicensePricing.Builder setStartTime(Timestamp value)Output only. Start time of the pricing.
.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
|
setStartTime(Timestamp.Builder builderForValue)
public UserListLicensePricing.Builder setStartTime(Timestamp.Builder builderForValue)Output only. Start time of the pricing.
.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
UserListLicensePricing.Builder |
|