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

Represents a WebProperty.

Implements

Package

@google-ads/admanager

Constructors

(constructor)(properties)

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

Constructs a new WebProperty.

Parameter
Name Description
properties IWebProperty

Properties to set

Properties

name

public name: string;

WebProperty name.

productType

public productType: (google.ads.admanager.v1.ExchangeSyndicationProductEnum.ExchangeSyndicationProduct|keyof typeof google.ads.admanager.v1.ExchangeSyndicationProductEnum.ExchangeSyndicationProduct);

WebProperty productType.

webPropertyCode

public webPropertyCode: string;

WebProperty webPropertyCode.

webPropertyId

public webPropertyId: (number|Long|string);

WebProperty webPropertyId.

Methods

create(properties)

public static create(properties?: google.ads.admanager.v1.IWebProperty): google.ads.admanager.v1.WebProperty;

Creates a new WebProperty instance using the specified properties.

Parameter
Name Description
properties IWebProperty

Properties to set

Returns
Type Description
WebProperty

WebProperty instance

decode(reader, length)

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

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

WebProperty

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
WebProperty

WebProperty

encode(message, writer)

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

Encodes the specified WebProperty message. Does not implicitly messages.

Parameters
Name Description
message IWebProperty

WebProperty 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.IWebProperty, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IWebProperty

WebProperty 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.WebProperty;

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

WebProperty

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for WebProperty

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message WebProperty

WebProperty

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