Class PriceInsightsProductView (0.24.0)

public final class PriceInsightsProductView extends GeneratedMessageV3 implements PriceInsightsProductViewOrBuilder

Fields available for query in price_insights_product_view table.

Price insights report.

Values are only set for fields requested explicitly in the request's search query.

Protobuf type google.shopping.merchant.reports.v1beta.PriceInsightsProductView

Static Fields

BRAND_FIELD_NUMBER

public static final int BRAND_FIELD_NUMBER
Field Value
Type Description
int

CATEGORY_L1_FIELD_NUMBER

public static final int CATEGORY_L1_FIELD_NUMBER
Field Value
Type Description
int

CATEGORY_L2_FIELD_NUMBER

public static final int CATEGORY_L2_FIELD_NUMBER
Field Value
Type Description
int

CATEGORY_L3_FIELD_NUMBER

public static final int CATEGORY_L3_FIELD_NUMBER
Field Value
Type Description
int

CATEGORY_L4_FIELD_NUMBER

public static final int CATEGORY_L4_FIELD_NUMBER
Field Value
Type Description
int

CATEGORY_L5_FIELD_NUMBER

public static final int CATEGORY_L5_FIELD_NUMBER
Field Value
Type Description
int

EFFECTIVENESS_FIELD_NUMBER

public static final int EFFECTIVENESS_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

OFFER_ID_FIELD_NUMBER

public static final int OFFER_ID_FIELD_NUMBER
Field Value
Type Description
int

PREDICTED_CLICKS_CHANGE_FRACTION_FIELD_NUMBER

public static final int PREDICTED_CLICKS_CHANGE_FRACTION_FIELD_NUMBER
Field Value
Type Description
int

PREDICTED_CONVERSIONS_CHANGE_FRACTION_FIELD_NUMBER

public static final int PREDICTED_CONVERSIONS_CHANGE_FRACTION_FIELD_NUMBER
Field Value
Type Description
int

PREDICTED_IMPRESSIONS_CHANGE_FRACTION_FIELD_NUMBER

public static final int PREDICTED_IMPRESSIONS_CHANGE_FRACTION_FIELD_NUMBER
Field Value
Type Description
int

PRICE_FIELD_NUMBER

public static final int PRICE_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_TYPE_L1_FIELD_NUMBER

public static final int PRODUCT_TYPE_L1_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_TYPE_L2_FIELD_NUMBER

public static final int PRODUCT_TYPE_L2_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_TYPE_L3_FIELD_NUMBER

public static final int PRODUCT_TYPE_L3_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_TYPE_L4_FIELD_NUMBER

public static final int PRODUCT_TYPE_L4_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_TYPE_L5_FIELD_NUMBER

public static final int PRODUCT_TYPE_L5_FIELD_NUMBER
Field Value
Type Description
int

SUGGESTED_PRICE_FIELD_NUMBER

public static final int SUGGESTED_PRICE_FIELD_NUMBER
Field Value
Type Description
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PriceInsightsProductView getDefaultInstance()
Returns
Type Description
PriceInsightsProductView

getDescriptor()

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

newBuilder()

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

newBuilder(PriceInsightsProductView prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBrand()

public String getBrand()

Brand of the product.

optional string brand = 4;

Returns
Type Description
String

The brand.

getBrandBytes()

public ByteString getBrandBytes()

Brand of the product.

optional string brand = 4;

Returns
Type Description
ByteString

The bytes for brand.

getCategoryL1()

public String getCategoryL1()

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

optional string category_l1 = 5;

Returns
Type Description
String

The categoryL1.

getCategoryL1Bytes()

public ByteString getCategoryL1Bytes()

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

optional string category_l1 = 5;

Returns
Type Description
ByteString

The bytes for categoryL1.

getCategoryL2()

public String getCategoryL2()

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

optional string category_l2 = 6;

Returns
Type Description
String

The categoryL2.

getCategoryL2Bytes()

public ByteString getCategoryL2Bytes()

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

optional string category_l2 = 6;

Returns
Type Description
ByteString

The bytes for categoryL2.

getCategoryL3()

public String getCategoryL3()

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

optional string category_l3 = 7;

Returns
Type Description
String

The categoryL3.

getCategoryL3Bytes()

public ByteString getCategoryL3Bytes()

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

optional string category_l3 = 7;

Returns
Type Description
ByteString

The bytes for categoryL3.

getCategoryL4()

public String getCategoryL4()

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

optional string category_l4 = 8;

Returns
Type Description
String

The categoryL4.

getCategoryL4Bytes()

public ByteString getCategoryL4Bytes()

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

optional string category_l4 = 8;

Returns
Type Description
ByteString

The bytes for categoryL4.

getCategoryL5()

public String getCategoryL5()

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

optional string category_l5 = 9;

Returns
Type Description
String

The categoryL5.

getCategoryL5Bytes()

public ByteString getCategoryL5Bytes()

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

optional string category_l5 = 9;

Returns
Type Description
ByteString

The bytes for categoryL5.

getDefaultInstanceForType()

public PriceInsightsProductView getDefaultInstanceForType()
Returns
Type Description
PriceInsightsProductView

getEffectiveness()

public PriceInsightsProductView.Effectiveness getEffectiveness()

The predicted effectiveness of applying the price suggestion, bucketed.

.google.shopping.merchant.reports.v1beta.PriceInsightsProductView.Effectiveness effectiveness = 22;

Returns
Type Description
PriceInsightsProductView.Effectiveness

The effectiveness.

getEffectivenessValue()

public int getEffectivenessValue()

The predicted effectiveness of applying the price suggestion, bucketed.

.google.shopping.merchant.reports.v1beta.PriceInsightsProductView.Effectiveness effectiveness = 22;

Returns
Type Description
int

The enum numeric value on the wire for effectiveness.

getId()

public String getId()

REST ID of the product, in the form of channel~languageCode~feedLabel~offerId. Can be used to join data with the product_view table.

Required in the SELECT clause.

optional string id = 1;

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

REST ID of the product, in the form of channel~languageCode~feedLabel~offerId. Can be used to join data with the product_view table.

Required in the SELECT clause.

optional string id = 1;

Returns
Type Description
ByteString

The bytes for id.

getOfferId()

public String getOfferId()

Merchant-provided id of the product.

optional string offer_id = 2;

Returns
Type Description
String

The offerId.

getOfferIdBytes()

public ByteString getOfferIdBytes()

Merchant-provided id of the product.

optional string offer_id = 2;

Returns
Type Description
ByteString

The bytes for offerId.

getParserForType()

public Parser<PriceInsightsProductView> getParserForType()
Returns
Type Description
Parser<PriceInsightsProductView>
Overrides

getPredictedClicksChangeFraction()

public double getPredictedClicksChangeFraction()

Predicted change in clicks as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in clicks.

optional double predicted_clicks_change_fraction = 18;

Returns
Type Description
double

The predictedClicksChangeFraction.

getPredictedConversionsChangeFraction()

public double getPredictedConversionsChangeFraction()

Predicted change in conversions as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in conversions).

optional double predicted_conversions_change_fraction = 19;

Returns
Type Description
double

The predictedConversionsChangeFraction.

getPredictedImpressionsChangeFraction()

public double getPredictedImpressionsChangeFraction()

Predicted change in impressions as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in impressions.

optional double predicted_impressions_change_fraction = 17;

Returns
Type Description
double

The predictedImpressionsChangeFraction.

getPrice()

public Price getPrice()

Current price of the product.

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

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

The price.

getPriceOrBuilder()

public PriceOrBuilder getPriceOrBuilder()

Current price of the product.

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

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

getProductTypeL1()

public String getProductTypeL1()

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

optional string product_type_l1 = 10;

Returns
Type Description
String

The productTypeL1.

getProductTypeL1Bytes()

public ByteString getProductTypeL1Bytes()

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

optional string product_type_l1 = 10;

Returns
Type Description
ByteString

The bytes for productTypeL1.

getProductTypeL2()

public String getProductTypeL2()

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

optional string product_type_l2 = 11;

Returns
Type Description
String

The productTypeL2.

getProductTypeL2Bytes()

public ByteString getProductTypeL2Bytes()

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

optional string product_type_l2 = 11;

Returns
Type Description
ByteString

The bytes for productTypeL2.

getProductTypeL3()

public String getProductTypeL3()

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

optional string product_type_l3 = 12;

Returns
Type Description
String

The productTypeL3.

getProductTypeL3Bytes()

public ByteString getProductTypeL3Bytes()

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

optional string product_type_l3 = 12;

Returns
Type Description
ByteString

The bytes for productTypeL3.

getProductTypeL4()

public String getProductTypeL4()

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

optional string product_type_l4 = 13;

Returns
Type Description
String

The productTypeL4.

getProductTypeL4Bytes()

public ByteString getProductTypeL4Bytes()

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

optional string product_type_l4 = 13;

Returns
Type Description
ByteString

The bytes for productTypeL4.

getProductTypeL5()

public String getProductTypeL5()

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

optional string product_type_l5 = 14;

Returns
Type Description
String

The productTypeL5.

getProductTypeL5Bytes()

public ByteString getProductTypeL5Bytes()

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

optional string product_type_l5 = 14;

Returns
Type Description
ByteString

The bytes for productTypeL5.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSuggestedPrice()

public Price getSuggestedPrice()

Latest suggested price for the product.

.google.shopping.type.Price suggested_price = 16;

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

The suggestedPrice.

getSuggestedPriceOrBuilder()

public PriceOrBuilder getSuggestedPriceOrBuilder()

Latest suggested price for the product.

.google.shopping.type.Price suggested_price = 16;

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

getTitle()

public String getTitle()

Title of the product.

optional string title = 3;

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

Title of the product.

optional string title = 3;

Returns
Type Description
ByteString

The bytes for title.

hasBrand()

public boolean hasBrand()

Brand of the product.

optional string brand = 4;

Returns
Type Description
boolean

Whether the brand field is set.

hasCategoryL1()

public boolean hasCategoryL1()

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

optional string category_l1 = 5;

Returns
Type Description
boolean

Whether the categoryL1 field is set.

hasCategoryL2()

public boolean hasCategoryL2()

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

optional string category_l2 = 6;

Returns
Type Description
boolean

Whether the categoryL2 field is set.

hasCategoryL3()

public boolean hasCategoryL3()

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

optional string category_l3 = 7;

Returns
Type Description
boolean

Whether the categoryL3 field is set.

hasCategoryL4()

public boolean hasCategoryL4()

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

optional string category_l4 = 8;

Returns
Type Description
boolean

Whether the categoryL4 field is set.

hasCategoryL5()

public boolean hasCategoryL5()

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

optional string category_l5 = 9;

Returns
Type Description
boolean

Whether the categoryL5 field is set.

hasId()

public boolean hasId()

REST ID of the product, in the form of channel~languageCode~feedLabel~offerId. Can be used to join data with the product_view table.

Required in the SELECT clause.

optional string id = 1;

Returns
Type Description
boolean

Whether the id field is set.

hasOfferId()

public boolean hasOfferId()

Merchant-provided id of the product.

optional string offer_id = 2;

Returns
Type Description
boolean

Whether the offerId field is set.

hasPredictedClicksChangeFraction()

public boolean hasPredictedClicksChangeFraction()

Predicted change in clicks as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in clicks.

optional double predicted_clicks_change_fraction = 18;

Returns
Type Description
boolean

Whether the predictedClicksChangeFraction field is set.

hasPredictedConversionsChangeFraction()

public boolean hasPredictedConversionsChangeFraction()

Predicted change in conversions as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in conversions).

optional double predicted_conversions_change_fraction = 19;

Returns
Type Description
boolean

Whether the predictedConversionsChangeFraction field is set.

hasPredictedImpressionsChangeFraction()

public boolean hasPredictedImpressionsChangeFraction()

Predicted change in impressions as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in impressions.

optional double predicted_impressions_change_fraction = 17;

Returns
Type Description
boolean

Whether the predictedImpressionsChangeFraction field is set.

hasPrice()

public boolean hasPrice()

Current price of the product.

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

Returns
Type Description
boolean

Whether the price field is set.

hasProductTypeL1()

public boolean hasProductTypeL1()

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

optional string product_type_l1 = 10;

Returns
Type Description
boolean

Whether the productTypeL1 field is set.

hasProductTypeL2()

public boolean hasProductTypeL2()

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

optional string product_type_l2 = 11;

Returns
Type Description
boolean

Whether the productTypeL2 field is set.

hasProductTypeL3()

public boolean hasProductTypeL3()

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

optional string product_type_l3 = 12;

Returns
Type Description
boolean

Whether the productTypeL3 field is set.

hasProductTypeL4()

public boolean hasProductTypeL4()

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

optional string product_type_l4 = 13;

Returns
Type Description
boolean

Whether the productTypeL4 field is set.

hasProductTypeL5()

public boolean hasProductTypeL5()

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

optional string product_type_l5 = 14;

Returns
Type Description
boolean

Whether the productTypeL5 field is set.

hasSuggestedPrice()

public boolean hasSuggestedPrice()

Latest suggested price for the product.

.google.shopping.type.Price suggested_price = 16;

Returns
Type Description
boolean

Whether the suggestedPrice field is set.

hasTitle()

public boolean hasTitle()

Title of the product.

optional string title = 3;

Returns
Type Description
boolean

Whether the title 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 PriceInsightsProductView.Builder newBuilderForType()
Returns
Type Description
PriceInsightsProductView.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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