Interface ProductViewOrBuilder (0.23.0)

Version 0.23.0

• 0.29.0 (latest)
• 0.28.0
• 0.27.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0

public interface ProductViewOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAggregatedReportingContextStatus()

public abstract ProductView.AggregatedReportingContextStatus getAggregatedReportingContextStatus()

Aggregated status.

optional .google.shopping.merchant.reports.v1beta.ProductView.AggregatedReportingContextStatus aggregated_reporting_context_status = 26;

Returns
Type	Description
ProductView.AggregatedReportingContextStatus	The aggregatedReportingContextStatus.

getAggregatedReportingContextStatusValue()

public abstract int getAggregatedReportingContextStatusValue()

Aggregated status.

optional .google.shopping.merchant.reports.v1beta.ProductView.AggregatedReportingContextStatus aggregated_reporting_context_status = 26;

Returns
Type	Description
int	The enum numeric value on the wire for aggregatedReportingContextStatus.

getAvailability()

public abstract String getAvailability()

Availability of the product.

optional string availability = 19;

Returns
Type	Description
String	The availability.

getAvailabilityBytes()

public abstract ByteString getAvailabilityBytes()

Availability of the product.

optional string availability = 19;

Returns
Type	Description
ByteString	The bytes for availability.

getBrand()

public abstract String getBrand()

Brand of the product.

optional string brand = 6;

Returns
Type	Description
String	The brand.

getBrandBytes()

public abstract ByteString getBrandBytes()

Brand of the product.

optional string brand = 6;

Returns
Type	Description
ByteString	The bytes for brand.

getCategoryL1()

public abstract String getCategoryL1()

Product category (1st level) in Google's product taxonomy.

optional string category_l1 = 7;

Returns
Type	Description
String	The categoryL1.

getCategoryL1Bytes()

public abstract ByteString getCategoryL1Bytes()

Product category (1st level) in Google's product taxonomy.

optional string category_l1 = 7;

Returns
Type	Description
ByteString	The bytes for categoryL1.

getCategoryL2()

public abstract String getCategoryL2()

Product category (2nd level) in Google's product taxonomy.

optional string category_l2 = 8;

Returns
Type	Description
String	The categoryL2.

getCategoryL2Bytes()

public abstract ByteString getCategoryL2Bytes()

Product category (2nd level) in Google's product taxonomy.

optional string category_l2 = 8;

Returns
Type	Description
ByteString	The bytes for categoryL2.

getCategoryL3()

public abstract String getCategoryL3()

Product category (3rd level) in Google's product taxonomy.

optional string category_l3 = 9;

Returns
Type	Description
String	The categoryL3.

getCategoryL3Bytes()

public abstract ByteString getCategoryL3Bytes()

Product category (3rd level) in Google's product taxonomy.

optional string category_l3 = 9;

Returns
Type	Description
ByteString	The bytes for categoryL3.

getCategoryL4()

public abstract String getCategoryL4()

Product category (4th level) in Google's product taxonomy.

optional string category_l4 = 10;

Returns
Type	Description
String	The categoryL4.

getCategoryL4Bytes()

public abstract ByteString getCategoryL4Bytes()

Product category (4th level) in Google's product taxonomy.

optional string category_l4 = 10;

Returns
Type	Description
ByteString	The bytes for categoryL4.

getCategoryL5()

public abstract String getCategoryL5()

Product category (5th level) in Google's product taxonomy.

optional string category_l5 = 11;

Returns
Type	Description
String	The categoryL5.

getCategoryL5Bytes()

public abstract ByteString getCategoryL5Bytes()

Product category (5th level) in Google's product taxonomy.

optional string category_l5 = 11;

Returns
Type	Description
ByteString	The bytes for categoryL5.

getChannel()

public abstract Channel.ChannelEnum getChannel()

Channel of the product. Can be ONLINE or LOCAL.

optional .google.shopping.type.Channel.ChannelEnum channel = 28;

Returns
Type	Description
com.google.shopping.type.Channel.ChannelEnum	The channel.

getChannelValue()

public abstract int getChannelValue()

Channel of the product. Can be ONLINE or LOCAL.

optional .google.shopping.type.Channel.ChannelEnum channel = 28;

Returns
Type	Description
int	The enum numeric value on the wire for channel.

getClickPotential()

public abstract ProductView.ClickPotential getClickPotential()

Estimated performance potential compared to highest performing products of the merchant.

.google.shopping.merchant.reports.v1beta.ProductView.ClickPotential click_potential = 29;

Returns
Type	Description
ProductView.ClickPotential	The clickPotential.

getClickPotentialRank()

public abstract long getClickPotentialRank()

Rank of the product based on its click potential. A product with click_potential_rank 1 has the highest click potential among the merchant's products that fulfill the search query conditions.

optional int64 click_potential_rank = 30;

Returns
Type	Description
long	The clickPotentialRank.

getClickPotentialValue()

public abstract int getClickPotentialValue()

Estimated performance potential compared to highest performing products of the merchant.

.google.shopping.merchant.reports.v1beta.ProductView.ClickPotential click_potential = 29;

Returns
Type	Description
int	The enum numeric value on the wire for clickPotential.

getCondition()

public abstract String getCondition()

Condition of the product.

optional string condition = 18;

Returns
Type	Description
String	The condition.

getConditionBytes()

public abstract ByteString getConditionBytes()

Condition of the product.

optional string condition = 18;

Returns
Type	Description
ByteString	The bytes for condition.

getCreationTime()

public abstract Timestamp getCreationTime()

The time the merchant created the product in timestamp seconds.

.google.protobuf.Timestamp creation_time = 24;

Returns
Type	Description
Timestamp	The creationTime.

getCreationTimeOrBuilder()

public abstract TimestampOrBuilder getCreationTimeOrBuilder()

The time the merchant created the product in timestamp seconds.

.google.protobuf.Timestamp creation_time = 24;

Returns
Type	Description
TimestampOrBuilder

getExpirationDate()

public abstract Date getExpirationDate()

Expiration date for the product, specified on insertion.

.google.type.Date expiration_date = 25;

Returns
Type	Description
com.google.type.Date	The expirationDate.

getExpirationDateOrBuilder()

public abstract DateOrBuilder getExpirationDateOrBuilder()

Expiration date for the product, specified on insertion.

.google.type.Date expiration_date = 25;

Returns
Type	Description
com.google.type.DateOrBuilder

getFeedLabel()

public abstract String getFeedLabel()

Feed label of the product.

optional string feed_label = 3;

Returns
Type	Description
String	The feedLabel.

getFeedLabelBytes()

public abstract ByteString getFeedLabelBytes()

Feed label of the product.

optional string feed_label = 3;

Returns
Type	Description
ByteString	The bytes for feedLabel.

getGtin(int index)

public abstract String getGtin(int index)

List of Global Trade Item Numbers (GTINs) of the product.

repeated string gtin = 21;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The gtin at the given index.

getGtinBytes(int index)

public abstract ByteString getGtinBytes(int index)

List of Global Trade Item Numbers (GTINs) of the product.

repeated string gtin = 21;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the gtin at the given index.

getGtinCount()

public abstract int getGtinCount()

List of Global Trade Item Numbers (GTINs) of the product.

repeated string gtin = 21;

Returns
Type	Description
int	The count of gtin.

getGtinList()

public abstract List<String> getGtinList()

List of Global Trade Item Numbers (GTINs) of the product.

repeated string gtin = 21;

Returns
Type	Description
List<String>	A list containing the gtin.

getId()

public abstract String getId()

REST ID of the product, in the form of channel~languageCode~feedLabel~offerId. Merchant API methods that operate on products take this as their name parameter.

Required in the SELECT clause.

optional string id = 1;

Returns
Type	Description
String	The id.

getIdBytes()

public abstract ByteString getIdBytes()

REST ID of the product, in the form of channel~languageCode~feedLabel~offerId. Merchant API methods that operate on products take this as their name parameter.

Required in the SELECT clause.

optional string id = 1;

Returns
Type	Description
ByteString	The bytes for id.

getItemGroupId()

public abstract String getItemGroupId()

Item group id provided by the merchant for grouping variants together.

optional string item_group_id = 22;

Returns
Type	Description
String	The itemGroupId.

getItemGroupIdBytes()

public abstract ByteString getItemGroupIdBytes()

Item group id provided by the merchant for grouping variants together.

optional string item_group_id = 22;

Returns
Type	Description
ByteString	The bytes for itemGroupId.

getItemIssues(int index)

public abstract ProductView.ItemIssue getItemIssues(int index)

List of item issues for the product.

This field cannot be used for sorting the results.

Only selected attributes of this field (for example, item_issues.severity.aggregated_severity) can be used for filtering the results.

repeated .google.shopping.merchant.reports.v1beta.ProductView.ItemIssue item_issues = 27;

Parameter
Name	Description
index	int

Returns
Type	Description
ProductView.ItemIssue

getItemIssuesCount()

public abstract int getItemIssuesCount()

List of item issues for the product.

This field cannot be used for sorting the results.

Only selected attributes of this field (for example, item_issues.severity.aggregated_severity) can be used for filtering the results.

repeated .google.shopping.merchant.reports.v1beta.ProductView.ItemIssue item_issues = 27;

Returns
Type	Description
int

getItemIssuesList()

public abstract List<ProductView.ItemIssue> getItemIssuesList()

List of item issues for the product.

This field cannot be used for sorting the results.

Only selected attributes of this field (for example, item_issues.severity.aggregated_severity) can be used for filtering the results.

repeated .google.shopping.merchant.reports.v1beta.ProductView.ItemIssue item_issues = 27;

Returns
Type	Description
List<ItemIssue>

getItemIssuesOrBuilder(int index)

public abstract ProductView.ItemIssueOrBuilder getItemIssuesOrBuilder(int index)

List of item issues for the product.

This field cannot be used for sorting the results.

Only selected attributes of this field (for example, item_issues.severity.aggregated_severity) can be used for filtering the results.

repeated .google.shopping.merchant.reports.v1beta.ProductView.ItemIssue item_issues = 27;

Parameter
Name	Description
index	int

Returns
Type	Description
ProductView.ItemIssueOrBuilder

getItemIssuesOrBuilderList()

public abstract List<? extends ProductView.ItemIssueOrBuilder> getItemIssuesOrBuilderList()

List of item issues for the product.

This field cannot be used for sorting the results.

Only selected attributes of this field (for example, item_issues.severity.aggregated_severity) can be used for filtering the results.

repeated .google.shopping.merchant.reports.v1beta.ProductView.ItemIssue item_issues = 27;

Returns
Type	Description
List<? extends com.google.shopping.merchant.reports.v1beta.ProductView.ItemIssueOrBuilder>

getLanguageCode()

public abstract String getLanguageCode()

Language code of the product in BCP 47 format.

optional string language_code = 2;

Returns
Type	Description
String	The languageCode.

getLanguageCodeBytes()

public abstract ByteString getLanguageCodeBytes()

Language code of the product in BCP 47 format.

optional string language_code = 2;

Returns
Type	Description
ByteString	The bytes for languageCode.

getOfferId()

public abstract String getOfferId()

Merchant-provided id of the product.

optional string offer_id = 4;

Returns
Type	Description
String	The offerId.

getOfferIdBytes()

public abstract ByteString getOfferIdBytes()

Merchant-provided id of the product.

optional string offer_id = 4;

Returns
Type	Description
ByteString	The bytes for offerId.

getPrice()

public abstract Price getPrice()

Product price. Absent if the information about the price of the product is not available.

.google.shopping.type.Price price = 17;

Returns
Type	Description
com.google.shopping.type.Price	The price.

getPriceOrBuilder()

public abstract PriceOrBuilder getPriceOrBuilder()

Product price. Absent if the information about the price of the product is not available.

.google.shopping.type.Price price = 17;

Returns
Type	Description
com.google.shopping.type.PriceOrBuilder

getProductTypeL1()

public abstract String getProductTypeL1()

Product type (1st level) in merchant's own product taxonomy.

optional string product_type_l1 = 12;

Returns
Type	Description
String	The productTypeL1.

getProductTypeL1Bytes()

public abstract ByteString getProductTypeL1Bytes()

Product type (1st level) in merchant's own product taxonomy.

optional string product_type_l1 = 12;

Returns
Type	Description
ByteString	The bytes for productTypeL1.

getProductTypeL2()

public abstract String getProductTypeL2()

Product type (2nd level) in merchant's own product taxonomy.

optional string product_type_l2 = 13;

Returns
Type	Description
String	The productTypeL2.

getProductTypeL2Bytes()

public abstract ByteString getProductTypeL2Bytes()

Product type (2nd level) in merchant's own product taxonomy.

optional string product_type_l2 = 13;

Returns
Type	Description
ByteString	The bytes for productTypeL2.

getProductTypeL3()

public abstract String getProductTypeL3()

Product type (3rd level) in merchant's own product taxonomy.

optional string product_type_l3 = 14;

Returns
Type	Description
String	The productTypeL3.

getProductTypeL3Bytes()

public abstract ByteString getProductTypeL3Bytes()

Product type (3rd level) in merchant's own product taxonomy.

optional string product_type_l3 = 14;

Returns
Type	Description
ByteString	The bytes for productTypeL3.

getProductTypeL4()

public abstract String getProductTypeL4()

Product type (4th level) in merchant's own product taxonomy.

optional string product_type_l4 = 15;

Returns
Type	Description
String	The productTypeL4.

getProductTypeL4Bytes()

public abstract ByteString getProductTypeL4Bytes()

Product type (4th level) in merchant's own product taxonomy.

optional string product_type_l4 = 15;

Returns
Type	Description
ByteString	The bytes for productTypeL4.

getProductTypeL5()

public abstract String getProductTypeL5()

Product type (5th level) in merchant's own product taxonomy.

optional string product_type_l5 = 16;

Returns
Type	Description
String	The productTypeL5.

getProductTypeL5Bytes()

public abstract ByteString getProductTypeL5Bytes()

Product type (5th level) in merchant's own product taxonomy.

optional string product_type_l5 = 16;

Returns
Type	Description
ByteString	The bytes for productTypeL5.

getShippingLabel()

public abstract String getShippingLabel()

Normalized shipping label specified in the data source.

optional string shipping_label = 20;

Returns
Type	Description
String	The shippingLabel.

getShippingLabelBytes()

public abstract ByteString getShippingLabelBytes()

Normalized shipping label specified in the data source.

optional string shipping_label = 20;

Returns
Type	Description
ByteString	The bytes for shippingLabel.

getThumbnailLink()

public abstract String getThumbnailLink()

Link to the processed image of the product, hosted on the Google infrastructure.

optional string thumbnail_link = 23;

Returns
Type	Description
String	The thumbnailLink.

getThumbnailLinkBytes()

public abstract ByteString getThumbnailLinkBytes()

Link to the processed image of the product, hosted on the Google infrastructure.

optional string thumbnail_link = 23;

Returns
Type	Description
ByteString	The bytes for thumbnailLink.

getTitle()

public abstract String getTitle()

Title of the product.

optional string title = 5;

Returns
Type	Description
String	The title.

getTitleBytes()

public abstract ByteString getTitleBytes()

Title of the product.

optional string title = 5;

Returns
Type	Description
ByteString	The bytes for title.

hasAggregatedReportingContextStatus()

public abstract boolean hasAggregatedReportingContextStatus()

Aggregated status.

optional .google.shopping.merchant.reports.v1beta.ProductView.AggregatedReportingContextStatus aggregated_reporting_context_status = 26;

Returns
Type	Description
boolean	Whether the aggregatedReportingContextStatus field is set.

hasAvailability()

public abstract boolean hasAvailability()

Availability of the product.

optional string availability = 19;

Returns
Type	Description
boolean	Whether the availability field is set.

hasBrand()

public abstract boolean hasBrand()

Brand of the product.

optional string brand = 6;

Returns
Type	Description
boolean	Whether the brand field is set.

hasCategoryL1()

public abstract boolean hasCategoryL1()

Product category (1st level) in Google's product taxonomy.

optional string category_l1 = 7;

Returns
Type	Description
boolean	Whether the categoryL1 field is set.

hasCategoryL2()

public abstract boolean hasCategoryL2()

Product category (2nd level) in Google's product taxonomy.

optional string category_l2 = 8;

Returns
Type	Description
boolean	Whether the categoryL2 field is set.

hasCategoryL3()

public abstract boolean hasCategoryL3()

Product category (3rd level) in Google's product taxonomy.

optional string category_l3 = 9;

Returns
Type	Description
boolean	Whether the categoryL3 field is set.

hasCategoryL4()

public abstract boolean hasCategoryL4()

Product category (4th level) in Google's product taxonomy.

optional string category_l4 = 10;

Returns
Type	Description
boolean	Whether the categoryL4 field is set.

hasCategoryL5()

public abstract boolean hasCategoryL5()

Product category (5th level) in Google's product taxonomy.

optional string category_l5 = 11;

Returns
Type	Description
boolean	Whether the categoryL5 field is set.

hasChannel()

public abstract boolean hasChannel()

Channel of the product. Can be ONLINE or LOCAL.

optional .google.shopping.type.Channel.ChannelEnum channel = 28;

Returns
Type	Description
boolean	Whether the channel field is set.

hasClickPotentialRank()

public abstract boolean hasClickPotentialRank()

Rank of the product based on its click potential. A product with click_potential_rank 1 has the highest click potential among the merchant's products that fulfill the search query conditions.

optional int64 click_potential_rank = 30;

Returns
Type	Description
boolean	Whether the clickPotentialRank field is set.

hasCondition()

public abstract boolean hasCondition()

Condition of the product.

optional string condition = 18;

Returns
Type	Description
boolean	Whether the condition field is set.

hasCreationTime()

public abstract boolean hasCreationTime()

The time the merchant created the product in timestamp seconds.

.google.protobuf.Timestamp creation_time = 24;

Returns
Type	Description
boolean	Whether the creationTime field is set.

hasExpirationDate()

public abstract boolean hasExpirationDate()

Expiration date for the product, specified on insertion.

.google.type.Date expiration_date = 25;

Returns
Type	Description
boolean	Whether the expirationDate field is set.

hasFeedLabel()

public abstract boolean hasFeedLabel()

Feed label of the product.

optional string feed_label = 3;

Returns
Type	Description
boolean	Whether the feedLabel field is set.

hasId()

public abstract boolean hasId()

REST ID of the product, in the form of channel~languageCode~feedLabel~offerId. Merchant API methods that operate on products take this as their name parameter.

Required in the SELECT clause.

optional string id = 1;

Returns
Type	Description
boolean	Whether the id field is set.

hasItemGroupId()

public abstract boolean hasItemGroupId()

Item group id provided by the merchant for grouping variants together.

optional string item_group_id = 22;

Returns
Type	Description
boolean	Whether the itemGroupId field is set.

hasLanguageCode()

public abstract boolean hasLanguageCode()

Language code of the product in BCP 47 format.

optional string language_code = 2;

Returns
Type	Description
boolean	Whether the languageCode field is set.

hasOfferId()

public abstract boolean hasOfferId()

Merchant-provided id of the product.

optional string offer_id = 4;

Returns
Type	Description
boolean	Whether the offerId field is set.

hasPrice()

public abstract boolean hasPrice()

Product price. Absent if the information about the price of the product is not available.

.google.shopping.type.Price price = 17;

Returns
Type	Description
boolean	Whether the price field is set.

hasProductTypeL1()

public abstract boolean hasProductTypeL1()

Product type (1st level) in merchant's own product taxonomy.

optional string product_type_l1 = 12;

Returns
Type	Description
boolean	Whether the productTypeL1 field is set.

hasProductTypeL2()

public abstract boolean hasProductTypeL2()

Product type (2nd level) in merchant's own product taxonomy.

optional string product_type_l2 = 13;

Returns
Type	Description
boolean	Whether the productTypeL2 field is set.

hasProductTypeL3()

public abstract boolean hasProductTypeL3()

Product type (3rd level) in merchant's own product taxonomy.

optional string product_type_l3 = 14;

Returns
Type	Description
boolean	Whether the productTypeL3 field is set.

hasProductTypeL4()

public abstract boolean hasProductTypeL4()

Product type (4th level) in merchant's own product taxonomy.

optional string product_type_l4 = 15;

Returns
Type	Description
boolean	Whether the productTypeL4 field is set.

hasProductTypeL5()

public abstract boolean hasProductTypeL5()

Product type (5th level) in merchant's own product taxonomy.

optional string product_type_l5 = 16;

Returns
Type	Description
boolean	Whether the productTypeL5 field is set.

hasShippingLabel()

public abstract boolean hasShippingLabel()

Normalized shipping label specified in the data source.

optional string shipping_label = 20;

Returns
Type	Description
boolean	Whether the shippingLabel field is set.

hasThumbnailLink()

public abstract boolean hasThumbnailLink()

Link to the processed image of the product, hosted on the Google infrastructure.

optional string thumbnail_link = 23;

Returns
Type	Description
boolean	Whether the thumbnailLink field is set.

hasTitle()

public abstract boolean hasTitle()

Title of the product.

optional string title = 5;

Returns
Type	Description
boolean	Whether the title field is set.