Reference documentation and code samples for the Google Ads Data Manager V1 Client class Event.
An event representing a user interaction with an advertiser's website or app.
Generated from protobuf message google.ads.datamanager.v1.Event
Namespace
Google \ Ads \ DataManager \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ destination_references
array
Optional. Reference string used to determine the destination. If empty, the event will be sent to all destinations in the request.
↳ transaction_id
string
Optional. The unique identifier for this event. Required for conversions using multiple data sources.
↳ event_timestamp
↳ last_updated_timestamp
↳ user_data
UserData
Optional. Pieces of user provided data, representing the user the event is associated with.
↳ consent
Consent
Optional. Information about whether the associated user has provided different types of consent.
↳ ad_identifiers
AdIdentifiers
Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).
↳ currency
string
Optional. The currency code associated with all monetary values within this event.
↳ conversion_value
float
Optional. The conversion value associated with the event, for value-based conversions.
↳ event_source
int
Optional. Signal for where the event happened (web, app, in-store, etc.).
↳ event_device_info
DeviceInfo
Optional. Information gathered about the device being used (if any) when the event happened.
↳ cart_data
↳ custom_variables
array< CustomVariable
>
Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).
↳ experimental_fields
array< ExperimentalField
>
Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.
↳ user_properties
UserProperties
Optional. Advertiser-assessed information about the user at the time that the event happened.
↳ event_name
string
Optional. The name of the event. Required for GA4 events.
↳ client_id
string
Optional. A unique identifier for the user instance of a web client for this GA4 web stream.
↳ user_id
string
Optional. A unique identifier for a user, as defined by the advertiser.
↳ additional_event_parameters
array< EventParameter
>
Optional. A bucket of any event parameters to be included within the event that were not already specified using other structured fields.
getDestinationReferences
Optional. Reference string used to determine the destination. If empty, the event will be sent to all destinations in the request.
setDestinationReferences
Optional. Reference string used to determine the destination. If empty, the event will be sent to all destinations in the request.
var
string[]
$this
getTransactionId
Optional. The unique identifier for this event. Required for conversions using multiple data sources.
string
setTransactionId
Optional. The unique identifier for this event. Required for conversions using multiple data sources.
var
string
$this
getEventTimestamp
Required. The time the event occurred.
hasEventTimestamp
clearEventTimestamp
setEventTimestamp
Required. The time the event occurred.
$this
getLastUpdatedTimestamp
Optional. The last time the event was updated.
hasLastUpdatedTimestamp
clearLastUpdatedTimestamp
setLastUpdatedTimestamp
Optional. The last time the event was updated.
$this
getUserData
Optional. Pieces of user provided data, representing the user the event is associated with.
hasUserData
clearUserData
setUserData
Optional. Pieces of user provided data, representing the user the event is associated with.
$this
getConsent
Optional. Information about whether the associated user has provided different types of consent.
hasConsent
clearConsent
setConsent
Optional. Information about whether the associated user has provided different types of consent.
$this
getAdIdentifiers
Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).
hasAdIdentifiers
clearAdIdentifiers
setAdIdentifiers
Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).
$this
getCurrency
Optional. The currency code associated with all monetary values within this event.
string
setCurrency
Optional. The currency code associated with all monetary values within this event.
var
string
$this
getConversionValue
Optional. The conversion value associated with the event, for value-based conversions.
float
setConversionValue
Optional. The conversion value associated with the event, for value-based conversions.
var
float
$this
getEventSource
Optional. Signal for where the event happened (web, app, in-store, etc.).
setEventSource
Optional. Signal for where the event happened (web, app, in-store, etc.).
$this
getEventDeviceInfo
Optional. Information gathered about the device being used (if any) when the event happened.
hasEventDeviceInfo
clearEventDeviceInfo
setEventDeviceInfo
Optional. Information gathered about the device being used (if any) when the event happened.
$this
getCartData
Optional. Information about the transaction and items associated with the event.
hasCartData
clearCartData
setCartData
Optional. Information about the transaction and items associated with the event.
$this
getCustomVariables
Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).
setCustomVariables
Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).
$this
getExperimentalFields
Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.
setExperimentalFields
Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.
$this
getUserProperties
Optional. Advertiser-assessed information about the user at the time that the event happened.
hasUserProperties
clearUserProperties
setUserProperties
Optional. Advertiser-assessed information about the user at the time that the event happened.
$this
getEventName
Optional. The name of the event. Required for GA4 events.
string
setEventName
Optional. The name of the event. Required for GA4 events.
var
string
$this
getClientId
Optional. A unique identifier for the user instance of a web client for this GA4 web stream.
string
setClientId
Optional. A unique identifier for the user instance of a web client for this GA4 web stream.
var
string
$this
getUserId
Optional. A unique identifier for a user, as defined by the advertiser.
string
setUserId
Optional. A unique identifier for a user, as defined by the advertiser.
var
string
$this
getAdditionalEventParameters
Optional. A bucket of any event parameters to be included within the event that were not already specified using other structured fields.
setAdditionalEventParameters
Optional. A bucket of any event parameters to be included within the event that were not already specified using other structured fields.
$this
