Class protos.google.shopping.type.Price (0.4.0)

Represents a Price.

Package

@google-shopping/css

Constructors

(constructor)(properties)

constructor(properties?: google.shopping.type.IPrice);

Constructs a new Price.

Parameter
Name	Description
properties	IPrice Properties to set

Properties

_amountMicros

public _amountMicros?: "amountMicros";

Price _amountMicros.

_currencyCode

public _currencyCode?: "currencyCode";

Price _currencyCode.

amountMicros

public amountMicros?: (number|Long|string|null);

Price amountMicros.

currencyCode

public currencyCode?: (string|null);

Price currencyCode.

Methods

create(properties)

public static create(properties?: google.shopping.type.IPrice): google.shopping.type.Price;

Creates a new Price instance using the specified properties.

Parameter
Name	Description
properties	IPrice Properties to set

Returns
Type	Description
Price	Price instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.shopping.type.Price;

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

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.shopping.type.Price;

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

Parameter
Name	Description
reader	(Reader|Uint8Array) Reader or buffer to decode from

Returns
Type	Description
Price	Price

encode(message, writer)

public static encode(message: google.shopping.type.IPrice, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Price message. Does not implicitly messages.

Parameters
Name	Description
message	IPrice Price 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.shopping.type.IPrice, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
message	IPrice Price 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.shopping.type.Price;

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

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Price

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

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

toObject(message, options)

public static toObject(message: google.shopping.type.Price, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name	Description
message	Price Price
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 Price 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