Interface ProductPerformanceViewOrBuilder (0.4.0)

public interface ProductPerformanceViewOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAccountDisplayName()

public abstract String getAccountDisplayName()

Merchant Center account name of the seller of the offer. Segment.

Available only for multi-client accounts.

optional string account_display_name = 30;

Returns
Type	Description
`String`	The accountDisplayName.

getAccountDisplayNameBytes()

public abstract ByteString getAccountDisplayNameBytes()

Merchant Center account name of the seller of the offer. Segment.

Available only for multi-client accounts.

optional string account_display_name = 30;

Returns
Type	Description
`ByteString`	The bytes for accountDisplayName.

getAccountId()

public abstract long getAccountId()

Merchant Center account id of the seller of the offer. Segment.

Available only for multi-client accounts.

optional int64 account_id = 29;

Returns
Type	Description
`long`	The accountId.

getBrand()

public abstract String getBrand()

Brand of the product. Segment.

optional string brand = 7;

Returns
Type	Description
`String`	The brand.

getBrandBytes()

public abstract ByteString getBrandBytes()

Brand of the product. Segment.

optional string brand = 7;

Returns
Type	Description
`ByteString`	The bytes for brand.

getCategoryL1()

public abstract String getCategoryL1()

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

optional string category_l1 = 8;

Returns
Type	Description
`String`	The categoryL1.

getCategoryL1Bytes()

public abstract ByteString getCategoryL1Bytes()

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

optional string category_l1 = 8;

Returns
Type	Description
`ByteString`	The bytes for categoryL1.

getCategoryL2()

public abstract String getCategoryL2()

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

optional string category_l2 = 9;

Returns
Type	Description
`String`	The categoryL2.

getCategoryL2Bytes()

public abstract ByteString getCategoryL2Bytes()

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

optional string category_l2 = 9;

Returns
Type	Description
`ByteString`	The bytes for categoryL2.

getCategoryL3()

public abstract String getCategoryL3()

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

optional string category_l3 = 10;

Returns
Type	Description
`String`	The categoryL3.

getCategoryL3Bytes()

public abstract ByteString getCategoryL3Bytes()

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

optional string category_l3 = 10;

Returns
Type	Description
`ByteString`	The bytes for categoryL3.

getCategoryL4()

public abstract String getCategoryL4()

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

optional string category_l4 = 11;

Returns
Type	Description
`String`	The categoryL4.

getCategoryL4Bytes()

public abstract ByteString getCategoryL4Bytes()

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

optional string category_l4 = 11;

Returns
Type	Description
`ByteString`	The bytes for categoryL4.

getCategoryL5()

public abstract String getCategoryL5()

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

optional string category_l5 = 12;

Returns
Type	Description
`String`	The categoryL5.

getCategoryL5Bytes()

public abstract ByteString getCategoryL5Bytes()

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

optional string category_l5 = 12;

Returns
Type	Description
`ByteString`	The bytes for categoryL5.

getClickThroughRate()

public abstract double getClickThroughRate()

Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions). Metric.

optional double click_through_rate = 25;

Returns
Type	Description
`double`	The clickThroughRate.

getClicks()

public abstract long getClicks()

Number of clicks. Metric.

optional int64 clicks = 23;

Returns
Type	Description
`long`	The clicks.

getConversionRate()

public abstract double getConversionRate()

Number of conversions divided by the number of clicks, reported on the impression date. Metric.

Available only for the FREE traffic source.

optional double conversion_rate = 28;

Returns
Type	Description
`double`	The conversionRate.

getConversionValue()

public abstract Price getConversionValue()

Value of conversions attributed to the product, reported on the conversion date. Metric.

Available only for the FREE traffic source.

.google.shopping.type.Price conversion_value = 27;

Returns
Type	Description
`Price`	The conversionValue.

getConversionValueOrBuilder()

public abstract PriceOrBuilder getConversionValueOrBuilder()

Value of conversions attributed to the product, reported on the conversion date. Metric.

Available only for the FREE traffic source.

.google.shopping.type.Price conversion_value = 27;

Returns
Type	Description
`PriceOrBuilder`

getConversions()

public abstract double getConversions()

Number of conversions attributed to the product, reported on the conversion date. Depending on the attribution model, a conversion might be distributed across multiple clicks, where each click gets its own credit assigned. This metric is a sum of all such credits. Metric.

Available only for the FREE traffic source.

optional double conversions = 26;

Returns
Type	Description
`double`	The conversions.

getCustomLabel0()

public abstract String getCustomLabel0()

Custom label 0 for custom grouping of products. Segment.

optional string custom_label0 = 18;

Returns
Type	Description
`String`	The customLabel0.

getCustomLabel0Bytes()

public abstract ByteString getCustomLabel0Bytes()

Custom label 0 for custom grouping of products. Segment.

optional string custom_label0 = 18;

Returns
Type	Description
`ByteString`	The bytes for customLabel0.

getCustomLabel1()

public abstract String getCustomLabel1()

Custom label 1 for custom grouping of products. Segment.

optional string custom_label1 = 19;

Returns
Type	Description
`String`	The customLabel1.

getCustomLabel1Bytes()

public abstract ByteString getCustomLabel1Bytes()

Custom label 1 for custom grouping of products. Segment.

optional string custom_label1 = 19;

Returns
Type	Description
`ByteString`	The bytes for customLabel1.

getCustomLabel2()

public abstract String getCustomLabel2()

Custom label 2 for custom grouping of products. Segment.

optional string custom_label2 = 20;

Returns
Type	Description
`String`	The customLabel2.

getCustomLabel2Bytes()

public abstract ByteString getCustomLabel2Bytes()

Custom label 2 for custom grouping of products. Segment.

optional string custom_label2 = 20;

Returns
Type	Description
`ByteString`	The bytes for customLabel2.

getCustomLabel3()

public abstract String getCustomLabel3()

Custom label 3 for custom grouping of products. Segment.

optional string custom_label3 = 21;

Returns
Type	Description
`String`	The customLabel3.

getCustomLabel3Bytes()

public abstract ByteString getCustomLabel3Bytes()

Custom label 3 for custom grouping of products. Segment.

optional string custom_label3 = 21;

Returns
Type	Description
`ByteString`	The bytes for customLabel3.

getCustomLabel4()

public abstract String getCustomLabel4()

Custom label 4 for custom grouping of products. Segment.

optional string custom_label4 = 22;

Returns
Type	Description
`String`	The customLabel4.

getCustomLabel4Bytes()

public abstract ByteString getCustomLabel4Bytes()

Custom label 4 for custom grouping of products. Segment.

optional string custom_label4 = 22;

Returns
Type	Description
`ByteString`	The bytes for customLabel4.

getCustomerCountryCode()

public abstract String getCustomerCountryCode()

Code of the country where the customer is located at the time of the event. Represented in the ISO 3166 format. Segment.

If the customer country cannot be determined, a special 'ZZ' code is returned.

optional string customer_country_code = 4;

Returns
Type	Description
`String`	The customerCountryCode.

getCustomerCountryCodeBytes()

public abstract ByteString getCustomerCountryCodeBytes()

Code of the country where the customer is located at the time of the event. Represented in the ISO 3166 format. Segment.

If the customer country cannot be determined, a special 'ZZ' code is returned.

optional string customer_country_code = 4;

Returns
Type	Description
`ByteString`	The bytes for customerCountryCode.

getDate()

public abstract Date getDate()

Date in the merchant timezone to which metrics apply. Segment.

Condition on date is required in the WHERE clause.

.google.type.Date date = 2;

Returns
Type	Description
`com.google.type.Date`	The date.

getDateOrBuilder()

public abstract DateOrBuilder getDateOrBuilder()

Date in the merchant timezone to which metrics apply. Segment.

Condition on date is required in the WHERE clause.

.google.type.Date date = 2;

Returns
Type	Description
`com.google.type.DateOrBuilder`

getDestination()

public abstract Destination getDestination()

Destination of the product to which metrics apply. Segment.

Product performance data is not available for the LOCAL_INVENTORY_ADS destination.

optional .google.shopping.type.Destination destination = 1;

Returns
Type	Description
`Destination`	The destination.

getDestinationValue()

public abstract int getDestinationValue()

Destination of the product to which metrics apply. Segment.

Product performance data is not available for the LOCAL_INVENTORY_ADS destination.

optional .google.shopping.type.Destination destination = 1;

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

getExternalAccountId()

public abstract String getExternalAccountId()

External account id submitted in an offer feed by a multi-seller account to identify the seller of the offer. Segment.

Available only for multi-client accounts. This field is non-empty only for auto-seller accounts.

optional string external_account_id = 31;

Returns
Type	Description
`String`	The externalAccountId.

getExternalAccountIdBytes()

public abstract ByteString getExternalAccountIdBytes()

External account id submitted in an offer feed by a multi-seller account to identify the seller of the offer. Segment.

Available only for multi-client accounts. This field is non-empty only for auto-seller accounts.

optional string external_account_id = 31;

Returns
Type	Description
`ByteString`	The bytes for externalAccountId.

getImpressions()

public abstract long getImpressions()

Number of times merchant's products are shown. Metric.

optional int64 impressions = 24;

Returns
Type	Description
`long`	The impressions.

getOfferId()

public abstract String getOfferId()

Merchant-provided id of the product. Segment.

optional string offer_id = 5;

Returns
Type	Description
`String`	The offerId.

getOfferIdBytes()

public abstract ByteString getOfferIdBytes()

Merchant-provided id of the product. Segment.

optional string offer_id = 5;

Returns
Type	Description
`ByteString`	The bytes for offerId.

getProductTypeL1()

public abstract String getProductTypeL1()

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

optional string product_type_l1 = 13;

Returns
Type	Description
`String`	The productTypeL1.

getProductTypeL1Bytes()

public abstract ByteString getProductTypeL1Bytes()

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

optional string product_type_l1 = 13;

Returns
Type	Description
`ByteString`	The bytes for productTypeL1.

getProductTypeL2()

public abstract String getProductTypeL2()

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

optional string product_type_l2 = 14;

Returns
Type	Description
`String`	The productTypeL2.

getProductTypeL2Bytes()

public abstract ByteString getProductTypeL2Bytes()

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

optional string product_type_l2 = 14;

Returns
Type	Description
`ByteString`	The bytes for productTypeL2.

getProductTypeL3()

public abstract String getProductTypeL3()

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

optional string product_type_l3 = 15;

Returns
Type	Description
`String`	The productTypeL3.

getProductTypeL3Bytes()

public abstract ByteString getProductTypeL3Bytes()

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

optional string product_type_l3 = 15;

Returns
Type	Description
`ByteString`	The bytes for productTypeL3.

getProductTypeL4()

public abstract String getProductTypeL4()

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

optional string product_type_l4 = 16;

Returns
Type	Description
`String`	The productTypeL4.

getProductTypeL4Bytes()

public abstract ByteString getProductTypeL4Bytes()

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

optional string product_type_l4 = 16;

Returns
Type	Description
`ByteString`	The bytes for productTypeL4.

getProductTypeL5()

public abstract String getProductTypeL5()

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

optional string product_type_l5 = 17;

Returns
Type	Description
`String`	The productTypeL5.

getProductTypeL5Bytes()

public abstract ByteString getProductTypeL5Bytes()

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

optional string product_type_l5 = 17;

Returns
Type	Description
`ByteString`	The bytes for productTypeL5.

getTitle()

public abstract String getTitle()

Title of the product. Segment.

optional string title = 6;

Returns
Type	Description
`String`	The title.

getTitleBytes()

public abstract ByteString getTitleBytes()

Title of the product. Segment.

optional string title = 6;

Returns
Type	Description
`ByteString`	The bytes for title.

getWeek()

public abstract Date getWeek()

First day of the week (Monday) of the metrics date in the merchant timezone. Segment.

.google.type.Date week = 3;

Returns
Type	Description
`com.google.type.Date`	The week.

getWeekOrBuilder()

public abstract DateOrBuilder getWeekOrBuilder()

First day of the week (Monday) of the metrics date in the merchant timezone. Segment.

.google.type.Date week = 3;

Returns
Type	Description
`com.google.type.DateOrBuilder`

hasAccountDisplayName()

public abstract boolean hasAccountDisplayName()

Merchant Center account name of the seller of the offer. Segment.

Available only for multi-client accounts.

optional string account_display_name = 30;

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

hasAccountId()

public abstract boolean hasAccountId()

Merchant Center account id of the seller of the offer. Segment.

Available only for multi-client accounts.

optional int64 account_id = 29;

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

hasBrand()

public abstract boolean hasBrand()

Brand of the product. Segment.

optional string brand = 7;

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

hasCategoryL1()

public abstract boolean hasCategoryL1()

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

optional string category_l1 = 8;

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

hasCategoryL2()

public abstract boolean hasCategoryL2()

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

optional string category_l2 = 9;

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

hasCategoryL3()

public abstract boolean hasCategoryL3()

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

optional string category_l3 = 10;

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

hasCategoryL4()

public abstract boolean hasCategoryL4()

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

optional string category_l4 = 11;

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

hasCategoryL5()

public abstract boolean hasCategoryL5()

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

optional string category_l5 = 12;

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

hasClickThroughRate()

public abstract boolean hasClickThroughRate()

Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions). Metric.

optional double click_through_rate = 25;

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

hasClicks()

public abstract boolean hasClicks()

Number of clicks. Metric.

optional int64 clicks = 23;

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

hasConversionRate()

public abstract boolean hasConversionRate()

Number of conversions divided by the number of clicks, reported on the impression date. Metric.

Available only for the FREE traffic source.

optional double conversion_rate = 28;

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

hasConversionValue()

public abstract boolean hasConversionValue()

Value of conversions attributed to the product, reported on the conversion date. Metric.

Available only for the FREE traffic source.

.google.shopping.type.Price conversion_value = 27;

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

hasConversions()

public abstract boolean hasConversions()

Available only for the FREE traffic source.

optional double conversions = 26;

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

hasCustomLabel0()

public abstract boolean hasCustomLabel0()

Custom label 0 for custom grouping of products. Segment.

optional string custom_label0 = 18;

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

hasCustomLabel1()

public abstract boolean hasCustomLabel1()

Custom label 1 for custom grouping of products. Segment.

optional string custom_label1 = 19;

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

hasCustomLabel2()

public abstract boolean hasCustomLabel2()

Custom label 2 for custom grouping of products. Segment.

optional string custom_label2 = 20;

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

hasCustomLabel3()

public abstract boolean hasCustomLabel3()

Custom label 3 for custom grouping of products. Segment.

optional string custom_label3 = 21;

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

hasCustomLabel4()

public abstract boolean hasCustomLabel4()

Custom label 4 for custom grouping of products. Segment.

optional string custom_label4 = 22;

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

hasCustomerCountryCode()

public abstract boolean hasCustomerCountryCode()

Code of the country where the customer is located at the time of the event. Represented in the ISO 3166 format. Segment.

If the customer country cannot be determined, a special 'ZZ' code is returned.

optional string customer_country_code = 4;

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

hasDate()

public abstract boolean hasDate()

Date in the merchant timezone to which metrics apply. Segment.

Condition on date is required in the WHERE clause.

.google.type.Date date = 2;

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

hasDestination()

public abstract boolean hasDestination()

Destination of the product to which metrics apply. Segment.

Product performance data is not available for the LOCAL_INVENTORY_ADS destination.

optional .google.shopping.type.Destination destination = 1;

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

hasExternalAccountId()

public abstract boolean hasExternalAccountId()

External account id submitted in an offer feed by a multi-seller account to identify the seller of the offer. Segment.

Available only for multi-client accounts. This field is non-empty only for auto-seller accounts.

optional string external_account_id = 31;

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

hasImpressions()

public abstract boolean hasImpressions()

Number of times merchant's products are shown. Metric.

optional int64 impressions = 24;

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

hasOfferId()

public abstract boolean hasOfferId()

Merchant-provided id of the product. Segment.

optional string offer_id = 5;

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

hasProductTypeL1()

public abstract boolean hasProductTypeL1()

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

optional string product_type_l1 = 13;

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. Segment.

optional string product_type_l2 = 14;

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. Segment.

optional string product_type_l3 = 15;

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. Segment.

optional string product_type_l4 = 16;

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. Segment.

optional string product_type_l5 = 17;

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

hasTitle()

public abstract boolean hasTitle()

Title of the product. Segment.

optional string title = 6;

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

hasWeek()

public abstract boolean hasWeek()

First day of the week (Monday) of the metrics date in the merchant timezone. Segment.

.google.type.Date week = 3;

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