public
final
class
Event
extends
GeneratedMessageV3
implements
EventOrBuilder
An event representing a user interaction with an advertiser's website or app.
Protobuf type google.ads.datamanager.v1.Event
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > EventImplements
EventOrBuilderStatic Fields
ADDITIONAL_EVENT_PARAMETERS_FIELD_NUMBER
public
static
final
int
ADDITIONAL_EVENT_PARAMETERS_FIELD_NUMBER
AD_IDENTIFIERS_FIELD_NUMBER
public
static
final
int
AD_IDENTIFIERS_FIELD_NUMBER
CART_DATA_FIELD_NUMBER
public
static
final
int
CART_DATA_FIELD_NUMBER
CLIENT_ID_FIELD_NUMBER
public
static
final
int
CLIENT_ID_FIELD_NUMBER
CONSENT_FIELD_NUMBER
public
static
final
int
CONSENT_FIELD_NUMBER
CONVERSION_VALUE_FIELD_NUMBER
public
static
final
int
CONVERSION_VALUE_FIELD_NUMBER
CURRENCY_FIELD_NUMBER
public
static
final
int
CURRENCY_FIELD_NUMBER
CUSTOM_VARIABLES_FIELD_NUMBER
public
static
final
int
CUSTOM_VARIABLES_FIELD_NUMBER
DESTINATION_REFERENCES_FIELD_NUMBER
public
static
final
int
DESTINATION_REFERENCES_FIELD_NUMBER
EVENT_DEVICE_INFO_FIELD_NUMBER
public
static
final
int
EVENT_DEVICE_INFO_FIELD_NUMBER
EVENT_NAME_FIELD_NUMBER
public
static
final
int
EVENT_NAME_FIELD_NUMBER
EVENT_SOURCE_FIELD_NUMBER
public
static
final
int
EVENT_SOURCE_FIELD_NUMBER
EVENT_TIMESTAMP_FIELD_NUMBER
public
static
final
int
EVENT_TIMESTAMP_FIELD_NUMBER
EXPERIMENTAL_FIELDS_FIELD_NUMBER
public
static
final
int
EXPERIMENTAL_FIELDS_FIELD_NUMBER
LAST_UPDATED_TIMESTAMP_FIELD_NUMBER
public
static
final
int
LAST_UPDATED_TIMESTAMP_FIELD_NUMBER
TRANSACTION_ID_FIELD_NUMBER
public
static
final
int
TRANSACTION_ID_FIELD_NUMBER
USER_DATA_FIELD_NUMBER
public
static
final
int
USER_DATA_FIELD_NUMBER
USER_ID_FIELD_NUMBER
public
static
final
int
USER_ID_FIELD_NUMBER
USER_PROPERTIES_FIELD_NUMBER
public
static
final
int
USER_PROPERTIES_FIELD_NUMBER
Static Methods
getDefaultInstance()
public
static
Event
getDefaultInstance
()
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
newBuilder()
public
static
Event
.
Builder
newBuilder
()
newBuilder(Event prototype)
public
static
Event
.
Builder
newBuilder
(
Event
prototype
)
parseDelimitedFrom(InputStream input)
public
static
Event
parseDelimitedFrom
(
InputStream
input
)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Event
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(byte[] data)
public
static
Event
parseFrom
(
byte
[]
data
)
data
byte
[]
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Event
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteString data)
public
static
Event
parseFrom
(
ByteString
data
)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Event
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(CodedInputStream input)
public
static
Event
parseFrom
(
CodedInputStream
input
)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Event
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(InputStream input)
public
static
Event
parseFrom
(
InputStream
input
)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Event
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteBuffer data)
public
static
Event
parseFrom
(
ByteBuffer
data
)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Event
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
parser()
public
static
Parser<Event>
parser
()
Methods
equals(Object obj)
public
boolean
equals
(
Object
obj
)
getAdIdentifiers()
public
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];
getAdIdentifiersOrBuilder()
public
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];
getAdditionalEventParameters(int index)
public
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];
getAdditionalEventParametersCount()
public
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];
getAdditionalEventParametersList()
public
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];
getAdditionalEventParametersOrBuilder(int index)
public
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];
getAdditionalEventParametersOrBuilderList()
public
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];
getCartData()
public
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];
getCartDataOrBuilder()
public
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];
getClientId()
public
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];
getClientIdBytes()
public
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];
getConsent()
public
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];
getConsentOrBuilder()
public
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];
getConversionValue()
public
double
getConversionValue
()
Optional. The conversion value associated with the event, for value-based conversions.
double conversion_value = 9 [(.google.api.field_behavior) = OPTIONAL];
getCurrency()
public
String
getCurrency
()
Optional. The currency code associated with all monetary values within this event.
string currency = 8 [(.google.api.field_behavior) = OPTIONAL];
getCurrencyBytes()
public
ByteString
getCurrencyBytes
()
Optional. The currency code associated with all monetary values within this event.
string currency = 8 [(.google.api.field_behavior) = OPTIONAL];
getCustomVariables(int index)
public
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];
getCustomVariablesCount()
public
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];
getCustomVariablesList()
public
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];
getCustomVariablesOrBuilder(int index)
public
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];
getCustomVariablesOrBuilderList()
public
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];
getDefaultInstanceForType()
public
Event
getDefaultInstanceForType
()
getDestinationReferences(int index)
public
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];
getDestinationReferencesBytes(int index)
public
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];
getDestinationReferencesCount()
public
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];
getDestinationReferencesList()
public
ProtocolStringList
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];
getEventDeviceInfo()
public
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];
getEventDeviceInfoOrBuilder()
public
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];
getEventName()
public
String
getEventName
()
Optional. The name of the event. Required for GA4 events.
string event_name = 16 [(.google.api.field_behavior) = OPTIONAL];
getEventNameBytes()
public
ByteString
getEventNameBytes
()
Optional. The name of the event. Required for GA4 events.
string event_name = 16 [(.google.api.field_behavior) = OPTIONAL];
getEventSource()
public
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];
getEventSourceValue()
public
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];
getEventTimestamp()
public
Timestamp
getEventTimestamp
()
Required. The time the event occurred.
.google.protobuf.Timestamp event_timestamp = 3 [(.google.api.field_behavior) = REQUIRED];
getEventTimestampOrBuilder()
public
TimestampOrBuilder
getEventTimestampOrBuilder
()
Required. The time the event occurred.
.google.protobuf.Timestamp event_timestamp = 3 [(.google.api.field_behavior) = REQUIRED];
getExperimentalFields(int index)
public
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];
getExperimentalFieldsCount()
public
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];
getExperimentalFieldsList()
public
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];
getExperimentalFieldsOrBuilder(int index)
public
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];
getExperimentalFieldsOrBuilderList()
public
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];
List
< ? extends com.google.ads.datamanager.v1.ExperimentalFieldOrBuilder
>
getLastUpdatedTimestamp()
public
Timestamp
getLastUpdatedTimestamp
()
Optional. The last time the event was updated.
.google.protobuf.Timestamp last_updated_timestamp = 4 [(.google.api.field_behavior) = OPTIONAL];
getLastUpdatedTimestampOrBuilder()
public
TimestampOrBuilder
getLastUpdatedTimestampOrBuilder
()
Optional. The last time the event was updated.
.google.protobuf.Timestamp last_updated_timestamp = 4 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public
Parser<Event>
getParserForType
()
getSerializedSize()
public
int
getSerializedSize
()
getTransactionId()
public
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];
getTransactionIdBytes()
public
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];
getUserData()
public
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];
getUserDataOrBuilder()
public
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];
getUserId()
public
String
getUserId
()
Optional. A unique identifier for a user, as defined by the advertiser.
string user_id = 18 [(.google.api.field_behavior) = OPTIONAL];
getUserIdBytes()
public
ByteString
getUserIdBytes
()
Optional. A unique identifier for a user, as defined by the advertiser.
string user_id = 18 [(.google.api.field_behavior) = OPTIONAL];
getUserProperties()
public
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];
getUserPropertiesOrBuilder()
public
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];
hasAdIdentifiers()
public
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];
hasCartData()
public
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];
hasConsent()
public
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];
hasEventDeviceInfo()
public
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];
hasEventTimestamp()
public
boolean
hasEventTimestamp
()
Required. The time the event occurred.
.google.protobuf.Timestamp event_timestamp = 3 [(.google.api.field_behavior) = REQUIRED];
hasLastUpdatedTimestamp()
public
boolean
hasLastUpdatedTimestamp
()
Optional. The last time the event was updated.
.google.protobuf.Timestamp last_updated_timestamp = 4 [(.google.api.field_behavior) = OPTIONAL];
hasUserData()
public
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];
hasUserProperties()
public
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];
hashCode()
public
int
hashCode
()
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
isInitialized()
public
final
boolean
isInitialized
()
newBuilderForType()
public
Event
.
Builder
newBuilderForType
()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Event
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
toBuilder()
public
Event
.
Builder
toBuilder
()
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
