Class protos.google.ads.admanager.v1.PrefetchSettings (0.7.0)

Represents a PrefetchSettings.

Implements

Package

@google-ads/admanager

Constructors

(constructor)(properties)

constructor(properties?: google.ads.admanager.v1.IPrefetchSettings);

Constructs a new PrefetchSettings.

Parameter
Name Description
properties IPrefetchSettings

Properties to set

Properties

stageOneAdRequestDuration

public stageOneAdRequestDuration?: (google.protobuf.IDuration|null);

PrefetchSettings stageOneAdRequestDuration.

Methods

create(properties)

public static create(properties?: google.ads.admanager.v1.IPrefetchSettings): google.ads.admanager.v1.PrefetchSettings;

Creates a new PrefetchSettings instance using the specified properties.

Parameter
Name Description
properties IPrefetchSettings

Properties to set

Returns
Type Description
PrefetchSettings

PrefetchSettings instance

decode(reader, length)

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

Decodes a PrefetchSettings 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
PrefetchSettings

PrefetchSettings

decodeDelimited(reader)

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

Decodes a PrefetchSettings message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
PrefetchSettings

PrefetchSettings

encode(message, writer)

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

Encodes the specified PrefetchSettings message. Does not implicitly messages.

Parameters
Name Description
message IPrefetchSettings

PrefetchSettings 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.admanager.v1.IPrefetchSettings, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IPrefetchSettings

PrefetchSettings 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.admanager.v1.PrefetchSettings;

Creates a PrefetchSettings 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
PrefetchSettings

PrefetchSettings

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PrefetchSettings

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 PrefetchSettings to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message PrefetchSettings

PrefetchSettings

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 a PrefetchSettings 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