Represents a CompetitiveVisibilityCompetitorView.
Package
@google-shopping/reportsConstructors
(constructor)(properties)
constructor(properties?: google.shopping.merchant.reports.v1beta.ICompetitiveVisibilityCompetitorView);Constructs a new CompetitiveVisibilityCompetitorView.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICompetitiveVisibilityCompetitorView
Properties to set |
Properties
_adsOrganicRatio
public _adsOrganicRatio?: "adsOrganicRatio";CompetitiveVisibilityCompetitorView _adsOrganicRatio.
_domain
public _domain?: "domain";CompetitiveVisibilityCompetitorView _domain.
_higherPositionRate
public _higherPositionRate?: "higherPositionRate";CompetitiveVisibilityCompetitorView _higherPositionRate.
_isYourDomain
public _isYourDomain?: "isYourDomain";CompetitiveVisibilityCompetitorView _isYourDomain.
_pageOverlapRate
public _pageOverlapRate?: "pageOverlapRate";CompetitiveVisibilityCompetitorView _pageOverlapRate.
_rank
public _rank?: "rank";CompetitiveVisibilityCompetitorView _rank.
_relativeVisibility
public _relativeVisibility?: "relativeVisibility";CompetitiveVisibilityCompetitorView _relativeVisibility.
_reportCategoryId
public _reportCategoryId?: "reportCategoryId";CompetitiveVisibilityCompetitorView _reportCategoryId.
_reportCountryCode
public _reportCountryCode?: "reportCountryCode";CompetitiveVisibilityCompetitorView _reportCountryCode.
_trafficSource
public _trafficSource?: "trafficSource";CompetitiveVisibilityCompetitorView _trafficSource.
adsOrganicRatio
public adsOrganicRatio?: (number|null);CompetitiveVisibilityCompetitorView adsOrganicRatio.
date
public date?: (google.type.IDate|null);CompetitiveVisibilityCompetitorView date.
domain
public domain?: (string|null);CompetitiveVisibilityCompetitorView domain.
higherPositionRate
public higherPositionRate?: (number|null);CompetitiveVisibilityCompetitorView higherPositionRate.
isYourDomain
public isYourDomain?: (boolean|null);CompetitiveVisibilityCompetitorView isYourDomain.
pageOverlapRate
public pageOverlapRate?: (number|null);CompetitiveVisibilityCompetitorView pageOverlapRate.
rank
public rank?: (number|Long|string|null);CompetitiveVisibilityCompetitorView rank.
relativeVisibility
public relativeVisibility?: (number|null);CompetitiveVisibilityCompetitorView relativeVisibility.
reportCategoryId
public reportCategoryId?: (number|Long|string|null);CompetitiveVisibilityCompetitorView reportCategoryId.
reportCountryCode
public reportCountryCode?: (string|null);CompetitiveVisibilityCompetitorView reportCountryCode.
trafficSource
public trafficSource?: (google.shopping.merchant.reports.v1beta.TrafficSource.TrafficSourceEnum|keyof typeof google.shopping.merchant.reports.v1beta.TrafficSource.TrafficSourceEnum|null);CompetitiveVisibilityCompetitorView trafficSource.
Methods
create(properties)
public static create(properties?: google.shopping.merchant.reports.v1beta.ICompetitiveVisibilityCompetitorView): google.shopping.merchant.reports.v1beta.CompetitiveVisibilityCompetitorView;Creates a new CompetitiveVisibilityCompetitorView instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICompetitiveVisibilityCompetitorView
Properties to set |
| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView |
CompetitiveVisibilityCompetitorView instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.shopping.merchant.reports.v1beta.CompetitiveVisibilityCompetitorView;Decodes a CompetitiveVisibilityCompetitorView 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 |
CompetitiveVisibilityCompetitorView |
CompetitiveVisibilityCompetitorView |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.shopping.merchant.reports.v1beta.CompetitiveVisibilityCompetitorView;Decodes a CompetitiveVisibilityCompetitorView message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView |
CompetitiveVisibilityCompetitorView |
encode(message, writer)
public static encode(message: google.shopping.merchant.reports.v1beta.ICompetitiveVisibilityCompetitorView, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CompetitiveVisibilityCompetitorView message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICompetitiveVisibilityCompetitorView
CompetitiveVisibilityCompetitorView 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.ICompetitiveVisibilityCompetitorView, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CompetitiveVisibilityCompetitorView message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICompetitiveVisibilityCompetitorView
CompetitiveVisibilityCompetitorView 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.CompetitiveVisibilityCompetitorView;Creates a CompetitiveVisibilityCompetitorView 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 |
CompetitiveVisibilityCompetitorView |
CompetitiveVisibilityCompetitorView |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for CompetitiveVisibilityCompetitorView
| 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 CompetitiveVisibilityCompetitorView to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.shopping.merchant.reports.v1beta.CompetitiveVisibilityCompetitorView, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a CompetitiveVisibilityCompetitorView message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
CompetitiveVisibilityCompetitorView
CompetitiveVisibilityCompetitorView |
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 CompetitiveVisibilityCompetitorView message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|