com.google.api.services.dfareporting.model.Conversion Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.dfareporting.model;
/**
* 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.
*/
@SuppressWarnings("javadoc")
public final class Conversion extends com.google.api.client.json.GenericJson {
/**
* This represents consent for ad user data.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String adUserDataConsent;
/**
* The cart data associated with this conversion.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private CartData cartData;
/**
* Whether this particular request may come from a user under the age of 13, under COPPA
* compliance.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean childDirectedTreatment;
/**
* Custom floodlight variables.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List customVariables;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String dclid;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String encryptedUserId;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List encryptedUserIdCandidates;
/**
* Floodlight Activity ID of this conversion. This is a required field.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key @com.google.api.client.json.JsonString
private java.lang.Long floodlightActivityId;
/**
* Floodlight Configuration ID of this conversion. This is a required field.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key @com.google.api.client.json.JsonString
private java.lang.Long floodlightConfigurationId;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String gclid;
/**
* The impression ID. This field is mutually exclusive with encryptedUserId,
* encryptedUserIdCandidates[], matchId, mobileDeviceId, and gclid. One of these identifiers must
* be set.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String impressionId;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String kind;
/**
* Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for
* reporting but not targeting. This will prevent remarketing.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean limitAdTracking;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String matchId;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String mobileDeviceId;
/**
* Whether the conversion was for a non personalized ad.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean nonPersonalizedAd;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String ordinal;
/**
* The quantity of the conversion. This is a required field.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key @com.google.api.client.json.JsonString
private java.lang.Long quantity;
/**
* The timestamp of conversion, in Unix epoch micros. This is a required field.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key @com.google.api.client.json.JsonString
private java.lang.Long timestampMicros;
/**
* 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).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean treatmentForUnderage;
/**
* The user identifiers to enhance the conversion. The maximum number of user identifiers for each
* conversion is 5.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List userIdentifiers;
/**
* The value of the conversion. This is a required field.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Double value;
/**
* This represents consent for ad user data.
* @return value or {@code null} for none
*/
public java.lang.String getAdUserDataConsent() {
return adUserDataConsent;
}
/**
* This represents consent for ad user data.
* @param adUserDataConsent adUserDataConsent or {@code null} for none
*/
public Conversion setAdUserDataConsent(java.lang.String adUserDataConsent) {
this.adUserDataConsent = adUserDataConsent;
return this;
}
/**
* The cart data associated with this conversion.
* @return value or {@code null} for none
*/
public CartData getCartData() {
return cartData;
}
/**
* The cart data associated with this conversion.
* @param cartData cartData or {@code null} for none
*/
public Conversion setCartData(CartData cartData) {
this.cartData = cartData;
return this;
}
/**
* Whether this particular request may come from a user under the age of 13, under COPPA
* compliance.
* @return value or {@code null} for none
*/
public java.lang.Boolean getChildDirectedTreatment() {
return childDirectedTreatment;
}
/**
* Whether this particular request may come from a user under the age of 13, under COPPA
* compliance.
* @param childDirectedTreatment childDirectedTreatment or {@code null} for none
*/
public Conversion setChildDirectedTreatment(java.lang.Boolean childDirectedTreatment) {
this.childDirectedTreatment = childDirectedTreatment;
return this;
}
/**
* Custom floodlight variables.
* @return value or {@code null} for none
*/
public java.util.List getCustomVariables() {
return customVariables;
}
/**
* Custom floodlight variables.
* @param customVariables customVariables or {@code null} for none
*/
public Conversion setCustomVariables(java.util.List customVariables) {
this.customVariables = customVariables;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getDclid() {
return 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.
* @param dclid dclid or {@code null} for none
*/
public Conversion setDclid(java.lang.String dclid) {
this.dclid = dclid;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getEncryptedUserId() {
return 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.
* @param encryptedUserId encryptedUserId or {@code null} for none
*/
public Conversion setEncryptedUserId(java.lang.String encryptedUserId) {
this.encryptedUserId = encryptedUserId;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.util.List getEncryptedUserIdCandidates() {
return 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.
* @param encryptedUserIdCandidates encryptedUserIdCandidates or {@code null} for none
*/
public Conversion setEncryptedUserIdCandidates(java.util.List encryptedUserIdCandidates) {
this.encryptedUserIdCandidates = encryptedUserIdCandidates;
return this;
}
/**
* Floodlight Activity ID of this conversion. This is a required field.
* @return value or {@code null} for none
*/
public java.lang.Long getFloodlightActivityId() {
return floodlightActivityId;
}
/**
* Floodlight Activity ID of this conversion. This is a required field.
* @param floodlightActivityId floodlightActivityId or {@code null} for none
*/
public Conversion setFloodlightActivityId(java.lang.Long floodlightActivityId) {
this.floodlightActivityId = floodlightActivityId;
return this;
}
/**
* Floodlight Configuration ID of this conversion. This is a required field.
* @return value or {@code null} for none
*/
public java.lang.Long getFloodlightConfigurationId() {
return floodlightConfigurationId;
}
/**
* Floodlight Configuration ID of this conversion. This is a required field.
* @param floodlightConfigurationId floodlightConfigurationId or {@code null} for none
*/
public Conversion setFloodlightConfigurationId(java.lang.Long floodlightConfigurationId) {
this.floodlightConfigurationId = floodlightConfigurationId;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getGclid() {
return 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.
* @param gclid gclid or {@code null} for none
*/
public Conversion setGclid(java.lang.String gclid) {
this.gclid = gclid;
return this;
}
/**
* The impression ID. This field is mutually exclusive with encryptedUserId,
* encryptedUserIdCandidates[], matchId, mobileDeviceId, and gclid. One of these identifiers must
* be set.
* @return value or {@code null} for none
*/
public java.lang.String getImpressionId() {
return impressionId;
}
/**
* The impression ID. This field is mutually exclusive with encryptedUserId,
* encryptedUserIdCandidates[], matchId, mobileDeviceId, and gclid. One of these identifiers must
* be set.
* @param impressionId impressionId or {@code null} for none
*/
public Conversion setImpressionId(java.lang.String impressionId) {
this.impressionId = impressionId;
return this;
}
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
* @return value or {@code null} for none
*/
public java.lang.String getKind() {
return kind;
}
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
* @param kind kind or {@code null} for none
*/
public Conversion setKind(java.lang.String kind) {
this.kind = kind;
return this;
}
/**
* Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for
* reporting but not targeting. This will prevent remarketing.
* @return value or {@code null} for none
*/
public java.lang.Boolean getLimitAdTracking() {
return 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.
* @param limitAdTracking limitAdTracking or {@code null} for none
*/
public Conversion setLimitAdTracking(java.lang.Boolean limitAdTracking) {
this.limitAdTracking = limitAdTracking;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getMatchId() {
return 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.
* @param matchId matchId or {@code null} for none
*/
public Conversion setMatchId(java.lang.String matchId) {
this.matchId = matchId;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getMobileDeviceId() {
return 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.
* @param mobileDeviceId mobileDeviceId or {@code null} for none
*/
public Conversion setMobileDeviceId(java.lang.String mobileDeviceId) {
this.mobileDeviceId = mobileDeviceId;
return this;
}
/**
* Whether the conversion was for a non personalized ad.
* @return value or {@code null} for none
*/
public java.lang.Boolean getNonPersonalizedAd() {
return nonPersonalizedAd;
}
/**
* Whether the conversion was for a non personalized ad.
* @param nonPersonalizedAd nonPersonalizedAd or {@code null} for none
*/
public Conversion setNonPersonalizedAd(java.lang.Boolean nonPersonalizedAd) {
this.nonPersonalizedAd = nonPersonalizedAd;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getOrdinal() {
return 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.
* @param ordinal ordinal or {@code null} for none
*/
public Conversion setOrdinal(java.lang.String ordinal) {
this.ordinal = ordinal;
return this;
}
/**
* The quantity of the conversion. This is a required field.
* @return value or {@code null} for none
*/
public java.lang.Long getQuantity() {
return quantity;
}
/**
* The quantity of the conversion. This is a required field.
* @param quantity quantity or {@code null} for none
*/
public Conversion setQuantity(java.lang.Long quantity) {
this.quantity = quantity;
return this;
}
/**
* The timestamp of conversion, in Unix epoch micros. This is a required field.
* @return value or {@code null} for none
*/
public java.lang.Long getTimestampMicros() {
return timestampMicros;
}
/**
* The timestamp of conversion, in Unix epoch micros. This is a required field.
* @param timestampMicros timestampMicros or {@code null} for none
*/
public Conversion setTimestampMicros(java.lang.Long timestampMicros) {
this.timestampMicros = timestampMicros;
return this;
}
/**
* 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).
* @return value or {@code null} for none
*/
public java.lang.Boolean getTreatmentForUnderage() {
return 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).
* @param treatmentForUnderage treatmentForUnderage or {@code null} for none
*/
public Conversion setTreatmentForUnderage(java.lang.Boolean treatmentForUnderage) {
this.treatmentForUnderage = treatmentForUnderage;
return this;
}
/**
* The user identifiers to enhance the conversion. The maximum number of user identifiers for each
* conversion is 5.
* @return value or {@code null} for none
*/
public java.util.List getUserIdentifiers() {
return userIdentifiers;
}
/**
* The user identifiers to enhance the conversion. The maximum number of user identifiers for each
* conversion is 5.
* @param userIdentifiers userIdentifiers or {@code null} for none
*/
public Conversion setUserIdentifiers(java.util.List userIdentifiers) {
this.userIdentifiers = userIdentifiers;
return this;
}
/**
* The value of the conversion. This is a required field.
* @return value or {@code null} for none
*/
public java.lang.Double getValue() {
return value;
}
/**
* The value of the conversion. This is a required field.
* @param value value or {@code null} for none
*/
public Conversion setValue(java.lang.Double value) {
this.value = value;
return this;
}
@Override
public Conversion set(String fieldName, Object value) {
return (Conversion) super.set(fieldName, value);
}
@Override
public Conversion clone() {
return (Conversion) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy