Class protos.google.shopping.merchant.accounts.v1beta.CarrierRate (2.2.0)

Represents a CarrierRate.

Package

@google-shopping/accounts

Constructors

(constructor)(properties)

constructor(properties?: google.shopping.merchant.accounts.v1beta.ICarrierRate);

Constructs a new CarrierRate.

Parameter
Name Description
properties ICarrierRate

Properties to set

Properties

_carrier

public _carrier?: "carrier";

CarrierRate _carrier.

_carrierService

public _carrierService?: "carrierService";

CarrierRate _carrierService.

_flatAdjustment

public _flatAdjustment?: "flatAdjustment";

CarrierRate _flatAdjustment.

_name

public _name?: "name";

CarrierRate _name.

_originPostalCode

public _originPostalCode?: "originPostalCode";

CarrierRate _originPostalCode.

_percentageAdjustment

public _percentageAdjustment?: "percentageAdjustment";

CarrierRate _percentageAdjustment.

carrier

public carrier?: (string|null);

CarrierRate carrier.

carrierService

public carrierService?: (string|null);

CarrierRate carrierService.

flatAdjustment

public flatAdjustment?: (google.shopping.type.IPrice|null);

CarrierRate flatAdjustment.

name

public name?: (string|null);

CarrierRate name.

originPostalCode

public originPostalCode?: (string|null);

CarrierRate originPostalCode.

percentageAdjustment

public percentageAdjustment?: (string|null);

CarrierRate percentageAdjustment.

Methods

create(properties)

public static create(properties?: google.shopping.merchant.accounts.v1beta.ICarrierRate): google.shopping.merchant.accounts.v1beta.CarrierRate;

Creates a new CarrierRate instance using the specified properties.

Parameter
Name Description
properties ICarrierRate

Properties to set

Returns
Type Description
CarrierRate

CarrierRate instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.shopping.merchant.accounts.v1beta.CarrierRate;

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

CarrierRate

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.shopping.merchant.accounts.v1beta.CarrierRate;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CarrierRate

CarrierRate

encode(message, writer)

public static encode(message: google.shopping.merchant.accounts.v1beta.ICarrierRate, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CarrierRate message. Does not implicitly messages.

Parameters
Name Description
message ICarrierRate

CarrierRate 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.merchant.accounts.v1beta.ICarrierRate, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICarrierRate

CarrierRate 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.merchant.accounts.v1beta.CarrierRate;

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

CarrierRate

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CarrierRate

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message CarrierRate

CarrierRate

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