Class IngestEventsRequest (0.1.0)

public final class IngestEventsRequest extends GeneratedMessageV3 implements IngestEventsRequestOrBuilder

Request to upload audience members to the provided destinations. Returns an IngestEventsResponse.

Protobuf type google.ads.datamanager.v1.IngestEventsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > IngestEventsRequest

Implements

IngestEventsRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CONSENT_FIELD_NUMBER

public static final int CONSENT_FIELD_NUMBER

Field Value
Type	Description
int

DESTINATIONS_FIELD_NUMBER

public static final int DESTINATIONS_FIELD_NUMBER

Field Value
Type	Description
int

ENCODING_FIELD_NUMBER

public static final int ENCODING_FIELD_NUMBER

Field Value
Type	Description
int

ENCRYPTION_INFO_FIELD_NUMBER

public static final int ENCRYPTION_INFO_FIELD_NUMBER

Field Value
Type	Description
int

EVENTS_FIELD_NUMBER

public static final int EVENTS_FIELD_NUMBER

Field Value
Type	Description
int

VALIDATE_ONLY_FIELD_NUMBER

public static final int VALIDATE_ONLY_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static IngestEventsRequest getDefaultInstance()

Returns
Type	Description
IngestEventsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static IngestEventsRequest.Builder newBuilder()

Returns
Type	Description
IngestEventsRequest.Builder

newBuilder(IngestEventsRequest prototype)

public static IngestEventsRequest.Builder newBuilder(IngestEventsRequest prototype)

Parameter
Name	Description
prototype	IngestEventsRequest

Returns
Type	Description
IngestEventsRequest.Builder

parseDelimitedFrom(InputStream input)

public static IngestEventsRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
IngestEventsRequest

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IngestEventsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
IngestEventsRequest

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static IngestEventsRequest parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
IngestEventsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IngestEventsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
IngestEventsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static IngestEventsRequest parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
IngestEventsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IngestEventsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
IngestEventsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static IngestEventsRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
IngestEventsRequest

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IngestEventsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
IngestEventsRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static IngestEventsRequest parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
IngestEventsRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IngestEventsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
IngestEventsRequest

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static IngestEventsRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
IngestEventsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IngestEventsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
IngestEventsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<IngestEventsRequest> parser()

Returns
Type	Description
Parser<IngestEventsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getConsent()

public 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 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

getDefaultInstanceForType()

public IngestEventsRequest getDefaultInstanceForType()

Returns
Type	Description
IngestEventsRequest

getDestinations(int index)

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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>

getParserForType()

public Parser<IngestEventsRequest> getParserForType()

Returns
Type	Description
Parser<IngestEventsRequest>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getValidateOnly()

public 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 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 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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public IngestEventsRequest.Builder newBuilderForType()

Returns
Type	Description
IngestEventsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IngestEventsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
IngestEventsRequest.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public IngestEventsRequest.Builder toBuilder()

Returns
Type	Description
IngestEventsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException