Represents a BestSellersProductClusterView.
Package
@google-shopping/reportsConstructors
(constructor)(properties)
constructor(properties?: google.shopping.merchant.reports.v1beta.IBestSellersProductClusterView);Constructs a new BestSellersProductClusterView.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBestSellersProductClusterView
Properties to set |
Properties
_brand
public _brand?: "brand";BestSellersProductClusterView _brand.
_brandInventoryStatus
public _brandInventoryStatus?: "brandInventoryStatus";BestSellersProductClusterView _brandInventoryStatus.
_categoryL1
public _categoryL1?: "categoryL1";BestSellersProductClusterView _categoryL1.
_categoryL2
public _categoryL2?: "categoryL2";BestSellersProductClusterView _categoryL2.
_categoryL3
public _categoryL3?: "categoryL3";BestSellersProductClusterView _categoryL3.
_categoryL4
public _categoryL4?: "categoryL4";BestSellersProductClusterView _categoryL4.
_categoryL5
public _categoryL5?: "categoryL5";BestSellersProductClusterView _categoryL5.
_inventoryStatus
public _inventoryStatus?: "inventoryStatus";BestSellersProductClusterView _inventoryStatus.
_previousRank
public _previousRank?: "previousRank";BestSellersProductClusterView _previousRank.
_previousRelativeDemand
public _previousRelativeDemand?: "previousRelativeDemand";BestSellersProductClusterView _previousRelativeDemand.
_rank
public _rank?: "rank";BestSellersProductClusterView _rank.
_relativeDemand
public _relativeDemand?: "relativeDemand";BestSellersProductClusterView _relativeDemand.
_relativeDemandChange
public _relativeDemandChange?: "relativeDemandChange";BestSellersProductClusterView _relativeDemandChange.
_reportCategoryId
public _reportCategoryId?: "reportCategoryId";BestSellersProductClusterView _reportCategoryId.
_reportCountryCode
public _reportCountryCode?: "reportCountryCode";BestSellersProductClusterView _reportCountryCode.
_reportGranularity
public _reportGranularity?: "reportGranularity";BestSellersProductClusterView _reportGranularity.
_title
public _title?: "title";BestSellersProductClusterView _title.
brand
public brand?: (string|null);BestSellersProductClusterView brand.
brandInventoryStatus
public brandInventoryStatus?: (google.shopping.merchant.reports.v1beta.BestSellersProductClusterView.InventoryStatus|keyof typeof google.shopping.merchant.reports.v1beta.BestSellersProductClusterView.InventoryStatus|null);BestSellersProductClusterView brandInventoryStatus.
categoryL1
public categoryL1?: (string|null);BestSellersProductClusterView categoryL1.
categoryL2
public categoryL2?: (string|null);BestSellersProductClusterView categoryL2.
categoryL3
public categoryL3?: (string|null);BestSellersProductClusterView categoryL3.
categoryL4
public categoryL4?: (string|null);BestSellersProductClusterView categoryL4.
categoryL5
public categoryL5?: (string|null);BestSellersProductClusterView categoryL5.
inventoryStatus
public inventoryStatus?: (google.shopping.merchant.reports.v1beta.BestSellersProductClusterView.InventoryStatus|keyof typeof google.shopping.merchant.reports.v1beta.BestSellersProductClusterView.InventoryStatus|null);BestSellersProductClusterView inventoryStatus.
previousRank
public previousRank?: (number|Long|string|null);BestSellersProductClusterView previousRank.
previousRelativeDemand
public previousRelativeDemand?: (google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum|keyof typeof google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum|null);BestSellersProductClusterView previousRelativeDemand.
rank
public rank?: (number|Long|string|null);BestSellersProductClusterView rank.
relativeDemand
public relativeDemand?: (google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum|keyof typeof google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum|null);BestSellersProductClusterView relativeDemand.
relativeDemandChange
public relativeDemandChange?: (google.shopping.merchant.reports.v1beta.RelativeDemandChangeType.RelativeDemandChangeTypeEnum|keyof typeof google.shopping.merchant.reports.v1beta.RelativeDemandChangeType.RelativeDemandChangeTypeEnum|null);BestSellersProductClusterView relativeDemandChange.
reportCategoryId
public reportCategoryId?: (number|Long|string|null);BestSellersProductClusterView reportCategoryId.
reportCountryCode
public reportCountryCode?: (string|null);BestSellersProductClusterView reportCountryCode.
reportDate
public reportDate?: (google.type.IDate|null);BestSellersProductClusterView reportDate.
reportGranularity
public reportGranularity?: (google.shopping.merchant.reports.v1beta.ReportGranularity.ReportGranularityEnum|keyof typeof google.shopping.merchant.reports.v1beta.ReportGranularity.ReportGranularityEnum|null);BestSellersProductClusterView reportGranularity.
title
public title?: (string|null);BestSellersProductClusterView title.
variantGtins
public variantGtins: string[];BestSellersProductClusterView variantGtins.
Methods
create(properties)
public static create(properties?: google.shopping.merchant.reports.v1beta.IBestSellersProductClusterView): google.shopping.merchant.reports.v1beta.BestSellersProductClusterView;Creates a new BestSellersProductClusterView instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBestSellersProductClusterView
Properties to set |
| Returns | |
|---|---|
| Type | Description |
BestSellersProductClusterView |
BestSellersProductClusterView instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.shopping.merchant.reports.v1beta.BestSellersProductClusterView;Decodes a BestSellersProductClusterView 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 |
BestSellersProductClusterView |
BestSellersProductClusterView |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.shopping.merchant.reports.v1beta.BestSellersProductClusterView;Decodes a BestSellersProductClusterView message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
BestSellersProductClusterView |
BestSellersProductClusterView |
encode(message, writer)
public static encode(message: google.shopping.merchant.reports.v1beta.IBestSellersProductClusterView, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BestSellersProductClusterView message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBestSellersProductClusterView
BestSellersProductClusterView 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.IBestSellersProductClusterView, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BestSellersProductClusterView message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBestSellersProductClusterView
BestSellersProductClusterView 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.BestSellersProductClusterView;Creates a BestSellersProductClusterView 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 |
BestSellersProductClusterView |
BestSellersProductClusterView |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for BestSellersProductClusterView
| 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 BestSellersProductClusterView to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.shopping.merchant.reports.v1beta.BestSellersProductClusterView, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a BestSellersProductClusterView message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
BestSellersProductClusterView
BestSellersProductClusterView |
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 BestSellersProductClusterView message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|