com.google.api.services.dfareporting.model

Class FeedField

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.FeedField

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Each field of the element. This is a required field.

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
FeedField()

Method Summary

Modifier and Type	Method and Description
FeedField	clone()
String	getDefaultValue() Optional.
Boolean	getFilterable() Optional.
Integer	getId() Required.
String	getName() Required.
Boolean	getRenderable() Optional.
Boolean	getRequired() Optional.
String	getType() Required.
FeedField	set(String fieldName, Object value)
FeedField	setDefaultValue(String defaultValue) Optional.
FeedField	setFilterable(Boolean filterable) Optional.
FeedField	setId(Integer id) Required.
FeedField	setName(String name) Required.
FeedField	setRenderable(Boolean renderable) Optional.
FeedField	setRequired(Boolean required) Optional.
FeedField	setType(String type) Required.

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

FeedField

public FeedField()

Method Detail

getDefaultValue

public String getDefaultValue()

Optional. The default value of the field.

Returns:

value or null for none

setDefaultValue

public FeedField setDefaultValue(String defaultValue)

Optional. The default value of the field.

Parameters:

defaultValue - defaultValue or null for none

getFilterable

public Boolean getFilterable()

Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID

Returns:

value or null for none

setFilterable

public FeedField setFilterable(Boolean filterable)

Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID

Parameters:

filterable - filterable or null for none

getId

public Integer getId()

Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link.

Returns:

value or null for none

setId

public FeedField setId(Integer id)

Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link.

Parameters:

id - id or null for none

getName

public String getName()

Required. The name of the field.

Returns:

value or null for none

setName

public FeedField setName(String name)

Required. The name of the field.

Parameters:

name - name or null for none

getRenderable

public Boolean getRenderable()

Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT

Returns:

value or null for none

setRenderable

public FeedField setRenderable(Boolean renderable)

Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT

Parameters:

renderable - renderable or null for none

getRequired

public Boolean getRequired()

Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE

Returns:

value or null for none

setRequired

public FeedField setRequired(Boolean required)

Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE

Parameters:

required - required or null for none

getType

public String getType()

Required. The type of the field.

Returns:

value or null for none

setType

public FeedField setType(String type)

Required. The type of the field.

Parameters:

type - type or null for none

set

public FeedField set(String fieldName,
                     Object value)

Overrides:

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

clone

public FeedField clone()

Overrides:

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