Class CompetitiveVisibilityBenchmarkView (0.22.0)

public final class CompetitiveVisibilityBenchmarkView extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CompetitiveVisibilityBenchmarkView

Static Fields

CATEGORY_BENCHMARK_VISIBILITY_TREND_FIELD_NUMBER

public static final int CATEGORY_BENCHMARK_VISIBILITY_TREND_FIELD_NUMBER
Field Value
Type Description
int

DATE_FIELD_NUMBER

public static final int DATE_FIELD_NUMBER
Field Value
Type Description
int

REPORT_CATEGORY_ID_FIELD_NUMBER

public static final int REPORT_CATEGORY_ID_FIELD_NUMBER
Field Value
Type Description
int

REPORT_COUNTRY_CODE_FIELD_NUMBER

public static final int REPORT_COUNTRY_CODE_FIELD_NUMBER
Field Value
Type Description
int

TRAFFIC_SOURCE_FIELD_NUMBER

public static final int TRAFFIC_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

YOUR_DOMAIN_VISIBILITY_TREND_FIELD_NUMBER

public static final int YOUR_DOMAIN_VISIBILITY_TREND_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CompetitiveVisibilityBenchmarkView getDefaultInstance()
Returns
Type Description
CompetitiveVisibilityBenchmarkView

getDescriptor()

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

newBuilder()

public static CompetitiveVisibilityBenchmarkView.Builder newBuilder()
Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

newBuilder(CompetitiveVisibilityBenchmarkView prototype)

public static CompetitiveVisibilityBenchmarkView.Builder newBuilder(CompetitiveVisibilityBenchmarkView prototype)
Parameter
Name Description
prototype CompetitiveVisibilityBenchmarkView
Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

parseDelimitedFrom(InputStream input)

public static CompetitiveVisibilityBenchmarkView parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CompetitiveVisibilityBenchmarkView
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompetitiveVisibilityBenchmarkView parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompetitiveVisibilityBenchmarkView
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CompetitiveVisibilityBenchmarkView parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CompetitiveVisibilityBenchmarkView
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CompetitiveVisibilityBenchmarkView parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompetitiveVisibilityBenchmarkView
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CompetitiveVisibilityBenchmarkView parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CompetitiveVisibilityBenchmarkView
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CompetitiveVisibilityBenchmarkView parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompetitiveVisibilityBenchmarkView
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CompetitiveVisibilityBenchmarkView parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CompetitiveVisibilityBenchmarkView
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CompetitiveVisibilityBenchmarkView parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompetitiveVisibilityBenchmarkView
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CompetitiveVisibilityBenchmarkView parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CompetitiveVisibilityBenchmarkView
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompetitiveVisibilityBenchmarkView parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompetitiveVisibilityBenchmarkView
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CompetitiveVisibilityBenchmarkView parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CompetitiveVisibilityBenchmarkView
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CompetitiveVisibilityBenchmarkView parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompetitiveVisibilityBenchmarkView
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CompetitiveVisibilityBenchmarkView> parser()
Returns
Type Description
Parser<CompetitiveVisibilityBenchmarkView>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

getParserForType()

public Parser<CompetitiveVisibilityBenchmarkView> getParserForType()
Returns
Type Description
Parser<CompetitiveVisibilityBenchmarkView>
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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CompetitiveVisibilityBenchmarkView.Builder newBuilderForType()
Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CompetitiveVisibilityBenchmarkView.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CompetitiveVisibilityBenchmarkView.Builder toBuilder()
Returns
Type Description
CompetitiveVisibilityBenchmarkView.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException