Class protos.google.shopping.merchant.reports.v1beta.BestSellersBrandView (0.7.0)

Represents a BestSellersBrandView.

Package

@google-shopping/reports

Constructors

(constructor)(properties)

constructor(properties?: google.shopping.merchant.reports.v1beta.IBestSellersBrandView);

Constructs a new BestSellersBrandView.

Parameter
Name Description
properties IBestSellersBrandView

Properties to set

Properties

_brand

public _brand?: "brand";

BestSellersBrandView _brand.

_previousRank

public _previousRank?: "previousRank";

BestSellersBrandView _previousRank.

_previousRelativeDemand

public _previousRelativeDemand?: "previousRelativeDemand";

BestSellersBrandView _previousRelativeDemand.

_rank

public _rank?: "rank";

BestSellersBrandView _rank.

_relativeDemand

public _relativeDemand?: "relativeDemand";

BestSellersBrandView _relativeDemand.

_relativeDemandChange

public _relativeDemandChange?: "relativeDemandChange";

BestSellersBrandView _relativeDemandChange.

_reportCategoryId

public _reportCategoryId?: "reportCategoryId";

BestSellersBrandView _reportCategoryId.

_reportCountryCode

public _reportCountryCode?: "reportCountryCode";

BestSellersBrandView _reportCountryCode.

_reportGranularity

public _reportGranularity?: "reportGranularity";

BestSellersBrandView _reportGranularity.

brand

public brand?: (string|null);

BestSellersBrandView brand.

previousRank

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

BestSellersBrandView previousRank.

previousRelativeDemand

public previousRelativeDemand?: (google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum|keyof typeof google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum|null);

BestSellersBrandView previousRelativeDemand.

rank

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

BestSellersBrandView rank.

relativeDemand

public relativeDemand?: (google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum|keyof typeof google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum|null);

BestSellersBrandView relativeDemand.

relativeDemandChange

public relativeDemandChange?: (google.shopping.merchant.reports.v1beta.RelativeDemandChangeType.RelativeDemandChangeTypeEnum|keyof typeof google.shopping.merchant.reports.v1beta.RelativeDemandChangeType.RelativeDemandChangeTypeEnum|null);

BestSellersBrandView relativeDemandChange.

reportCategoryId

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

BestSellersBrandView reportCategoryId.

reportCountryCode

public reportCountryCode?: (string|null);

BestSellersBrandView reportCountryCode.

reportDate

public reportDate?: (google.type.IDate|null);

BestSellersBrandView reportDate.

reportGranularity

public reportGranularity?: (google.shopping.merchant.reports.v1beta.ReportGranularity.ReportGranularityEnum|keyof typeof google.shopping.merchant.reports.v1beta.ReportGranularity.ReportGranularityEnum|null);

BestSellersBrandView reportGranularity.

Methods

create(properties)

public static create(properties?: google.shopping.merchant.reports.v1beta.IBestSellersBrandView): google.shopping.merchant.reports.v1beta.BestSellersBrandView;

Creates a new BestSellersBrandView instance using the specified properties.

Parameter
Name Description
properties IBestSellersBrandView

Properties to set

Returns
Type Description
BestSellersBrandView

BestSellersBrandView instance

decode(reader, length)

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

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

BestSellersBrandView

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
BestSellersBrandView

BestSellersBrandView

encode(message, writer)

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

Encodes the specified BestSellersBrandView message. Does not implicitly messages.

Parameters
Name Description
message IBestSellersBrandView

BestSellersBrandView 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.reports.v1beta.IBestSellersBrandView, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IBestSellersBrandView

BestSellersBrandView 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.reports.v1beta.BestSellersBrandView;

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

BestSellersBrandView

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BestSellersBrandView

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message BestSellersBrandView

BestSellersBrandView

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