Class CompetitiveVisibilityBenchmarkView.Builder (0.20.0)

public static final class CompetitiveVisibilityBenchmarkView.Builder extends GeneratedMessageV3.Builder<CompetitiveVisibilityBenchmarkView.Builder> implements CompetitiveVisibilityBenchmarkViewOrBuilder

Fields available for query in competitive_visibility_benchmark_view table.

Competitive visibility report with the category benchmark.

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

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public CompetitiveVisibilityBenchmarkView build()
Returns
Type Description
CompetitiveVisibilityBenchmarkView

buildPartial()

public CompetitiveVisibilityBenchmarkView buildPartial()
Returns
Type Description
CompetitiveVisibilityBenchmarkView

clear()

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

clearCategoryBenchmarkVisibilityTrend()

public CompetitiveVisibilityBenchmarkView.Builder clearCategoryBenchmarkVisibilityTrend()

Change in visibility based on impressions with respect to the start of the selected time range (or first day with non-zero impressions) for a combined set of merchants with highest visibility approximating the market.

Cannot be filtered on in the 'WHERE' clause.

optional double category_benchmark_visibility_trend = 6;

Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

This builder for chaining.

clearDate()

public CompetitiveVisibilityBenchmarkView.Builder clearDate()

Date of this row.

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

.google.type.Date date = 1;

Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearReportCategoryId()

public CompetitiveVisibilityBenchmarkView.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 = 3;

Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

This builder for chaining.

clearReportCountryCode()

public CompetitiveVisibilityBenchmarkView.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 = 2;

Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

This builder for chaining.

clearTrafficSource()

public CompetitiveVisibilityBenchmarkView.Builder clearTrafficSource()

Traffic source of impressions.

Required in the SELECT clause.

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

Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

This builder for chaining.

clearYourDomainVisibilityTrend()

public CompetitiveVisibilityBenchmarkView.Builder clearYourDomainVisibilityTrend()

Change in visibility based on impressions for your domain with respect to the start of the selected time range (or first day with non-zero impressions).

Cannot be filtered on in the 'WHERE' clause.

optional double your_domain_visibility_trend = 5;

Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

This builder for chaining.

clone()

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

getCategoryBenchmarkVisibilityTrend()

public double getCategoryBenchmarkVisibilityTrend()

Change in visibility based on impressions with respect to the start of the selected time range (or first day with non-zero impressions) for a combined set of merchants with highest visibility approximating the market.

Cannot be filtered on in the 'WHERE' clause.

optional double category_benchmark_visibility_trend = 6;

Returns
Type Description
double

The categoryBenchmarkVisibilityTrend.

getDate()

public Date getDate()

Date of this row.

Required in the SELECT clause. 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.

Required in the SELECT clause. 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.

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

.google.type.Date date = 1;

Returns
Type Description
com.google.type.DateOrBuilder

getDefaultInstanceForType()

public CompetitiveVisibilityBenchmarkView getDefaultInstanceForType()
Returns
Type Description
CompetitiveVisibilityBenchmarkView

getDescriptorForType()

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

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 = 3;

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 = 2;

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 = 2;

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 = 4;

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 = 4;

Returns
Type Description
int

The enum numeric value on the wire for trafficSource.

getYourDomainVisibilityTrend()

public double getYourDomainVisibilityTrend()

Change in visibility based on impressions for your domain with respect to the start of the selected time range (or first day with non-zero impressions).

Cannot be filtered on in the 'WHERE' clause.

optional double your_domain_visibility_trend = 5;

Returns
Type Description
double

The yourDomainVisibilityTrend.

hasCategoryBenchmarkVisibilityTrend()

public boolean hasCategoryBenchmarkVisibilityTrend()

Change in visibility based on impressions with respect to the start of the selected time range (or first day with non-zero impressions) for a combined set of merchants with highest visibility approximating the market.

Cannot be filtered on in the 'WHERE' clause.

optional double category_benchmark_visibility_trend = 6;

Returns
Type Description
boolean

Whether the categoryBenchmarkVisibilityTrend field is set.

hasDate()

public boolean hasDate()

Date of this row.

Required in the SELECT clause. 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.

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 = 3;

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 = 2;

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 = 4;

Returns
Type Description
boolean

Whether the trafficSource field is set.

hasYourDomainVisibilityTrend()

public boolean hasYourDomainVisibilityTrend()

Change in visibility based on impressions for your domain with respect to the start of the selected time range (or first day with non-zero impressions).

Cannot be filtered on in the 'WHERE' clause.

optional double your_domain_visibility_trend = 5;

Returns
Type Description
boolean

Whether the yourDomainVisibilityTrend 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 CompetitiveVisibilityBenchmarkView.Builder mergeDate(Date value)

Date of this row.

Required in the SELECT clause. 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
CompetitiveVisibilityBenchmarkView.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(CompetitiveVisibilityBenchmarkView other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCategoryBenchmarkVisibilityTrend(double value)

public CompetitiveVisibilityBenchmarkView.Builder setCategoryBenchmarkVisibilityTrend(double value)

Change in visibility based on impressions with respect to the start of the selected time range (or first day with non-zero impressions) for a combined set of merchants with highest visibility approximating the market.

Cannot be filtered on in the 'WHERE' clause.

optional double category_benchmark_visibility_trend = 6;

Parameter
Name Description
value double

The categoryBenchmarkVisibilityTrend to set.

Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

This builder for chaining.

setDate(Date value)

public CompetitiveVisibilityBenchmarkView.Builder setDate(Date value)

Date of this row.

Required in the SELECT clause. 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
CompetitiveVisibilityBenchmarkView.Builder

setDate(Date.Builder builderForValue)

public CompetitiveVisibilityBenchmarkView.Builder setDate(Date.Builder builderForValue)

Date of this row.

Required in the SELECT clause. 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
CompetitiveVisibilityBenchmarkView.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setReportCategoryId(long value)

public CompetitiveVisibilityBenchmarkView.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 = 3;

Parameter
Name Description
value long

The reportCategoryId to set.

Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

This builder for chaining.

setReportCountryCode(String value)

public CompetitiveVisibilityBenchmarkView.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 = 2;

Parameter
Name Description
value String

The reportCountryCode to set.

Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

This builder for chaining.

setReportCountryCodeBytes(ByteString value)

public CompetitiveVisibilityBenchmarkView.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 = 2;

Parameter
Name Description
value ByteString

The bytes for reportCountryCode to set.

Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

This builder for chaining.

setTrafficSource(TrafficSource.TrafficSourceEnum value)

public CompetitiveVisibilityBenchmarkView.Builder setTrafficSource(TrafficSource.TrafficSourceEnum value)

Traffic source of impressions.

Required in the SELECT clause.

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

Parameter
Name Description
value TrafficSource.TrafficSourceEnum

The trafficSource to set.

Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

This builder for chaining.

setTrafficSourceValue(int value)

public CompetitiveVisibilityBenchmarkView.Builder setTrafficSourceValue(int value)

Traffic source of impressions.

Required in the SELECT clause.

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

Parameter
Name Description
value int

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

Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setYourDomainVisibilityTrend(double value)

public CompetitiveVisibilityBenchmarkView.Builder setYourDomainVisibilityTrend(double value)

Change in visibility based on impressions for your domain with respect to the start of the selected time range (or first day with non-zero impressions).

Cannot be filtered on in the 'WHERE' clause.

optional double your_domain_visibility_trend = 5;

Parameter
Name Description
value double

The yourDomainVisibilityTrend to set.

Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

This builder for chaining.