Class protos.google.shopping.merchant.reports.v1beta.ProductPerformanceView (0.9.0)

Represents a ProductPerformanceView.

Package

@google-shopping/reports

Constructors

(constructor)(properties)

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

Constructs a new ProductPerformanceView.

Parameter
Name Description
properties IProductPerformanceView

Properties to set

Properties

brand

public brand?: (string|null);

ProductPerformanceView brand.

categoryL1

public categoryL1?: (string|null);

ProductPerformanceView categoryL1.

categoryL2

public categoryL2?: (string|null);

ProductPerformanceView categoryL2.

categoryL3

public categoryL3?: (string|null);

ProductPerformanceView categoryL3.

categoryL4

public categoryL4?: (string|null);

ProductPerformanceView categoryL4.

categoryL5

public categoryL5?: (string|null);

ProductPerformanceView categoryL5.

clicks

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

ProductPerformanceView clicks.

clickThroughRate

public clickThroughRate?: (number|null);

ProductPerformanceView clickThroughRate.

conversionRate

public conversionRate?: (number|null);

ProductPerformanceView conversionRate.

conversions

public conversions?: (number|null);

ProductPerformanceView conversions.

conversionValue

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

ProductPerformanceView conversionValue.

customerCountryCode

public customerCountryCode?: (string|null);

ProductPerformanceView customerCountryCode.

customLabel0

public customLabel0?: (string|null);

ProductPerformanceView customLabel0.

customLabel1

public customLabel1?: (string|null);

ProductPerformanceView customLabel1.

customLabel2

public customLabel2?: (string|null);

ProductPerformanceView customLabel2.

customLabel3

public customLabel3?: (string|null);

ProductPerformanceView customLabel3.

customLabel4

public customLabel4?: (string|null);

ProductPerformanceView customLabel4.

date

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

ProductPerformanceView date.

impressions

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

ProductPerformanceView impressions.

marketingMethod

public marketingMethod?: (google.shopping.merchant.reports.v1beta.MarketingMethod.MarketingMethodEnum|keyof typeof google.shopping.merchant.reports.v1beta.MarketingMethod.MarketingMethodEnum|null);

ProductPerformanceView marketingMethod.

offerId

public offerId?: (string|null);

ProductPerformanceView offerId.

productTypeL1

public productTypeL1?: (string|null);

ProductPerformanceView productTypeL1.

productTypeL2

public productTypeL2?: (string|null);

ProductPerformanceView productTypeL2.

productTypeL3

public productTypeL3?: (string|null);

ProductPerformanceView productTypeL3.

productTypeL4

public productTypeL4?: (string|null);

ProductPerformanceView productTypeL4.

productTypeL5

public productTypeL5?: (string|null);

ProductPerformanceView productTypeL5.

title

public title?: (string|null);

ProductPerformanceView title.

week

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

ProductPerformanceView week.

Methods

create(properties)

public static create(properties?: google.shopping.merchant.reports.v1beta.IProductPerformanceView): google.shopping.merchant.reports.v1beta.ProductPerformanceView;

Creates a new ProductPerformanceView instance using the specified properties.

Parameter
Name Description
properties IProductPerformanceView

Properties to set
Returns
Type Description
ProductPerformanceView

ProductPerformanceView instance

decode(reader, length)

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

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

ProductPerformanceView

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
ProductPerformanceView

ProductPerformanceView

encode(message, writer)

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

Encodes the specified ProductPerformanceView message. Does not implicitly messages.

Parameters
Name Description
message IProductPerformanceView

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

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

Parameters
Name Description
message IProductPerformanceView

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

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

ProductPerformanceView

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ProductPerformanceView

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ProductPerformanceView

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