Product (DFP AppEngine components 3.14.2 API)

java.lang.Object
- com.google.api.ads.dfp.jaxws.v201708.Product

public class Product
extends Object

Proposal line items are created from products, from which their properties are copied.

Java class for Product complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Product">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="nameSource" type="{https://www.google.com/apis/ads/publisher/v201708}ValueSourceType" minOccurs="0"/>
         <element name="status" type="{https://www.google.com/apis/ads/publisher/v201708}ProductStatus" minOccurs="0"/>
         <element name="productType" type="{https://www.google.com/apis/ads/publisher/v201708}ProductType" minOccurs="0"/>
         <element name="productTemplateId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="id" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="notes" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="productTemplateDescription" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="lastModifiedDateTime" type="{https://www.google.com/apis/ads/publisher/v201708}DateTime" minOccurs="0"/>
         <element name="rateType" type="{https://www.google.com/apis/ads/publisher/v201708}RateType" minOccurs="0"/>
         <element name="roadblockingType" type="{https://www.google.com/apis/ads/publisher/v201708}RoadblockingType" minOccurs="0"/>
         <element name="deliveryRateType" type="{https://www.google.com/apis/ads/publisher/v201708}DeliveryRateType" minOccurs="0"/>
         <element name="creativeRotationType" type="{https://www.google.com/apis/ads/publisher/v201708}CreativeRotationType" minOccurs="0"/>
         <element name="companionDeliveryOption" type="{https://www.google.com/apis/ads/publisher/v201708}CompanionDeliveryOption" minOccurs="0"/>
         <element name="creativePlaceholders" type="{https://www.google.com/apis/ads/publisher/v201708}CreativePlaceholder" maxOccurs="unbounded" minOccurs="0"/>
         <element name="lineItemType" type="{https://www.google.com/apis/ads/publisher/v201708}LineItemType" minOccurs="0"/>
         <element name="priority" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="frequencyCaps" type="{https://www.google.com/apis/ads/publisher/v201708}FrequencyCap" maxOccurs="unbounded" minOccurs="0"/>
         <element name="builtInTargeting" type="{https://www.google.com/apis/ads/publisher/v201708}Targeting" minOccurs="0"/>
         <element name="customizableAttributes" type="{https://www.google.com/apis/ads/publisher/v201708}CustomizableAttributes" minOccurs="0"/>
         <element name="customFieldValues" type="{https://www.google.com/apis/ads/publisher/v201708}BaseCustomFieldValue" maxOccurs="unbounded" minOccurs="0"/>
         <element name="environmentType" type="{https://www.google.com/apis/ads/publisher/v201708}EnvironmentType" minOccurs="0"/>
         <element name="rate" type="{https://www.google.com/apis/ads/publisher/v201708}Money" minOccurs="0"/>
         <element name="productMarketplaceInfo" type="{https://www.google.com/apis/ads/publisher/v201708}ProductMarketplaceInfo" minOccurs="0"/>
         <element name="videoMaxDuration" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Targeting`	`builtInTargeting`
`protected CompanionDeliveryOption`	`companionDeliveryOption`
`protected List<CreativePlaceholder>`	`creativePlaceholders`
`protected CreativeRotationType`	`creativeRotationType`
`protected List<BaseCustomFieldValue>`	`customFieldValues`
`protected CustomizableAttributes`	`customizableAttributes`
`protected DeliveryRateType`	`deliveryRateType`
`protected EnvironmentType`	`environmentType`
`protected List<FrequencyCap>`	`frequencyCaps`
`protected Long`	`id`
`protected DateTime`	`lastModifiedDateTime`
`protected LineItemType`	`lineItemType`
`protected String`	`name`
`protected ValueSourceType`	`nameSource`
`protected String`	`notes`
`protected Integer`	`priority`
`protected ProductMarketplaceInfo`	`productMarketplaceInfo`
`protected String`	`productTemplateDescription`
`protected Long`	`productTemplateId`
`protected ProductType`	`productType`
`protected Money`	`rate`
`protected RateType`	`rateType`
`protected RoadblockingType`	`roadblockingType`
`protected ProductStatus`	`status`
`protected Long`	`videoMaxDuration`

Constructor Summary

Constructors
Constructor and Description

Product()

Constructors
Constructor and Description
`Product()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Targeting`	`getBuiltInTargeting()` Gets the value of the builtInTargeting property.
`CompanionDeliveryOption`	`getCompanionDeliveryOption()` Gets the value of the companionDeliveryOption property.
`List<CreativePlaceholder>`	`getCreativePlaceholders()` Gets the value of the creativePlaceholders property.
`CreativeRotationType`	`getCreativeRotationType()` Gets the value of the creativeRotationType property.
`List<BaseCustomFieldValue>`	`getCustomFieldValues()` Gets the value of the customFieldValues property.
`CustomizableAttributes`	`getCustomizableAttributes()` Gets the value of the customizableAttributes property.
`DeliveryRateType`	`getDeliveryRateType()` Gets the value of the deliveryRateType property.
`EnvironmentType`	`getEnvironmentType()` Gets the value of the environmentType property.
`List<FrequencyCap>`	`getFrequencyCaps()` Gets the value of the frequencyCaps property.
`Long`	`getId()` Gets the value of the id property.
`DateTime`	`getLastModifiedDateTime()` Gets the value of the lastModifiedDateTime property.
`LineItemType`	`getLineItemType()` Gets the value of the lineItemType property.
`String`	`getName()` Gets the value of the name property.
`ValueSourceType`	`getNameSource()` Gets the value of the nameSource property.
`String`	`getNotes()` Gets the value of the notes property.
`Integer`	`getPriority()` Gets the value of the priority property.
`ProductMarketplaceInfo`	`getProductMarketplaceInfo()` Gets the value of the productMarketplaceInfo property.
`String`	`getProductTemplateDescription()` Gets the value of the productTemplateDescription property.
`Long`	`getProductTemplateId()` Gets the value of the productTemplateId property.
`ProductType`	`getProductType()` Gets the value of the productType property.
`Money`	`getRate()` Gets the value of the rate property.
`RateType`	`getRateType()` Gets the value of the rateType property.
`RoadblockingType`	`getRoadblockingType()` Gets the value of the roadblockingType property.
`ProductStatus`	`getStatus()` Gets the value of the status property.
`Long`	`getVideoMaxDuration()` Gets the value of the videoMaxDuration property.
`void`	`setBuiltInTargeting(Targeting value)` Sets the value of the builtInTargeting property.
`void`	`setCompanionDeliveryOption(CompanionDeliveryOption value)` Sets the value of the companionDeliveryOption property.
`void`	`setCreativeRotationType(CreativeRotationType value)` Sets the value of the creativeRotationType property.
`void`	`setCustomizableAttributes(CustomizableAttributes value)` Sets the value of the customizableAttributes property.
`void`	`setDeliveryRateType(DeliveryRateType value)` Sets the value of the deliveryRateType property.
`void`	`setEnvironmentType(EnvironmentType value)` Sets the value of the environmentType property.
`void`	`setId(Long value)` Sets the value of the id property.
`void`	`setLastModifiedDateTime(DateTime value)` Sets the value of the lastModifiedDateTime property.
`void`	`setLineItemType(LineItemType value)` Sets the value of the lineItemType property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setNameSource(ValueSourceType value)` Sets the value of the nameSource property.
`void`	`setNotes(String value)` Sets the value of the notes property.
`void`	`setPriority(Integer value)` Sets the value of the priority property.
`void`	`setProductMarketplaceInfo(ProductMarketplaceInfo value)` Sets the value of the productMarketplaceInfo property.
`void`	`setProductTemplateDescription(String value)` Sets the value of the productTemplateDescription property.
`void`	`setProductTemplateId(Long value)` Sets the value of the productTemplateId property.
`void`	`setProductType(ProductType value)` Sets the value of the productType property.
`void`	`setRate(Money value)` Sets the value of the rate property.
`void`	`setRateType(RateType value)` Sets the value of the rateType property.
`void`	`setRoadblockingType(RoadblockingType value)` Sets the value of the roadblockingType property.
`void`	`setStatus(ProductStatus value)` Sets the value of the status property.
`void`	`setVideoMaxDuration(Long value)` Sets the value of the videoMaxDuration property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - name
```
protected String name
```
  - nameSource
```
protected ValueSourceType nameSource
```
  - status
```
protected ProductStatus status
```
  - productType
```
protected ProductType productType
```
  - productTemplateId
```
protected Long productTemplateId
```
  - id
```
protected Long id
```
  - notes
```
protected String notes
```
  - productTemplateDescription
```
protected String productTemplateDescription
```
  - lastModifiedDateTime
```
protected DateTime lastModifiedDateTime
```
  - rateType
```
protected RateType rateType
```
  - roadblockingType
```
protected RoadblockingType roadblockingType
```
  - deliveryRateType
```
protected DeliveryRateType deliveryRateType
```
  - creativeRotationType
```
protected CreativeRotationType creativeRotationType
```
  - companionDeliveryOption
```
protected CompanionDeliveryOption companionDeliveryOption
```
  - creativePlaceholders
```
protected List<CreativePlaceholder> creativePlaceholders
```
  - lineItemType
```
protected LineItemType lineItemType
```
  - priority
```
protected Integer priority
```
  - frequencyCaps
```
protected List<FrequencyCap> frequencyCaps
```
  - builtInTargeting
```
protected Targeting builtInTargeting
```
  - customizableAttributes
```
protected CustomizableAttributes customizableAttributes
```
  - customFieldValues
```
protected List<BaseCustomFieldValue> customFieldValues
```
  - environmentType
```
protected EnvironmentType environmentType
```
  - rate
```
protected Money rate
```
  - productMarketplaceInfo
```
protected ProductMarketplaceInfo productMarketplaceInfo
```
  - videoMaxDuration
```
protected Long videoMaxDuration
```
- Constructor Detail
  - Product
```
public Product()
```
- Method Detail
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getNameSource
```
public ValueSourceType getNameSource()
```
    Gets the value of the nameSource property.
    
    Returns:
    
    possible object is ValueSourceType
  - setNameSource
```
public void setNameSource(ValueSourceType value)
```
    Sets the value of the nameSource property.
    
    Parameters:
    
    value - allowed object is ValueSourceType
  - getStatus
```
public ProductStatus getStatus()
```
    Gets the value of the status property.
    
    Returns:
    
    possible object is ProductStatus
  - setStatus
```
public void setStatus(ProductStatus value)
```
    Sets the value of the status property.
    
    Parameters:
    
    value - allowed object is ProductStatus
  - getProductType
```
public ProductType getProductType()
```
    Gets the value of the productType property.
    
    Returns:
    
    possible object is ProductType
  - setProductType
```
public void setProductType(ProductType value)
```
    Sets the value of the productType property.
    
    Parameters:
    
    value - allowed object is ProductType
  - getProductTemplateId
```
public Long getProductTemplateId()
```
    Gets the value of the productTemplateId property.
    
    Returns:
    
    possible object is Long
  - setProductTemplateId
```
public void setProductTemplateId(Long value)
```
    Sets the value of the productTemplateId property.
    
    Parameters:
    
    value - allowed object is Long
  - getId
```
public Long getId()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is Long
  - setId
```
public void setId(Long value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is Long
  - getNotes
```
public String getNotes()
```
    Gets the value of the notes property.
    
    Returns:
    
    possible object is String
  - setNotes
```
public void setNotes(String value)
```
    Sets the value of the notes property.
    
    Parameters:
    
    value - allowed object is String
  - getProductTemplateDescription
```
public String getProductTemplateDescription()
```
    Gets the value of the productTemplateDescription property.
    
    Returns:
    
    possible object is String
  - setProductTemplateDescription
```
public void setProductTemplateDescription(String value)
```
    Sets the value of the productTemplateDescription property.
    
    Parameters:
    
    value - allowed object is String
  - getLastModifiedDateTime
```
public DateTime getLastModifiedDateTime()
```
    Gets the value of the lastModifiedDateTime property.
    
    Returns:
    
    possible object is DateTime
  - setLastModifiedDateTime
```
public void setLastModifiedDateTime(DateTime value)
```
    Sets the value of the lastModifiedDateTime property.
    
    Parameters:
    
    value - allowed object is DateTime
  - getRateType
```
public RateType getRateType()
```
    Gets the value of the rateType property.
    
    Returns:
    
    possible object is RateType
  - setRateType
```
public void setRateType(RateType value)
```
    Sets the value of the rateType property.
    
    Parameters:
    
    value - allowed object is RateType
  - getRoadblockingType
```
public RoadblockingType getRoadblockingType()
```
    Gets the value of the roadblockingType property.
    
    Returns:
    
    possible object is RoadblockingType
  - setRoadblockingType
```
public void setRoadblockingType(RoadblockingType value)
```
    Sets the value of the roadblockingType property.
    
    Parameters:
    
    value - allowed object is RoadblockingType
  - getDeliveryRateType
```
public DeliveryRateType getDeliveryRateType()
```
    Gets the value of the deliveryRateType property.
    
    Returns:
    
    possible object is DeliveryRateType
  - setDeliveryRateType
```
public void setDeliveryRateType(DeliveryRateType value)
```
    Sets the value of the deliveryRateType property.
    
    Parameters:
    
    value - allowed object is DeliveryRateType
  - getCreativeRotationType
```
public CreativeRotationType getCreativeRotationType()
```
    Gets the value of the creativeRotationType property.
    
    Returns:
    
    possible object is CreativeRotationType
  - setCreativeRotationType
```
public void setCreativeRotationType(CreativeRotationType value)
```
    Sets the value of the creativeRotationType property.
    
    Parameters:
    
    value - allowed object is CreativeRotationType
  - getCompanionDeliveryOption
```
public CompanionDeliveryOption getCompanionDeliveryOption()
```
    Gets the value of the companionDeliveryOption property.
    
    Returns:
    
    possible object is CompanionDeliveryOption
  - setCompanionDeliveryOption
```
public void setCompanionDeliveryOption(CompanionDeliveryOption value)
```
    Sets the value of the companionDeliveryOption property.
    
    Parameters:
    
    value - allowed object is CompanionDeliveryOption
  - getCreativePlaceholders
```
public List<CreativePlaceholder> getCreativePlaceholders()
```
    Gets the value of the creativePlaceholders property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the creativePlaceholders property.
    For example, to add a new item, do as follows:
```
    getCreativePlaceholders().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list CreativePlaceholder
  - getLineItemType
```
public LineItemType getLineItemType()
```
    Gets the value of the lineItemType property.
    
    Returns:
    
    possible object is LineItemType
  - setLineItemType
```
public void setLineItemType(LineItemType value)
```
    Sets the value of the lineItemType property.
    
    Parameters:
    
    value - allowed object is LineItemType
  - getPriority
```
public Integer getPriority()
```
    Gets the value of the priority property.
    
    Returns:
    
    possible object is Integer
  - setPriority
```
public void setPriority(Integer value)
```
    Sets the value of the priority property.
    
    Parameters:
    
    value - allowed object is Integer
  - getFrequencyCaps
```
public List<FrequencyCap> getFrequencyCaps()
```
    Gets the value of the frequencyCaps property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the frequencyCaps property.
    For example, to add a new item, do as follows:
```
    getFrequencyCaps().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list FrequencyCap
  - getBuiltInTargeting
```
public Targeting getBuiltInTargeting()
```
    Gets the value of the builtInTargeting property.
    
    Returns:
    
    possible object is Targeting
  - setBuiltInTargeting
```
public void setBuiltInTargeting(Targeting value)
```
    Sets the value of the builtInTargeting property.
    
    Parameters:
    
    value - allowed object is Targeting
  - getCustomizableAttributes
```
public CustomizableAttributes getCustomizableAttributes()
```
    Gets the value of the customizableAttributes property.
    
    Returns:
    
    possible object is CustomizableAttributes
  - setCustomizableAttributes
```
public void setCustomizableAttributes(CustomizableAttributes value)
```
    Sets the value of the customizableAttributes property.
    
    Parameters:
    
    value - allowed object is CustomizableAttributes
  - getCustomFieldValues
```
public List<BaseCustomFieldValue> getCustomFieldValues()
```
    Gets the value of the customFieldValues property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the customFieldValues property.
    For example, to add a new item, do as follows:
```
    getCustomFieldValues().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list BaseCustomFieldValue
  - getEnvironmentType
```
public EnvironmentType getEnvironmentType()
```
    Gets the value of the environmentType property.
    
    Returns:
    
    possible object is EnvironmentType
  - setEnvironmentType
```
public void setEnvironmentType(EnvironmentType value)
```
    Sets the value of the environmentType property.
    
    Parameters:
    
    value - allowed object is EnvironmentType
  - getRate
```
public Money getRate()
```
    Gets the value of the rate property.
    
    Returns:
    
    possible object is Money
  - setRate
```
public void setRate(Money value)
```
    Sets the value of the rate property.
    
    Parameters:
    
    value - allowed object is Money
  - getProductMarketplaceInfo
```
public ProductMarketplaceInfo getProductMarketplaceInfo()
```
    Gets the value of the productMarketplaceInfo property.
    
    Returns:
    
    possible object is ProductMarketplaceInfo
  - setProductMarketplaceInfo
```
public void setProductMarketplaceInfo(ProductMarketplaceInfo value)
```
    Sets the value of the productMarketplaceInfo property.
    
    Parameters:
    
    value - allowed object is ProductMarketplaceInfo
  - getVideoMaxDuration
```
public Long getVideoMaxDuration()
```
    Gets the value of the videoMaxDuration property.
    
    Returns:
    
    possible object is Long
  - setVideoMaxDuration
```
public void setVideoMaxDuration(Long value)
```
    Sets the value of the videoMaxDuration property.
    
    Parameters:
    
    value - allowed object is Long

Class Product

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

nameSource

status

productType

productTemplateId

id

notes

productTemplateDescription

lastModifiedDateTime

rateType

roadblockingType

deliveryRateType

creativeRotationType

companionDeliveryOption

creativePlaceholders

lineItemType

priority

frequencyCaps

builtInTargeting

customizableAttributes

customFieldValues

environmentType

rate

productMarketplaceInfo

videoMaxDuration

Constructor Detail

Product

Method Detail

getName

setName

getNameSource

setNameSource

getStatus

setStatus

getProductType

setProductType

getProductTemplateId

setProductTemplateId

getId

setId

getNotes

setNotes

getProductTemplateDescription

setProductTemplateDescription

getLastModifiedDateTime

setLastModifiedDateTime

getRateType

setRateType

getRoadblockingType

setRoadblockingType

getDeliveryRateType

setDeliveryRateType

getCreativeRotationType

setCreativeRotationType

getCompanionDeliveryOption

setCompanionDeliveryOption

getCreativePlaceholders

getLineItemType

setLineItemType

getPriority

setPriority

getFrequencyCaps

getBuiltInTargeting

setBuiltInTargeting

getCustomizableAttributes

setCustomizableAttributes

getCustomFieldValues

getEnvironmentType

setEnvironmentType

getRate

setRate

getProductMarketplaceInfo

setProductMarketplaceInfo

getVideoMaxDuration