com.google.api.services.dfareporting.model

Class Conversion

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dfareporting.model.Conversion

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

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

A Conversion represents when a user successfully performs a desired action after seeing an ad.

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 DCM/DFA Reporting And Trafficking 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

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

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Conversion()

Method Summary

Methods

Modifier and Type	Method and Description
Conversion	clone()
java.lang.Boolean	getChildDirectedTreatment() Whether the conversion was directed toward children.
java.util.List<CustomFloodlightVariable>	getCustomVariables() Custom floodlight variables.
java.lang.String	getEncryptedUserId() The alphanumeric encrypted user ID.
java.util.List<java.lang.String>	getEncryptedUserIdCandidates() A list of the alphanumeric encrypted user IDs.
java.lang.Long	getFloodlightActivityId() Floodlight Activity ID of this conversion.
java.lang.Long	getFloodlightConfigurationId() Floodlight Configuration ID of this conversion.
java.lang.String	getGclid() The Google click ID.
java.lang.String	getKind() Identifies what kind of resource this is.
java.lang.Boolean	getLimitAdTracking() Whether Limit Ad Tracking is enabled.
java.lang.String	getMobileDeviceId() The mobile device ID.
java.lang.String	getOrdinal() The ordinal of the conversion.
java.lang.Long	getQuantity() The quantity of the conversion.
java.lang.Long	getTimestampMicros() The timestamp of conversion, in Unix epoch micros.
java.lang.Double	getValue() The value of the conversion.
Conversion	set(java.lang.String fieldName, java.lang.Object value)
Conversion	setChildDirectedTreatment(java.lang.Boolean childDirectedTreatment) Whether the conversion was directed toward children.
Conversion	setCustomVariables(java.util.List<CustomFloodlightVariable> customVariables) Custom floodlight variables.
Conversion	setEncryptedUserId(java.lang.String encryptedUserId) The alphanumeric encrypted user ID.
Conversion	setEncryptedUserIdCandidates(java.util.List<java.lang.String> encryptedUserIdCandidates) A list of the alphanumeric encrypted user IDs.
Conversion	setFloodlightActivityId(java.lang.Long floodlightActivityId) Floodlight Activity ID of this conversion.
Conversion	setFloodlightConfigurationId(java.lang.Long floodlightConfigurationId) Floodlight Configuration ID of this conversion.
Conversion	setGclid(java.lang.String gclid) The Google click ID.
Conversion	setKind(java.lang.String kind) Identifies what kind of resource this is.
Conversion	setLimitAdTracking(java.lang.Boolean limitAdTracking) Whether Limit Ad Tracking is enabled.
Conversion	setMobileDeviceId(java.lang.String mobileDeviceId) The mobile device ID.
Conversion	setOrdinal(java.lang.String ordinal) The ordinal of the conversion.
Conversion	setQuantity(java.lang.Long quantity) The quantity of the conversion.
Conversion	setTimestampMicros(java.lang.Long timestampMicros) The timestamp of conversion, in Unix epoch micros.
Conversion	setValue(java.lang.Double value) The value of the conversion.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Conversion

public Conversion()

Method Detail

getChildDirectedTreatment

public java.lang.Boolean getChildDirectedTreatment()

Whether the conversion was directed toward children.

Returns:

value or null for none

setChildDirectedTreatment

public Conversion setChildDirectedTreatment(java.lang.Boolean childDirectedTreatment)

Whether the conversion was directed toward children.

Parameters:

childDirectedTreatment - childDirectedTreatment or null for none

getCustomVariables

public java.util.List<CustomFloodlightVariable> getCustomVariables()

Custom floodlight variables.

Returns:

value or null for none

setCustomVariables

public Conversion setCustomVariables(java.util.List<CustomFloodlightVariable> customVariables)

Custom floodlight variables.

Parameters:

customVariables - customVariables or null for none

getEncryptedUserId

public java.lang.String getEncryptedUserId()

The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field.

Returns:

value or null for none

setEncryptedUserId

public Conversion setEncryptedUserId(java.lang.String encryptedUserId)

The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field.

Parameters:

encryptedUserId - encryptedUserId or null for none

getEncryptedUserIdCandidates

public java.util.List<java.lang.String> getEncryptedUserIdCandidates()

A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, mobileDeviceId and gclid. This or encryptedUserId or mobileDeviceId or gclid is a required field.

Returns:

value or null for none

setEncryptedUserIdCandidates

public Conversion setEncryptedUserIdCandidates(java.util.List<java.lang.String> encryptedUserIdCandidates)

A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, mobileDeviceId and gclid. This or encryptedUserId or mobileDeviceId or gclid is a required field.

Parameters:

encryptedUserIdCandidates - encryptedUserIdCandidates or null for none

getFloodlightActivityId

public java.lang.Long getFloodlightActivityId()

Floodlight Activity ID of this conversion. This is a required field.

Returns:

value or null for none

setFloodlightActivityId

public Conversion setFloodlightActivityId(java.lang.Long floodlightActivityId)

Floodlight Activity ID of this conversion. This is a required field.

Parameters:

floodlightActivityId - floodlightActivityId or null for none

getFloodlightConfigurationId

public java.lang.Long getFloodlightConfigurationId()

Floodlight Configuration ID of this conversion. This is a required field.

Returns:

value or null for none

setFloodlightConfigurationId

public Conversion setFloodlightConfigurationId(java.lang.Long floodlightConfigurationId)

Floodlight Configuration ID of this conversion. This is a required field.

Parameters:

floodlightConfigurationId - floodlightConfigurationId or null for none

getGclid

public java.lang.String getGclid()

The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a required field.

Returns:

value or null for none

setGclid

public Conversion setGclid(java.lang.String gclid)

The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a required field.

Parameters:

gclid - gclid or null for none

getKind

public java.lang.String getKind()

Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".

Returns:

value or null for none

setKind

public Conversion setKind(java.lang.String kind)

Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".

Parameters:

kind - kind or null for none

getLimitAdTracking

public java.lang.Boolean getLimitAdTracking()

Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.

Returns:

value or null for none

setLimitAdTracking

public Conversion setLimitAdTracking(java.lang.Boolean limitAdTracking)

Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.

Parameters:

limitAdTracking - limitAdTracking or null for none

getMobileDeviceId

public java.lang.String getMobileDeviceId()

The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or gclid is a required field.

Returns:

value or null for none

setMobileDeviceId

public Conversion setMobileDeviceId(java.lang.String mobileDeviceId)

The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or gclid is a required field.

Parameters:

mobileDeviceId - mobileDeviceId or null for none

getOrdinal

public java.lang.String getOrdinal()

The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.

Returns:

value or null for none

setOrdinal

public Conversion setOrdinal(java.lang.String ordinal)

The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.

Parameters:

ordinal - ordinal or null for none

getQuantity

public java.lang.Long getQuantity()

The quantity of the conversion.

Returns:

value or null for none

setQuantity

public Conversion setQuantity(java.lang.Long quantity)

The quantity of the conversion.

Parameters:

quantity - quantity or null for none

getTimestampMicros

public java.lang.Long getTimestampMicros()

The timestamp of conversion, in Unix epoch micros. This is a required field.

Returns:

value or null for none

setTimestampMicros

public Conversion setTimestampMicros(java.lang.Long timestampMicros)

The timestamp of conversion, in Unix epoch micros. This is a required field.

Parameters:

timestampMicros - timestampMicros or null for none

getValue

public java.lang.Double getValue()

The value of the conversion.

Returns:

value or null for none

setValue

public Conversion setValue(java.lang.Double value)

The value of the conversion.

Parameters:

value - value or null for none

set

public Conversion set(java.lang.String fieldName,
             java.lang.Object value)

Overrides:

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

clone

public Conversion clone()

Overrides:

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