com.google.api.services.dfareporting.model

Class Conversion

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

All Implemented Interfaces:

Cloneable, Map<String,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 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
Conversion()

Method Summary

Modifier and Type	Method and Description
Conversion	clone()
Boolean	getChildDirectedTreatment() Whether this particular request may come from a user under the age of 13, under COPPA compliance.
List<CustomFloodlightVariable>	getCustomVariables() Custom floodlight variables.
String	getDclid() The display click ID.
String	getEncryptedUserId() The alphanumeric encrypted user ID.
List<String>	getEncryptedUserIdCandidates() A list of the alphanumeric encrypted user IDs.
Long	getFloodlightActivityId() Floodlight Activity ID of this conversion.
Long	getFloodlightConfigurationId() Floodlight Configuration ID of this conversion.
String	getGclid() The Google click ID.
String	getImpressionId() The impression ID.
String	getKind() Identifies what kind of resource this is.
Boolean	getLimitAdTracking() Whether Limit Ad Tracking is enabled.
String	getMatchId() The match ID field.
String	getMobileDeviceId() The mobile device ID.
Boolean	getNonPersonalizedAd() Whether the conversion was for a non personalized ad.
String	getOrdinal() The ordinal of the conversion.
Long	getQuantity() The quantity of the conversion.
Long	getTimestampMicros() The timestamp of conversion, in Unix epoch micros.
Boolean	getTreatmentForUnderage() Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).
List<UserIdentifier>	getUserIdentifiers() The user identifiers to enhance the conversion.
Double	getValue() The value of the conversion.
Conversion	set(String fieldName, Object value)
Conversion	setChildDirectedTreatment(Boolean childDirectedTreatment) Whether this particular request may come from a user under the age of 13, under COPPA compliance.
Conversion	setCustomVariables(List<CustomFloodlightVariable> customVariables) Custom floodlight variables.
Conversion	setDclid(String dclid) The display click ID.
Conversion	setEncryptedUserId(String encryptedUserId) The alphanumeric encrypted user ID.
Conversion	setEncryptedUserIdCandidates(List<String> encryptedUserIdCandidates) A list of the alphanumeric encrypted user IDs.
Conversion	setFloodlightActivityId(Long floodlightActivityId) Floodlight Activity ID of this conversion.
Conversion	setFloodlightConfigurationId(Long floodlightConfigurationId) Floodlight Configuration ID of this conversion.
Conversion	setGclid(String gclid) The Google click ID.
Conversion	setImpressionId(String impressionId) The impression ID.
Conversion	setKind(String kind) Identifies what kind of resource this is.
Conversion	setLimitAdTracking(Boolean limitAdTracking) Whether Limit Ad Tracking is enabled.
Conversion	setMatchId(String matchId) The match ID field.
Conversion	setMobileDeviceId(String mobileDeviceId) The mobile device ID.
Conversion	setNonPersonalizedAd(Boolean nonPersonalizedAd) Whether the conversion was for a non personalized ad.
Conversion	setOrdinal(String ordinal) The ordinal of the conversion.
Conversion	setQuantity(Long quantity) The quantity of the conversion.
Conversion	setTimestampMicros(Long timestampMicros) The timestamp of conversion, in Unix epoch micros.
Conversion	setTreatmentForUnderage(Boolean treatmentForUnderage) Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).
Conversion	setUserIdentifiers(List<UserIdentifier> userIdentifiers) The user identifiers to enhance the conversion.
Conversion	setValue(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, 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

Conversion

public Conversion()

Method Detail

getChildDirectedTreatment

public Boolean getChildDirectedTreatment()

Whether this particular request may come from a user under the age of 13, under COPPA compliance.

Returns:

value or null for none

setChildDirectedTreatment

public Conversion setChildDirectedTreatment(Boolean childDirectedTreatment)

Whether this particular request may come from a user under the age of 13, under COPPA compliance.

Parameters:

childDirectedTreatment - childDirectedTreatment or null for none

getCustomVariables

public List<CustomFloodlightVariable> getCustomVariables()

Custom floodlight variables. This field may only be used when calling batchinsert; it is not supported by batchupdate.

Returns:

value or null for none

setCustomVariables

public Conversion setCustomVariables(List<CustomFloodlightVariable> customVariables)

Custom floodlight variables. This field may only be used when calling batchinsert; it is not supported by batchupdate.

Parameters:

customVariables - customVariables or null for none

getDclid

public String getDclid()

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

Returns:

value or null for none

setDclid

public Conversion setDclid(String dclid)

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

Parameters:

dclid - dclid or null for none

getEncryptedUserId

public String getEncryptedUserId()

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

Returns:

value or null for none

setEncryptedUserId

public Conversion setEncryptedUserId(String encryptedUserId)

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

Parameters:

encryptedUserId - encryptedUserId or null for none

getEncryptedUserIdCandidates

public List<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 INVALID_ARGUMENT 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, matchId, mobileDeviceId, gclid dclid, and impressionId. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid or impressionId is a required field.

Returns:

value or null for none

setEncryptedUserIdCandidates

public Conversion setEncryptedUserIdCandidates(List<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 INVALID_ARGUMENT 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, matchId, mobileDeviceId, gclid dclid, and impressionId. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid or impressionId is a required field.

Parameters:

encryptedUserIdCandidates - encryptedUserIdCandidates or null for none

getFloodlightActivityId

public Long getFloodlightActivityId()

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

Returns:

value or null for none

setFloodlightActivityId

public Conversion setFloodlightActivityId(Long floodlightActivityId)

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

Parameters:

floodlightActivityId - floodlightActivityId or null for none

getFloodlightConfigurationId

public Long getFloodlightConfigurationId()

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

Returns:

value or null for none

setFloodlightConfigurationId

public Conversion setFloodlightConfigurationId(Long floodlightConfigurationId)

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

Parameters:

floodlightConfigurationId - floodlightConfigurationId or null for none

getGclid

public String getGclid()

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

Returns:

value or null for none

setGclid

public Conversion setGclid(String gclid)

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

Parameters:

gclid - gclid or null for none

getImpressionId

public String getImpressionId()

The impression ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId, and gclid. One of these identifiers must be set.

Returns:

value or null for none

setImpressionId

public Conversion setImpressionId(String impressionId)

The impression ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId, and gclid. One of these identifiers must be set.

Parameters:

impressionId - impressionId or null for none

getKind

public 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(String kind)

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

Parameters:

kind - kind or null for none

getLimitAdTracking

public 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(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

getMatchId

public String getMatchId()

The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid, dclid, and impressionId. This or encryptedUserId orencryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid or impressionIdis a required field.

Returns:

value or null for none

setMatchId

public Conversion setMatchId(String matchId)

The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid, dclid, and impressionId. This or encryptedUserId orencryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid or impressionIdis a required field.

Parameters:

matchId - matchId or null for none

getMobileDeviceId

public String getMobileDeviceId()

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

Returns:

value or null for none

setMobileDeviceId

public Conversion setMobileDeviceId(String mobileDeviceId)

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

Parameters:

mobileDeviceId - mobileDeviceId or null for none

getNonPersonalizedAd

public Boolean getNonPersonalizedAd()

Whether the conversion was for a non personalized ad.

Returns:

value or null for none

setNonPersonalizedAd

public Conversion setNonPersonalizedAd(Boolean nonPersonalizedAd)

Whether the conversion was for a non personalized ad.

Parameters:

nonPersonalizedAd - nonPersonalizedAd or null for none

getOrdinal

public 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(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 Long getQuantity()

The quantity of the conversion. This is a required field.

Returns:

value or null for none

setQuantity

public Conversion setQuantity(Long quantity)

The quantity of the conversion. This is a required field.

Parameters:

quantity - quantity or null for none

getTimestampMicros

public 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(Long timestampMicros)

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

Parameters:

timestampMicros - timestampMicros or null for none

getTreatmentForUnderage

public Boolean getTreatmentForUnderage()

Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).

Returns:

value or null for none

setTreatmentForUnderage

public Conversion setTreatmentForUnderage(Boolean treatmentForUnderage)

Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).

Parameters:

treatmentForUnderage - treatmentForUnderage or null for none

getUserIdentifiers

public List<UserIdentifier> getUserIdentifiers()

The user identifiers to enhance the conversion. The maximum number of user identifiers for each conversion is 5.

Returns:

value or null for none

setUserIdentifiers

public Conversion setUserIdentifiers(List<UserIdentifier> userIdentifiers)

The user identifiers to enhance the conversion. The maximum number of user identifiers for each conversion is 5.

Parameters:

userIdentifiers - userIdentifiers or null for none

getValue

public Double getValue()

The value of the conversion. This is a required field.

Returns:

value or null for none

setValue

public Conversion setValue(Double value)

The value of the conversion. This is a required field.

Parameters:

value - value or null for none

set

public Conversion set(String fieldName,
                      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