Element (Campaign Manager 360 API v5-rev20251009-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.dfareporting.model.Element

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Element
extends com.google.api.client.json.GenericJson
```
Contains the element of the dynamic feed.
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 Campaign Manager 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

Element()

Constructors
Constructor and Description
`Element()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Element`	`clone()`
`Integer`	`getActiveFieldId()` Optional.
`LastModifiedInfo`	`getCreateInfo()` Output only.
`Integer`	`getDefaultFieldId()` Optional.
`String`	`getElementName()` Optional.
`Integer`	`getEndTimestampFieldId()` Optional.
`Integer`	`getExternalIdFieldId()` Required.
`List<FeedField>`	`getFeedFields()` Required.
`Boolean`	`getIsLocalTimestamp()` Optional.
`LastModifiedInfo`	`getLastModifiedInfo()` Output only.
`Integer`	`getProximityTargetingFieldId()` Optional.
`Integer`	`getReportingLabelFieldId()` Required.
`Integer`	`getStartTimestampFieldId()` Optional.
`Element`	`set(String fieldName, Object value)`
`Element`	`setActiveFieldId(Integer activeFieldId)` Optional.
`Element`	`setCreateInfo(LastModifiedInfo createInfo)` Output only.
`Element`	`setDefaultFieldId(Integer defaultFieldId)` Optional.
`Element`	`setElementName(String elementName)` Optional.
`Element`	`setEndTimestampFieldId(Integer endTimestampFieldId)` Optional.
`Element`	`setExternalIdFieldId(Integer externalIdFieldId)` Required.
`Element`	`setFeedFields(List<FeedField> feedFields)` Required.
`Element`	`setIsLocalTimestamp(Boolean isLocalTimestamp)` Optional.
`Element`	`setLastModifiedInfo(LastModifiedInfo lastModifiedInfo)` Output only.
`Element`	`setProximityTargetingFieldId(Integer proximityTargetingFieldId)` Optional.
`Element`	`setReportingLabelFieldId(Integer reportingLabelFieldId)` Required.
`Element`	`setStartTimestampFieldId(Integer startTimestampFieldId)` Optional.

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
  - Element
```
public Element()
```
- Method Detail
  - getActiveFieldId
```
public Integer getActiveFieldId()
```
    Optional. The field ID to specify the active field in the feed.
    
    Returns:
    
    value or null for none
  - setActiveFieldId
```
public Element setActiveFieldId(Integer activeFieldId)
```
    Optional. The field ID to specify the active field in the feed.
    
    Parameters:
    
    activeFieldId - activeFieldId or null for none
  - getCreateInfo
```
public LastModifiedInfo getCreateInfo()
```
    Output only. The creation timestamp of the element. This is a read-only field.
    
    Returns:
    
    value or null for none
  - setCreateInfo
```
public Element setCreateInfo(LastModifiedInfo createInfo)
```
    Output only. The creation timestamp of the element. This is a read-only field.
    
    Parameters:
    
    createInfo - createInfo or null for none
  - getDefaultFieldId
```
public Integer getDefaultFieldId()
```
    Optional. The field ID to specify the field that represents the default field in the feed.
    
    Returns:
    
    value or null for none
  - setDefaultFieldId
```
public Element setDefaultFieldId(Integer defaultFieldId)
```
    Optional. The field ID to specify the field that represents the default field in the feed.
    
    Parameters:
    
    defaultFieldId - defaultFieldId or null for none
  - getElementName
```
public String getElementName()
```
    Optional. The name of the element. It is defaulted to resource file name if not provided.
    
    Returns:
    
    value or null for none
  - setElementName
```
public Element setElementName(String elementName)
```
    Optional. The name of the element. It is defaulted to resource file name if not provided.
    
    Parameters:
    
    elementName - elementName or null for none
  - getEndTimestampFieldId
```
public Integer getEndTimestampFieldId()
```
    Optional. The field ID to specify the field that represents the end timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
    
    Returns:
    
    value or null for none
  - setEndTimestampFieldId
```
public Element setEndTimestampFieldId(Integer endTimestampFieldId)
```
    Optional. The field ID to specify the field that represents the end timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
    
    Parameters:
    
    endTimestampFieldId - endTimestampFieldId or null for none
  - getExternalIdFieldId
```
public Integer getExternalIdFieldId()
```
    Required. The field ID to specify the field used for uniquely identifying the feed row. This is a required field.
    
    Returns:
    
    value or null for none
  - setExternalIdFieldId
```
public Element setExternalIdFieldId(Integer externalIdFieldId)
```
    Required. The field ID to specify the field used for uniquely identifying the feed row. This is a required field.
    
    Parameters:
    
    externalIdFieldId - externalIdFieldId or null for none
  - getFeedFields
```
public List<FeedField> getFeedFields()
```
    Required. The list of fields of the element. The field order and name should match the meta data in the content source source.
    
    Returns:
    
    value or null for none
  - setFeedFields
```
public Element setFeedFields(List<FeedField> feedFields)
```
    Required. The list of fields of the element. The field order and name should match the meta data in the content source source.
    
    Parameters:
    
    feedFields - feedFields or null for none
  - getIsLocalTimestamp
```
public Boolean getIsLocalTimestamp()
```
    Optional. Whether the start and end timestamp is local timestamp. The default value is false which means start and end timestamp is in UTC.
    
    Returns:
    
    value or null for none
  - setIsLocalTimestamp
```
public Element setIsLocalTimestamp(Boolean isLocalTimestamp)
```
    Optional. Whether the start and end timestamp is local timestamp. The default value is false which means start and end timestamp is in UTC.
    
    Parameters:
    
    isLocalTimestamp - isLocalTimestamp or null for none
  - getLastModifiedInfo
```
public LastModifiedInfo getLastModifiedInfo()
```
    Output only. The last modified timestamp of the element. This is a read-only field.
    
    Returns:
    
    value or null for none
  - setLastModifiedInfo
```
public Element setLastModifiedInfo(LastModifiedInfo lastModifiedInfo)
```
    Output only. The last modified timestamp of the element. This is a read-only field.
    
    Parameters:
    
    lastModifiedInfo - lastModifiedInfo or null for none
  - getProximityTargetingFieldId
```
public Integer getProximityTargetingFieldId()
```
    Optional. The field ID that specify field used for proximity targeting.
    
    Returns:
    
    value or null for none
  - setProximityTargetingFieldId
```
public Element setProximityTargetingFieldId(Integer proximityTargetingFieldId)
```
    Optional. The field ID that specify field used for proximity targeting.
    
    Parameters:
    
    proximityTargetingFieldId - proximityTargetingFieldId or null for none
  - getReportingLabelFieldId
```
public Integer getReportingLabelFieldId()
```
    Required. The field ID to specify the field used for dynamic reporting in Campaign Manager 360.
    
    Returns:
    
    value or null for none
  - setReportingLabelFieldId
```
public Element setReportingLabelFieldId(Integer reportingLabelFieldId)
```
    Required. The field ID to specify the field used for dynamic reporting in Campaign Manager 360.
    
    Parameters:
    
    reportingLabelFieldId - reportingLabelFieldId or null for none
  - getStartTimestampFieldId
```
public Integer getStartTimestampFieldId()
```
    Optional. The field ID to specify the field that represents the start timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
    
    Returns:
    
    value or null for none
  - setStartTimestampFieldId
```
public Element setStartTimestampFieldId(Integer startTimestampFieldId)
```
    Optional. The field ID to specify the field that represents the start timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
    
    Parameters:
    
    startTimestampFieldId - startTimestampFieldId or null for none
  - set
```
public Element set(String fieldName,
                   Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Element clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Element

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Element

Method Detail

getActiveFieldId

setActiveFieldId

getCreateInfo

setCreateInfo

getDefaultFieldId

setDefaultFieldId

getElementName

setElementName

getEndTimestampFieldId

setEndTimestampFieldId

getExternalIdFieldId

setExternalIdFieldId

getFeedFields

setFeedFields

getIsLocalTimestamp

setIsLocalTimestamp

getLastModifiedInfo

setLastModifiedInfo

getProximityTargetingFieldId

setProximityTargetingFieldId

getReportingLabelFieldId

setReportingLabelFieldId

getStartTimestampFieldId

setStartTimestampFieldId

set

clone