public static final class Event.Builder extends GeneratedMessageV3.Builder<Event.Builder> implements EventOrBuilderAn event representing a user interaction with an advertiser's website or app.
Protobuf type google.ads.datamanager.v1.Event
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Event.BuilderImplements
EventOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAdditionalEventParameters(EventParameter value)
public Event.Builder addAdditionalEventParameters(EventParameter value)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 |
value |
EventParameter |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
addAdditionalEventParameters(EventParameter.Builder builderForValue)
public Event.Builder addAdditionalEventParameters(EventParameter.Builder builderForValue)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 |
builderForValue |
EventParameter.Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
addAdditionalEventParameters(int index, EventParameter value)
public Event.Builder addAdditionalEventParameters(int index, EventParameter value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
EventParameter |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
addAdditionalEventParameters(int index, EventParameter.Builder builderForValue)
public Event.Builder addAdditionalEventParameters(int index, EventParameter.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
EventParameter.Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
addAdditionalEventParametersBuilder()
public EventParameter.Builder addAdditionalEventParametersBuilder()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 |
EventParameter.Builder |
|
addAdditionalEventParametersBuilder(int index)
public EventParameter.Builder addAdditionalEventParametersBuilder(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.Builder |
|
addAllAdditionalEventParameters(Iterable<? extends EventParameter> values)
public Event.Builder addAllAdditionalEventParameters(Iterable<? extends EventParameter> values)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 |
values |
Iterable<? extends com.google.ads.datamanager.v1.EventParameter> |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
addAllCustomVariables(Iterable<? extends CustomVariable> values)
public Event.Builder addAllCustomVariables(Iterable<? extends CustomVariable> values)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 |
values |
Iterable<? extends com.google.ads.datamanager.v1.CustomVariable> |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
addAllDestinationReferences(Iterable<String> values)
public Event.Builder addAllDestinationReferences(Iterable<String> values)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 |
values |
Iterable<String>The destinationReferences to add. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
addAllExperimentalFields(Iterable<? extends ExperimentalField> values)
public Event.Builder addAllExperimentalFields(Iterable<? extends ExperimentalField> values)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 |
values |
Iterable<? extends com.google.ads.datamanager.v1.ExperimentalField> |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
addCustomVariables(CustomVariable value)
public Event.Builder addCustomVariables(CustomVariable value)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 |
value |
CustomVariable |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
addCustomVariables(CustomVariable.Builder builderForValue)
public Event.Builder addCustomVariables(CustomVariable.Builder builderForValue)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 |
builderForValue |
CustomVariable.Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
addCustomVariables(int index, CustomVariable value)
public Event.Builder addCustomVariables(int index, CustomVariable value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CustomVariable |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
addCustomVariables(int index, CustomVariable.Builder builderForValue)
public Event.Builder addCustomVariables(int index, CustomVariable.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CustomVariable.Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
addCustomVariablesBuilder()
public CustomVariable.Builder addCustomVariablesBuilder()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 |
CustomVariable.Builder |
|
addCustomVariablesBuilder(int index)
public CustomVariable.Builder addCustomVariablesBuilder(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.Builder |
|
addDestinationReferences(String value)
public Event.Builder addDestinationReferences(String value)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 |
value |
StringThe destinationReferences to add. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
addDestinationReferencesBytes(ByteString value)
public Event.Builder addDestinationReferencesBytes(ByteString value)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 |
value |
ByteStringThe bytes of the destinationReferences to add. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
addExperimentalFields(ExperimentalField value)
public Event.Builder addExperimentalFields(ExperimentalField value)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 |
value |
ExperimentalField |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
addExperimentalFields(ExperimentalField.Builder builderForValue)
public Event.Builder addExperimentalFields(ExperimentalField.Builder builderForValue)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 |
builderForValue |
ExperimentalField.Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
addExperimentalFields(int index, ExperimentalField value)
public Event.Builder addExperimentalFields(int index, ExperimentalField value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ExperimentalField |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
addExperimentalFields(int index, ExperimentalField.Builder builderForValue)
public Event.Builder addExperimentalFields(int index, ExperimentalField.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ExperimentalField.Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
addExperimentalFieldsBuilder()
public ExperimentalField.Builder addExperimentalFieldsBuilder()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 |
ExperimentalField.Builder |
|
addExperimentalFieldsBuilder(int index)
public ExperimentalField.Builder addExperimentalFieldsBuilder(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.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Event.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
build()
public Event build()| Returns | |
|---|---|
| Type | Description |
Event |
|
buildPartial()
public Event buildPartial()| Returns | |
|---|---|
| Type | Description |
Event |
|
clear()
public Event.Builder clear()| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
clearAdIdentifiers()
public Event.Builder clearAdIdentifiers()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 |
Event.Builder |
|
clearAdditionalEventParameters()
public Event.Builder clearAdditionalEventParameters()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 |
Event.Builder |
|
clearCartData()
public Event.Builder clearCartData()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 |
Event.Builder |
|
clearClientId()
public Event.Builder clearClientId()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 |
Event.Builder |
This builder for chaining. |
clearConsent()
public Event.Builder clearConsent()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 |
Event.Builder |
|
clearConversionValue()
public Event.Builder clearConversionValue()Optional. The conversion value associated with the event, for value-based conversions.
double conversion_value = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
clearCurrency()
public Event.Builder clearCurrency()Optional. The currency code associated with all monetary values within this event.
string currency = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
clearCustomVariables()
public Event.Builder clearCustomVariables()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 |
Event.Builder |
|
clearDestinationReferences()
public Event.Builder clearDestinationReferences()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 |
Event.Builder |
This builder for chaining. |
clearEventDeviceInfo()
public Event.Builder clearEventDeviceInfo()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 |
Event.Builder |
|
clearEventName()
public Event.Builder clearEventName()Optional. The name of the event. Required for GA4 events.
string event_name = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
clearEventSource()
public Event.Builder clearEventSource()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 |
Event.Builder |
This builder for chaining. |
clearEventTimestamp()
public Event.Builder clearEventTimestamp()Required. The time the event occurred.
.google.protobuf.Timestamp event_timestamp = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
clearExperimentalFields()
public Event.Builder clearExperimentalFields()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 |
Event.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Event.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
clearLastUpdatedTimestamp()
public Event.Builder clearLastUpdatedTimestamp()Optional. The last time the event was updated.
.google.protobuf.Timestamp last_updated_timestamp = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public Event.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
clearTransactionId()
public Event.Builder clearTransactionId()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 |
Event.Builder |
This builder for chaining. |
clearUserData()
public Event.Builder clearUserData()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 |
Event.Builder |
|
clearUserId()
public Event.Builder clearUserId()Optional. A unique identifier for a user, as defined by the advertiser.
string user_id = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
clearUserProperties()
public Event.Builder clearUserProperties()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 |
Event.Builder |
|
clone()
public Event.Builder clone()| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
AdIdentifiers |
The adIdentifiers. |
getAdIdentifiersBuilder()
public AdIdentifiers.Builder getAdIdentifiersBuilder()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.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
AdIdentifiersOrBuilder |
|
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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
EventParameter |
|
getAdditionalEventParametersBuilder(int index)
public EventParameter.Builder getAdditionalEventParametersBuilder(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.Builder |
|
getAdditionalEventParametersBuilderList()
public List<EventParameter.Builder> getAdditionalEventParametersBuilderList()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<Builder> |
|
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];
| Returns | |
|---|---|
| Type | Description |
int |
|
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];
| Returns | |
|---|---|
| Type | Description |
List<EventParameter> |
|
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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
EventParameterOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.ads.datamanager.v1.EventParameterOrBuilder> |
|
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];
| Returns | |
|---|---|
| Type | Description |
CartData |
The cartData. |
getCartDataBuilder()
public CartData.Builder getCartDataBuilder()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.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
CartDataOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
String |
The clientId. |
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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for clientId. |
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];
| Returns | |
|---|---|
| Type | Description |
Consent |
The consent. |
getConsentBuilder()
public Consent.Builder getConsentBuilder()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.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
ConsentOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
double |
The conversionValue. |
getCurrency()
public 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 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 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 |
|
getCustomVariablesBuilder(int index)
public CustomVariable.Builder getCustomVariablesBuilder(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.Builder |
|
getCustomVariablesBuilderList()
public List<CustomVariable.Builder> getCustomVariablesBuilderList()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<Builder> |
|
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];
| Returns | |
|---|---|
| Type | Description |
int |
|
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];
| Returns | |
|---|---|
| Type | Description |
List<CustomVariable> |
|
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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CustomVariableOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.ads.datamanager.v1.CustomVariableOrBuilder> |
|
getDefaultInstanceForType()
public Event getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Event |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The destinationReferences at the given index. |
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];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the destinationReferences at the given index. |
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];
| Returns | |
|---|---|
| Type | Description |
int |
The count of destinationReferences. |
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];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the destinationReferences. |
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];
| Returns | |
|---|---|
| Type | Description |
DeviceInfo |
The eventDeviceInfo. |
getEventDeviceInfoBuilder()
public DeviceInfo.Builder getEventDeviceInfoBuilder()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.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
DeviceInfoOrBuilder |
|
getEventName()
public 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 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 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 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 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. |
getEventTimestampBuilder()
public Timestamp.Builder getEventTimestampBuilder()Required. The time the event occurred.
.google.protobuf.Timestamp event_timestamp = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getEventTimestampOrBuilder()
public 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 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 |
|
getExperimentalFieldsBuilder(int index)
public ExperimentalField.Builder getExperimentalFieldsBuilder(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.Builder |
|
getExperimentalFieldsBuilderList()
public List<ExperimentalField.Builder> getExperimentalFieldsBuilderList()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<Builder> |
|
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];
| Returns | |
|---|---|
| Type | Description |
int |
|
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];
| Returns | |
|---|---|
| Type | Description |
List<ExperimentalField> |
|
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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ExperimentalFieldOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
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];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The lastUpdatedTimestamp. |
getLastUpdatedTimestampBuilder()
public Timestamp.Builder getLastUpdatedTimestampBuilder()Optional. The last time the event was updated.
.google.protobuf.Timestamp last_updated_timestamp = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getLastUpdatedTimestampOrBuilder()
public 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 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 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 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. |
getUserDataBuilder()
public UserData.Builder getUserDataBuilder()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.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
UserDataOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
String |
The userId. |
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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for userId. |
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];
| Returns | |
|---|---|
| Type | Description |
UserProperties |
The userProperties. |
getUserPropertiesBuilder()
public UserProperties.Builder getUserPropertiesBuilder()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.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
UserPropertiesOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the adIdentifiers field is set. |
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];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the cartData field is set. |
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];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the consent field is set. |
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];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the eventDeviceInfo field is set. |
hasEventTimestamp()
public 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAdIdentifiers(AdIdentifiers value)
public Event.Builder mergeAdIdentifiers(AdIdentifiers value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
AdIdentifiers |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
mergeCartData(CartData value)
public Event.Builder mergeCartData(CartData value)Optional. Information about the transaction and items associated with the event.
.google.ads.datamanager.v1.CartData cart_data = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
CartData |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
mergeConsent(Consent value)
public Event.Builder mergeConsent(Consent value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Consent |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
mergeEventDeviceInfo(DeviceInfo value)
public Event.Builder mergeEventDeviceInfo(DeviceInfo value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
DeviceInfo |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
mergeEventTimestamp(Timestamp value)
public Event.Builder mergeEventTimestamp(Timestamp value)Required. The time the event occurred.
.google.protobuf.Timestamp event_timestamp = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
mergeFrom(Event other)
public Event.Builder mergeFrom(Event other)| Parameter | |
|---|---|
| Name | Description |
other |
Event |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Event.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Event.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
mergeLastUpdatedTimestamp(Timestamp value)
public Event.Builder mergeLastUpdatedTimestamp(Timestamp value)Optional. The last time the event was updated.
.google.protobuf.Timestamp last_updated_timestamp = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Event.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
mergeUserData(UserData value)
public Event.Builder mergeUserData(UserData value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
UserData |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
mergeUserProperties(UserProperties value)
public Event.Builder mergeUserProperties(UserProperties value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
UserProperties |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
removeAdditionalEventParameters(int index)
public Event.Builder removeAdditionalEventParameters(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 |
Event.Builder |
|
removeCustomVariables(int index)
public Event.Builder removeCustomVariables(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 |
Event.Builder |
|
removeExperimentalFields(int index)
public Event.Builder removeExperimentalFields(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 |
Event.Builder |
|
setAdIdentifiers(AdIdentifiers value)
public Event.Builder setAdIdentifiers(AdIdentifiers value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
AdIdentifiers |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setAdIdentifiers(AdIdentifiers.Builder builderForValue)
public Event.Builder setAdIdentifiers(AdIdentifiers.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AdIdentifiers.Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setAdditionalEventParameters(int index, EventParameter value)
public Event.Builder setAdditionalEventParameters(int index, EventParameter value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
EventParameter |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setAdditionalEventParameters(int index, EventParameter.Builder builderForValue)
public Event.Builder setAdditionalEventParameters(int index, EventParameter.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
EventParameter.Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setCartData(CartData value)
public Event.Builder setCartData(CartData value)Optional. Information about the transaction and items associated with the event.
.google.ads.datamanager.v1.CartData cart_data = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
CartData |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setCartData(CartData.Builder builderForValue)
public Event.Builder setCartData(CartData.Builder builderForValue)Optional. Information about the transaction and items associated with the event.
.google.ads.datamanager.v1.CartData cart_data = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CartData.Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setClientId(String value)
public Event.Builder setClientId(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe clientId to set. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
setClientIdBytes(ByteString value)
public Event.Builder setClientIdBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for clientId to set. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
setConsent(Consent value)
public Event.Builder setConsent(Consent value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Consent |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setConsent(Consent.Builder builderForValue)
public Event.Builder setConsent(Consent.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Consent.Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setConversionValue(double value)
public Event.Builder setConversionValue(double value)Optional. The conversion value associated with the event, for value-based conversions.
double conversion_value = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
doubleThe conversionValue to set. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
setCurrency(String value)
public Event.Builder setCurrency(String value)Optional. The currency code associated with all monetary values within this event.
string currency = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe currency to set. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
setCurrencyBytes(ByteString value)
public Event.Builder setCurrencyBytes(ByteString value)Optional. The currency code associated with all monetary values within this event.
string currency = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for currency to set. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
setCustomVariables(int index, CustomVariable value)
public Event.Builder setCustomVariables(int index, CustomVariable value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CustomVariable |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setCustomVariables(int index, CustomVariable.Builder builderForValue)
public Event.Builder setCustomVariables(int index, CustomVariable.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CustomVariable.Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setDestinationReferences(int index, String value)
public Event.Builder setDestinationReferences(int index, String value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe destinationReferences to set. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
setEventDeviceInfo(DeviceInfo value)
public Event.Builder setEventDeviceInfo(DeviceInfo value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
DeviceInfo |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setEventDeviceInfo(DeviceInfo.Builder builderForValue)
public Event.Builder setEventDeviceInfo(DeviceInfo.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DeviceInfo.Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setEventName(String value)
public Event.Builder setEventName(String value)Optional. The name of the event. Required for GA4 events.
string event_name = 16 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe eventName to set. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
setEventNameBytes(ByteString value)
public Event.Builder setEventNameBytes(ByteString value)Optional. The name of the event. Required for GA4 events.
string event_name = 16 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for eventName to set. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
setEventSource(EventSource value)
public Event.Builder setEventSource(EventSource value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
EventSourceThe eventSource to set. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
setEventSourceValue(int value)
public Event.Builder setEventSourceValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for eventSource to set. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
setEventTimestamp(Timestamp value)
public Event.Builder setEventTimestamp(Timestamp value)Required. The time the event occurred.
.google.protobuf.Timestamp event_timestamp = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setEventTimestamp(Timestamp.Builder builderForValue)
public Event.Builder setEventTimestamp(Timestamp.Builder builderForValue)Required. The time the event occurred.
.google.protobuf.Timestamp event_timestamp = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setExperimentalFields(int index, ExperimentalField value)
public Event.Builder setExperimentalFields(int index, ExperimentalField value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ExperimentalField |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setExperimentalFields(int index, ExperimentalField.Builder builderForValue)
public Event.Builder setExperimentalFields(int index, ExperimentalField.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ExperimentalField.Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public Event.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setLastUpdatedTimestamp(Timestamp value)
public Event.Builder setLastUpdatedTimestamp(Timestamp value)Optional. The last time the event was updated.
.google.protobuf.Timestamp last_updated_timestamp = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setLastUpdatedTimestamp(Timestamp.Builder builderForValue)
public Event.Builder setLastUpdatedTimestamp(Timestamp.Builder builderForValue)Optional. The last time the event was updated.
.google.protobuf.Timestamp last_updated_timestamp = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Event.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setTransactionId(String value)
public Event.Builder setTransactionId(String value)Optional. The unique identifier for this event. Required for conversions using multiple data sources.
string transaction_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe transactionId to set. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
setTransactionIdBytes(ByteString value)
public Event.Builder setTransactionIdBytes(ByteString value)Optional. The unique identifier for this event. Required for conversions using multiple data sources.
string transaction_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for transactionId to set. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Event.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setUserData(UserData value)
public Event.Builder setUserData(UserData value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
UserData |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setUserData(UserData.Builder builderForValue)
public Event.Builder setUserData(UserData.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
UserData.Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setUserId(String value)
public Event.Builder setUserId(String value)Optional. A unique identifier for a user, as defined by the advertiser.
string user_id = 18 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe userId to set. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
setUserIdBytes(ByteString value)
public Event.Builder setUserIdBytes(ByteString value)Optional. A unique identifier for a user, as defined by the advertiser.
string user_id = 18 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for userId to set. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
This builder for chaining. |
setUserProperties(UserProperties value)
public Event.Builder setUserProperties(UserProperties value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
UserProperties |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|
setUserProperties(UserProperties.Builder builderForValue)
public Event.Builder setUserProperties(UserProperties.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
UserProperties.Builder |
| Returns | |
|---|---|
| Type | Description |
Event.Builder |
|