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

Represents a CompetitiveVisibilityBenchmarkView.

Package

@google-shopping/reports

Constructors

(constructor)(properties)

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

Constructs a new CompetitiveVisibilityBenchmarkView.

Parameter
Name Description
properties ICompetitiveVisibilityBenchmarkView

Properties to set

Properties

_categoryBenchmarkVisibilityTrend

public _categoryBenchmarkVisibilityTrend?: "categoryBenchmarkVisibilityTrend";

CompetitiveVisibilityBenchmarkView _categoryBenchmarkVisibilityTrend.

_reportCategoryId

public _reportCategoryId?: "reportCategoryId";

CompetitiveVisibilityBenchmarkView _reportCategoryId.

_reportCountryCode

public _reportCountryCode?: "reportCountryCode";

CompetitiveVisibilityBenchmarkView _reportCountryCode.

_trafficSource

public _trafficSource?: "trafficSource";

CompetitiveVisibilityBenchmarkView _trafficSource.

_yourDomainVisibilityTrend

public _yourDomainVisibilityTrend?: "yourDomainVisibilityTrend";

CompetitiveVisibilityBenchmarkView _yourDomainVisibilityTrend.

categoryBenchmarkVisibilityTrend

public categoryBenchmarkVisibilityTrend?: (number|null);

CompetitiveVisibilityBenchmarkView categoryBenchmarkVisibilityTrend.

date

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

CompetitiveVisibilityBenchmarkView date.

reportCategoryId

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

CompetitiveVisibilityBenchmarkView reportCategoryId.

reportCountryCode

public reportCountryCode?: (string|null);

CompetitiveVisibilityBenchmarkView reportCountryCode.

trafficSource

public trafficSource?: (google.shopping.merchant.reports.v1beta.TrafficSource.TrafficSourceEnum|keyof typeof google.shopping.merchant.reports.v1beta.TrafficSource.TrafficSourceEnum|null);

CompetitiveVisibilityBenchmarkView trafficSource.

yourDomainVisibilityTrend

public yourDomainVisibilityTrend?: (number|null);

CompetitiveVisibilityBenchmarkView yourDomainVisibilityTrend.

Methods

create(properties)

public static create(properties?: google.shopping.merchant.reports.v1beta.ICompetitiveVisibilityBenchmarkView): google.shopping.merchant.reports.v1beta.CompetitiveVisibilityBenchmarkView;

Creates a new CompetitiveVisibilityBenchmarkView instance using the specified properties.

Parameter
Name Description
properties ICompetitiveVisibilityBenchmarkView

Properties to set

Returns
Type Description
CompetitiveVisibilityBenchmarkView

CompetitiveVisibilityBenchmarkView instance

decode(reader, length)

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

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

CompetitiveVisibilityBenchmarkView

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CompetitiveVisibilityBenchmarkView

CompetitiveVisibilityBenchmarkView

encode(message, writer)

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

Encodes the specified CompetitiveVisibilityBenchmarkView message. Does not implicitly messages.

Parameters
Name Description
message ICompetitiveVisibilityBenchmarkView

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

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

Parameters
Name Description
message ICompetitiveVisibilityBenchmarkView

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

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

CompetitiveVisibilityBenchmarkView

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CompetitiveVisibilityBenchmarkView

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message CompetitiveVisibilityBenchmarkView

CompetitiveVisibilityBenchmarkView

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