public final class CompetitiveVisibilityCompetitorView extends GeneratedMessageV3 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CompetitiveVisibilityCompetitorViewImplements
CompetitiveVisibilityCompetitorViewOrBuilderStatic Fields
ADS_ORGANIC_RATIO_FIELD_NUMBER
public static final int ADS_ORGANIC_RATIO_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
DATE_FIELD_NUMBER
public static final int DATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
DOMAIN_FIELD_NUMBER
public static final int DOMAIN_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
HIGHER_POSITION_RATE_FIELD_NUMBER
public static final int HIGHER_POSITION_RATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
IS_YOUR_DOMAIN_FIELD_NUMBER
public static final int IS_YOUR_DOMAIN_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
PAGE_OVERLAP_RATE_FIELD_NUMBER
public static final int PAGE_OVERLAP_RATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
RANK_FIELD_NUMBER
public static final int RANK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
RELATIVE_VISIBILITY_FIELD_NUMBER
public static final int RELATIVE_VISIBILITY_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 | |
Static Methods
getDefaultInstance()
public static CompetitiveVisibilityCompetitorView getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
newBuilder()
public static CompetitiveVisibilityCompetitorView.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView.Builder | |
newBuilder(CompetitiveVisibilityCompetitorView prototype)
public static CompetitiveVisibilityCompetitorView.Builder newBuilder(CompetitiveVisibilityCompetitorView prototype)| Parameter | |
|---|---|
| Name | Description |
prototype | CompetitiveVisibilityCompetitorView |
| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView.Builder | |
parseDelimitedFrom(InputStream input)
public static CompetitiveVisibilityCompetitorView parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static CompetitiveVisibilityCompetitorView parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(byte[] data)
public static CompetitiveVisibilityCompetitorView parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data | byte[] |
| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CompetitiveVisibilityCompetitorView parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data)
public static CompetitiveVisibilityCompetitorView parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data | ByteString |
| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CompetitiveVisibilityCompetitorView parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(CodedInputStream input)
public static CompetitiveVisibilityCompetitorView parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input | CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CompetitiveVisibilityCompetitorView parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input)
public static CompetitiveVisibilityCompetitorView parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static CompetitiveVisibilityCompetitorView parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(ByteBuffer data)
public static CompetitiveVisibilityCompetitorView parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data | ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CompetitiveVisibilityCompetitorView parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parser()
public static Parser<CompetitiveVisibilityCompetitorView> parser()| Returns | |
|---|---|
| Type | Description |
Parser<CompetitiveVisibilityCompetitorView> | |
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj | Object |
| Returns | |
|---|---|
| Type | Description |
boolean | |
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. |
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 | |
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. |
getParserForType()
public Parser<CompetitiveVisibilityCompetitorView> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<CompetitiveVisibilityCompetitorView> | |
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. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int | |
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. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
newBuilderForType()
public CompetitiveVisibilityCompetitorView.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView.Builder | |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CompetitiveVisibilityCompetitorView.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent | BuilderParent |
| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView.Builder | |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused | UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object | |
toBuilder()
public CompetitiveVisibilityCompetitorView.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
CompetitiveVisibilityCompetitorView.Builder | |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output | CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |