Interface TitleExampleOrBuilder (0.2.0) 

public interface TitleExampleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsFinalProductInfo(String key)

public abstract boolean containsFinalProductInfo(String key)

Required. A map in the same format as product_info but with all improvements included. For example, {"brand": "Dresses4All", "product": "dress", "color": "red", ...}. The order of attributes in this map may be used to guide the order in which they appear in the final generated title. For instance, the above will become: Dresses4All dress | red

map<string, string> final_product_info = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsProductInfo(String key)

public abstract boolean containsProductInfo(String key)

Required. A map containing all existing product information. For example: {"title": "dress", "description": "A red dress", "brand": "Dresses4All"} Any information that you might use to populate your product feed.

map<string, string> product_info = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
key String
Returns
Type Description
boolean

getCategory()

public abstract String getCategory()

Required. The product's category. This helps the AI understand when certain examples are more relevant than others.

optional string category = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The category.

getCategoryBytes()

public abstract ByteString getCategoryBytes()

Required. The product's category. This helps the AI understand when certain examples are more relevant than others.

optional string category = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for category.

getFinalProductInfo() (deprecated)

public abstract Map<String,String> getFinalProductInfo()

Use #getFinalProductInfoMap() instead.

Returns
Type Description
Map<String,String>

getFinalProductInfoCount()

public abstract int getFinalProductInfoCount()

Required. A map in the same format as product_info but with all improvements included. For example, {"brand": "Dresses4All", "product": "dress", "color": "red", ...}. The order of attributes in this map may be used to guide the order in which they appear in the final generated title. For instance, the above will become: Dresses4All dress | red

map<string, string> final_product_info = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getFinalProductInfoMap()

public abstract Map<String,String> getFinalProductInfoMap()

Required. A map in the same format as product_info but with all improvements included. For example, {"brand": "Dresses4All", "product": "dress", "color": "red", ...}. The order of attributes in this map may be used to guide the order in which they appear in the final generated title. For instance, the above will become: Dresses4All dress | red

map<string, string> final_product_info = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Map<String,String>

getFinalProductInfoOrDefault(String key, String defaultValue)

public abstract String getFinalProductInfoOrDefault(String key, String defaultValue)

Required. A map in the same format as product_info but with all improvements included. For example, {"brand": "Dresses4All", "product": "dress", "color": "red", ...}. The order of attributes in this map may be used to guide the order in which they appear in the final generated title. For instance, the above will become: Dresses4All dress | red

map<string, string> final_product_info = 4 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getFinalProductInfoOrThrow(String key)

public abstract String getFinalProductInfoOrThrow(String key)

Required. A map in the same format as product_info but with all improvements included. For example, {"brand": "Dresses4All", "product": "dress", "color": "red", ...}. The order of attributes in this map may be used to guide the order in which they appear in the final generated title. For instance, the above will become: Dresses4All dress | red

map<string, string> final_product_info = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
key String
Returns
Type Description
String

getProductInfo() (deprecated)

public abstract Map<String,String> getProductInfo()

Use #getProductInfoMap() instead.

Returns
Type Description
Map<String,String>

getProductInfoCount()

public abstract int getProductInfoCount()

Required. A map containing all existing product information. For example: {"title": "dress", "description": "A red dress", "brand": "Dresses4All"} Any information that you might use to populate your product feed.

map<string, string> product_info = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getProductInfoMap()

public abstract Map<String,String> getProductInfoMap()

Required. A map containing all existing product information. For example: {"title": "dress", "description": "A red dress", "brand": "Dresses4All"} Any information that you might use to populate your product feed.

map<string, string> product_info = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Map<String,String>

getProductInfoOrDefault(String key, String defaultValue)

public abstract String getProductInfoOrDefault(String key, String defaultValue)

Required. A map containing all existing product information. For example: {"title": "dress", "description": "A red dress", "brand": "Dresses4All"} Any information that you might use to populate your product feed.

map<string, string> product_info = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getProductInfoOrThrow(String key)

public abstract String getProductInfoOrThrow(String key)

Required. A map containing all existing product information. For example: {"title": "dress", "description": "A red dress", "brand": "Dresses4All"} Any information that you might use to populate your product feed.

map<string, string> product_info = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
key String
Returns
Type Description
String

getTitleFormat()

public abstract String getTitleFormat()

Required. The attributes or approximate attributes that make up the title. For example, title "Google GShoe M" title_format can be "brand | product | size".

optional string title_format = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The titleFormat.

getTitleFormatBytes()

public abstract ByteString getTitleFormatBytes()

Required. The attributes or approximate attributes that make up the title. For example, title "Google GShoe M" title_format can be "brand | product | size".

optional string title_format = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for titleFormat.

hasCategory()

public abstract boolean hasCategory()

Required. The product's category. This helps the AI understand when certain examples are more relevant than others.

optional string category = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the category field is set.

hasTitleFormat()

public abstract boolean hasTitleFormat()

Required. The attributes or approximate attributes that make up the title. For example, title "Google GShoe M" title_format can be "brand | product | size".

optional string title_format = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the titleFormat field is set.