Class CompetitiveVisibilityCompetitorView.Builder (0.15.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CompetitiveVisibilityCompetitorView.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CompetitiveVisibilityCompetitorView.Builder
Overrides

build()

public CompetitiveVisibilityCompetitorView build()
Returns
TypeDescription
CompetitiveVisibilityCompetitorView

buildPartial()

public CompetitiveVisibilityCompetitorView buildPartial()
Returns
TypeDescription
CompetitiveVisibilityCompetitorView

clear()

public CompetitiveVisibilityCompetitorView.Builder clear()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CompetitiveVisibilityCompetitorView.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CompetitiveVisibilityCompetitorView.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

clone()

public CompetitiveVisibilityCompetitorView.Builder clone()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
com.google.type.DateOrBuilder

getDefaultInstanceForType()

public CompetitiveVisibilityCompetitorView getDefaultInstanceForType()
Returns
TypeDescription
CompetitiveVisibilityCompetitorView

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the trafficSource field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
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
NameDescription
valuecom.google.type.Date
Returns
TypeDescription
CompetitiveVisibilityCompetitorView.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CompetitiveVisibilityCompetitorView.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompetitiveVisibilityCompetitorView.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CompetitiveVisibilityCompetitorView.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CompetitiveVisibilityCompetitorView.Builder
Overrides

mergeFrom(CompetitiveVisibilityCompetitorView other)

public CompetitiveVisibilityCompetitorView.Builder mergeFrom(CompetitiveVisibilityCompetitorView other)
Parameter
NameDescription
otherCompetitiveVisibilityCompetitorView
Returns
TypeDescription
CompetitiveVisibilityCompetitorView.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CompetitiveVisibilityCompetitorView.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valuedouble

The adsOrganicRatio to set.

Returns
TypeDescription
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
NameDescription
valuecom.google.type.Date
Returns
TypeDescription
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
NameDescription
builderForValuecom.google.type.Date.Builder
Returns
TypeDescription
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
NameDescription
valueString

The domain to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for domain to set.

Returns
TypeDescription
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CompetitiveVisibilityCompetitorView.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valuedouble

The higherPositionRate to set.

Returns
TypeDescription
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
NameDescription
valueboolean

The isYourDomain to set.

Returns
TypeDescription
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
NameDescription
valuedouble

The pageOverlapRate to set.

Returns
TypeDescription
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
NameDescription
valuelong

The rank to set.

Returns
TypeDescription
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
NameDescription
valuedouble

The relativeVisibility to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valuelong

The reportCategoryId to set.

Returns
TypeDescription
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
NameDescription
valueString

The reportCountryCode to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for reportCountryCode to set.

Returns
TypeDescription
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
NameDescription
valueTrafficSource.TrafficSourceEnum

The trafficSource to set.

Returns
TypeDescription
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
NameDescription
valueint

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

Returns
TypeDescription
CompetitiveVisibilityCompetitorView.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CompetitiveVisibilityCompetitorView.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CompetitiveVisibilityCompetitorView.Builder
Overrides