Class protos.google.ads.datamanager.v1.IngestEventsRequest (0.5.0)

Represents an IngestEventsRequest.

Implements

Package

@google-ads/datamanager

Constructors

(constructor)(properties)

constructor(properties?: google.ads.datamanager.v1.IIngestEventsRequest);

Constructs a new IngestEventsRequest.

Parameter
Name Description
properties IIngestEventsRequest

Properties to set

Properties

public consent?: (google.ads.datamanager.v1.IConsent|null);

IngestEventsRequest consent.

destinations

public destinations: google.ads.datamanager.v1.IDestination[];

IngestEventsRequest destinations.

encoding

public encoding: (google.ads.datamanager.v1.Encoding|keyof typeof google.ads.datamanager.v1.Encoding);

IngestEventsRequest encoding.

encryptionInfo

public encryptionInfo?: (google.ads.datamanager.v1.IEncryptionInfo|null);

IngestEventsRequest encryptionInfo.

events

public events: google.ads.datamanager.v1.IEvent[];

IngestEventsRequest events.

validateOnly

public validateOnly: boolean;

IngestEventsRequest validateOnly.

Methods

create(properties)

public static create(properties?: google.ads.datamanager.v1.IIngestEventsRequest): google.ads.datamanager.v1.IngestEventsRequest;

Creates a new IngestEventsRequest instance using the specified properties.

Parameter
Name Description
properties IIngestEventsRequest

Properties to set

Returns
Type Description
IngestEventsRequest

IngestEventsRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.datamanager.v1.IngestEventsRequest;

Decodes an IngestEventsRequest message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
IngestEventsRequest

IngestEventsRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.datamanager.v1.IngestEventsRequest;

Decodes an IngestEventsRequest message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
IngestEventsRequest

IngestEventsRequest

encode(message, writer)

public static encode(message: google.ads.datamanager.v1.IIngestEventsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified IngestEventsRequest message. Does not implicitly messages.

Parameters
Name Description
message IIngestEventsRequest

IngestEventsRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.ads.datamanager.v1.IIngestEventsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified IngestEventsRequest message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IIngestEventsRequest

IngestEventsRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.ads.datamanager.v1.IngestEventsRequest;

Creates an IngestEventsRequest message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
IngestEventsRequest

IngestEventsRequest

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for IngestEventsRequest

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this IngestEventsRequest to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.ads.datamanager.v1.IngestEventsRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an IngestEventsRequest message. Also converts values to other types if specified.

Parameters
Name Description
message IngestEventsRequest

IngestEventsRequest

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an IngestEventsRequest message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not