Class CompetitiveVisibilityCompetitorView.Builder (0.30.0)

public static final class CompetitiveVisibilityCompetitorView.Builder extends GeneratedMessageV3.Builder<CompetitiveVisibilityCompetitorView.Builder> implements CompetitiveVisibilityCompetitorViewOrBuilder

Fields available for query in competitive_visibility_competitor_view table.

Competitive visibility report with businesses with similar visibility.

Values are only set for fields requested explicitly in the request's search query.

Protobuf type google.shopping.merchant.reports.v1beta.CompetitiveVisibilityCompetitorView

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CompetitiveVisibilityCompetitorView.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder
Overrides

build()

public CompetitiveVisibilityCompetitorView build()
Returns
Type Description
CompetitiveVisibilityCompetitorView

buildPartial()

public CompetitiveVisibilityCompetitorView buildPartial()
Returns
Type Description
CompetitiveVisibilityCompetitorView

clear()

public CompetitiveVisibilityCompetitorView.Builder clear()
Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder
Overrides

clearAdsOrganicRatio()

public CompetitiveVisibilityCompetitorView.Builder clearAdsOrganicRatio()

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
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

clearDate()

public CompetitiveVisibilityCompetitorView.Builder clearDate()

Date of this row.

A condition on date is required in the WHERE clause.

.google.type.Date date = 1;

Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

clearDomain()

public CompetitiveVisibilityCompetitorView.Builder clearDomain()

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
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CompetitiveVisibilityCompetitorView.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder
Overrides

clearHigherPositionRate()

public CompetitiveVisibilityCompetitorView.Builder clearHigherPositionRate()

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
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

clearIsYourDomain()

public CompetitiveVisibilityCompetitorView.Builder clearIsYourDomain()

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
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CompetitiveVisibilityCompetitorView.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder
Overrides

clearPageOverlapRate()

public CompetitiveVisibilityCompetitorView.Builder clearPageOverlapRate()

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
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

clearRank()

public CompetitiveVisibilityCompetitorView.Builder clearRank()

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
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

clearRelativeVisibility()

public CompetitiveVisibilityCompetitorView.Builder clearRelativeVisibility()

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
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

clearReportCategoryId()

public CompetitiveVisibilityCompetitorView.Builder clearReportCategoryId()

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
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

clearReportCountryCode()

public CompetitiveVisibilityCompetitorView.Builder clearReportCountryCode()

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
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

clearTrafficSource()

public CompetitiveVisibilityCompetitorView.Builder clearTrafficSource()

Traffic source of impressions.

Required in the SELECT clause.

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

Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

clone()

public CompetitiveVisibilityCompetitorView.Builder clone()
Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder
Overrides

getAdsOrganicRatio()

public 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 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.

getDateBuilder()

public Date.Builder getDateBuilder()

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.Builder

getDateOrBuilder()

public 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

getDefaultInstanceForType()

public CompetitiveVisibilityCompetitorView getDefaultInstanceForType()
Returns
Type Description
CompetitiveVisibilityCompetitorView

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDomain()

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDate(Date value)

public CompetitiveVisibilityCompetitorView.Builder mergeDate(Date value)

Date of this row.

A condition on date is required in the WHERE clause.

.google.type.Date date = 1;

Parameter
Name Description
value com.google.type.Date
Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CompetitiveVisibilityCompetitorView.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CompetitiveVisibilityCompetitorView.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder
Overrides

mergeFrom(CompetitiveVisibilityCompetitorView other)

public CompetitiveVisibilityCompetitorView.Builder mergeFrom(CompetitiveVisibilityCompetitorView other)
Parameter
Name Description
other CompetitiveVisibilityCompetitorView
Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CompetitiveVisibilityCompetitorView.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder
Overrides

setAdsOrganicRatio(double value)

public CompetitiveVisibilityCompetitorView.Builder setAdsOrganicRatio(double value)

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;

Parameter
Name Description
value double

The adsOrganicRatio to set.

Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

setDate(Date value)

public CompetitiveVisibilityCompetitorView.Builder setDate(Date value)

Date of this row.

A condition on date is required in the WHERE clause.

.google.type.Date date = 1;

Parameter
Name Description
value com.google.type.Date
Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

setDate(Date.Builder builderForValue)

public CompetitiveVisibilityCompetitorView.Builder setDate(Date.Builder builderForValue)

Date of this row.

A condition on date is required in the WHERE clause.

.google.type.Date date = 1;

Parameter
Name Description
builderForValue com.google.type.Date.Builder
Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

setDomain(String value)

public CompetitiveVisibilityCompetitorView.Builder setDomain(String value)

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;

Parameter
Name Description
value String

The domain to set.

Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

setDomainBytes(ByteString value)

public CompetitiveVisibilityCompetitorView.Builder setDomainBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for domain to set.

Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CompetitiveVisibilityCompetitorView.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder
Overrides

setHigherPositionRate(double value)

public CompetitiveVisibilityCompetitorView.Builder setHigherPositionRate(double value)

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;

Parameter
Name Description
value double

The higherPositionRate to set.

Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

setIsYourDomain(boolean value)

public CompetitiveVisibilityCompetitorView.Builder setIsYourDomain(boolean value)

True if this row contains data for your domain.

Cannot be filtered on in the 'WHERE' clause.

optional bool is_your_domain = 3;

Parameter
Name Description
value boolean

The isYourDomain to set.

Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

setPageOverlapRate(double value)

public CompetitiveVisibilityCompetitorView.Builder setPageOverlapRate(double value)

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;

Parameter
Name Description
value double

The pageOverlapRate to set.

Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

setRank(long value)

public CompetitiveVisibilityCompetitorView.Builder setRank(long value)

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;

Parameter
Name Description
value long

The rank to set.

Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

setRelativeVisibility(double value)

public CompetitiveVisibilityCompetitorView.Builder setRelativeVisibility(double value)

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;

Parameter
Name Description
value double

The relativeVisibility to set.

Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CompetitiveVisibilityCompetitorView.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder
Overrides

setReportCategoryId(long value)

public CompetitiveVisibilityCompetitorView.Builder setReportCategoryId(long value)

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;

Parameter
Name Description
value long

The reportCategoryId to set.

Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

setReportCountryCode(String value)

public CompetitiveVisibilityCompetitorView.Builder setReportCountryCode(String value)

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;

Parameter
Name Description
value String

The reportCountryCode to set.

Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

setReportCountryCodeBytes(ByteString value)

public CompetitiveVisibilityCompetitorView.Builder setReportCountryCodeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for reportCountryCode to set.

Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

setTrafficSource(TrafficSource.TrafficSourceEnum value)

public CompetitiveVisibilityCompetitorView.Builder setTrafficSource(TrafficSource.TrafficSourceEnum value)

Traffic source of impressions.

Required in the SELECT clause.

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

Parameter
Name Description
value TrafficSource.TrafficSourceEnum

The trafficSource to set.

Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

setTrafficSourceValue(int value)

public CompetitiveVisibilityCompetitorView.Builder setTrafficSourceValue(int value)

Traffic source of impressions.

Required in the SELECT clause.

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

Parameter
Name Description
value int

The enum numeric value on the wire for trafficSource to set.

Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CompetitiveVisibilityCompetitorView.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CompetitiveVisibilityCompetitorView.Builder
Overrides