Class CompetitiveVisibilityBenchmarkView.Builder (0.3.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public CompetitiveVisibilityBenchmarkView build()
Returns
TypeDescription
CompetitiveVisibilityBenchmarkView

buildPartial()

public CompetitiveVisibilityBenchmarkView buildPartial()
Returns
TypeDescription
CompetitiveVisibilityBenchmarkView

clear()

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

clearField(Descriptors.FieldDescriptor field)

public CompetitiveVisibilityBenchmarkView.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CompetitiveVisibilityBenchmarkView.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CompetitiveVisibilityBenchmarkView.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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 traffic_source = 4;

Returns
TypeDescription
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
TypeDescription
CompetitiveVisibilityBenchmarkView.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public CompetitiveVisibilityBenchmarkView getDefaultInstanceForType()
Returns
TypeDescription
CompetitiveVisibilityBenchmarkView

getDescriptorForType()

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

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

Returns
TypeDescription
ByteString

The bytes for reportCountryCode.

getTrafficSource()

public TrafficSource getTrafficSource()

Traffic source of impressions.

Required in the SELECT clause.

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

Returns
TypeDescription
TrafficSource

The trafficSource.

getTrafficSourceValue()

public int getTrafficSourceValue()

Traffic source of impressions.

Required in the SELECT clause.

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

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

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the yourDomainVisibilityTrend 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 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
NameDescription
valuecom.google.type.Date
Returns
TypeDescription
CompetitiveVisibilityBenchmarkView.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(CompetitiveVisibilityBenchmarkView other)

public CompetitiveVisibilityBenchmarkView.Builder mergeFrom(CompetitiveVisibilityBenchmarkView other)
Parameter
NameDescription
otherCompetitiveVisibilityBenchmarkView
Returns
TypeDescription
CompetitiveVisibilityBenchmarkView.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

The categoryBenchmarkVisibilityTrend to set.

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

setField(Descriptors.FieldDescriptor field, Object value)

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

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

public CompetitiveVisibilityBenchmarkView.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valuelong

The reportCategoryId to set.

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

The reportCountryCode to set.

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

The bytes for reportCountryCode to set.

Returns
TypeDescription
CompetitiveVisibilityBenchmarkView.Builder

This builder for chaining.

setTrafficSource(TrafficSource value)

public CompetitiveVisibilityBenchmarkView.Builder setTrafficSource(TrafficSource value)

Traffic source of impressions.

Required in the SELECT clause.

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

Parameter
NameDescription
valueTrafficSource

The trafficSource to set.

Returns
TypeDescription
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 traffic_source = 4;

Parameter
NameDescription
valueint

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

Returns
TypeDescription
CompetitiveVisibilityBenchmarkView.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

The yourDomainVisibilityTrend to set.

Returns
TypeDescription
CompetitiveVisibilityBenchmarkView.Builder

This builder for chaining.