Interface EventOrBuilder (0.1.0)

public interface EventOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdIdentifiers()

public abstract AdIdentifiers getAdIdentifiers()

Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).

.google.ads.datamanager.v1.AdIdentifiers ad_identifiers = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AdIdentifiers	The adIdentifiers.

getAdIdentifiersOrBuilder()

public abstract AdIdentifiersOrBuilder getAdIdentifiersOrBuilder()

Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).

.google.ads.datamanager.v1.AdIdentifiers ad_identifiers = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AdIdentifiersOrBuilder

getAdditionalEventParameters(int index)

public abstract EventParameter getAdditionalEventParameters(int index)

Optional. A bucket of any event parameters to be included within the event that were not already specified using other structured fields.

repeated .google.ads.datamanager.v1.EventParameter additional_event_parameters = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
EventParameter

getAdditionalEventParametersCount()

public abstract int getAdditionalEventParametersCount()

Optional. A bucket of any event parameters to be included within the event that were not already specified using other structured fields.

repeated .google.ads.datamanager.v1.EventParameter additional_event_parameters = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getAdditionalEventParametersList()

public abstract List<EventParameter> getAdditionalEventParametersList()

Optional. A bucket of any event parameters to be included within the event that were not already specified using other structured fields.

repeated .google.ads.datamanager.v1.EventParameter additional_event_parameters = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<EventParameter>

getAdditionalEventParametersOrBuilder(int index)

public abstract EventParameterOrBuilder getAdditionalEventParametersOrBuilder(int index)

Optional. A bucket of any event parameters to be included within the event that were not already specified using other structured fields.

repeated .google.ads.datamanager.v1.EventParameter additional_event_parameters = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
EventParameterOrBuilder

getAdditionalEventParametersOrBuilderList()

public abstract List<? extends EventParameterOrBuilder> getAdditionalEventParametersOrBuilderList()

Optional. A bucket of any event parameters to be included within the event that were not already specified using other structured fields.

repeated .google.ads.datamanager.v1.EventParameter additional_event_parameters = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.ads.datamanager.v1.EventParameterOrBuilder>

getCartData()

public abstract CartData getCartData()

Optional. Information about the transaction and items associated with the event.

.google.ads.datamanager.v1.CartData cart_data = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CartData	The cartData.

getCartDataOrBuilder()

public abstract CartDataOrBuilder getCartDataOrBuilder()

Optional. Information about the transaction and items associated with the event.

.google.ads.datamanager.v1.CartData cart_data = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CartDataOrBuilder

getClientId()

public abstract String getClientId()

Optional. A unique identifier for the user instance of a web client for this GA4 web stream.

string client_id = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The clientId.

getClientIdBytes()

public abstract ByteString getClientIdBytes()

Optional. A unique identifier for the user instance of a web client for this GA4 web stream.

string client_id = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for clientId.

getConsent()

public abstract Consent getConsent()

Optional. Information about whether the associated user has provided different types of consent.

.google.ads.datamanager.v1.Consent consent = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Consent	The consent.

getConsentOrBuilder()

public abstract ConsentOrBuilder getConsentOrBuilder()

Optional. Information about whether the associated user has provided different types of consent.

.google.ads.datamanager.v1.Consent consent = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ConsentOrBuilder

getConversionValue()

public abstract double getConversionValue()

Optional. The conversion value associated with the event, for value-based conversions.

double conversion_value = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
double	The conversionValue.

getCurrency()

public abstract String getCurrency()

Optional. The currency code associated with all monetary values within this event.

string currency = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The currency.

getCurrencyBytes()

public abstract ByteString getCurrencyBytes()

Optional. The currency code associated with all monetary values within this event.

string currency = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for currency.

getCustomVariables(int index)

public abstract CustomVariable getCustomVariables(int index)

Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).

repeated .google.ads.datamanager.v1.CustomVariable custom_variables = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
CustomVariable

getCustomVariablesCount()

public abstract int getCustomVariablesCount()

Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).

repeated .google.ads.datamanager.v1.CustomVariable custom_variables = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getCustomVariablesList()

public abstract List<CustomVariable> getCustomVariablesList()

Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).

repeated .google.ads.datamanager.v1.CustomVariable custom_variables = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<CustomVariable>

getCustomVariablesOrBuilder(int index)

public abstract CustomVariableOrBuilder getCustomVariablesOrBuilder(int index)

Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).

repeated .google.ads.datamanager.v1.CustomVariable custom_variables = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
CustomVariableOrBuilder

getCustomVariablesOrBuilderList()

public abstract List<? extends CustomVariableOrBuilder> getCustomVariablesOrBuilderList()

Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).

repeated .google.ads.datamanager.v1.CustomVariable custom_variables = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.ads.datamanager.v1.CustomVariableOrBuilder>

getDestinationReferences(int index)

public abstract String getDestinationReferences(int index)

Optional. Reference string used to determine the destination. If empty, the event will be sent to all destinations in the request.

repeated string destination_references = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The destinationReferences at the given index.

getDestinationReferencesBytes(int index)

public abstract ByteString getDestinationReferencesBytes(int index)

Optional. Reference string used to determine the destination. If empty, the event will be sent to all destinations in the request.

repeated string destination_references = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the destinationReferences at the given index.

getDestinationReferencesCount()

public abstract int getDestinationReferencesCount()

Optional. Reference string used to determine the destination. If empty, the event will be sent to all destinations in the request.

repeated string destination_references = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of destinationReferences.

getDestinationReferencesList()

public abstract List<String> getDestinationReferencesList()

Optional. Reference string used to determine the destination. If empty, the event will be sent to all destinations in the request.

repeated string destination_references = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the destinationReferences.

getEventDeviceInfo()

public abstract DeviceInfo getEventDeviceInfo()

Optional. Information gathered about the device being used (if any) when the event happened.

.google.ads.datamanager.v1.DeviceInfo event_device_info = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DeviceInfo	The eventDeviceInfo.

getEventDeviceInfoOrBuilder()

public abstract DeviceInfoOrBuilder getEventDeviceInfoOrBuilder()

Optional. Information gathered about the device being used (if any) when the event happened.

.google.ads.datamanager.v1.DeviceInfo event_device_info = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DeviceInfoOrBuilder

getEventName()

public abstract String getEventName()

Optional. The name of the event. Required for GA4 events.

string event_name = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The eventName.

getEventNameBytes()

public abstract ByteString getEventNameBytes()

Optional. The name of the event. Required for GA4 events.

string event_name = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for eventName.

getEventSource()

public abstract EventSource getEventSource()

Optional. Signal for where the event happened (web, app, in-store, etc.).

.google.ads.datamanager.v1.EventSource event_source = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EventSource	The eventSource.

getEventSourceValue()

public abstract int getEventSourceValue()

Optional. Signal for where the event happened (web, app, in-store, etc.).

.google.ads.datamanager.v1.EventSource event_source = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for eventSource.

getEventTimestamp()

public abstract Timestamp getEventTimestamp()

Required. The time the event occurred.

.google.protobuf.Timestamp event_timestamp = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Timestamp	The eventTimestamp.

getEventTimestampOrBuilder()

public abstract TimestampOrBuilder getEventTimestampOrBuilder()

Required. The time the event occurred.

.google.protobuf.Timestamp event_timestamp = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
TimestampOrBuilder

getExperimentalFields(int index)

public abstract ExperimentalField getExperimentalFields(int index)

Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.

repeated .google.ads.datamanager.v1.ExperimentalField experimental_fields = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
ExperimentalField

getExperimentalFieldsCount()

public abstract int getExperimentalFieldsCount()

Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.

repeated .google.ads.datamanager.v1.ExperimentalField experimental_fields = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getExperimentalFieldsList()

public abstract List<ExperimentalField> getExperimentalFieldsList()

Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.

repeated .google.ads.datamanager.v1.ExperimentalField experimental_fields = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<ExperimentalField>

getExperimentalFieldsOrBuilder(int index)

public abstract ExperimentalFieldOrBuilder getExperimentalFieldsOrBuilder(int index)

Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.

repeated .google.ads.datamanager.v1.ExperimentalField experimental_fields = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
ExperimentalFieldOrBuilder

getExperimentalFieldsOrBuilderList()

public abstract List<? extends ExperimentalFieldOrBuilder> getExperimentalFieldsOrBuilderList()

Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.

repeated .google.ads.datamanager.v1.ExperimentalField experimental_fields = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.ads.datamanager.v1.ExperimentalFieldOrBuilder>

getLastUpdatedTimestamp()

public abstract Timestamp getLastUpdatedTimestamp()

Optional. The last time the event was updated.

.google.protobuf.Timestamp last_updated_timestamp = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Timestamp	The lastUpdatedTimestamp.

getLastUpdatedTimestampOrBuilder()

public abstract TimestampOrBuilder getLastUpdatedTimestampOrBuilder()

Optional. The last time the event was updated.

.google.protobuf.Timestamp last_updated_timestamp = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TimestampOrBuilder

getTransactionId()

public abstract String getTransactionId()

Optional. The unique identifier for this event. Required for conversions using multiple data sources.

string transaction_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The transactionId.

getTransactionIdBytes()

public abstract ByteString getTransactionIdBytes()

Optional. The unique identifier for this event. Required for conversions using multiple data sources.

string transaction_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for transactionId.

getUserData()

public abstract UserData getUserData()

Optional. Pieces of user provided data, representing the user the event is associated with.

.google.ads.datamanager.v1.UserData user_data = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserData	The userData.

getUserDataOrBuilder()

public abstract UserDataOrBuilder getUserDataOrBuilder()

Optional. Pieces of user provided data, representing the user the event is associated with.

.google.ads.datamanager.v1.UserData user_data = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserDataOrBuilder

getUserId()

public abstract String getUserId()

Optional. A unique identifier for a user, as defined by the advertiser.

string user_id = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The userId.

getUserIdBytes()

public abstract ByteString getUserIdBytes()

Optional. A unique identifier for a user, as defined by the advertiser.

string user_id = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for userId.

getUserProperties()

public abstract UserProperties getUserProperties()

Optional. Advertiser-assessed information about the user at the time that the event happened.

.google.ads.datamanager.v1.UserProperties user_properties = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserProperties	The userProperties.

getUserPropertiesOrBuilder()

public abstract UserPropertiesOrBuilder getUserPropertiesOrBuilder()

Optional. Advertiser-assessed information about the user at the time that the event happened.

.google.ads.datamanager.v1.UserProperties user_properties = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserPropertiesOrBuilder

hasAdIdentifiers()

public abstract boolean hasAdIdentifiers()

Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).

.google.ads.datamanager.v1.AdIdentifiers ad_identifiers = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the adIdentifiers field is set.

hasCartData()

public abstract boolean hasCartData()

Optional. Information about the transaction and items associated with the event.

.google.ads.datamanager.v1.CartData cart_data = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the cartData field is set.

hasConsent()

public abstract boolean hasConsent()

Optional. Information about whether the associated user has provided different types of consent.

.google.ads.datamanager.v1.Consent consent = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the consent field is set.

hasEventDeviceInfo()

public abstract boolean hasEventDeviceInfo()

Optional. Information gathered about the device being used (if any) when the event happened.

.google.ads.datamanager.v1.DeviceInfo event_device_info = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the eventDeviceInfo field is set.

hasEventTimestamp()

public abstract boolean hasEventTimestamp()

Required. The time the event occurred.

.google.protobuf.Timestamp event_timestamp = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the eventTimestamp field is set.

hasLastUpdatedTimestamp()

public abstract boolean hasLastUpdatedTimestamp()

Optional. The last time the event was updated.

.google.protobuf.Timestamp last_updated_timestamp = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the lastUpdatedTimestamp field is set.

hasUserData()

public abstract boolean hasUserData()

Optional. Pieces of user provided data, representing the user the event is associated with.

.google.ads.datamanager.v1.UserData user_data = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the userData field is set.

hasUserProperties()

public abstract boolean hasUserProperties()

Optional. Advertiser-assessed information about the user at the time that the event happened.

.google.ads.datamanager.v1.UserProperties user_properties = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the userProperties field is set.