Class: Google::Apis::DatamanagerV1::Event

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datamanager_v1/classes.rb,
lib/google/apis/datamanager_v1/representations.rb,
lib/google/apis/datamanager_v1/representations.rb

Overview

An event representing a user interaction with an advertiser's website or app.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Event

Returns a new instance of Event.



1144
1145
1146
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1144

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#ad_identifiers ⇒ Google::Apis::DatamanagerV1::AdIdentifiers

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

Returns:



1018
1019
1020
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1018

def ad_identifiers
  @ad_identifiers
end

#additional_event_parameters ⇒ Array<Google::Apis::DatamanagerV1::EventParameter>

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

Returns:



1025
1026
1027
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1025

def additional_event_parameters
  @additional_event_parameters
end

#app_instance_id ⇒ String

Optional. A unique identifier for the user instance of an app client for this GA4 app stream. Corresponds to the JSON property appInstanceId

Returns:

  • (String) 


1031
1032
1033
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1031

def app_instance_id
  @app_instance_id
end

#cart_data ⇒ Google::Apis::DatamanagerV1::CartData

The cart data associated with the event. Corresponds to the JSON property cartData

Returns:



1036
1037
1038
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1036

def cart_data
  @cart_data
end

#client_id ⇒ String

Optional. A unique identifier for the user instance of a web client for this GA4 web stream. Corresponds to the JSON property clientId

Returns:

  • (String) 


1042
1043
1044
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1042

def client_id
  @client_id
end

#consent ⇒ Google::Apis::DatamanagerV1::Consent

Digital Markets Act (DMA) consent settings for the user. Corresponds to the JSON property consent

Returns:



1048
1049
1050
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1048

def consent
  @consent
end

#conversion_count ⇒ Float

Optional. The conversion quantity associated with the event, for counting- based conversions. Corresponds to the JSON property conversionCount

Returns:

  • (Float) 


1054
1055
1056
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1054

def conversion_count
  @conversion_count
end

#conversion_value ⇒ Float

Optional. The conversion value associated with the event, for value-based conversions. Corresponds to the JSON property conversionValue

Returns:

  • (Float) 


1060
1061
1062
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1060

def conversion_value
  @conversion_value
end

#currency ⇒ String

Optional. The currency code associated with all monetary values within this event. Corresponds to the JSON property currency

Returns:

  • (String) 


1066
1067
1068
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1066

def currency
  @currency
end

#custom_variables ⇒ Array<Google::Apis::DatamanagerV1::CustomVariable>

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

Returns:



1072
1073
1074
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1072

def custom_variables
  @custom_variables
end

#destination_references ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1078
1079
1080
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1078

def destination_references
  @destination_references
end

#event_device_info ⇒ Google::Apis::DatamanagerV1::DeviceInfo

Information about the device being used (if any) when the event happened. Corresponds to the JSON property eventDeviceInfo

Returns:



1083
1084
1085
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1083

def event_device_info
  @event_device_info
end

#event_location ⇒ Google::Apis::DatamanagerV1::EventLocation

The location where the event occurred. Corresponds to the JSON property eventLocation

Returns:



1088
1089
1090
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1088

def event_location
  @event_location
end

#event_name ⇒ String

Optional. The name of the event. Required for GA4 events. Corresponds to the JSON property eventName

Returns:

  • (String) 


1093
1094
1095
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1093

def event_name
  @event_name
end

#event_source ⇒ String

Optional. Signal for where the event happened (web, app, in-store, etc.). Corresponds to the JSON property eventSource

Returns:

  • (String) 


1098
1099
1100
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1098

def event_source
  @event_source
end

#event_timestamp ⇒ String

Required. The time the event occurred. Corresponds to the JSON property eventTimestamp

Returns:

  • (String) 


1103
1104
1105
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1103

def event_timestamp
  @event_timestamp
end

#experimental_fields ⇒ Array<Google::Apis::DatamanagerV1::ExperimentalField>

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

Returns:



1109
1110
1111
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1109

def experimental_fields
  @experimental_fields
end

#last_updated_timestamp ⇒ String

Optional. The last time the event was updated. Corresponds to the JSON property lastUpdatedTimestamp

Returns:

  • (String) 


1114
1115
1116
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1114

def last_updated_timestamp
  @last_updated_timestamp
end

#third_party_user_data ⇒ Google::Apis::DatamanagerV1::UserData

Data that identifies the user. At least one identifier is required. Corresponds to the JSON property thirdPartyUserData

Returns:



1119
1120
1121
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1119

def third_party_user_data
  @third_party_user_data
end

#transaction_id ⇒ String

Optional. The unique identifier for this event. Required for events sent as an additional data source for tag conversions. Corresponds to the JSON property transactionId

Returns:

  • (String) 


1125
1126
1127
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1125

def transaction_id
  @transaction_id
end

#user_data ⇒ Google::Apis::DatamanagerV1::UserData

Data that identifies the user. At least one identifier is required. Corresponds to the JSON property userData

Returns:



1130
1131
1132
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1130

def user_data
  @user_data
end

#user_id ⇒ String

Optional. A unique identifier for a user, as defined by the advertiser. Corresponds to the JSON property userId

Returns:

  • (String) 


1135
1136
1137
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1135

def user_id
  @user_id
end

#user_properties ⇒ Google::Apis::DatamanagerV1::UserProperties

Advertiser-assessed information about the user at the time that the event happened. See https://support.google.com/google-ads/answer/14007601 for more details. Corresponds to the JSON property userProperties

Returns:



1142
1143
1144
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1142

def user_properties
  @user_properties
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/google/apis/datamanager_v1/classes.rb', line 1149

def update!(**args)
  @ad_identifiers = args[:ad_identifiers] if args.key?(:ad_identifiers)
  @additional_event_parameters = args[:additional_event_parameters] if args.key?(:additional_event_parameters)
  @app_instance_id = args[:app_instance_id] if args.key?(:app_instance_id)
  @cart_data = args[:cart_data] if args.key?(:cart_data)
  @client_id = args[:client_id] if args.key?(:client_id)
  @consent = args[:consent] if args.key?(:consent)
  @conversion_count = args[:conversion_count] if args.key?(:conversion_count)
  @conversion_value = args[:conversion_value] if args.key?(:conversion_value)
  @currency = args[:currency] if args.key?(:currency)
  @custom_variables = args[:custom_variables] if args.key?(:custom_variables)
  @destination_references = args[:destination_references] if args.key?(:destination_references)
  @event_device_info = args[:event_device_info] if args.key?(:event_device_info)
  @event_location = args[:event_location] if args.key?(:event_location)
  @event_name = args[:event_name] if args.key?(:event_name)
  @event_source = args[:event_source] if args.key?(:event_source)
  @event_timestamp = args[:event_timestamp] if args.key?(:event_timestamp)
  @experimental_fields = args[:experimental_fields] if args.key?(:experimental_fields)
  @last_updated_timestamp = args[:last_updated_timestamp] if args.key?(:last_updated_timestamp)
  @third_party_user_data = args[:third_party_user_data] if args.key?(:third_party_user_data)
  @transaction_id = args[:transaction_id] if args.key?(:transaction_id)
  @user_data = args[:user_data] if args.key?(:user_data)
  @user_id = args[:user_id] if args.key?(:user_id)
  @user_properties = args[:user_properties] if args.key?(:user_properties)
end