public final class BestSellersBrandView extends GeneratedMessageV3 implements BestSellersBrandViewOrBuilder Fields available for query in best_sellers_brand_view table.
Best sellers report with top brands.
Values are only set for fields requested explicitly in the request's search query.
Protobuf type google.shopping.merchant.reports.v1beta.BestSellersBrandView
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BestSellersBrandViewImplements
BestSellersBrandViewOrBuilderStatic Fields
BRAND_FIELD_NUMBER
public static final int BRAND_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PREVIOUS_RANK_FIELD_NUMBER
public static final int PREVIOUS_RANK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PREVIOUS_RELATIVE_DEMAND_FIELD_NUMBER
public static final int PREVIOUS_RELATIVE_DEMAND_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RANK_FIELD_NUMBER
public static final int RANK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RELATIVE_DEMAND_CHANGE_FIELD_NUMBER
public static final int RELATIVE_DEMAND_CHANGE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RELATIVE_DEMAND_FIELD_NUMBER
public static final int RELATIVE_DEMAND_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 |
|
REPORT_DATE_FIELD_NUMBER
public static final int REPORT_DATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
REPORT_GRANULARITY_FIELD_NUMBER
public static final int REPORT_GRANULARITY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static BestSellersBrandView getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static BestSellersBrandView.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView.Builder |
|
newBuilder(BestSellersBrandView prototype)
public static BestSellersBrandView.Builder newBuilder(BestSellersBrandView prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
BestSellersBrandView |
| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView.Builder |
|
parseDelimitedFrom(InputStream input)
public static BestSellersBrandView parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static BestSellersBrandView parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static BestSellersBrandView parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BestSellersBrandView parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static BestSellersBrandView parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BestSellersBrandView parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static BestSellersBrandView parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BestSellersBrandView parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static BestSellersBrandView parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static BestSellersBrandView parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static BestSellersBrandView parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BestSellersBrandView parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<BestSellersBrandView> parser()| Returns | |
|---|---|
| Type | Description |
Parser<BestSellersBrandView> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getBrand()
public String getBrand()Name of the brand.
optional string brand = 6;
| Returns | |
|---|---|
| Type | Description |
String |
The brand. |
getBrandBytes()
public ByteString getBrandBytes()Name of the brand.
optional string brand = 6;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for brand. |
getDefaultInstanceForType()
public BestSellersBrandView getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView |
|
getParserForType()
public Parser<BestSellersBrandView> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<BestSellersBrandView> |
|
getPreviousRank()
public long getPreviousRank()Popularity rank in the previous week or month.
optional int64 previous_rank = 8;
| Returns | |
|---|---|
| Type | Description |
long |
The previousRank. |
getPreviousRelativeDemand()
public RelativeDemand.RelativeDemandEnum getPreviousRelativeDemand()Estimated demand in relation to the brand with the highest popularity rank in the same category and country in the previous week or month.
optional .google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum previous_relative_demand = 10;
| Returns | |
|---|---|
| Type | Description |
RelativeDemand.RelativeDemandEnum |
The previousRelativeDemand. |
getPreviousRelativeDemandValue()
public int getPreviousRelativeDemandValue()Estimated demand in relation to the brand with the highest popularity rank in the same category and country in the previous week or month.
optional .google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum previous_relative_demand = 10;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for previousRelativeDemand. |
getRank()
public long getRank()Popularity of the brand on Ads and organic surfaces, in the selected category and country, based on the estimated number of units sold.
optional int64 rank = 7;
| Returns | |
|---|---|
| Type | Description |
long |
The rank. |
getRelativeDemand()
public RelativeDemand.RelativeDemandEnum getRelativeDemand()Estimated demand in relation to the brand with the highest popularity rank in the same category and country.
optional .google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum relative_demand = 9;
| Returns | |
|---|---|
| Type | Description |
RelativeDemand.RelativeDemandEnum |
The relativeDemand. |
getRelativeDemandChange()
public RelativeDemandChangeType.RelativeDemandChangeTypeEnum getRelativeDemandChange()Change in the estimated demand. Whether it rose, sank or remained flat.
optional .google.shopping.merchant.reports.v1beta.RelativeDemandChangeType.RelativeDemandChangeTypeEnum relative_demand_change = 11;
| Returns | |
|---|---|
| Type | Description |
RelativeDemandChangeType.RelativeDemandChangeTypeEnum |
The relativeDemandChange. |
getRelativeDemandChangeValue()
public int getRelativeDemandChangeValue()Change in the estimated demand. Whether it rose, sank or remained flat.
optional .google.shopping.merchant.reports.v1beta.RelativeDemandChangeType.RelativeDemandChangeTypeEnum relative_demand_change = 11;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for relativeDemandChange. |
getRelativeDemandValue()
public int getRelativeDemandValue()Estimated demand in relation to the brand with the highest popularity rank in the same category and country.
optional .google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum relative_demand = 9;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for relativeDemand. |
getReportCategoryId()
public long getReportCategoryId()Google product category ID to calculate the ranking for, represented in Google's product taxonomy.
Required in the SELECT clause. If a WHERE condition on
report_category_id is not specified in the query, rankings for all
top-level categories are returned.
optional int64 report_category_id = 4;
| Returns | |
|---|---|
| Type | Description |
long |
The reportCategoryId. |
getReportCountryCode()
public String getReportCountryCode()Country where the ranking is calculated. Represented in the ISO 3166 format.
Required in the SELECT clause. Condition on report_country_code is
required in the WHERE clause.
optional string report_country_code = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The reportCountryCode. |
getReportCountryCodeBytes()
public ByteString getReportCountryCodeBytes()Country where the ranking is calculated. Represented in the ISO 3166 format.
Required in the SELECT clause. Condition on report_country_code is
required in the WHERE clause.
optional string report_country_code = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for reportCountryCode. |
getReportDate()
public Date getReportDate()Report date. The value of this field can only be one of the following:
- The first day of the week (Monday) for weekly reports,
The first day of the month for monthly reports.
Required in the
SELECTclause. If aWHEREcondition onreport_dateis not specified in the query, the latest available weekly or monthly report is returned.
.google.type.Date report_date = 1;
| Returns | |
|---|---|
| Type | Description |
com.google.type.Date |
The reportDate. |
getReportDateOrBuilder()
public DateOrBuilder getReportDateOrBuilder()Report date. The value of this field can only be one of the following:
- The first day of the week (Monday) for weekly reports,
The first day of the month for monthly reports.
Required in the
SELECTclause. If aWHEREcondition onreport_dateis not specified in the query, the latest available weekly or monthly report is returned.
.google.type.Date report_date = 1;
| Returns | |
|---|---|
| Type | Description |
com.google.type.DateOrBuilder |
|
getReportGranularity()
public ReportGranularity.ReportGranularityEnum getReportGranularity()Granularity of the report. The ranking can be done over a week or a month timeframe.
Required in the SELECT clause. Condition on report_granularity is
required in the WHERE clause.
optional .google.shopping.merchant.reports.v1beta.ReportGranularity.ReportGranularityEnum report_granularity = 2;
| Returns | |
|---|---|
| Type | Description |
ReportGranularity.ReportGranularityEnum |
The reportGranularity. |
getReportGranularityValue()
public int getReportGranularityValue()Granularity of the report. The ranking can be done over a week or a month timeframe.
Required in the SELECT clause. Condition on report_granularity is
required in the WHERE clause.
optional .google.shopping.merchant.reports.v1beta.ReportGranularity.ReportGranularityEnum report_granularity = 2;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for reportGranularity. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hasBrand()
public boolean hasBrand()Name of the brand.
optional string brand = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the brand field is set. |
hasPreviousRank()
public boolean hasPreviousRank()Popularity rank in the previous week or month.
optional int64 previous_rank = 8;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the previousRank field is set. |
hasPreviousRelativeDemand()
public boolean hasPreviousRelativeDemand()Estimated demand in relation to the brand with the highest popularity rank in the same category and country in the previous week or month.
optional .google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum previous_relative_demand = 10;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the previousRelativeDemand field is set. |
hasRank()
public boolean hasRank()Popularity of the brand on Ads and organic surfaces, in the selected category and country, based on the estimated number of units sold.
optional int64 rank = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the rank field is set. |
hasRelativeDemand()
public boolean hasRelativeDemand()Estimated demand in relation to the brand with the highest popularity rank in the same category and country.
optional .google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum relative_demand = 9;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the relativeDemand field is set. |
hasRelativeDemandChange()
public boolean hasRelativeDemandChange()Change in the estimated demand. Whether it rose, sank or remained flat.
optional .google.shopping.merchant.reports.v1beta.RelativeDemandChangeType.RelativeDemandChangeTypeEnum relative_demand_change = 11;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the relativeDemandChange field is set. |
hasReportCategoryId()
public boolean hasReportCategoryId()Google product category ID to calculate the ranking for, represented in Google's product taxonomy.
Required in the SELECT clause. If a WHERE condition on
report_category_id is not specified in the query, rankings for all
top-level categories are returned.
optional int64 report_category_id = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the reportCategoryId field is set. |
hasReportCountryCode()
public boolean hasReportCountryCode()Country where the ranking is calculated. Represented in the ISO 3166 format.
Required in the SELECT clause. Condition on report_country_code is
required in the WHERE clause.
optional string report_country_code = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the reportCountryCode field is set. |
hasReportDate()
public boolean hasReportDate()Report date. The value of this field can only be one of the following:
- The first day of the week (Monday) for weekly reports,
The first day of the month for monthly reports.
Required in the
SELECTclause. If aWHEREcondition onreport_dateis not specified in the query, the latest available weekly or monthly report is returned.
.google.type.Date report_date = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the reportDate field is set. |
hasReportGranularity()
public boolean hasReportGranularity()Granularity of the report. The ranking can be done over a week or a month timeframe.
Required in the SELECT clause. Condition on report_granularity is
required in the WHERE clause.
optional .google.shopping.merchant.reports.v1beta.ReportGranularity.ReportGranularityEnum report_granularity = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the reportGranularity 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 BestSellersBrandView.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BestSellersBrandView.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public BestSellersBrandView.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
BestSellersBrandView.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|