Class protos.google.shopping.css.v1.AccountLabel (0.4.0)

Represents an AccountLabel.

Package

@google-shopping/css

Constructors

(constructor)(properties)

constructor(properties?: google.shopping.css.v1.IAccountLabel);

Constructs a new AccountLabel.

Parameter
Name Description
properties IAccountLabel

Properties to set

Properties

_description

public _description?: "description";

AccountLabel _description.

_displayName

public _displayName?: "displayName";

AccountLabel _displayName.

accountId

public accountId: (number|Long|string);

AccountLabel accountId.

description

public description?: (string|null);

AccountLabel description.

displayName

public displayName?: (string|null);

AccountLabel displayName.

labelId

public labelId: (number|Long|string);

AccountLabel labelId.

labelType

public labelType: (google.shopping.css.v1.AccountLabel.LabelType|keyof typeof google.shopping.css.v1.AccountLabel.LabelType);

AccountLabel labelType.

name

public name: string;

AccountLabel name.

Methods

create(properties)

public static create(properties?: google.shopping.css.v1.IAccountLabel): google.shopping.css.v1.AccountLabel;

Creates a new AccountLabel instance using the specified properties.

Parameter
Name Description
properties IAccountLabel

Properties to set

Returns
Type Description
AccountLabel

AccountLabel instance

decode(reader, length)

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

Decodes an AccountLabel 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
AccountLabel

AccountLabel

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.shopping.css.v1.AccountLabel;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
AccountLabel

AccountLabel

encode(message, writer)

public static encode(message: google.shopping.css.v1.IAccountLabel, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AccountLabel message. Does not implicitly messages.

Parameters
Name Description
message IAccountLabel

AccountLabel 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.css.v1.IAccountLabel, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IAccountLabel

AccountLabel 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.css.v1.AccountLabel;

Creates an AccountLabel 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
AccountLabel

AccountLabel

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AccountLabel

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message AccountLabel

AccountLabel

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