Interface IngestEventsRequestOrBuilder (0.1.0)

public interface IngestEventsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConsent()

public abstract Consent getConsent()

Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each Event.

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

Returns
Type	Description
`Consent`	The consent.

getConsentOrBuilder()

public abstract ConsentOrBuilder getConsentOrBuilder()

Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each Event.

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

Returns
Type	Description
`ConsentOrBuilder`

getDestinations(int index)

public abstract Destination getDestinations(int index)

Required. The list of destinations to send the events to.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Destination`

getDestinationsCount()

public abstract int getDestinationsCount()

Required. The list of destinations to send the events to.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`

getDestinationsList()

public abstract List<Destination> getDestinationsList()

Required. The list of destinations to send the events to.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`List<Destination>`

getDestinationsOrBuilder(int index)

public abstract DestinationOrBuilder getDestinationsOrBuilder(int index)

Required. The list of destinations to send the events to.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DestinationOrBuilder`

getDestinationsOrBuilderList()

public abstract List<? extends DestinationOrBuilder> getDestinationsOrBuilderList()

Required. The list of destinations to send the events to.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

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

getEncoding()

public abstract Encoding getEncoding()

Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non UserData uploads, this field is ignored.

.google.ads.datamanager.v1.Encoding encoding = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Encoding`	The encoding.

getEncodingValue()

public abstract int getEncodingValue()

Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non UserData uploads, this field is ignored.

.google.ads.datamanager.v1.Encoding encoding = 5 [(.google.api.field_behavior) = OPTIONAL];

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

getEncryptionInfo()

public abstract EncryptionInfo getEncryptionInfo()

Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non UserData uploads, this field is ignored.

.google.ads.datamanager.v1.EncryptionInfo encryption_info = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`EncryptionInfo`	The encryptionInfo.

getEncryptionInfoOrBuilder()

public abstract EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()

Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non UserData uploads, this field is ignored.

.google.ads.datamanager.v1.EncryptionInfo encryption_info = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`EncryptionInfoOrBuilder`

getEvents(int index)

public abstract Event getEvents(int index)

Required. The list of events to send to the specified destinations. At most 2000 Event resources can be sent in a single request.

repeated .google.ads.datamanager.v1.Event events = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Event`

getEventsCount()

public abstract int getEventsCount()

Required. The list of events to send to the specified destinations. At most 2000 Event resources can be sent in a single request.

repeated .google.ads.datamanager.v1.Event events = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`

getEventsList()

public abstract List<Event> getEventsList()

Required. The list of events to send to the specified destinations. At most 2000 Event resources can be sent in a single request.

repeated .google.ads.datamanager.v1.Event events = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`List<Event>`

getEventsOrBuilder(int index)

public abstract EventOrBuilder getEventsOrBuilder(int index)

Required. The list of events to send to the specified destinations. At most 2000 Event resources can be sent in a single request.

repeated .google.ads.datamanager.v1.Event events = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`EventOrBuilder`

getEventsOrBuilderList()

public abstract List<? extends EventOrBuilder> getEventsOrBuilderList()

Required. The list of events to send to the specified destinations. At most 2000 Event resources can be sent in a single request.

repeated .google.ads.datamanager.v1.Event events = 2 [(.google.api.field_behavior) = REQUIRED];

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

getValidateOnly()

public abstract boolean getValidateOnly()

Optional. For testing purposes. If true, the request is validated but not executed. Only errors are returned, not results.

bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The validateOnly.

hasConsent()

public abstract boolean hasConsent()

Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each Event.

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

Returns
Type	Description
`boolean`	Whether the consent field is set.

hasEncryptionInfo()

public abstract boolean hasEncryptionInfo()

Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non UserData uploads, this field is ignored.

.google.ads.datamanager.v1.EncryptionInfo encryption_info = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the encryptionInfo field is set.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-11-19 UTC.