com.google.api.services.displayvideo.v3.model

Class PartnerCost

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.displayvideo.v3.model.PartnerCost

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class PartnerCost
extends com.google.api.client.json.GenericJson

Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Display & Video 360 API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
PartnerCost()

Method Summary

Modifier and Type	Method and Description
PartnerCost	clone()
String	getCostType() Required.
Long	getFeeAmount() The CPM fee amount in micros of advertiser's currency.
Long	getFeePercentageMillis() The media fee percentage in millis (1/1000 of a percent).
String	getFeeType() Required.
String	getInvoiceType() The invoice type for this partner cost.
PartnerCost	set(String fieldName, Object value)
PartnerCost	setCostType(String costType) Required.
PartnerCost	setFeeAmount(Long feeAmount) The CPM fee amount in micros of advertiser's currency.
PartnerCost	setFeePercentageMillis(Long feePercentageMillis) The media fee percentage in millis (1/1000 of a percent).
PartnerCost	setFeeType(String feeType) Required.
PartnerCost	setInvoiceType(String invoiceType) The invoice type for this partner cost.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

PartnerCost

public PartnerCost()

Method Detail

getCostType

public String getCostType()

Required. The type of the partner cost.

Returns:

value or null for none

setCostType

public PartnerCost setCostType(String costType)

Required. The type of the partner cost.

Parameters:

costType - costType or null for none

getFeeAmount

public Long getFeeAmount()

The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.

Returns:

value or null for none

setFeeAmount

public PartnerCost setFeeAmount(Long feeAmount)

The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.

Parameters:

feeAmount - feeAmount or null for none

getFeePercentageMillis

public Long getFeePercentageMillis()

The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.

Returns:

value or null for none

setFeePercentageMillis

public PartnerCost setFeePercentageMillis(Long feePercentageMillis)

The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.

Parameters:

feePercentageMillis - feePercentageMillis or null for none

getFeeType

public String getFeeType()

Required. The fee type for this partner cost.

Returns:

value or null for none

setFeeType

public PartnerCost setFeeType(String feeType)

Required. The fee type for this partner cost.

Parameters:

feeType - feeType or null for none

getInvoiceType

public String getInvoiceType()

The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.

Returns:

value or null for none

setInvoiceType

public PartnerCost setInvoiceType(String invoiceType)

The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.

Parameters:

invoiceType - invoiceType or null for none

set

public PartnerCost set(String fieldName,
                       Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public PartnerCost clone()

Overrides:

clone in class com.google.api.client.json.GenericJson