Interface CompetitiveVisibilityCompetitorViewOrBuilder (0.31.0)

public interface CompetitiveVisibilityCompetitorViewOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdsOrganicRatio()

public abstract double getAdsOrganicRatio()

Ads / organic ratio shows how often the domain receives impressions from Shopping ads compared to organic traffic. The number is rounded and bucketed.

Cannot be filtered on in the 'WHERE' clause.

optional double ads_organic_ratio = 8;

Returns
Type Description
double

The adsOrganicRatio.

getDate()

public abstract Date getDate()

Date of this row.

A condition on date is required in the WHERE clause.

.google.type.Date date = 1;

Returns
Type Description
com.google.type.Date

The date.

getDateOrBuilder()

public abstract DateOrBuilder getDateOrBuilder()

Date of this row.

A condition on date is required in the WHERE clause.

.google.type.Date date = 1;

Returns
Type Description
com.google.type.DateOrBuilder

getDomain()

public abstract String getDomain()

Domain of your competitor or your domain, if 'is_your_domain' is true.

Required in the SELECT clause. Cannot be filtered on in the 'WHERE' clause.

optional string domain = 2;

Returns
Type Description
String

The domain.

getDomainBytes()

public abstract ByteString getDomainBytes()

Domain of your competitor or your domain, if 'is_your_domain' is true.

Required in the SELECT clause. Cannot be filtered on in the 'WHERE' clause.

optional string domain = 2;

Returns
Type Description
ByteString

The bytes for domain.

getHigherPositionRate()

public abstract double getHigherPositionRate()

Higher position rate shows how often a competitor’s offer got placed in a higher position on the page than your offer.

Cannot be filtered on in the 'WHERE' clause.

optional double higher_position_rate = 10;

Returns
Type Description
double

The higherPositionRate.

getIsYourDomain()

public abstract boolean getIsYourDomain()

True if this row contains data for your domain.

Cannot be filtered on in the 'WHERE' clause.

optional bool is_your_domain = 3;

Returns
Type Description
boolean

The isYourDomain.

getPageOverlapRate()

public abstract double getPageOverlapRate()

Page overlap rate shows how frequently competing retailers’ offers are shown together with your offers on the same page.

Cannot be filtered on in the 'WHERE' clause.

optional double page_overlap_rate = 9;

Returns
Type Description
double

The pageOverlapRate.

getRank()

public abstract long getRank()

Position of the domain in the similar businesses ranking for the selected keys (date, report_category_id, report_country_code, traffic_source) based on impressions. 1 is the highest.

Cannot be filtered on in the 'WHERE' clause.

optional int64 rank = 7;

Returns
Type Description
long

The rank.

getRelativeVisibility()

public abstract double getRelativeVisibility()

Relative visibility shows how often your competitors’ offers are shown compared to your offers. In other words, this is the number of displayed impressions of a competitor retailer divided by the number of your displayed impressions during a selected time range for a selected product category and country.

Cannot be filtered on in the 'WHERE' clause.

optional double relative_visibility = 11;

Returns
Type Description
double

The relativeVisibility.

getReportCategoryId()

public abstract long getReportCategoryId()

Google product category ID to calculate the report for, represented in Google's product taxonomy.

Required in the SELECT clause. A condition on report_category_id is required in the WHERE clause.

optional int64 report_category_id = 5;

Returns
Type Description
long

The reportCategoryId.

getReportCountryCode()

public abstract String getReportCountryCode()

Country where impressions appeared.

Required in the SELECT clause. A condition on report_country_code is required in the WHERE clause.

optional string report_country_code = 4;

Returns
Type Description
String

The reportCountryCode.

getReportCountryCodeBytes()

public abstract ByteString getReportCountryCodeBytes()

Country where impressions appeared.

Required in the SELECT clause. A condition on report_country_code is required in the WHERE clause.

optional string report_country_code = 4;

Returns
Type Description
ByteString

The bytes for reportCountryCode.

getTrafficSource()

public abstract TrafficSource.TrafficSourceEnum getTrafficSource()

Traffic source of impressions.

Required in the SELECT clause.

optional .google.shopping.merchant.reports.v1beta.TrafficSource.TrafficSourceEnum traffic_source = 6;

Returns
Type Description
TrafficSource.TrafficSourceEnum

The trafficSource.

getTrafficSourceValue()

public abstract int getTrafficSourceValue()

Traffic source of impressions.

Required in the SELECT clause.

optional .google.shopping.merchant.reports.v1beta.TrafficSource.TrafficSourceEnum traffic_source = 6;

Returns
Type Description
int

The enum numeric value on the wire for trafficSource.

hasAdsOrganicRatio()

public abstract boolean hasAdsOrganicRatio()

Ads / organic ratio shows how often the domain receives impressions from Shopping ads compared to organic traffic. The number is rounded and bucketed.

Cannot be filtered on in the 'WHERE' clause.

optional double ads_organic_ratio = 8;

Returns
Type Description
boolean

Whether the adsOrganicRatio field is set.

hasDate()

public abstract boolean hasDate()

Date of this row.

A condition on date is required in the WHERE clause.

.google.type.Date date = 1;

Returns
Type Description
boolean

Whether the date field is set.

hasDomain()

public abstract boolean hasDomain()

Domain of your competitor or your domain, if 'is_your_domain' is true.

Required in the SELECT clause. Cannot be filtered on in the 'WHERE' clause.

optional string domain = 2;

Returns
Type Description
boolean

Whether the domain field is set.

hasHigherPositionRate()

public abstract boolean hasHigherPositionRate()

Higher position rate shows how often a competitor’s offer got placed in a higher position on the page than your offer.

Cannot be filtered on in the 'WHERE' clause.

optional double higher_position_rate = 10;

Returns
Type Description
boolean

Whether the higherPositionRate field is set.

hasIsYourDomain()

public abstract boolean hasIsYourDomain()

True if this row contains data for your domain.

Cannot be filtered on in the 'WHERE' clause.

optional bool is_your_domain = 3;

Returns
Type Description
boolean

Whether the isYourDomain field is set.

hasPageOverlapRate()

public abstract boolean hasPageOverlapRate()

Page overlap rate shows how frequently competing retailers’ offers are shown together with your offers on the same page.

Cannot be filtered on in the 'WHERE' clause.

optional double page_overlap_rate = 9;

Returns
Type Description
boolean

Whether the pageOverlapRate field is set.

hasRank()

public abstract boolean hasRank()

Position of the domain in the similar businesses ranking for the selected keys (date, report_category_id, report_country_code, traffic_source) based on impressions. 1 is the highest.

Cannot be filtered on in the 'WHERE' clause.

optional int64 rank = 7;

Returns
Type Description
boolean

Whether the rank field is set.

hasRelativeVisibility()

public abstract boolean hasRelativeVisibility()

Relative visibility shows how often your competitors’ offers are shown compared to your offers. In other words, this is the number of displayed impressions of a competitor retailer divided by the number of your displayed impressions during a selected time range for a selected product category and country.

Cannot be filtered on in the 'WHERE' clause.

optional double relative_visibility = 11;

Returns
Type Description
boolean

Whether the relativeVisibility field is set.

hasReportCategoryId()

public abstract boolean hasReportCategoryId()

Google product category ID to calculate the report for, represented in Google's product taxonomy.

Required in the SELECT clause. A condition on report_category_id is required in the WHERE clause.

optional int64 report_category_id = 5;

Returns
Type Description
boolean

Whether the reportCategoryId field is set.

hasReportCountryCode()

public abstract boolean hasReportCountryCode()

Country where impressions appeared.

Required in the SELECT clause. A condition on report_country_code is required in the WHERE clause.

optional string report_country_code = 4;

Returns
Type Description
boolean

Whether the reportCountryCode field is set.

hasTrafficSource()

public abstract boolean hasTrafficSource()

Traffic source of impressions.

Required in the SELECT clause.

optional .google.shopping.merchant.reports.v1beta.TrafficSource.TrafficSourceEnum traffic_source = 6;

Returns
Type Description
boolean

Whether the trafficSource field is set.