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

Represents a ProductView.

Package

@google-shopping/reports

Constructors

(constructor)(properties)

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

Constructs a new ProductView.

Parameter
Name Description
properties IProductView

Properties to set

Properties

_aggregatedReportingContextStatus

public _aggregatedReportingContextStatus?: "aggregatedReportingContextStatus";

ProductView _aggregatedReportingContextStatus.

_availability

public _availability?: "availability";

ProductView _availability.

_brand

public _brand?: "brand";

ProductView _brand.

_categoryL1

public _categoryL1?: "categoryL1";

ProductView _categoryL1.

_categoryL2

public _categoryL2?: "categoryL2";

ProductView _categoryL2.

_categoryL3

public _categoryL3?: "categoryL3";

ProductView _categoryL3.

_categoryL4

public _categoryL4?: "categoryL4";

ProductView _categoryL4.

_categoryL5

public _categoryL5?: "categoryL5";

ProductView _categoryL5.

_channel

public _channel?: "channel";

ProductView _channel.

_clickPotentialRank

public _clickPotentialRank?: "clickPotentialRank";

ProductView _clickPotentialRank.

_condition

public _condition?: "condition";

ProductView _condition.

_feedLabel

public _feedLabel?: "feedLabel";

ProductView _feedLabel.

_id

public _id?: "id";

ProductView _id.

_itemGroupId

public _itemGroupId?: "itemGroupId";

ProductView _itemGroupId.

_languageCode

public _languageCode?: "languageCode";

ProductView _languageCode.

_offerId

public _offerId?: "offerId";

ProductView _offerId.

_productTypeL1

public _productTypeL1?: "productTypeL1";

ProductView _productTypeL1.

_productTypeL2

public _productTypeL2?: "productTypeL2";

ProductView _productTypeL2.

_productTypeL3

public _productTypeL3?: "productTypeL3";

ProductView _productTypeL3.

_productTypeL4

public _productTypeL4?: "productTypeL4";

ProductView _productTypeL4.

_productTypeL5

public _productTypeL5?: "productTypeL5";

ProductView _productTypeL5.

_shippingLabel

public _shippingLabel?: "shippingLabel";

ProductView _shippingLabel.

public _thumbnailLink?: "thumbnailLink";

ProductView _thumbnailLink.

_title

public _title?: "title";

ProductView _title.

aggregatedReportingContextStatus

public aggregatedReportingContextStatus?: (google.shopping.merchant.reports.v1beta.ProductView.AggregatedReportingContextStatus|keyof typeof google.shopping.merchant.reports.v1beta.ProductView.AggregatedReportingContextStatus|null);

ProductView aggregatedReportingContextStatus.

availability

public availability?: (string|null);

ProductView availability.

brand

public brand?: (string|null);

ProductView brand.

categoryL1

public categoryL1?: (string|null);

ProductView categoryL1.

categoryL2

public categoryL2?: (string|null);

ProductView categoryL2.

categoryL3

public categoryL3?: (string|null);

ProductView categoryL3.

categoryL4

public categoryL4?: (string|null);

ProductView categoryL4.

categoryL5

public categoryL5?: (string|null);

ProductView categoryL5.

channel

public channel?: (google.shopping.type.Channel.ChannelEnum|keyof typeof google.shopping.type.Channel.ChannelEnum|null);

ProductView channel.

clickPotential

public clickPotential: (google.shopping.merchant.reports.v1beta.ProductView.ClickPotential|keyof typeof google.shopping.merchant.reports.v1beta.ProductView.ClickPotential);

ProductView clickPotential.

clickPotentialRank

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

ProductView clickPotentialRank.

condition

public condition?: (string|null);

ProductView condition.

creationTime

public creationTime?: (google.protobuf.ITimestamp|null);

ProductView creationTime.

expirationDate

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

ProductView expirationDate.

feedLabel

public feedLabel?: (string|null);

ProductView feedLabel.

gtin

public gtin: string[];

ProductView gtin.

id

public id?: (string|null);

ProductView id.

itemGroupId

public itemGroupId?: (string|null);

ProductView itemGroupId.

itemIssues

public itemIssues: google.shopping.merchant.reports.v1beta.ProductView.IItemIssue[];

ProductView itemIssues.

languageCode

public languageCode?: (string|null);

ProductView languageCode.

offerId

public offerId?: (string|null);

ProductView offerId.

price

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

ProductView price.

productTypeL1

public productTypeL1?: (string|null);

ProductView productTypeL1.

productTypeL2

public productTypeL2?: (string|null);

ProductView productTypeL2.

productTypeL3

public productTypeL3?: (string|null);

ProductView productTypeL3.

productTypeL4

public productTypeL4?: (string|null);

ProductView productTypeL4.

productTypeL5

public productTypeL5?: (string|null);

ProductView productTypeL5.

shippingLabel

public shippingLabel?: (string|null);

ProductView shippingLabel.

public thumbnailLink?: (string|null);

ProductView thumbnailLink.

title

public title?: (string|null);

ProductView title.

Methods

create(properties)

public static create(properties?: google.shopping.merchant.reports.v1beta.IProductView): google.shopping.merchant.reports.v1beta.ProductView;

Creates a new ProductView instance using the specified properties.

Parameter
Name Description
properties IProductView

Properties to set

Returns
Type Description
ProductView

ProductView instance

decode(reader, length)

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

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

ProductView

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ProductView

ProductView

encode(message, writer)

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

Encodes the specified ProductView message. Does not implicitly messages.

Parameters
Name Description
message IProductView

ProductView 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.IProductView, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IProductView

ProductView 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.ProductView;

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

ProductView

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ProductView

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ProductView

ProductView

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