ProductTemplate (DFP AppEngine components 3.14.2 API)

java.lang.Object
- com.google.api.ads.dfp.jaxws.v201711.ProductTemplate

public class ProductTemplate
extends Object

ProductTemplate is used to generate products. All generated products will inherit all attributes from their ProductTemplate, except for segmentation, which will be included in the Product#targeting. The generated products in turn will be used to create proposal line items so that almost all attributes in the product template are properties of the proposal line item.

Java class for ProductTemplate complex type.

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

 <complexType name="ProductTemplate">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="id" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="creationDateTime" type="{https://www.google.com/apis/ads/publisher/v201711}DateTime" minOccurs="0"/>
         <element name="lastModifiedDateTime" type="{https://www.google.com/apis/ads/publisher/v201711}DateTime" minOccurs="0"/>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="nameMacro" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="status" type="{https://www.google.com/apis/ads/publisher/v201711}ProductTemplateStatus" minOccurs="0"/>
         <element name="productType" type="{https://www.google.com/apis/ads/publisher/v201711}ProductType" minOccurs="0"/>
         <element name="creatorId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="rateType" type="{https://www.google.com/apis/ads/publisher/v201711}RateType" minOccurs="0"/>
         <element name="roadblockingType" type="{https://www.google.com/apis/ads/publisher/v201711}RoadblockingType" minOccurs="0"/>
         <element name="deliveryRateType" type="{https://www.google.com/apis/ads/publisher/v201711}DeliveryRateType" minOccurs="0"/>
         <element name="creativeRotationType" type="{https://www.google.com/apis/ads/publisher/v201711}CreativeRotationType" minOccurs="0"/>
         <element name="companionDeliveryOption" type="{https://www.google.com/apis/ads/publisher/v201711}CompanionDeliveryOption" minOccurs="0"/>
         <element name="creativePlaceholders" type="{https://www.google.com/apis/ads/publisher/v201711}CreativePlaceholder" maxOccurs="unbounded" minOccurs="0"/>
         <element name="lineItemType" type="{https://www.google.com/apis/ads/publisher/v201711}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/v201711}FrequencyCap" maxOccurs="unbounded" minOccurs="0"/>
         <element name="productSegmentation" type="{https://www.google.com/apis/ads/publisher/v201711}ProductSegmentation" minOccurs="0"/>
         <element name="builtInTargeting" type="{https://www.google.com/apis/ads/publisher/v201711}Targeting" minOccurs="0"/>
         <element name="customizableAttributes" type="{https://www.google.com/apis/ads/publisher/v201711}CustomizableAttributes" minOccurs="0"/>
         <element name="customFieldValues" type="{https://www.google.com/apis/ads/publisher/v201711}BaseCustomFieldValue" maxOccurs="unbounded" minOccurs="0"/>
         <element name="environmentType" type="{https://www.google.com/apis/ads/publisher/v201711}EnvironmentType" minOccurs="0"/>
         <element name="videoMaxDuration" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="productTemplateMarketplaceInfo" type="{https://www.google.com/apis/ads/publisher/v201711}ProductTemplateMarketplaceInfo" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Targeting`	`builtInTargeting`
`protected CompanionDeliveryOption`	`companionDeliveryOption`
`protected DateTime`	`creationDateTime`
`protected List<CreativePlaceholder>`	`creativePlaceholders`
`protected CreativeRotationType`	`creativeRotationType`
`protected Long`	`creatorId`
`protected List<BaseCustomFieldValue>`	`customFieldValues`
`protected CustomizableAttributes`	`customizableAttributes`
`protected DeliveryRateType`	`deliveryRateType`
`protected String`	`description`
`protected EnvironmentType`	`environmentType`
`protected List<FrequencyCap>`	`frequencyCaps`
`protected Long`	`id`
`protected DateTime`	`lastModifiedDateTime`
`protected LineItemType`	`lineItemType`
`protected String`	`name`
`protected String`	`nameMacro`
`protected Integer`	`priority`
`protected ProductSegmentation`	`productSegmentation`
`protected ProductTemplateMarketplaceInfo`	`productTemplateMarketplaceInfo`
`protected ProductType`	`productType`
`protected RateType`	`rateType`
`protected RoadblockingType`	`roadblockingType`
`protected ProductTemplateStatus`	`status`
`protected Long`	`videoMaxDuration`

Constructor Summary

Constructors
Constructor and Description

ProductTemplate()

Constructors
Constructor and Description
`ProductTemplate()`

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.
`DateTime`	`getCreationDateTime()` Gets the value of the creationDateTime property.
`List<CreativePlaceholder>`	`getCreativePlaceholders()` Gets the value of the creativePlaceholders property.
`CreativeRotationType`	`getCreativeRotationType()` Gets the value of the creativeRotationType property.
`Long`	`getCreatorId()` Gets the value of the creatorId 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.
`String`	`getDescription()` Gets the value of the description 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.
`String`	`getNameMacro()` Gets the value of the nameMacro property.
`Integer`	`getPriority()` Gets the value of the priority property.
`ProductSegmentation`	`getProductSegmentation()` Gets the value of the productSegmentation property.
`ProductTemplateMarketplaceInfo`	`getProductTemplateMarketplaceInfo()` Gets the value of the productTemplateMarketplaceInfo property.
`ProductType`	`getProductType()` Gets the value of the productType property.
`RateType`	`getRateType()` Gets the value of the rateType property.
`RoadblockingType`	`getRoadblockingType()` Gets the value of the roadblockingType property.
`ProductTemplateStatus`	`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`	`setCreationDateTime(DateTime value)` Sets the value of the creationDateTime property.
`void`	`setCreativeRotationType(CreativeRotationType value)` Sets the value of the creativeRotationType property.
`void`	`setCreatorId(Long value)` Sets the value of the creatorId property.
`void`	`setCustomizableAttributes(CustomizableAttributes value)` Sets the value of the customizableAttributes property.
`void`	`setDeliveryRateType(DeliveryRateType value)` Sets the value of the deliveryRateType property.
`void`	`setDescription(String value)` Sets the value of the description 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`	`setNameMacro(String value)` Sets the value of the nameMacro property.
`void`	`setPriority(Integer value)` Sets the value of the priority property.
`void`	`setProductSegmentation(ProductSegmentation value)` Sets the value of the productSegmentation property.
`void`	`setProductTemplateMarketplaceInfo(ProductTemplateMarketplaceInfo value)` Sets the value of the productTemplateMarketplaceInfo property.
`void`	`setProductType(ProductType value)` Sets the value of the productType 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(ProductTemplateStatus 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
  - id
```
protected Long id
```
  - name
```
protected String name
```
  - creationDateTime
```
protected DateTime creationDateTime
```
  - lastModifiedDateTime
```
protected DateTime lastModifiedDateTime
```
  - description
```
protected String description
```
  - nameMacro
```
protected String nameMacro
```
  - status
```
protected ProductTemplateStatus status
```
  - productType
```
protected ProductType productType
```
  - creatorId
```
protected Long creatorId
```
  - 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
```
  - productSegmentation
```
protected ProductSegmentation productSegmentation
```
  - builtInTargeting
```
protected Targeting builtInTargeting
```
  - customizableAttributes
```
protected CustomizableAttributes customizableAttributes
```
  - customFieldValues
```
protected List<BaseCustomFieldValue> customFieldValues
```
  - environmentType
```
protected EnvironmentType environmentType
```
  - videoMaxDuration
```
protected Long videoMaxDuration
```
  - productTemplateMarketplaceInfo
```
protected ProductTemplateMarketplaceInfo productTemplateMarketplaceInfo
```
- Constructor Detail
  - ProductTemplate
```
public ProductTemplate()
```
- Method Detail
  - 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
  - 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
  - getCreationDateTime
```
public DateTime getCreationDateTime()
```
    Gets the value of the creationDateTime property.
    
    Returns:
    
    possible object is DateTime
  - setCreationDateTime
```
public void setCreationDateTime(DateTime value)
```
    Sets the value of the creationDateTime property.
    
    Parameters:
    
    value - allowed object is DateTime
  - 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
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    
    value - allowed object is String
  - getNameMacro
```
public String getNameMacro()
```
    Gets the value of the nameMacro property.
    
    Returns:
    
    possible object is String
  - setNameMacro
```
public void setNameMacro(String value)
```
    Sets the value of the nameMacro property.
    
    Parameters:
    
    value - allowed object is String
  - getStatus
```
public ProductTemplateStatus getStatus()
```
    Gets the value of the status property.
    
    Returns:
    
    possible object is ProductTemplateStatus
  - setStatus
```
public void setStatus(ProductTemplateStatus value)
```
    Sets the value of the status property.
    
    Parameters:
    
    value - allowed object is ProductTemplateStatus
  - 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
  - getCreatorId
```
public Long getCreatorId()
```
    Gets the value of the creatorId property.
    
    Returns:
    
    possible object is Long
  - setCreatorId
```
public void setCreatorId(Long value)
```
    Sets the value of the creatorId property.
    
    Parameters:
    
    value - allowed object is Long
  - 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
  - getProductSegmentation
```
public ProductSegmentation getProductSegmentation()
```
    Gets the value of the productSegmentation property.
    
    Returns:
    
    possible object is ProductSegmentation
  - setProductSegmentation
```
public void setProductSegmentation(ProductSegmentation value)
```
    Sets the value of the productSegmentation property.
    
    Parameters:
    
    value - allowed object is ProductSegmentation
  - 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
  - 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
  - getProductTemplateMarketplaceInfo
```
public ProductTemplateMarketplaceInfo getProductTemplateMarketplaceInfo()
```
    Gets the value of the productTemplateMarketplaceInfo property.
    
    Returns:
    
    possible object is ProductTemplateMarketplaceInfo
  - setProductTemplateMarketplaceInfo
```
public void setProductTemplateMarketplaceInfo(ProductTemplateMarketplaceInfo value)
```
    Sets the value of the productTemplateMarketplaceInfo property.
    
    Parameters:
    
    value - allowed object is ProductTemplateMarketplaceInfo

Class ProductTemplate

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

name

creationDateTime

lastModifiedDateTime

description

nameMacro

status

productType

creatorId

rateType

roadblockingType

deliveryRateType

creativeRotationType

companionDeliveryOption

creativePlaceholders

lineItemType

priority

frequencyCaps

productSegmentation

builtInTargeting

customizableAttributes

customFieldValues

environmentType

videoMaxDuration

productTemplateMarketplaceInfo

Constructor Detail

ProductTemplate

Method Detail

getId

setId

getName

setName

getCreationDateTime

setCreationDateTime

getLastModifiedDateTime

setLastModifiedDateTime

getDescription

setDescription

getNameMacro

setNameMacro

getStatus

setStatus

getProductType

setProductType

getCreatorId

setCreatorId

getRateType

setRateType

getRoadblockingType

setRoadblockingType

getDeliveryRateType

setDeliveryRateType

getCreativeRotationType

setCreativeRotationType

getCompanionDeliveryOption

setCompanionDeliveryOption

getCreativePlaceholders

getLineItemType

setLineItemType

getPriority

setPriority

getFrequencyCaps

getProductSegmentation

setProductSegmentation

getBuiltInTargeting

setBuiltInTargeting

getCustomizableAttributes

setCustomizableAttributes

getCustomFieldValues

getEnvironmentType

setEnvironmentType

getVideoMaxDuration

setVideoMaxDuration

getProductTemplateMarketplaceInfo