Interface BestSellersBrandViewOrBuilder (0.31.0)

public interface BestSellersBrandViewOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBrand()

public abstract String getBrand()

Name of the brand.

optional string brand = 6;

Returns
Type	Description
`String`	The brand.

getBrandBytes()

public abstract ByteString getBrandBytes()

Name of the brand.

optional string brand = 6;

Returns
Type	Description
`ByteString`	The bytes for brand.

getPreviousRank()

public abstract long getPreviousRank()

Popularity rank in the previous week or month.

optional int64 previous_rank = 8;

Returns
Type	Description
`long`	The previousRank.

getPreviousRelativeDemand()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 SELECT clause. If a WHERE condition on report_date is 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 abstract 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 SELECT clause. If a WHERE condition on report_date is 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 abstract 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 abstract 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.

hasBrand()

public abstract boolean hasBrand()

Name of the brand.

optional string brand = 6;

Returns
Type	Description
`boolean`	Whether the brand field is set.

hasPreviousRank()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 SELECT clause. If a WHERE condition on report_date is 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 abstract 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.